Google Cloud Dialogflow v2beta1 API - Class StreamingDetectIntentResponse (1.0.0-beta13)

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

Reference documentation and code samples for the Google Cloud Dialogflow v2beta1 API class StreamingDetectIntentResponse.

The top-level message returned from the StreamingDetectIntent method.

Multiple response messages can be returned in order:

  1. If the StreamingDetectIntentRequest.input_audio field was set, the recognition_result field is populated for one or more messages. See the [StreamingRecognitionResult][google.cloud.dialogflow.v2beta1.StreamingRecognitionResult] message for details about the result message sequence.

  2. The next message contains response_id, query_result, alternative_query_results and optionally webhook_status if a WebHook was called.

  3. If output_audio_config was specified in the request or agent-level speech synthesizer is configured, all subsequent messages contain output_audio and output_audio_config.

Inheritance

object > StreamingDetectIntentResponse

Namespace

Google.Cloud.Dialogflow.V2Beta1

Assembly

Google.Cloud.Dialogflow.V2Beta1.dll

Constructors

StreamingDetectIntentResponse()

public StreamingDetectIntentResponse()

StreamingDetectIntentResponse(StreamingDetectIntentResponse)

public StreamingDetectIntentResponse(StreamingDetectIntentResponse other)
Parameter
NameDescription
otherStreamingDetectIntentResponse

Properties

AlternativeQueryResults

public RepeatedField<QueryResult> AlternativeQueryResults { get; }

If Knowledge Connectors are enabled, there could be more than one result returned for a given query or event, and this field will contain all results except for the top one, which is captured in query_result. The alternative results are ordered by decreasing QueryResult.intent_detection_confidence. If Knowledge Connectors are disabled, this field will be empty until multiple responses for regular intents are supported, at which point those additional results will be surfaced here.

Property Value
TypeDescription
RepeatedFieldQueryResult

DebuggingInfo

public CloudConversationDebuggingInfo DebuggingInfo { get; set; }

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

Property Value
TypeDescription
CloudConversationDebuggingInfo

OutputAudio

public ByteString OutputAudio { get; set; }

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

Property Value
TypeDescription
ByteString

OutputAudioConfig

public OutputAudioConfig OutputAudioConfig { get; set; }

The config used by the speech synthesizer to generate the output audio.

Property Value
TypeDescription
OutputAudioConfig

QueryResult

public QueryResult QueryResult { get; set; }

The selected results of the conversational query or event processing. See alternative_query_results for additional potential results.

Property Value
TypeDescription
QueryResult

RecognitionResult

public StreamingRecognitionResult RecognitionResult { get; set; }

The result of speech recognition.

Property Value
TypeDescription
StreamingRecognitionResult

ResponseId

public string ResponseId { get; set; }

The unique identifier of the response. It can be used to locate a response in the training example set or for reporting issues.

Property Value
TypeDescription
string

WebhookStatus

public Status WebhookStatus { get; set; }

Specifies the status of the webhook request.

Property Value
TypeDescription
Status