Struct AnswerQueryRequest 

#[non_exhaustive]
pub struct AnswerQueryRequest {

    pub serving_config: String,
    pub query: Option<Query>,
    pub session: String,
    pub safety_spec: Option<SafetySpec>,
    pub related_questions_spec: Option<RelatedQuestionsSpec>,
    pub grounding_spec: Option<GroundingSpec>,
    pub answer_generation_spec: Option<AnswerGenerationSpec>,
    pub search_spec: Option<SearchSpec>,
    pub query_understanding_spec: Option<QueryUnderstandingSpec>,
    pub asynchronous_mode: bool,
    pub user_pseudo_id: String,
    pub user_labels: HashMap<String, String>,
    pub end_user_spec: Option<EndUserSpec>,
    /* private fields */
}

Available on crate feature conversational-search-service only.

Request message for ConversationalSearchService.AnswerQuery method.

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.

serving_config: String

Required. The resource name of the Search serving config, such as projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config, or projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config. This field is used to identify the serving configuration name, set of models used to make the search.

query: Option<Query>

Required. Current user query.

session: String

The session resource name. Not required.

When session field is not set, the API is in sessionless mode.

We support auto session mode: users can use the wildcard symbol - as session ID. A new ID will be automatically generated and assigned.

safety_spec: Option<SafetySpec>

Model specification.

related_questions_spec: Option<RelatedQuestionsSpec>

Related questions specification.

grounding_spec: Option<GroundingSpec>

Optional. Grounding specification.

answer_generation_spec: Option<AnswerGenerationSpec>

Answer generation specification.

search_spec: Option<SearchSpec>

Search specification.

query_understanding_spec: Option<QueryUnderstandingSpec>

Query understanding specification.

asynchronous_mode: bool

👎Deprecated

Deprecated: This field is deprecated. Streaming Answer API will be supported.

Asynchronous mode control.

If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method.

user_pseudo_id: String

A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website.

This field should NOT have a fixed value such as unknown_visitor.

The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.

user_labels: HashMap<String, String>

The user labels applied to a resource must meet the following requirements:

• Each resource can have multiple labels, up to a maximum of 64.
• Each label must be a key-value pair.
• Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
• Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
• The key portion of a label must be unique. However, you can use the same key with multiple resources.
• Keys must start with a lowercase letter or international character.

See Google Cloud Document for more details.

end_user_spec: Option<EndUserSpec>

Optional. End user specification.

Implementations

impl AnswerQueryRequest

pub fn new() -> Self

Creates a new default instance.

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

Sets the value of serving_config.

Example

let x = AnswerQueryRequest::new().set_serving_config(format!("projects/{project_id}/locations/{location_id}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}"));

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 = AnswerQueryRequest::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 = AnswerQueryRequest::new().set_or_clear_query(Some(Query::default()/* use setters */));
let x = AnswerQueryRequest::new().set_or_clear_query(None::<Query>);

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

Sets the value of session.

Example

let x = AnswerQueryRequest::new().set_session(format!("projects/{project_id}/locations/{location_id}/dataStores/{data_store_id}/sessions/{session_id}"));

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

where T: Into<SafetySpec>,

Sets the value of safety_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::SafetySpec;
let x = AnswerQueryRequest::new().set_safety_spec(SafetySpec::default()/* use setters */);

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

where T: Into<SafetySpec>,

Sets or clears the value of safety_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::SafetySpec;
let x = AnswerQueryRequest::new().set_or_clear_safety_spec(Some(SafetySpec::default()/* use setters */));
let x = AnswerQueryRequest::new().set_or_clear_safety_spec(None::<SafetySpec>);

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

where T: Into<RelatedQuestionsSpec>,

Sets the value of related_questions_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::RelatedQuestionsSpec;
let x = AnswerQueryRequest::new().set_related_questions_spec(RelatedQuestionsSpec::default()/* use setters */);

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

where T: Into<RelatedQuestionsSpec>,

Sets or clears the value of related_questions_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::RelatedQuestionsSpec;
let x = AnswerQueryRequest::new().set_or_clear_related_questions_spec(Some(RelatedQuestionsSpec::default()/* use setters */));
let x = AnswerQueryRequest::new().set_or_clear_related_questions_spec(None::<RelatedQuestionsSpec>);

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

where T: Into<GroundingSpec>,

Sets the value of grounding_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::GroundingSpec;
let x = AnswerQueryRequest::new().set_grounding_spec(GroundingSpec::default()/* use setters */);

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

where T: Into<GroundingSpec>,

Sets or clears the value of grounding_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::GroundingSpec;
let x = AnswerQueryRequest::new().set_or_clear_grounding_spec(Some(GroundingSpec::default()/* use setters */));
let x = AnswerQueryRequest::new().set_or_clear_grounding_spec(None::<GroundingSpec>);

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

where T: Into<AnswerGenerationSpec>,

Sets the value of answer_generation_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::AnswerGenerationSpec;
let x = AnswerQueryRequest::new().set_answer_generation_spec(AnswerGenerationSpec::default()/* use setters */);

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

where T: Into<AnswerGenerationSpec>,

Sets or clears the value of answer_generation_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::AnswerGenerationSpec;
let x = AnswerQueryRequest::new().set_or_clear_answer_generation_spec(Some(AnswerGenerationSpec::default()/* use setters */));
let x = AnswerQueryRequest::new().set_or_clear_answer_generation_spec(None::<AnswerGenerationSpec>);

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

where T: Into<SearchSpec>,

Sets the value of search_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::SearchSpec;
let x = AnswerQueryRequest::new().set_search_spec(SearchSpec::default()/* use setters */);

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

where T: Into<SearchSpec>,

Sets or clears the value of search_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::SearchSpec;
let x = AnswerQueryRequest::new().set_or_clear_search_spec(Some(SearchSpec::default()/* use setters */));
let x = AnswerQueryRequest::new().set_or_clear_search_spec(None::<SearchSpec>);

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

where T: Into<QueryUnderstandingSpec>,

Sets the value of query_understanding_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::QueryUnderstandingSpec;
let x = AnswerQueryRequest::new().set_query_understanding_spec(QueryUnderstandingSpec::default()/* use setters */);

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

where T: Into<QueryUnderstandingSpec>,

Sets or clears the value of query_understanding_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::QueryUnderstandingSpec;
let x = AnswerQueryRequest::new().set_or_clear_query_understanding_spec(Some(QueryUnderstandingSpec::default()/* use setters */));
let x = AnswerQueryRequest::new().set_or_clear_query_understanding_spec(None::<QueryUnderstandingSpec>);

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

👎Deprecated

Sets the value of asynchronous_mode.

Example

let x = AnswerQueryRequest::new().set_asynchronous_mode(true);

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

Sets the value of user_pseudo_id.

Example

let x = AnswerQueryRequest::new().set_user_pseudo_id("example");

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

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

Sets the value of user_labels.

Example

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

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

where T: Into<EndUserSpec>,

Sets the value of end_user_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::EndUserSpec;
let x = AnswerQueryRequest::new().set_end_user_spec(EndUserSpec::default()/* use setters */);

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

where T: Into<EndUserSpec>,

Sets or clears the value of end_user_spec.

Example

use google_cloud_discoveryengine_v1::model::answer_query_request::EndUserSpec;
let x = AnswerQueryRequest::new().set_or_clear_end_user_spec(Some(EndUserSpec::default()/* use setters */));
let x = AnswerQueryRequest::new().set_or_clear_end_user_spec(None::<EndUserSpec>);

Trait Implementations

impl Clone for AnswerQueryRequest

fn clone(&self) -> AnswerQueryRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AnswerQueryRequest

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

Formats the value using the given formatter.

impl Default for AnswerQueryRequest

fn default() -> AnswerQueryRequest

Returns the “default value” for a type.

impl Message for AnswerQueryRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for AnswerQueryRequest

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AnswerQueryRequest