Reference documentation and code samples for the Google Cloud Retail V2 Client class CompleteQueryRequest.
Auto-complete parameters.
Generated from protobuf message google.cloud.retail.v2.CompleteQueryRequest
Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ catalog |
string
Required. Catalog for which the completion is performed. Full resource name of catalog, such as |
↳ query |
string
Required. The query used to generate suggestions. The maximum number of allowed characters is 255. |
↳ visitor_id |
string
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. |
↳ language_codes |
array
Note that this field applies for |
↳ device_type |
string
The device type context for completion suggestions. It is useful to apply different suggestions on different device types, e.g. |
↳ dataset |
string
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. |
↳ 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. |
getCatalog
Required. Catalog for which the completion is performed.
Full resource name of catalog, such as
projects/*/locations/global/catalogs/default_catalog
.
Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
Returns | |
---|---|
Type | Description |
string |
setCatalog
Required. Catalog for which the completion is performed.
Full resource name of catalog, such as
projects/*/locations/global/catalogs/default_catalog
.
Generated from protobuf field string catalog = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getQuery
Required. The query used to generate suggestions.
The maximum number of allowed characters is 255.
Generated from protobuf field string query = 2 [(.google.api.field_behavior) = REQUIRED];
Returns | |
---|---|
Type | Description |
string |
setQuery
Required. The query used to generate suggestions.
The maximum number of allowed characters is 255.
Generated from protobuf field string query = 2 [(.google.api.field_behavior) = REQUIRED];
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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.
Generated from protobuf field string visitor_id = 7;
Returns | |
---|---|
Type | Description |
string |
setVisitorId
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.
Generated from protobuf field string visitor_id = 7;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getLanguageCodes
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.
Generated from protobuf field repeated string language_codes = 3;
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setLanguageCodes
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.
Generated from protobuf field repeated string language_codes = 3;
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getDeviceType
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
.
Generated from protobuf field string device_type = 4;
Returns | |
---|---|
Type | Description |
string |
setDeviceType
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
.
Generated from protobuf field string device_type = 4;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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.
Generated from protobuf field string dataset = 6;
Returns | |
---|---|
Type | Description |
string |
setDataset
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.
Generated from protobuf field string dataset = 6;
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
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.
Generated from protobuf field int32 max_suggestions = 5;
Returns | |
---|---|
Type | Description |
int |
setMaxSuggestions
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.
Generated from protobuf field int32 max_suggestions = 5;
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |