Google Cloud Retail V2 Client - Class CompleteQueryRequest (2.1.2)

Reference documentation and code samples for the Google Cloud Retail V2 Client class CompleteQueryRequest.

Autocomplete parameters.

Generated from protobuf message google.cloud.retail.v2.CompleteQueryRequest

Namespace

Google \ Cloud \ Retail \ V2

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 projects/*/locations/global/catalogs/default_catalog.
↳ 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 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.
↳ device_type string

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_TYPE * * DESKTOP * * MOBILE * * A customized string starts with OTHER_, e.g. OTHER_IPHONE.
↳ 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.
↳ enable_attribute_suggestions bool

If true, attribute suggestions are enabled and provided in the response. This field is only available for the "cloud-retail" dataset.
↳ entity string

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.

getCatalog

Required. Catalog for which the completion is performed.

Full resource name of catalog, such as projects/*/locations/global/catalogs/default_catalog.

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.

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.

Returns
Type Description
string

setQuery

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

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.

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.

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.

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

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_TYPE
  • DESKTOP
  • MOBILE
  • A customized string starts with OTHER_, e.g. OTHER_IPHONE.
Returns
Type Description
string

setDeviceType

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_TYPE
  • DESKTOP
  • MOBILE
  • A customized string starts with OTHER_, e.g. OTHER_IPHONE.
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.
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.
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.

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.

Parameter
Name Description
var int
Returns
Type Description
$this

getEnableAttributeSuggestions

If true, attribute suggestions are enabled and provided in the response.

This field is only available for the "cloud-retail" dataset.

Returns
Type Description
bool

setEnableAttributeSuggestions

If true, attribute suggestions are enabled and provided in the response.

This field is only available for the "cloud-retail" dataset.

Parameter
Name Description
var bool
Returns
Type Description
$this

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.

Returns
Type Description
string

setEntity

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.

Parameter
Name Description
var string
Returns
Type Description
$this