Struct QueryResult 

#[non_exhaustive]
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>,
    /* private fields */
}

Available on crate features answer-records or participants or sessions only.

Represents the result of conversational query or event processing.

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.

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 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.

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. For more information, see the cancel slot filling documentation.

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.

Implementations

impl QueryResult

pub fn new() -> Self

pub fn set_query_text<T: Into<String>>(self, v: T) -> Self

Sets the value of query_text.

Example

let x = QueryResult::new().set_query_text("example");

pub fn set_language_code<T: Into<String>>(self, v: T) -> Self

Sets the value of language_code.

Example

let x = QueryResult::new().set_language_code("example");

pub fn set_speech_recognition_confidence<T: Into<f32>>(self, v: T) -> Self

Sets the value of speech_recognition_confidence.

Example

let x = QueryResult::new().set_speech_recognition_confidence(42.0);

pub fn set_action<T: Into<String>>(self, v: T) -> Self

Sets the value of action.

Example

let x = QueryResult::new().set_action("example");

pub fn set_parameters<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of parameters.

Example

use wkt::Struct;
let x = QueryResult::new().set_parameters(Struct::default()/* use setters */);

pub fn set_or_clear_parameters<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of parameters.

Example

use wkt::Struct;
let x = QueryResult::new().set_or_clear_parameters(Some(Struct::default()/* use setters */));
let x = QueryResult::new().set_or_clear_parameters(None::<Struct>);

pub fn set_all_required_params_present<T: Into<bool>>(self, v: T) -> Self

Sets the value of all_required_params_present.

Example

let x = QueryResult::new().set_all_required_params_present(true);

pub fn set_cancels_slot_filling<T: Into<bool>>(self, v: T) -> Self

Sets the value of cancels_slot_filling.

Example

let x = QueryResult::new().set_cancels_slot_filling(true);

pub fn set_fulfillment_text<T: Into<String>>(self, v: T) -> Self

Sets the value of fulfillment_text.

Example

let x = QueryResult::new().set_fulfillment_text("example");

pub fn set_fulfillment_messages<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Message>,

Sets the value of fulfillment_messages.

Example

use google_cloud_dialogflow_v2::model::intent::Message;
let x = QueryResult::new()
    .set_fulfillment_messages([
        Message::default()/* use setters */,
        Message::default()/* use (different) setters */,
    ]);

pub fn set_webhook_source<T: Into<String>>(self, v: T) -> Self

Sets the value of webhook_source.

Example

let x = QueryResult::new().set_webhook_source("example");

pub fn set_webhook_payload<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of webhook_payload.

Example

use wkt::Struct;
let x = QueryResult::new().set_webhook_payload(Struct::default()/* use setters */);

pub fn set_or_clear_webhook_payload<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of webhook_payload.

Example

use wkt::Struct;
let x = QueryResult::new().set_or_clear_webhook_payload(Some(Struct::default()/* use setters */));
let x = QueryResult::new().set_or_clear_webhook_payload(None::<Struct>);

pub fn set_output_contexts<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Context>,

Sets the value of output_contexts.

Example

use google_cloud_dialogflow_v2::model::Context;
let x = QueryResult::new()
    .set_output_contexts([
        Context::default()/* use setters */,
        Context::default()/* use (different) setters */,
    ]);

pub fn set_intent<T>(self, v: T) -> Self

where T: Into<Intent>,

Sets the value of intent.

Example

use google_cloud_dialogflow_v2::model::Intent;
let x = QueryResult::new().set_intent(Intent::default()/* use setters */);

pub fn set_or_clear_intent<T>(self, v: Option<T>) -> Self

where T: Into<Intent>,

Sets or clears the value of intent.

Example

use google_cloud_dialogflow_v2::model::Intent;
let x = QueryResult::new().set_or_clear_intent(Some(Intent::default()/* use setters */));
let x = QueryResult::new().set_or_clear_intent(None::<Intent>);

pub fn set_intent_detection_confidence<T: Into<f32>>(self, v: T) -> Self

Sets the value of intent_detection_confidence.

Example

let x = QueryResult::new().set_intent_detection_confidence(42.0);

pub fn set_diagnostic_info<T>(self, v: T) -> Self

where T: Into<Struct>,

Sets the value of diagnostic_info.

Example

use wkt::Struct;
let x = QueryResult::new().set_diagnostic_info(Struct::default()/* use setters */);

pub fn set_or_clear_diagnostic_info<T>(self, v: Option<T>) -> Self

where T: Into<Struct>,

Sets or clears the value of diagnostic_info.

Example

use wkt::Struct;
let x = QueryResult::new().set_or_clear_diagnostic_info(Some(Struct::default()/* use setters */));
let x = QueryResult::new().set_or_clear_diagnostic_info(None::<Struct>);

pub fn set_sentiment_analysis_result<T>(self, v: T) -> Self

where T: Into<SentimentAnalysisResult>,

Sets the value of sentiment_analysis_result.

Example

use google_cloud_dialogflow_v2::model::SentimentAnalysisResult;
let x = QueryResult::new().set_sentiment_analysis_result(SentimentAnalysisResult::default()/* use setters */);

pub fn set_or_clear_sentiment_analysis_result<T>(self, v: Option<T>) -> Self

where T: Into<SentimentAnalysisResult>,

Sets or clears the value of sentiment_analysis_result.

Example

use google_cloud_dialogflow_v2::model::SentimentAnalysisResult;
let x = QueryResult::new().set_or_clear_sentiment_analysis_result(Some(SentimentAnalysisResult::default()/* use setters */));
let x = QueryResult::new().set_or_clear_sentiment_analysis_result(None::<SentimentAnalysisResult>);

Trait Implementations

impl Clone for QueryResult

fn clone(&self) -> QueryResult

Returns a duplicate 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() -> QueryResult

Returns the “default value” for a type.

impl Message for QueryResult

fn typename() -> &'static str

The typename of this message.

impl PartialEq for QueryResult

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