Struct Answer 

#[non_exhaustive]
pub struct Answer {

    pub name: String,
    pub state: State,
    pub answer_text: String,
    pub grounding_score: Option<f64>,
    pub citations: Vec<Citation>,
    pub grounding_supports: Vec<GroundingSupport>,
    pub references: Vec<Reference>,
    pub related_questions: Vec<String>,
    pub steps: Vec<Step>,
    pub query_understanding_info: Option<QueryUnderstandingInfo>,
    pub answer_skipped_reasons: Vec<AnswerSkippedReason>,
    pub create_time: Option<Timestamp>,
    pub complete_time: Option<Timestamp>,
    pub safety_ratings: Vec<SafetyRating>,
    /* private fields */
}

Available on crate features conversational-search-service or session-service only.

Defines an answer.

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.

name: String

Immutable. Fully qualified name projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*

state: State

The state of the answer generation.

answer_text: String

The textual answer.

grounding_score: Option<f64>

A score in the range of [0, 1] describing how grounded the answer is by the reference chunks.

citations: Vec<Citation>

Citations.

grounding_supports: Vec<GroundingSupport>

Optional. Grounding supports.

references: Vec<Reference>

References.

related_questions: Vec<String>

Suggested related questions.

steps: Vec<Step>

Answer generation steps.

query_understanding_info: Option<QueryUnderstandingInfo>

Query understanding information.

answer_skipped_reasons: Vec<AnswerSkippedReason>

Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.

create_time: Option<Timestamp>

Output only. Answer creation timestamp.

complete_time: Option<Timestamp>

Output only. Answer completed timestamp.

safety_ratings: Vec<SafetyRating>

Optional. Safety ratings.

Implementations

impl Answer

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of name.

Example

let x = Answer::new().set_name(format!("projects/{project_id}/locations/{location_id}/dataStores/{data_store_id}/sessions/{session_id}/answers/{answer_id}"));

pub fn set_state<T: Into<State>>(self, v: T) -> Self

Sets the value of state.

Example

use google_cloud_discoveryengine_v1::model::answer::State;
let x0 = Answer::new().set_state(State::InProgress);
let x1 = Answer::new().set_state(State::Failed);
let x2 = Answer::new().set_state(State::Succeeded);

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

Sets the value of answer_text.

Example

let x = Answer::new().set_answer_text("example");

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

where T: Into<f64>,

Sets the value of grounding_score.

Example

let x = Answer::new().set_grounding_score(42.0);

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

where T: Into<f64>,

Sets or clears the value of grounding_score.

Example

let x = Answer::new().set_or_clear_grounding_score(Some(42.0));
let x = Answer::new().set_or_clear_grounding_score(None::<f32>);

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

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

Sets the value of citations.

Example

use google_cloud_discoveryengine_v1::model::answer::Citation;
let x = Answer::new()
    .set_citations([
        Citation::default()/* use setters */,
        Citation::default()/* use (different) setters */,
    ]);

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

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

Sets the value of grounding_supports.

Example

use google_cloud_discoveryengine_v1::model::answer::GroundingSupport;
let x = Answer::new()
    .set_grounding_supports([
        GroundingSupport::default()/* use setters */,
        GroundingSupport::default()/* use (different) setters */,
    ]);

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

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

Sets the value of references.

Example

use google_cloud_discoveryengine_v1::model::answer::Reference;
let x = Answer::new()
    .set_references([
        Reference::default()/* use setters */,
        Reference::default()/* use (different) setters */,
    ]);

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

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

Sets the value of related_questions.

Example

let x = Answer::new().set_related_questions(["a", "b", "c"]);

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

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

Sets the value of steps.

Example

use google_cloud_discoveryengine_v1::model::answer::Step;
let x = Answer::new()
    .set_steps([
        Step::default()/* use setters */,
        Step::default()/* use (different) setters */,
    ]);

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

where T: Into<QueryUnderstandingInfo>,

Sets the value of query_understanding_info.

Example

use google_cloud_discoveryengine_v1::model::answer::QueryUnderstandingInfo;
let x = Answer::new().set_query_understanding_info(QueryUnderstandingInfo::default()/* use setters */);

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

where T: Into<QueryUnderstandingInfo>,

Sets or clears the value of query_understanding_info.

Example

use google_cloud_discoveryengine_v1::model::answer::QueryUnderstandingInfo;
let x = Answer::new().set_or_clear_query_understanding_info(Some(QueryUnderstandingInfo::default()/* use setters */));
let x = Answer::new().set_or_clear_query_understanding_info(None::<QueryUnderstandingInfo>);

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

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

Sets the value of answer_skipped_reasons.

Example

use google_cloud_discoveryengine_v1::model::answer::AnswerSkippedReason;
let x = Answer::new().set_answer_skipped_reasons([
    AnswerSkippedReason::AdversarialQueryIgnored,
    AnswerSkippedReason::NonAnswerSeekingQueryIgnored,
    AnswerSkippedReason::OutOfDomainQueryIgnored,
]);

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

where T: Into<Timestamp>,

Sets the value of create_time.

Example

use wkt::Timestamp;
let x = Answer::new().set_create_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of create_time.

Example

use wkt::Timestamp;
let x = Answer::new().set_or_clear_create_time(Some(Timestamp::default()/* use setters */));
let x = Answer::new().set_or_clear_create_time(None::<Timestamp>);

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

where T: Into<Timestamp>,

Sets the value of complete_time.

Example

use wkt::Timestamp;
let x = Answer::new().set_complete_time(Timestamp::default()/* use setters */);

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

where T: Into<Timestamp>,

Sets or clears the value of complete_time.

Example

use wkt::Timestamp;
let x = Answer::new().set_or_clear_complete_time(Some(Timestamp::default()/* use setters */));
let x = Answer::new().set_or_clear_complete_time(None::<Timestamp>);

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

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

Sets the value of safety_ratings.

Example

use google_cloud_discoveryengine_v1::model::SafetyRating;
let x = Answer::new()
    .set_safety_ratings([
        SafetyRating::default()/* use setters */,
        SafetyRating::default()/* use (different) setters */,
    ]);

Trait Implementations

impl Clone for Answer

fn clone(&self) -> Answer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Answer

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

Formats the value using the given formatter.

impl Default for Answer

fn default() -> Answer

Returns the “default value” for a type.

impl Message for Answer

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Answer

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Answer