Method: projects.locations.agents.environments.sessions.matchIntent

Returns preliminary intent match results, doesn't change the session status.

HTTP request

POST https://{endpoint}/v3/{session=projects/*/locations/*/agents/*/environments/*/sessions/*}:matchIntent

Where {endpoint} is one of the supported service endpoints.

The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
session

string

Required. The name of the session this query is sent to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. If Environment ID is not specified, we assume default 'draft' environment. It's up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters.

For more information, see the sessions guide.

Authorization requires the following IAM permission on the specified resource session:

  • dialogflow.sessions.detectIntent

Request body

The request body contains data with the following structure:

JSON representation 
{
  "queryParams": {
    object (QueryParameters)
  },
  "queryInput": {
    object (QueryInput)
  },
  "persistParameterChanges": boolean
}
Fields
queryParams

object (QueryParameters)

The parameters of this query.
queryInput

object (QueryInput)

Required. The input specification.
persistParameterChanges

boolean

Persist session parameter changes from queryParams.

Response body

If successful, the response body contains an instance of MatchIntentResponse.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/dialogflow

For more information, see the Authentication Overview.