Retail v2 API - Class CompleteQueryRequest (2.9.0)

public sealed class CompleteQueryRequest : IMessage<CompleteQueryRequest>, IEquatable<CompleteQueryRequest>, IDeepCloneable<CompleteQueryRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class CompleteQueryRequest.

Autocomplete parameters.

Inheritance

object > CompleteQueryRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

CompleteQueryRequest()

public CompleteQueryRequest()

CompleteQueryRequest(CompleteQueryRequest)

public CompleteQueryRequest(CompleteQueryRequest other)
Parameter
Name Description
other CompleteQueryRequest

Properties

Catalog

public string Catalog { get; set; }

Required. Catalog for which the completion is performed.

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

Property Value
Type Description
string

CatalogAsCatalogName

public CatalogName CatalogAsCatalogName { get; set; }

CatalogName-typed view over the Catalog resource name property.

Property Value
Type Description
CatalogName

Dataset

public string Dataset { get; set; }

Determines which dataset to use for fetching completion. "user-data" will use the imported dataset through [CompletionService.ImportCompletionData][google.cloud.retail.v2.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.

Property Value
Type Description
string

DeviceType

public string DeviceType { get; set; }

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.

Property Value
Type Description
string

Entity

public string Entity { get; set; }

The entity for customers that may run multiple different entities, domains, sites or regions, for example, Google US, Google Ads, Waymo, google.com, youtube.com, etc. If this is set, it should be exactly matched with [UserEvent.entity][google.cloud.retail.v2.UserEvent.entity] to get per-entity autocomplete results.

Property Value
Type Description
string

LanguageCodes

public RepeatedField<string> LanguageCodes { get; }

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.

Property Value
Type Description
RepeatedFieldstring

MaxSuggestions

public int MaxSuggestions { get; set; }

Completion max suggestions. If left unset or set to 0, then will fallback to the configured value [CompletionConfig.max_suggestions][google.cloud.retail.v2.CompletionConfig.max_suggestions].

The maximum allowed max suggestions is 20. If it is set higher, it will be capped by 20.

Property Value
Type Description
int

Query

public string Query { get; set; }

Required. The query used to generate suggestions.

The maximum number of allowed characters is 255.

Property Value
Type Description
string

VisitorId

public string VisitorId { get; set; }

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.

Property Value
Type Description
string