AnswerQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for ConversationalSearchService.AnswerQuery method.
Attributes |
|
|---|---|
| Name | Description |
serving_config |
str
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 |
google.cloud.discoveryengine_v1beta.types.Query
Required. Current user query. |
session |
str
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 |
google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.SafetySpec
Model specification. |
related_questions_spec |
google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.RelatedQuestionsSpec
Related questions specification. |
answer_generation_spec |
google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.AnswerGenerationSpec
Answer generation specification. |
search_spec |
google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.SearchSpec
Search specification. |
query_understanding_spec |
google.cloud.discoveryengine_v1beta.types.AnswerQueryRequest.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 or ConversationalSearchService.GetSession method. |
user_pseudo_id |
str
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.
|
Classes
AnswerGenerationSpec
AnswerGenerationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Answer generation specification.
QueryUnderstandingSpec
QueryUnderstandingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Query understanding specification.
RelatedQuestionsSpec
RelatedQuestionsSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Related questions specification.
SafetySpec
SafetySpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Safety specification.
SearchSpec
SearchSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Search specification.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields