Struct google_api_proto::google::cloud::dialogflow::v2beta1::StreamingAnalyzeContentRequest

pub struct StreamingAnalyzeContentRequest {
    pub participant: String,
    pub reply_audio_config: Option<OutputAudioConfig>,
    pub query_params: Option<QueryParameters>,
    pub assist_query_params: Option<AssistQueryParameters>,
    pub cx_parameters: Option<Struct>,
    pub cx_current_page: String,
    pub enable_extended_streaming: bool,
    pub enable_partial_automated_agent_reply: bool,
    pub enable_debugging_info: bool,
    pub config: Option<Config>,
    pub input: Option<Input>,
}

The top-level message sent by the client to the [Participants.StreamingAnalyzeContent][google.cloud.dialogflow.v2beta1.Participants.StreamingAnalyzeContent] method.

Multiple request messages should be sent in order:

1. The first message must contain [participant][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.participant], [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] and optionally [query_params][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.query_params]. If you want to receive an audio response, it should also contain [reply_audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.reply_audio_config]. The message must not contain [input][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input].

2. If [config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to [audio_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.audio_config], all subsequent messages must contain [input_audio][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_audio] to continue with Speech recognition. If you decide to rather analyze text input after you already started Speech recognition, please send a message with [StreamingAnalyzeContentRequest.input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_text].

   However, note that:

   • Dialogflow will bill you for the audio so far.
   • Dialogflow discards all Speech recognition results in favor of the text input.

3. If [StreamingAnalyzeContentRequest.config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.config] in the first message was set to [StreamingAnalyzeContentRequest.text_config][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.text_config], then the second message must contain only [input_text][google.cloud.dialogflow.v2beta1.StreamingAnalyzeContentRequest.input_text]. Moreover, you must not send more than two messages.

After you sent all input, you must half-close or abort the request stream.

Fields

participant: String

Required. The name of the participant this text comes from. Format: projects/<Project ID>/locations/<Location ID>/conversations/<Conversation ID>/participants/<Participant ID>.

reply_audio_config: Option<OutputAudioConfig>

Speech synthesis configuration. The speech synthesis settings for a virtual agent that may be configured for the associated conversation profile are not used when calling StreamingAnalyzeContent. If this configuration is not supplied, speech synthesis is disabled.

query_params: Option<QueryParameters>

Parameters for a Dialogflow virtual-agent query.

assist_query_params: Option<AssistQueryParameters>

Parameters for a human assist query.

cx_parameters: Option<Struct>

Additional parameters to be put into Dialogflow CX session parameters. To remove a parameter from the session, clients should explicitly set the parameter value to null.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

cx_current_page: String

The unique identifier of the CX page to override the current_page in the session. Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>/flows/<Flow ID>/pages/<Page ID>.

If cx_current_page is specified, the previous state of the session will be ignored by Dialogflow CX, including the [previous page][QueryResult.current_page] and the [previous session parameters][QueryResult.parameters]. In most cases, cx_current_page and cx_parameters should be configured together to direct a session to a specific state.

Note: this field should only be used if you are connecting to a Dialogflow CX agent.

enable_extended_streaming: bool

Optional. Enable full bidirectional streaming. You can keep streaming the audio until timeout, and there’s no need to half close the stream to get the response.

Restrictions:

• Timeout: 3 mins.
• Audio Encoding: only supports [AudioEncoding.AUDIO_ENCODING_LINEAR_16][google.cloud.dialogflow.v2beta1.AudioEncoding.AUDIO_ENCODING_LINEAR_16] and [AudioEncoding.AUDIO_ENCODING_MULAW][google.cloud.dialogflow.v2beta1.AudioEncoding.AUDIO_ENCODING_MULAW]
• Lifecycle: conversation should be in Assist Stage, go to [Conversation.CreateConversation][] for more information.

InvalidArgument Error will be returned if the one of restriction checks failed.

You can find more details in https://cloud.google.com/agent-assist/docs/extended-streaming

enable_partial_automated_agent_reply: bool

Enable partial virtual agent responses. If this flag is not enabled, response stream still contains only one final response even if some Fulfillments in Dialogflow virtual agent have been configured to return partial responses.

enable_debugging_info: bool

if true, StreamingAnalyzeContentResponse.debugging_info will get populated.

config: Option<Config>

Required. The input config.

input: Option<Input>

Required. The input.

Trait Implementations

impl Clone for StreamingAnalyzeContentRequest

fn clone(&self) -> StreamingAnalyzeContentRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StreamingAnalyzeContentRequest

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

Formats the value using the given formatter.

impl Default for StreamingAnalyzeContentRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for StreamingAnalyzeContentRequest

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.

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

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where B: BufMut, Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

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

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for StreamingAnalyzeContentRequest

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

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

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

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

impl StructuralPartialEq for StreamingAnalyzeContentRequest