Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class AnalyzeContentResponse.
The response message for Participants.AnalyzeContent.
Generated from protobuf message google.cloud.dialogflow.v2.AnalyzeContentResponse
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ reply_text |
string
The output text content. This field is set if the automated agent responded with text to show to the user. |
↳ reply_audio |
Google\Cloud\Dialogflow\V2\OutputAudio
The audio data bytes encoded as specified in the request. This field is set if: - |
↳ automated_agent_reply |
Google\Cloud\Dialogflow\V2\AutomatedAgentReply
Only set if a Dialogflow automated agent has responded. Note that: AutomatedAgentReply.detect_intent_response.output_audio and AutomatedAgentReply.detect_intent_response.output_audio_config are always empty, use reply_audio instead. |
↳ message |
Google\Cloud\Dialogflow\V2\Message
Message analyzed by CCAI. |
↳ human_agent_suggestion_results |
array<Google\Cloud\Dialogflow\V2\SuggestionResult>
The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config. Note that any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult. |
↳ end_user_suggestion_results |
array<Google\Cloud\Dialogflow\V2\SuggestionResult>
The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config. Same as human_agent_suggestion_results, any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult. |
↳ dtmf_parameters |
Google\Cloud\Dialogflow\V2\DtmfParameters
Indicates the parameters of DTMF. |
getReplyText
The output text content.
This field is set if the automated agent responded with text to show to the user.
| Returns | |
|---|---|
| Type | Description |
string | |
setReplyText
The output text content.
This field is set if the automated agent responded with text to show to the user.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getReplyAudio
The audio data bytes encoded as specified in the request.
This field is set if:
reply_audio_configwas specified in the request, or- The automated agent responded with audio to play to the user. In such
case,
reply_audio.configcontains settings used to synthesize the speech. 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 |
Google\Cloud\Dialogflow\V2\OutputAudio|null | |
hasReplyAudio
clearReplyAudio
setReplyAudio
The audio data bytes encoded as specified in the request.
This field is set if:
reply_audio_configwas specified in the request, or- The automated agent responded with audio to play to the user. In such
case,
reply_audio.configcontains settings used to synthesize the speech. 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 |
Google\Cloud\Dialogflow\V2\OutputAudio
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAutomatedAgentReply
Only set if a Dialogflow automated agent has responded.
Note that: AutomatedAgentReply.detect_intent_response.output_audio and AutomatedAgentReply.detect_intent_response.output_audio_config are always empty, use reply_audio instead.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\AutomatedAgentReply|null | |
hasAutomatedAgentReply
clearAutomatedAgentReply
setAutomatedAgentReply
Only set if a Dialogflow automated agent has responded.
Note that: AutomatedAgentReply.detect_intent_response.output_audio and AutomatedAgentReply.detect_intent_response.output_audio_config are always empty, use reply_audio instead.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\AutomatedAgentReply
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMessage
Message analyzed by CCAI.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\Message|null | |
hasMessage
clearMessage
setMessage
Message analyzed by CCAI.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\Message
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getHumanAgentSuggestionResults
The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.
Note that any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setHumanAgentSuggestionResults
The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config.
Note that any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\V2\SuggestionResult>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEndUserSuggestionResults
The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.
Same as human_agent_suggestion_results, any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setEndUserSuggestionResults
The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.
Same as human_agent_suggestion_results, any failure of Agent Assist features will not lead to the overall failure of an AnalyzeContent API call. Instead, the features will fail silently with the error field set in the corresponding SuggestionResult.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dialogflow\V2\SuggestionResult>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDtmfParameters
Indicates the parameters of DTMF.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\DtmfParameters|null | |
hasDtmfParameters
clearDtmfParameters
setDtmfParameters
Indicates the parameters of DTMF.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\DtmfParameters
|
| Returns | |
|---|---|
| Type | Description |
$this | |