Struct StreamingAnalyzeContentResponse 

#[non_exhaustive]
pub struct StreamingAnalyzeContentResponse {
    pub recognition_result: Option<StreamingRecognitionResult>,
    pub reply_text: String,
    pub reply_audio: Option<OutputAudio>,
    pub automated_agent_reply: Option<AutomatedAgentReply>,
    pub message: Option<Message>,
    pub human_agent_suggestion_results: Vec<SuggestionResult>,
    pub end_user_suggestion_results: Vec<SuggestionResult>,
    pub dtmf_parameters: Option<DtmfParameters>,
    pub debugging_info: Option<CloudConversationDebuggingInfo>,
    pub speech_model: String,
    /* private fields */
}

Available on crate feature participants only.

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.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

recognition_result: Option<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: Option<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: Option<AutomatedAgentReply>

Note that in [AutomatedAgentReply.DetectIntentResponse][], [Sessions.DetectIntentResponse.output_audio][] and [Sessions.DetectIntentResponse.output_audio_config][] are always empty, use reply_audio instead.

message: Option<Message>

Message analyzed by CCAI.

human_agent_suggestion_results: Vec<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: Vec<SuggestionResult>

The suggestions for end user. The order is the same as HumanAgentAssistantConfig.SuggestionConfig.feature_configs of HumanAgentAssistantConfig.end_user_suggestion_config.

dtmf_parameters: Option<DtmfParameters>

Indicates the parameters of DTMF.

debugging_info: Option<CloudConversationDebuggingInfo>

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

speech_model: String

The name of the actual Cloud speech model used for speech recognition.

Implementations

impl StreamingAnalyzeContentResponse

pub fn new() -> Self

pub fn set_recognition_result<T>(self, v: T) -> Self

where T: Into<StreamingRecognitionResult>,

Sets the value of recognition_result.

Example

use google_cloud_dialogflow_v2::model::StreamingRecognitionResult;
let x = StreamingAnalyzeContentResponse::new().set_recognition_result(StreamingRecognitionResult::default()/* use setters */);

pub fn set_or_clear_recognition_result<T>(self, v: Option<T>) -> Self

where T: Into<StreamingRecognitionResult>,

Sets or clears the value of recognition_result.

Example

use google_cloud_dialogflow_v2::model::StreamingRecognitionResult;
let x = StreamingAnalyzeContentResponse::new().set_or_clear_recognition_result(Some(StreamingRecognitionResult::default()/* use setters */));
let x = StreamingAnalyzeContentResponse::new().set_or_clear_recognition_result(None::<StreamingRecognitionResult>);

pub fn set_reply_text<T: Into<String>>(self, v: T) -> Self

Sets the value of reply_text.

Example

let x = StreamingAnalyzeContentResponse::new().set_reply_text("example");

pub fn set_reply_audio<T>(self, v: T) -> Self

where T: Into<OutputAudio>,

Sets the value of reply_audio.

Example

use google_cloud_dialogflow_v2::model::OutputAudio;
let x = StreamingAnalyzeContentResponse::new().set_reply_audio(OutputAudio::default()/* use setters */);

pub fn set_or_clear_reply_audio<T>(self, v: Option<T>) -> Self

where T: Into<OutputAudio>,

Sets or clears the value of reply_audio.

Example

use google_cloud_dialogflow_v2::model::OutputAudio;
let x = StreamingAnalyzeContentResponse::new().set_or_clear_reply_audio(Some(OutputAudio::default()/* use setters */));
let x = StreamingAnalyzeContentResponse::new().set_or_clear_reply_audio(None::<OutputAudio>);

pub fn set_automated_agent_reply<T>(self, v: T) -> Self

where T: Into<AutomatedAgentReply>,

Sets the value of automated_agent_reply.

Example

use google_cloud_dialogflow_v2::model::AutomatedAgentReply;
let x = StreamingAnalyzeContentResponse::new().set_automated_agent_reply(AutomatedAgentReply::default()/* use setters */);

pub fn set_or_clear_automated_agent_reply<T>(self, v: Option<T>) -> Self

where T: Into<AutomatedAgentReply>,

Sets or clears the value of automated_agent_reply.

Example

use google_cloud_dialogflow_v2::model::AutomatedAgentReply;
let x = StreamingAnalyzeContentResponse::new().set_or_clear_automated_agent_reply(Some(AutomatedAgentReply::default()/* use setters */));
let x = StreamingAnalyzeContentResponse::new().set_or_clear_automated_agent_reply(None::<AutomatedAgentReply>);

pub fn set_message<T>(self, v: T) -> Self

where T: Into<Message>,

Sets the value of message.

Example

use google_cloud_dialogflow_v2::model::Message;
let x = StreamingAnalyzeContentResponse::new().set_message(Message::default()/* use setters */);

pub fn set_or_clear_message<T>(self, v: Option<T>) -> Self

where T: Into<Message>,

Sets or clears the value of message.

Example

use google_cloud_dialogflow_v2::model::Message;
let x = StreamingAnalyzeContentResponse::new().set_or_clear_message(Some(Message::default()/* use setters */));
let x = StreamingAnalyzeContentResponse::new().set_or_clear_message(None::<Message>);

pub fn set_human_agent_suggestion_results<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SuggestionResult>,

Sets the value of human_agent_suggestion_results.

Example

use google_cloud_dialogflow_v2::model::SuggestionResult;
let x = StreamingAnalyzeContentResponse::new()
    .set_human_agent_suggestion_results([
        SuggestionResult::default()/* use setters */,
        SuggestionResult::default()/* use (different) setters */,
    ]);

pub fn set_end_user_suggestion_results<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SuggestionResult>,

Sets the value of end_user_suggestion_results.

Example

use google_cloud_dialogflow_v2::model::SuggestionResult;
let x = StreamingAnalyzeContentResponse::new()
    .set_end_user_suggestion_results([
        SuggestionResult::default()/* use setters */,
        SuggestionResult::default()/* use (different) setters */,
    ]);

pub fn set_dtmf_parameters<T>(self, v: T) -> Self

where T: Into<DtmfParameters>,

Sets the value of dtmf_parameters.

Example

use google_cloud_dialogflow_v2::model::DtmfParameters;
let x = StreamingAnalyzeContentResponse::new().set_dtmf_parameters(DtmfParameters::default()/* use setters */);

pub fn set_or_clear_dtmf_parameters<T>(self, v: Option<T>) -> Self

where T: Into<DtmfParameters>,

Sets or clears the value of dtmf_parameters.

Example

use google_cloud_dialogflow_v2::model::DtmfParameters;
let x = StreamingAnalyzeContentResponse::new().set_or_clear_dtmf_parameters(Some(DtmfParameters::default()/* use setters */));
let x = StreamingAnalyzeContentResponse::new().set_or_clear_dtmf_parameters(None::<DtmfParameters>);

pub fn set_debugging_info<T>(self, v: T) -> Self

where T: Into<CloudConversationDebuggingInfo>,

Sets the value of debugging_info.

Example

use google_cloud_dialogflow_v2::model::CloudConversationDebuggingInfo;
let x = StreamingAnalyzeContentResponse::new().set_debugging_info(CloudConversationDebuggingInfo::default()/* use setters */);

pub fn set_or_clear_debugging_info<T>(self, v: Option<T>) -> Self

where T: Into<CloudConversationDebuggingInfo>,

Sets or clears the value of debugging_info.

Example

use google_cloud_dialogflow_v2::model::CloudConversationDebuggingInfo;
let x = StreamingAnalyzeContentResponse::new().set_or_clear_debugging_info(Some(CloudConversationDebuggingInfo::default()/* use setters */));
let x = StreamingAnalyzeContentResponse::new().set_or_clear_debugging_info(None::<CloudConversationDebuggingInfo>);

pub fn set_speech_model<T: Into<String>>(self, v: T) -> Self

Sets the value of speech_model.

Example

let x = StreamingAnalyzeContentResponse::new().set_speech_model("example");

Trait Implementations

impl Clone for StreamingAnalyzeContentResponse

fn clone(&self) -> StreamingAnalyzeContentResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamingAnalyzeContentResponse

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

Formats the value using the given formatter.

impl Default for StreamingAnalyzeContentResponse

fn default() -> StreamingAnalyzeContentResponse

Returns the “default value” for a type.

impl Message for StreamingAnalyzeContentResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StreamingAnalyzeContentResponse

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StreamingAnalyzeContentResponse