- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
public interface CompleteQueryRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getCatalog()
public abstract String getCatalog()Required. Catalog for which the completion is performed.
Full resource name of catalog, such as
projects/*/locations/global/catalogs/default_catalog.
string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The catalog. |
getCatalogBytes()
public abstract ByteString getCatalogBytes()Required. Catalog for which the completion is performed.
Full resource name of catalog, such as
projects/*/locations/global/catalogs/default_catalog.
string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for catalog. |
getDataset()
public abstract String getDataset()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 enabling auto-learning function first. See guidelines.
string dataset = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The dataset. |
getDatasetBytes()
public abstract ByteString getDatasetBytes()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 enabling auto-learning function first. See guidelines.
string dataset = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for dataset. |
getDeviceType()
public abstract String getDeviceType()The device type context for completion suggestions. We recommend that you leave this field empty.
It can 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_TYPEDESKTOPMOBILEA customized string starts with
OTHER_, e.g.OTHER_IPHONE.
string device_type = 4;
| Returns | |
|---|---|
| Type | Description |
String |
The deviceType. |
getDeviceTypeBytes()
public abstract ByteString getDeviceTypeBytes()The device type context for completion suggestions. We recommend that you leave this field empty.
It can 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_TYPEDESKTOPMOBILEA customized string starts with
OTHER_, e.g.OTHER_IPHONE.
string device_type = 4;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for deviceType. |
getEnableAttributeSuggestions()
public abstract boolean getEnableAttributeSuggestions()If true, attribute suggestions are enabled and provided in response.
This field is only available for "cloud-retail" dataset.
bool enable_attribute_suggestions = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
The enableAttributeSuggestions. |
getEntity()
public abstract String getEntity() The entity for customers who run multiple entities, domains, sites, or
regions, for example, Google US, Google Ads, Waymo,
google.com, youtube.com, etc.
If this is set, it must be an exact match with
UserEvent.entity to get
per-entity autocomplete results.
string entity = 10;
| Returns | |
|---|---|
| Type | Description |
String |
The entity. |
getEntityBytes()
public abstract ByteString getEntityBytes() The entity for customers who run multiple entities, domains, sites, or
regions, for example, Google US, Google Ads, Waymo,
google.com, youtube.com, etc.
If this is set, it must be an exact match with
UserEvent.entity to get
per-entity autocomplete results.
string entity = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for entity. |
getLanguageCodes(int index)
public abstract String getLanguageCodes(int index) Note that this field applies for user-data dataset only. For requests
with cloud-retail dataset, setting this field has no effect.
The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.
repeated string language_codes = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The languageCodes at the given index. |
getLanguageCodesBytes(int index)
public abstract ByteString getLanguageCodesBytes(int index) Note that this field applies for user-data dataset only. For requests
with cloud-retail dataset, setting this field has no effect.
The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.
repeated string language_codes = 3;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the languageCodes at the given index. |
getLanguageCodesCount()
public abstract int getLanguageCodesCount() Note that this field applies for user-data dataset only. For requests
with cloud-retail dataset, setting this field has no effect.
The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.
repeated string language_codes = 3;
| Returns | |
|---|---|
| Type | Description |
int |
The count of languageCodes. |
getLanguageCodesList()
public abstract List<String> getLanguageCodesList() Note that this field applies for user-data dataset only. For requests
with cloud-retail dataset, setting this field has no effect.
The language filters applied to the output suggestions. If set, it should contain the language of the query. If not set, suggestions are returned without considering language restrictions. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see Tags for Identifying Languages. The maximum number of language codes is 3.
repeated string language_codes = 3;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the languageCodes. |
getMaxSuggestions()
public abstract int getMaxSuggestions()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.
int32 max_suggestions = 5;
| Returns | |
|---|---|
| Type | Description |
int |
The maxSuggestions. |
getQuery()
public abstract String getQuery()Required. The query used to generate suggestions.
The maximum number of allowed characters is 255.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public abstract ByteString getQueryBytes()Required. The query used to generate suggestions.
The maximum number of allowed characters is 255.
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for query. |
getVisitorId()
public abstract String getVisitorId()Required field. 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.
string visitor_id = 7;
| Returns | |
|---|---|
| Type | Description |
String |
The visitorId. |
getVisitorIdBytes()
public abstract ByteString getVisitorIdBytes()Required field. 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.
string visitor_id = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for visitorId. |