Method: projects.matchIntents
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Encontra os intents que correspondem a uma determinada consulta.
Solicitação HTTP
POST https://actions.googleapis.com/v2/{project=projects/*}:matchIntents
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
| Parâmetros |
project |
string
Obrigatório. O projeto que está sendo testado, indicado pelo ID do projeto. Formato: projects/{project}
|
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
| Representação JSON |
{
"query": string,
"locale": string
} |
| Campos |
query |
string
Obrigatório. Consulta do usuário como texto simples.
|
locale |
string
Obrigatório. Localidade a ser usada para avaliar a consulta, como "en". O formato precisa seguir o BCP 47: https://tools.ietf.org/html/bcp47. Consulte a lista de idiomas compatíveis em https://developers.google.com/assistant/console/languages-locales
|
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Resposta para encontrar intents correspondentes.
| Representação JSON |
{
"matchedIntents": [
{
object (Intent)
}
]
} |
| Campos |
matchedIntents[] |
object (Intent)
Intents correspondentes, ordenadas da mais para a menos relevante. Somente as primeiras 50 correspondências são retornadas.
|
Intenção
| Representação JSON |
{
"name": string,
"params": {
string: {
object (IntentParameterValue)
},
...
},
"query": string
} |
| Campos |
name |
string
Obrigatório. O nome da última intent correspondente.
|
params |
map (key: string, value: object (IntentParameterValue))
Obrigatório. Representa os parâmetros identificados como parte da correspondência de intents. Esse é um mapa do nome do parâmetro identificado para o valor dele na entrada do usuário. Todos os parâmetros definidos na intent correspondente que forem identificados serão exibidos aqui. Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
|
query |
string
Opcional. Entrada digitada ou falada do usuário final que correspondeu à intent. Ele será preenchido quando houver correspondência com uma intent, com base na entrada do usuário.
|
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-26 UTC.
[null,null,["Última atualização 2025-07-26 UTC."],[[["\u003cp\u003eFinds the intents that match a given user query, returning the top 50 matches ranked by relevance.\u003c/p\u003e\n"],["\u003cp\u003eRequires a \u003ccode\u003ePOST\u003c/code\u003e request to the specified endpoint, including the project ID and user query.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain the user query as plain text and the locale for evaluation.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes a list of matched intents, each with its name, parameters, and the original query.\u003c/p\u003e\n"],["\u003cp\u003eEach intent object provides details like the intent name, identified parameters, and the portion of the user input that triggered the match.\u003c/p\u003e\n"]]],["This document details the process of matching user queries to intents via a `POST` request to `https://actions.googleapis.com/v2/{project=projects/*}:matchIntents`. The request requires a `project` path parameter, a JSON body with `query` and `locale` strings. The response returns a JSON object with `matchedIntents`, an array of matched intents, each with `name`, `params` (parameter name-value pairs), and `query` fields. Only the first 50 matching intents are returned, ordered from most to least relevant.\n"],null,["# Method: projects.matchIntents\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.MatchIntentsResponse.SCHEMA_REPRESENTATION)\n- [Intent](#Intent)\n - [JSON representation](#Intent.SCHEMA_REPRESENTATION)\n\nFinds the intents that match a given query.\n\n### HTTP request\n\n`POST https://actions.googleapis.com/v2/{project=projects/*}:matchIntents`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-----------|------------------------------------------------------------------------------------------------------|\n| `project` | `string` Required. The project being tested, indicated by the Project ID. Format: projects/{project} |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|-----------------------------------------------|---|\n| ``` { \"query\": string, \"locale\": string } ``` |\n\n| Fields ||\n|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `query` | `string` Required. User query as plain text. |\n| `locale` | `string` Required. Locale to use to evaluate the query, such as \"en\". The format should follow BCP 47: \u003chttps://tools.ietf.org/html/bcp47\u003e See the list of supported languages in \u003chttps://developers.google.com/assistant/console/languages-locales\u003e |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse for finding matching intents.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"matchedIntents\": [ { object (/assistant/actions/api/reference/rest/v2/projects/matchIntents#Intent) } ] } ``` |\n\n| Fields ||\n|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `matchedIntents[]` | `object (`[Intent](/assistant/actions/api/reference/rest/v2/projects/matchIntents#Intent)`)` Intents matched, ordered from most to least relevant. Only the first 50 matches are returned. |\n\nIntent\n------\n\nRepresents an intent.\n\n| JSON representation ||\n|----------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"params\": { string: { object (/assistant/actions/api/reference/rest/v2/IntentParameterValue) }, ... }, \"query\": string } ``` |\n\n| Fields ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the last matched intent. |\n| `params` | `map (key: string, value: object (`[IntentParameterValue](/assistant/actions/api/reference/rest/v2/IntentParameterValue)`))` Required. Represents parameters identified as part of intent matching. This is a map of the name of the identified parameter to the value of the parameter identified from user input. All parameters defined in the matched intent that are identified will be surfaced here. An object containing a list of `\"key\": value` pairs. Example: `{ \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }`. |\n| `query` | `string` Optional. Typed or spoken input from the end user that matched this intent. This will be populated when an intent is matched, based on the user input. |"]]
