Struct Turn 

#[non_exhaustive]
pub struct Turn {
    pub query: Option<Query>,
    pub answer: String,
    pub detailed_answer: Option<Answer>,
    pub detailed_assist_answer: Option<AssistAnswer>,
    pub query_config: HashMap<String, String>,
    /* private fields */
}

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

Represents a turn, including a query from the user and a answer from service.

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: Option<Query>

Optional. The user query. May not be set if this turn is merely regenerating an answer to a different turn

answer: String

Optional. The resource name of the answer to the user query.

Only set if the answer generation (/answer API call) happened in this turn.

detailed_answer: Option<Answer>

Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session.

detailed_assist_answer: Option<AssistAnswer>

Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting assistant session.

query_config: HashMap<String, String>

Optional. Represents metadata related to the query config, for example LLM model and version used, model parameters (temperature, grounding parameters, etc.). The prefix “google.” is reserved for Google-developed functionality.

Implementations

impl Turn

pub fn new() -> Self

Creates a new default instance.

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

where T: Into<Query>,

Sets the value of query.

Example

use google_cloud_discoveryengine_v1::model::Query;
let x = Turn::new().set_query(Query::default()/* use setters */);

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

where T: Into<Query>,

Sets or clears the value of query.

Example

use google_cloud_discoveryengine_v1::model::Query;
let x = Turn::new().set_or_clear_query(Some(Query::default()/* use setters */));
let x = Turn::new().set_or_clear_query(None::<Query>);

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

Sets the value of answer.

Example

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

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

where T: Into<Answer>,

Sets the value of detailed_answer.

Example

use google_cloud_discoveryengine_v1::model::Answer;
let x = Turn::new().set_detailed_answer(Answer::default()/* use setters */);

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

where T: Into<Answer>,

Sets or clears the value of detailed_answer.

Example

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

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

where T: Into<AssistAnswer>,

Sets the value of detailed_assist_answer.

Example

use google_cloud_discoveryengine_v1::model::AssistAnswer;
let x = Turn::new().set_detailed_assist_answer(AssistAnswer::default()/* use setters */);

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

where T: Into<AssistAnswer>,

Sets or clears the value of detailed_assist_answer.

Example

use google_cloud_discoveryengine_v1::model::AssistAnswer;
let x = Turn::new().set_or_clear_detailed_assist_answer(Some(AssistAnswer::default()/* use setters */));
let x = Turn::new().set_or_clear_detailed_assist_answer(None::<AssistAnswer>);

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

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

Sets the value of query_config.

Example

let x = Turn::new().set_query_config([
    ("key0", "abc"),
    ("key1", "xyz"),
]);

Trait Implementations

impl Clone for Turn

fn clone(&self) -> Turn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Turn

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

Formats the value using the given formatter.

impl Default for Turn

fn default() -> Turn

Returns the “default value” for a type.

impl Message for Turn

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Turn

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Turn