Struct gapi_grpc::google::cloud::dialogflow::v2beta1::DetectIntentRequest

[+] Show declaration

pub struct DetectIntentRequest {
    pub session: String,
    pub query_params: Option<QueryParameters>,
    pub query_input: Option<QueryInput>,
    pub output_audio_config: Option<OutputAudioConfig>,
    pub output_audio_config_mask: Option<FieldMask>,
    pub input_audio: Vec<u8>,
}

[−] Expand description

The request to detect user’s intent.

Fields

session: String

[−] Expand description

Required. The name of the session this query is sent to. Supported formats:

• `projects//agent/sessions/,
• projects/<Project ID>/locations/<Location ID>/agent/sessions/<Session ID>,
• projects/<Project ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,
• projects/<Project ID>/locations/<Location ID>/agent/environments/<Environment ID>/users/<User ID>/sessions/<Session ID>,

If Location ID is not specified we assume default ‘us’ location. If Environment ID is not specified, we assume default ‘draft’ environment (Environment ID might be referred to as environment name at some places). 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>

[−] Expand description

The parameters of this query.

query_input: Option<QueryInput>

[−] Expand description

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.

output_audio_config: Option<OutputAudioConfig>

[−] Expand description

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>

[−] Expand description

Mask for [output_audio_config][google.cloud.dialogflow.v2beta1.DetectIntentRequest.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][google.cloud.dialogflow.v2beta1.DetectIntentRequest.output_audio_config] replaces the agent-level config in its entirety.

input_audio: Vec<u8>

[−] Expand description

The natural language speech audio to be processed. This field should be populated iff query_input is set to an input audio config. A single request can contain up to 1 minute of speech audio data.

Trait Implementations

impl Clone for DetectIntentRequest[+]

[+] Show hidden undocumented items

fn clone(&self) -> DetectIntentRequest[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DetectIntentRequest[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for DetectIntentRequest[+]

[+] Show hidden undocumented items

fn default() -> DetectIntentRequest[−]

Returns the “default value” for a type.

impl Message for DetectIntentRequest[+]

[+] Show hidden undocumented items

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<DetectIntentRequest> for DetectIntentRequest[+]

[+] Show hidden undocumented items

fn eq(&self, other: &DetectIntentRequest) -> bool[−]

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

fn ne(&self, other: &DetectIntentRequest) -> bool[−]

This method tests for !=.

impl StructuralPartialEq for DetectIntentRequest