Struct google_api_proto::google::cloud::discoveryengine::v1alpha::AnswerQueryRequest
source · 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 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,
}
Expand description
Request message for [ConversationalSearchService.AnswerQuery][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.AnswerQuery] method.
Fields§
§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 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
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][google.cloud.discoveryengine.v1alpha.ConversationalSearchService.GetAnswer] or [ConversationalSearchService.GetSession][google.cloud.discoveryengine.v1alpha.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.
Trait Implementations§
source§impl Clone for AnswerQueryRequest
impl Clone for AnswerQueryRequest
source§fn clone(&self) -> AnswerQueryRequest
fn clone(&self) -> AnswerQueryRequest
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for AnswerQueryRequest
impl Debug for AnswerQueryRequest
source§impl Default for AnswerQueryRequest
impl Default for AnswerQueryRequest
source§impl Message for AnswerQueryRequest
impl Message for AnswerQueryRequest
source§fn encoded_len(&self) -> usize
fn encoded_len(&self) -> usize
source§fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
B: BufMut,
Self: Sized,
source§fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
fn encode_length_delimited_to_vec(&self) -> Vec<u8>where
Self: Sized,
source§fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
B: Buf,
Self: Default,
source§fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
. Read moresource§fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
B: Buf,
Self: Sized,
self
.source§impl PartialEq for AnswerQueryRequest
impl PartialEq for AnswerQueryRequest
source§fn eq(&self, other: &AnswerQueryRequest) -> bool
fn eq(&self, other: &AnswerQueryRequest) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for AnswerQueryRequest
Auto Trait Implementations§
impl Freeze for AnswerQueryRequest
impl RefUnwindSafe for AnswerQueryRequest
impl Send for AnswerQueryRequest
impl Sync for AnswerQueryRequest
impl Unpin for AnswerQueryRequest
impl UnwindSafe for AnswerQueryRequest
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request