Struct gapi_grpc::google::cloud::dialogflow::v2beta1::StreamingDetectIntentResponse

pub struct StreamingDetectIntentResponse {
    pub response_id: String,
    pub recognition_result: Option<StreamingRecognitionResult>,
    pub query_result: Option<QueryResult>,
    pub alternative_query_results: Vec<QueryResult>,
    pub webhook_status: Option<Status>,
    pub output_audio: Vec<u8>,
    pub output_audio_config: Option<OutputAudioConfig>,
}

The top-level message returned from the StreamingDetectIntent 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. 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.

Fields

response_id: String

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

recognition_result: Option<StreamingRecognitionResult>

The result of speech recognition.

query_result: Option<QueryResult>

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

alternative_query_results: Vec<QueryResult>

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.

webhook_status: Option<Status>

Specifies the status of the webhook request.

output_audio: Vec<u8>

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.

output_audio_config: Option<OutputAudioConfig>

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

Trait Implementations

impl Clone for StreamingDetectIntentResponse

fn clone(&self) -> StreamingDetectIntentResponse

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StreamingDetectIntentResponse

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StreamingDetectIntentResponse

fn default() -> StreamingDetectIntentResponse

Returns the “default value” for a type.

impl Message for StreamingDetectIntentResponse

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

pub fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

pub fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes a length-delimited instance of the message from the buffer.

pub fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

pub fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<StreamingDetectIntentResponse> for StreamingDetectIntentResponse

fn eq(&self, other: &StreamingDetectIntentResponse) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &StreamingDetectIntentResponse) -> bool

This method tests for !=.

impl StructuralPartialEq for StreamingDetectIntentResponse