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

pub struct QueryResult {

    pub language_code: String,
    pub parameters: Option<Struct>,
    pub response_messages: Vec<ResponseMessage>,
    pub webhook_ids: Vec<String>,
    pub webhook_display_names: Vec<String>,
    pub webhook_latencies: Vec<Duration>,
    pub webhook_tags: Vec<String>,
    pub webhook_statuses: Vec<Status>,
    pub webhook_payloads: Vec<Struct>,
    pub current_page: Option<Page>,
    pub current_flow: Option<Flow>,
    pub intent: Option<Intent>,
    pub intent_detection_confidence: f32,
    pub match: Option<Match>,
    pub diagnostic_info: Option<Struct>,
    pub generative_info: Option<GenerativeInfo>,
    pub sentiment_analysis_result: Option<SentimentAnalysisResult>,
    pub advanced_settings: Option<AdvancedSettings>,
    pub allow_answer_feedback: bool,
    pub data_store_connection_signals: Option<DataStoreConnectionSignals>,
    pub query: Option<Query>,
}

Represents the result of a conversational query.

Fields

language_code: String

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

parameters: Option<Struct>

The collected [session parameters][google.cloud.dialogflow.cx.v3beta1.SessionInfo.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 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.

response_messages: Vec<ResponseMessage>

The list of rich messages returned to the client. Responses vary from simple text messages to more sophisticated, structured payloads used to drive complex logic.

webhook_ids: Vec<String>

The list of webhook ids in the order of call sequence.

webhook_display_names: Vec<String>

The list of webhook display names in the order of call sequence.

webhook_latencies: Vec<Duration>

The list of webhook latencies in the order of call sequence.

webhook_tags: Vec<String>

The list of webhook tags in the order of call sequence.

webhook_statuses: Vec<Status>

The list of webhook call status in the order of call sequence.

webhook_payloads: Vec<Struct>

The list of webhook payload in [WebhookResponse.payload][google.cloud.dialogflow.cx.v3beta1.WebhookResponse.payload], in the order of call sequence. If some webhook call fails or doesn’t return any payload, an empty Struct would be used instead.

current_page: Option<Page>

The current [Page][google.cloud.dialogflow.cx.v3beta1.Page]. Some, not all fields are filled in this message, including but not limited to name and display_name.

current_flow: Option<Flow>

The current [Flow][google.cloud.dialogflow.cx.v3beta1.Flow]. Some, not all fields are filled in this message, including but not limited to name and display_name.

intent: Option<Intent>

👎Deprecated

The [Intent][google.cloud.dialogflow.cx.v3beta1.Intent] that matched the conversational query. Some, not all fields are filled in this message, including but not limited to: name and display_name. This field is deprecated, please use [QueryResult.match][google.cloud.dialogflow.cx.v3beta1.QueryResult.match] instead.

intent_detection_confidence: f32

👎Deprecated

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. This field is deprecated, please use [QueryResult.match][google.cloud.dialogflow.cx.v3beta1.QueryResult.match] instead.

match: Option<Match>

Intent match result, could be an intent or an event.

diagnostic_info: Option<Struct>

The free-form diagnostic info. For example, this field could contain webhook call latency. The fields of this data can change without notice, so you should not write code that depends on its structure.

One of the fields is called “Alternative Matched Intents”, which may aid with debugging. The following describes these intent results:

• The list is empty if no intent was matched to end-user input.
• Only intents that are referenced in the currently active flow are included.
• The matched intent is included.
• Other intents that could have matched end-user input, but did not match because they are referenced by intent routes that are out of scope, are included.
• Other intents referenced by intent routes in scope that matched end-user input, but had a lower confidence score.

generative_info: Option<GenerativeInfo>

The information of a query if handled by generative agent resources.

sentiment_analysis_result: Option<SentimentAnalysisResult>

The sentiment analyss result, which depends on [analyze_query_text_sentiment] [google.cloud.dialogflow.cx.v3beta1.QueryParameters.analyze_query_text_sentiment], specified in the request.

advanced_settings: Option<AdvancedSettings>

Returns the current advanced settings including IVR settings. Even though the operations configured by these settings are performed by Dialogflow, the client may need to perform special logic at the moment. For example, if Dialogflow exports audio to Google Cloud Storage, then the client may need to wait for the resulting object to appear in the bucket before proceeding.

allow_answer_feedback: bool

Indicates whether the Thumbs up/Thumbs down rating controls are need to be shown for the response in the Dialogflow Messenger widget.

data_store_connection_signals: Option<DataStoreConnectionSignals>

Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request.

query: Option<Query>

The original conversational query.

Trait Implementations

impl Clone for QueryResult

fn clone(&self) -> QueryResult

Returns a copy of the value.

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() -> Self

Returns the “default value” for a type.

impl Message for QueryResult

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 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: &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 QueryResult