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. Eachrecognition_resultrepresents a more complete transcript of what the user said. The lastrecognition_resulthasis_finalset totrue. - In virtual agent stage: if
enable_partial_automated_agent_replyis true, the following N (currently 1 <= N <= 4) messages containautomated_agent_replyand optionallyreply_audioreturned by the virtual agent. The first (N-1)automated_agent_replys will haveautomated_agent_reply_typeset toPARTIAL. The lastautomated_agent_replyhasautomated_agent_reply_typeset toFINAL. Ifenable_partial_automated_agent_replyis not enabled, response stream only contains the final reply. In human assist stage: the following N (N >= 1) messages containhuman_agent_suggestion_results,end_user_suggestion_resultsormessage.
Generated from protobuf message google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ recognition_result
↳ 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
↳ 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
getRecognitionResult
The result of speech recognition.
hasRecognitionResult
clearRecognitionResult
setRecognitionResult
The result of speech recognition.
$this
getReplyText
The output text content.
This field is set if an automated agent responded with a text for the user.
string
setReplyText
The output text content.
This field is set if an automated agent responded with a text for the user.
var
string
$this
getReplyAudio
The audio data bytes encoded as specified in the request.
This field is set if:
- The
reply_audio_configfield is specified in the request. - The automated agent, which this output comes from, responded with audio.
In such case, the
reply_audio.configfield 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.
hasReplyAudio
clearReplyAudio
setReplyAudio
The audio data bytes encoded as specified in the request.
This field is set if:
- The
reply_audio_configfield is specified in the request. - The automated agent, which this output comes from, responded with audio.
In such case, the
reply_audio.configfield 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.
$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.
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.
$this
getMessage
Message analyzed by CCAI.
hasMessage
clearMessage
setMessage
Message analyzed by CCAI.
$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 .
setHumanAgentSuggestionResults
The suggestions for most recent human agent. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.human_agent_suggestion_config .
$this
getEndUserSuggestionResults
The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config .
setEndUserSuggestionResults
The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config .
$this
getDtmfParameters
Indicates the parameters of DTMF.
hasDtmfParameters
clearDtmfParameters
setDtmfParameters
Indicates the parameters of DTMF.
$this
