Struct google_api_proto::google::cloud::dialogflow::cx::v3beta1::Match

pub struct Match {
    pub intent: Option<Intent>,
    pub event: String,
    pub parameters: Option<Struct>,
    pub resolved_input: String,
    pub match_type: i32,
    pub confidence: f32,
}

Represents one match result of [MatchIntent][].

Fields

intent: Option<Intent>

The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the query. Some, not all fields are filled in this message, including but not limited to: name and display_name. Only filled for [INTENT][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] match type.

event: String

The event that matched the query. Filled for [EVENT][google.cloud.dialogflow.cx.v3beta1.Match.MatchType], [NO_MATCH][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] and [NO_INPUT][google.cloud.dialogflow.cx.v3beta1.Match.MatchType] match types.

parameters: Option<Struct>

The collection of parameters extracted from the query.

Depending on your protocol or client library language, this is a map, associative array, symbol table, dictionary, or JSON object composed of a collection of (MapKey, MapValue) pairs:

• MapKey type: string
• MapKey value: parameter name
• MapValue type: If parameter’s entity type is a composite entity then use map, otherwise, depending on the parameter value type, it could be one of string, number, boolean, null, list or map.
• MapValue value: If parameter’s entity type is a composite entity then use map from composite entity property names to property values, otherwise, use parameter value.

resolved_input: String

Final text input which was matched during MatchIntent. This value can be different from original input sent in request because of spelling correction or other processing.

match_type: i32

Type of this [Match][google.cloud.dialogflow.cx.v3beta1.Match].

confidence: f32

The confidence of this match. Values range from 0.0 (completely uncertain) to 1.0 (completely certain). This value is for informational purpose only and is only used to help match the best intent within the classification threshold. This value may change for the same end-user expression at any time due to a model retraining or change in implementation.

Implementations

impl Match

pub fn match_type(&self) -> MatchType

Returns the enum value of match_type, or the default if the field is set to an invalid enum value.

pub fn set_match_type(&mut self, value: MatchType)

Sets match_type to the provided enum value.

Trait Implementations

impl Clone for Match

fn clone(&self) -> Match

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Match

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

Formats the value using the given formatter.

impl Default for Match

fn default() -> Self

Returns the “default value” for a type.

impl Message for Match

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(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where 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( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where 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(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

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

where Self: Default,

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

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

where Self: Sized,

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

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

where Self: Sized,

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

impl PartialEq for Match

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