Struct gapi_grpc::google::cloud::dialogflow::v2beta1::QueryResult

pub struct QueryResult {
    pub query_text: String,
    pub language_code: String,
    pub speech_recognition_confidence: f32,
    pub action: String,
    pub parameters: Option<Struct>,
    pub all_required_params_present: bool,
    pub cancels_slot_filling: bool,
    pub fulfillment_text: String,
    pub fulfillment_messages: Vec<Message>,
    pub webhook_source: String,
    pub webhook_payload: Option<Struct>,
    pub output_contexts: Vec<Context>,
    pub intent: Option<Intent>,
    pub intent_detection_confidence: f32,
    pub diagnostic_info: Option<Struct>,
    pub sentiment_analysis_result: Option<SentimentAnalysisResult>,
    pub knowledge_answers: Option<KnowledgeAnswers>,
}

Represents the result of conversational query or event processing.

Fields

query_text: String

The original conversational query text:

• If natural language text was provided as input, query_text contains a copy of the input.
• If natural language speech audio was provided as input, query_text contains the speech recognition result. If speech recognizer produced multiple alternatives, a particular one is picked.
• If automatic spell correction is enabled, query_text will contain the corrected user input.

language_code: String

The language that was triggered during intent detection. See Language Support for a list of the currently supported language codes.

speech_recognition_confidence: f32

The Speech recognition confidence between 0.0 and 1.0. A higher number indicates an estimated greater likelihood that the recognized words are correct. The default of 0.0 is a sentinel value indicating that confidence was not set.

This field is not guaranteed to be accurate or set. In particular this field isn’t set for StreamingDetectIntent since the streaming endpoint has separate confidence estimates per portion of the audio in StreamingRecognitionResult.

action: String

The action name from the matched intent.

parameters: Option<Struct>

The collection of extracted parameters.

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: map
  • Else: depending on parameter value type, could be one of string, number, boolean, null, list or map
• MapValue value:
  • If parameter’s entity type is a composite entity: map from composite entity property names to property values
  • Else: parameter value

all_required_params_present: bool

This field is set to:

• false if the matched intent has required parameters and not all of the required parameter values have been collected.
• true if all required parameter values have been collected, or if the matched intent doesn’t contain any required parameters.

cancels_slot_filling: bool

Indicates whether the conversational query triggers a cancellation for slot filling.

fulfillment_text: String

The text to be pronounced to the user or shown on the screen. Note: This is a legacy field, fulfillment_messages should be preferred.

fulfillment_messages: Vec<Message>

The collection of rich messages to present to the user.

webhook_source: String

If the query was fulfilled by a webhook call, this field is set to the value of the source field returned in the webhook response.

webhook_payload: Option<Struct>

If the query was fulfilled by a webhook call, this field is set to the value of the payload field returned in the webhook response.

output_contexts: Vec<Context>

The collection of output contexts. If applicable, output_contexts.parameters contains entries with name <parameter name>.original containing the original parameter values before the query.

intent: Option<Intent>

The intent that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name, display_name, end_interaction and is_fallback.

intent_detection_confidence: f32

The intent detection confidence. 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. If there are multiple knowledge_answers messages, this value is set to the greatest knowledgeAnswers.match_confidence value in the list.

diagnostic_info: Option<Struct>

Free-form diagnostic information for the associated detect intent request. The fields of this data can change without notice, so you should not write code that depends on its structure. The data may contain:

• webhook call latency
• webhook errors

sentiment_analysis_result: Option<SentimentAnalysisResult>

The sentiment analysis result, which depends on the sentiment_analysis_request_config specified in the request.

knowledge_answers: Option<KnowledgeAnswers>

The result from Knowledge Connector (if any), ordered by decreasing KnowledgeAnswers.match_confidence.

Trait Implementations

impl Clone for QueryResult

fn clone(&self) -> QueryResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryResult

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

Formats the value using the given formatter.

impl Default for QueryResult

fn default() -> QueryResult

Returns the “default value” for a type.

impl Message for QueryResult

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<QueryResult> for QueryResult

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

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

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

This method tests for !=.

impl StructuralPartialEq for QueryResult