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 \ V3Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
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 |
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 |
↳ output_audio_config |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQueryResult
The result of the conversational query.
| Returns | |
|---|---|
| Type | Description |
QueryResult|null |
|
hasQueryResult
clearQueryResult
setQueryResult
The result of the conversational query.
| Parameter | |
|---|---|
| Name | Description |
var |
QueryResult
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOutputAudioConfig
The config used by the speech synthesizer to generate the output audio.
| Returns | |
|---|---|
| Type | Description |
OutputAudioConfig|null |
|
hasOutputAudioConfig
clearOutputAudioConfig
setOutputAudioConfig
The config used by the speech synthesizer to generate the output audio.
| Parameter | |
|---|---|
| Name | Description |
var |
OutputAudioConfig
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getResponseType
Response type.
| Returns | |
|---|---|
| Type | Description |
int |
|
setResponseType
Response type.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|