Google Cloud Dialogflow Cx V3 Client - Class DetectIntentResponse (0.2.1)

Reference documentation and code samples for the Google Cloud Dialogflow Cx V3 Client class DetectIntentResponse.

The message returned from the DetectIntent method.

Generated from protobuf message google.cloud.dialogflow.cx.v3.DetectIntentResponse

Namespace

Google \ Cloud \ Dialogflow \ Cx \ V3

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ response_id 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.

↳ query_result Google\Cloud\Dialogflow\Cx\V3\QueryResult

The result of the conversational query.

↳ output_audio string

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 query_result.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.

↳ output_audio_config Google\Cloud\Dialogflow\Cx\V3\OutputAudioConfig

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

↳ response_type int

Response type.

↳ allow_cancellation bool

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.

getResponseId

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.

Returns
TypeDescription
string

setResponseId

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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getQueryResult

The result of the conversational query.

Returns
TypeDescription
Google\Cloud\Dialogflow\Cx\V3\QueryResult|null

hasQueryResult

clearQueryResult

setQueryResult

The result of the conversational query.

Parameter
NameDescription
var Google\Cloud\Dialogflow\Cx\V3\QueryResult
Returns
TypeDescription
$this

getOutputAudio

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 query_result.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.

Returns
TypeDescription
string

setOutputAudio

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 query_result.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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOutputAudioConfig

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

Returns
TypeDescription
Google\Cloud\Dialogflow\Cx\V3\OutputAudioConfig|null

hasOutputAudioConfig

clearOutputAudioConfig

setOutputAudioConfig

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

Parameter
NameDescription
var Google\Cloud\Dialogflow\Cx\V3\OutputAudioConfig
Returns
TypeDescription
$this

getResponseType

Response type.

Returns
TypeDescription
int

setResponseType

Response type.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAllowCancellation

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.

Returns
TypeDescription
bool

setAllowCancellation

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.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this