DetectIntentResponse

Stay organized with collections Save and categorize content based on your preferences.

The message returned from the sessions.detectIntent method.

JSON representation 
{
  "responseId": string,
  "queryResult": {
    object (QueryResult)
  },
  "outputAudio": string,
  "outputAudioConfig": {
    object (OutputAudioConfig)
  },
  "responseType": enum (ResponseType),
  "allowCancellation": boolean
}
Fields
responseId

string

Output only. The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.
queryResult

object (QueryResult)

The result of the conversational query.
outputAudio

string (bytes format)

The audio data bytes encoded as specified in the request. Note: The output audio is generated based on the values of default platform text responses found in the queryResult.response_messages field. If multiple default text responses exist, they will be concatenated when generating audio. If no default platform text responses exist, the generated audio content will be empty.

In some scenarios, multiple output audio fields may be present in the response structure. In these cases, only the top-most-level audio output has content.

A base64-encoded string.
outputAudioConfig

object (OutputAudioConfig)

The config used by the speech synthesizer to generate the output audio.
responseType

enum (ResponseType)

Response type.
allowCancellation

boolean

Indicates whether the partial response can be cancelled when a later response arrives. e.g. if the agent specified some music as partial response, it can be cancelled.

ResponseType

Represents different DetectIntentResponse types.

Enums
RESPONSE_TYPE_UNSPECIFIED Not specified. This should never happen.
PARTIAL Partial response. e.g. Aggregated responses in a Fulfillment that enables return_partial_response can be returned as partial response. WARNING: partial response is not eligible for barge-in.
FINAL Final response.