Google Cloud Dialogflow v2 API - Class StreamingAnalyzeContentResponse (4.24.0)

public sealed class StreamingAnalyzeContentResponse : IMessage<StreamingAnalyzeContentResponse>, IEquatable<StreamingAnalyzeContentResponse>, IDeepCloneable<StreamingAnalyzeContentResponse>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Dialogflow v2 API class StreamingAnalyzeContentResponse.

The top-level message returned from the StreamingAnalyzeContent method.

Multiple response messages can be returned in order:

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

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

Inheritance

object > StreamingAnalyzeContentResponse

Namespace

Google.Cloud.Dialogflow.V2

Assembly

Google.Cloud.Dialogflow.V2.dll

Constructors

StreamingAnalyzeContentResponse()

public StreamingAnalyzeContentResponse()

StreamingAnalyzeContentResponse(StreamingAnalyzeContentResponse)

public StreamingAnalyzeContentResponse(StreamingAnalyzeContentResponse other)
Parameter
Name Description
other StreamingAnalyzeContentResponse

Properties

AutomatedAgentReply

public AutomatedAgentReply AutomatedAgentReply { get; set; }

Note that in [AutomatedAgentReply.DetectIntentResponse][], [Sessions.DetectIntentResponse.output_audio][] and [Sessions.DetectIntentResponse.output_audio_config][] are always empty, use [reply_audio][google.cloud.dialogflow.v2.StreamingAnalyzeContentResponse.reply_audio] instead.

Property Value
Type Description
AutomatedAgentReply

DebuggingInfo

public CloudConversationDebuggingInfo DebuggingInfo { get; set; }

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

Property Value
Type Description
CloudConversationDebuggingInfo

DtmfParameters

public DtmfParameters DtmfParameters { get; set; }

Indicates the parameters of DTMF.

Property Value
Type Description
DtmfParameters

EndUserSuggestionResults

public RepeatedField<SuggestionResult> EndUserSuggestionResults { get; }

The suggestions for end user. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.end_user_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.end_user_suggestion_config].

Property Value
Type Description
RepeatedFieldSuggestionResult

HumanAgentSuggestionResults

public RepeatedField<SuggestionResult> HumanAgentSuggestionResults { get; }

The suggestions for most recent human agent. The order is the same as [HumanAgentAssistantConfig.SuggestionConfig.feature_configs][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.SuggestionConfig.feature_configs] of [HumanAgentAssistantConfig.human_agent_suggestion_config][google.cloud.dialogflow.v2.HumanAgentAssistantConfig.human_agent_suggestion_config].

Property Value
Type Description
RepeatedFieldSuggestionResult

Message

public Message Message { get; set; }

Message analyzed by CCAI.

Property Value
Type Description
Message

RecognitionResult

public StreamingRecognitionResult RecognitionResult { get; set; }

The result of speech recognition.

Property Value
Type Description
StreamingRecognitionResult

ReplyAudio

public OutputAudio ReplyAudio { get; set; }

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.

Property Value
Type Description
OutputAudio

ReplyText

public string ReplyText { get; set; }

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

Property Value
Type Description
string