CompleteQueryRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)
Auto-complete parameters.
Attributes | |
---|---|
Name | Description |
catalog |
str
Required. Catalog for which the completion is performed. Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog .
|
query |
str
Required. The query used to generate suggestions. The maximum number of allowed characters is 255. |
visitor_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. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
language_codes |
Sequence[str]
The list of languages of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see `Tags for Identifying Languages |
device_type |
str
The device type context for completion suggestions. It is useful to apply different suggestions on different device types, e.g. DESKTOP , MOBILE . If it is empty, the
suggestions are across all device types.
Supported formats:
- UNKNOWN_DEVICE_TYPE
- DESKTOP
- MOBILE
- A customized string starts with OTHER_ , e.g.
OTHER_IPHONE .
|
dataset |
str
Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through CompletionService.ImportCompletionData. "cloud-retail" will use the dataset generated by cloud retail based on user events. If leave empty, it will use the "user-data". Current supported values: - user-data - cloud-retail This option requires additional allowlisting. Before using cloud-retail, contact Cloud Retail support team first. |
max_suggestions |
int
Completion max suggestions. If left unset or set to 0, then will fallback to the configured value [CompletionConfig.max_suggestions][]. The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20. |