Struct StreamingDetectIntentRequest 

#[non_exhaustive]
pub struct StreamingDetectIntentRequest {
    pub session: String,
    pub query_params: Option<QueryParameters>,
    pub query_input: Option<QueryInput>,
    pub output_audio_config: Option<OutputAudioConfig>,
    pub enable_partial_response: bool,
    pub enable_debugging_info: bool,
    pub response_view: DetectIntentResponseView,
    /* private fields */
}

Available on crate feature sessions only.

The top-level message sent by the client to the [Sessions.StreamingDetectIntent][google.cloud.dialogflow.cx.v3.Sessions.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.

2. If query_input was set to query_input.audio.config, all subsequent messages must contain query_input.audio.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

The name of the session this query is sent to. Format: projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID> or projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>. If Environment ID is not specified, we assume default ‘draft’ environment. It’s up to the API caller to choose an appropriate Session ID. It can be a random number or some type of session identifiers (preferably hashed). The length of the Session ID must not exceed 36 characters. Note: session must be set in the first request.

For more information, see the sessions 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.

output_audio_config: Option<OutputAudioConfig>

Instructs the speech synthesizer how to generate the output audio.

enable_partial_response: bool

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

enable_debugging_info: bool

If true, StreamingDetectIntentResponse.debugging_info will get populated.

response_view: DetectIntentResponseView

Optional. Specifies which fields in the QueryResult to return. If not set, the default is DETECT_INTENT_RESPONSE_VIEW_FULL.

Implementations

impl StreamingDetectIntentRequest

pub fn new() -> Self

Creates a new default instance.

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_cx_v3::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_cx_v3::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_cx_v3::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_cx_v3::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_output_audio_config<T>(self, v: T) -> Self

where T: Into<OutputAudioConfig>,

Sets the value of output_audio_config.

Example

use google_cloud_dialogflow_cx_v3::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_cx_v3::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_enable_partial_response<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_partial_response.

Example

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

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);

pub fn set_response_view<T: Into<DetectIntentResponseView>>(self, v: T) -> Self

Sets the value of response_view.

Example

use google_cloud_dialogflow_cx_v3::model::DetectIntentResponseView;
let x0 = StreamingDetectIntentRequest::new().set_response_view(DetectIntentResponseView::Full);
let x1 = StreamingDetectIntentRequest::new().set_response_view(DetectIntentResponseView::Basic);
let x2 = StreamingDetectIntentRequest::new().set_response_view(DetectIntentResponseView::Default);

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