Google Cloud Dialogflow V2 Client - Class StreamingAnalyzeContentResponse (1.4.0)

Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class StreamingAnalyzeContentResponse.

The top-level message returned from the StreamingAnalyzeContent method.

Multiple response messages can be returned in order:

If the input was set to streaming audio, the first one or more messages contain recognition_result. Each recognition_result represents a more complete transcript of what the user said. The last recognition_result has is_final set to true.
In virtual agent stage: if enable_partial_automated_agent_reply is true, the following N (currently 1 <= N <= 4) messages contain automated_agent_reply and optionally reply_audio returned by the virtual agent. The first (N-1) automated_agent_replys will have automated_agent_reply_type set to PARTIAL. The last automated_agent_reply has automated_agent_reply_type set to FINAL. If enable_partial_automated_agent_reply is not enabled, response stream only contains the final reply. In human assist stage: the following N (N >= 1) messages contain human_agent_suggestion_results, end_user_suggestion_results or message.

Generated from protobuf message google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ recognition_result`	`Google\Cloud\Dialogflow\V2\StreamingRecognitionResult` The result of speech recognition.
`↳ reply_text`	`string` The output text content. This field is set if an automated agent responded with a text for the user.
`↳ reply_audio`	`Google\Cloud\Dialogflow\V2\OutputAudio` The audio data bytes encoded as specified in the request. This field is set if: - The `reply_audio_config` field is specified in the request. - The automated agent, which this output comes from, responded with audio. In such case, the `reply_audio.config` field contains 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.
`↳ 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.
`↳ 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.
`↳ dtmf_parameters`	`Google\Cloud\Dialogflow\V2\DtmfParameters` Indicates the parameters of DTMF.
`↳ debugging_info`	`Google\Cloud\Dialogflow\V2\CloudConversationDebuggingInfo` Debugging info that would get populated when `StreamingAnalyzeContentRequest.enable_debugging_info` is set to true.

getRecognitionResult

The result of speech recognition.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\StreamingRecognitionResult\|null`

hasRecognitionResult

clearRecognitionResult

setRecognitionResult

The result of speech recognition.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\StreamingRecognitionResult`

Returns
Type	Description
`$this`

getReplyText

The output text content.

This field is set if an automated agent responded with a text for the user.

Returns
Type	Description
`string`

setReplyText

The output text content.

This field is set if an automated agent responded with a text for 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:

The reply_audio_config field is specified in the request.
The automated agent, which this output comes from, responded with audio. In such case, the reply_audio.config field contains 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:

The reply_audio_config field is specified in the request.
The automated agent, which this output comes from, responded with audio. In such case, the reply_audio.config field contains 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.

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.

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.

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.

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`

getDebuggingInfo

Debugging info that would get populated when StreamingAnalyzeContentRequest.enable_debugging_info is set to true.

Returns
Type	Description
`Google\Cloud\Dialogflow\V2\CloudConversationDebuggingInfo\|null`

hasDebuggingInfo

clearDebuggingInfo

setDebuggingInfo

Debugging info that would get populated when StreamingAnalyzeContentRequest.enable_debugging_info is set to true.

Parameter
Name	Description
`var`	`Google\Cloud\Dialogflow\V2\CloudConversationDebuggingInfo`

Returns
Type	Description
`$this`