Class CompleteQueryRequest (1.5.0)

Version 1.5.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

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

Auto-complete parameters.

Inheritance

Object > CompleteQueryRequest

Implements

IMessage<CompleteQueryRequest>, IEquatable<CompleteQueryRequest>, IDeepCloneable<CompleteQueryRequest>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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 additional allowlisting. Before using cloud-retail, contact Cloud Retail support team first.

Property Value
Type	Description
String

DeviceType

public string DeviceType { get; set; }

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.

Property Value
Type	Description
String

LanguageCodes

public RepeatedField<string> LanguageCodes { get; }

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.

The maximum number of allowed characters is 255. Only "en-US" is currently supported.

Property Value
Type	Description
RepeatedField<String>

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][].

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

Property Value
Type	Description
Int32

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; }

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