Struct StreamingDetectIntentRequest 

#[non_exhaustive]
pub struct StreamingDetectIntentRequest {
    pub session: String,
    pub query_params: Option<QueryParameters>,
    pub query_input: Option<QueryInput>,
    pub single_utterance: bool,
    pub output_audio_config: Option<OutputAudioConfig>,
    pub output_audio_config_mask: Option<FieldMask>,
    pub input_audio: Bytes,
    pub enable_debugging_info: bool,
    /* private fields */
}

Available on crate feature sessions only.

The top-level message sent by the client to the [StreamingDetectIntent][] method.

Multiple request messages should be sent in order:

1. The first message must contain session, query_input plus optionally query_params. If the client wants to receive an audio response, it should also contain output_audio_config. The message must not contain input_audio.

2. If query_input was set to query_input.audio_config, all subsequent messages must contain input_audio to continue with Speech recognition. If you decide to rather detect an intent from text input after you already started Speech recognition, please send a message with query_input.text.

   However, note that:

   • Dialogflow will bill you for the audio duration so far.
   • Dialogflow discards all Speech recognition results in favor of the input text.
   • Dialogflow will use the language code from the first message.

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

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.

session: String

Required. The name of the session the query is sent to. Format of the session name: projects/<Project ID>/agent/sessions/<Session ID>, or projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>. If Environment ID is not specified, we assume default ‘draft’ environment. If User ID is not specified, we are using “-”. It’s up to the API caller to choose an appropriate Session ID and User Id. They can be a random number or some type of user and session identifiers (preferably hashed). The length of the Session ID and User ID must not exceed 36 characters.

For more information, see the API interactions guide.

Note: Always use agent versions for production traffic. See Versions and environments.

query_params: Option<QueryParameters>

The parameters of this query.

query_input: Option<QueryInput>

Required. The input specification. It can be set to:

1. an audio config which instructs the speech recognizer how to process the speech audio,

2. a conversational query in the form of text, or

3. an event that specifies which intent to trigger.

single_utterance: bool

👎Deprecated

Please use InputAudioConfig.single_utterance instead. If false (default), recognition does not cease until the client closes the stream. If true, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio’s voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. This setting is ignored when query_input is a piece of text or an event.

output_audio_config: Option<OutputAudioConfig>

Instructs the speech synthesizer how to generate the output audio. If this field is not set and agent-level speech synthesizer is not configured, no output audio is generated.

output_audio_config_mask: Option<FieldMask>

Mask for output_audio_config indicating which settings in this request-level config should override speech synthesizer settings defined at agent-level.

If unspecified or empty, output_audio_config replaces the agent-level config in its entirety.

input_audio: Bytes

The input audio content to be recognized. Must be sent if query_input was set to a streaming input audio config. The complete audio over all streaming messages must not exceed 1 minute.

enable_debugging_info: bool

if true, StreamingDetectIntentResponse.debugging_info will get populated.

Implementations

impl StreamingDetectIntentRequest

pub fn new() -> Self

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

Sets the value of session.

Example

let x = StreamingDetectIntentRequest::new().set_session("example");

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

where T: Into<QueryParameters>,

Sets the value of query_params.

Example

use google_cloud_dialogflow_v2::model::QueryParameters;
let x = StreamingDetectIntentRequest::new().set_query_params(QueryParameters::default()/* use setters */);

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

where T: Into<QueryParameters>,

Sets or clears the value of query_params.

Example

use google_cloud_dialogflow_v2::model::QueryParameters;
let x = StreamingDetectIntentRequest::new().set_or_clear_query_params(Some(QueryParameters::default()/* use setters */));
let x = StreamingDetectIntentRequest::new().set_or_clear_query_params(None::<QueryParameters>);

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

where T: Into<QueryInput>,

Sets the value of query_input.

Example

use google_cloud_dialogflow_v2::model::QueryInput;
let x = StreamingDetectIntentRequest::new().set_query_input(QueryInput::default()/* use setters */);

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

where T: Into<QueryInput>,

Sets or clears the value of query_input.

Example

use google_cloud_dialogflow_v2::model::QueryInput;
let x = StreamingDetectIntentRequest::new().set_or_clear_query_input(Some(QueryInput::default()/* use setters */));
let x = StreamingDetectIntentRequest::new().set_or_clear_query_input(None::<QueryInput>);

pub fn set_single_utterance<T: Into<bool>>(self, v: T) -> Self

👎Deprecated

Sets the value of single_utterance.

Example

let x = StreamingDetectIntentRequest::new().set_single_utterance(true);

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

where T: Into<OutputAudioConfig>,

Sets the value of output_audio_config.

Example

use google_cloud_dialogflow_v2::model::OutputAudioConfig;
let x = StreamingDetectIntentRequest::new().set_output_audio_config(OutputAudioConfig::default()/* use setters */);

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

where T: Into<OutputAudioConfig>,

Sets or clears the value of output_audio_config.

Example

use google_cloud_dialogflow_v2::model::OutputAudioConfig;
let x = StreamingDetectIntentRequest::new().set_or_clear_output_audio_config(Some(OutputAudioConfig::default()/* use setters */));
let x = StreamingDetectIntentRequest::new().set_or_clear_output_audio_config(None::<OutputAudioConfig>);

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

where T: Into<FieldMask>,

Sets the value of output_audio_config_mask.

Example

use wkt::FieldMask;
let x = StreamingDetectIntentRequest::new().set_output_audio_config_mask(FieldMask::default()/* use setters */);

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

where T: Into<FieldMask>,

Sets or clears the value of output_audio_config_mask.

Example

use wkt::FieldMask;
let x = StreamingDetectIntentRequest::new().set_or_clear_output_audio_config_mask(Some(FieldMask::default()/* use setters */));
let x = StreamingDetectIntentRequest::new().set_or_clear_output_audio_config_mask(None::<FieldMask>);

pub fn set_input_audio<T: Into<Bytes>>(self, v: T) -> Self

Sets the value of input_audio.

Example

let x = StreamingDetectIntentRequest::new().set_input_audio(bytes::Bytes::from_static(b"example"));

pub fn set_enable_debugging_info<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_debugging_info.

Example

let x = StreamingDetectIntentRequest::new().set_enable_debugging_info(true);

Trait Implementations

impl Clone for StreamingDetectIntentRequest

fn clone(&self) -> StreamingDetectIntentRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamingDetectIntentRequest

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

Formats the value using the given formatter.

impl Default for StreamingDetectIntentRequest

fn default() -> StreamingDetectIntentRequest

Returns the “default value” for a type.

impl Message for StreamingDetectIntentRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StreamingDetectIntentRequest

fn eq(&self, other: &StreamingDetectIntentRequest) -> 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 StreamingDetectIntentRequest