AdvancedCompleteQueryRequest(
mapping=None, *, ignore_unknown_fields=False, **kwargs
)Request message for CompletionService.AdvancedCompleteQuery method. .
Attributes |
|
|---|---|
| Name | Description |
completion_config |
str
Required. The completion_config of the parent dataStore or engine resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/*/completionConfig
projects/*/locations/global/collections/default_collection/engines/*/completionConfig.
|
query |
str
Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. The query can not be empty for most of the suggestion types. If it is empty, an INVALID_ARGUMENT error is returned.
The exception is when the suggestion_types contains only the
type RECENT_SEARCH, the query can be an empty string.
The is called "zero prefix" feature, which returns user's
recently searched queries given the empty query.
|
query_model |
str
Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: - document - Using suggestions generated from
user-imported documents.
- search-history - Using suggestions generated from the
past history of
SearchService.Search
API calls. Do not use it when there is no traffic for
Search API.
- user-event - Using suggestions generated from
user-imported search events.
- document-completable - Using suggestions taken
directly from user-imported document fields marked as
completable.
Default values:
- document is the default model for regular dataStores.
- search-history is the default model for site search
dataStores.
|
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.
This should be the same identifier as
UserEvent.user_pseudo_id
and
SearchRequest.user_pseudo_id.
The field must be a UTF-8 encoded string with a length limit
of 128
|
user_info |
google.cloud.discoveryengine_v1beta.types.UserInfo
Optional. Information about the end user. This should be the same identifier information as UserEvent.user_info and SearchRequest.user_info. |
include_tail_suggestions |
bool
Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. |
boost_spec |
google.cloud.discoveryengine_v1beta.types.AdvancedCompleteQueryRequest.BoostSpec
Optional. Specification to boost suggestions matching the condition. |
suggestion_types |
MutableSequence[google.cloud.discoveryengine_v1beta.types.AdvancedCompleteQueryRequest.SuggestionType]
Optional. Suggestion types to return. If empty or unspecified, query suggestions are returned. Only one suggestion type is supported at the moment. |
Classes
BoostSpec
BoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)Specification to boost suggestions based on the condtion of the suggestion.
SuggestionType
SuggestionType(value)Suggestion type to return.