Retail v2 API - Class CompletionConfig (2.4.0)

Version 2.4.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 CompletionConfig : IMessage<CompletionConfig>, IEquatable<CompletionConfig>, IDeepCloneable<CompletionConfig>, IBufferMessage, IMessage

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

Catalog level autocomplete config for customers to customize autocomplete feature's settings.

Inheritance

Object > CompletionConfig

Implements

IMessage<CompletionConfig>, IEquatable<CompletionConfig>, IDeepCloneable<CompletionConfig>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

CompletionConfig()

public CompletionConfig()

CompletionConfig(CompletionConfig)

public CompletionConfig(CompletionConfig other)

Parameter
Name	Description
other	CompletionConfig

Properties

AllowlistInputConfig

public CompletionDataInputConfig AllowlistInputConfig { get; set; }

Output only. The source data for the latest import of the autocomplete allowlist phrases.

Property Value
Type	Description
CompletionDataInputConfig

AutoLearning

public bool AutoLearning { get; set; }

If set to true, the auto learning function is enabled. Auto learning uses user data to generate suggestions using ML techniques. Default value is false. Only after enabling auto learning can users use cloud-retail data in [CompleteQueryRequest][google.cloud.retail.v2.CompleteQueryRequest].

Property Value
Type	Description
Boolean

CompletionConfigName

public CompletionConfigName CompletionConfigName { get; set; }

CompletionConfigName-typed view over the Name resource name property.

Property Value
Type	Description
CompletionConfigName

DenylistInputConfig

public CompletionDataInputConfig DenylistInputConfig { get; set; }

Output only. The source data for the latest import of the autocomplete denylist phrases.

Property Value
Type	Description
CompletionDataInputConfig

LastAllowlistImportOperation

public string LastAllowlistImportOperation { get; set; }

Output only. Name of the LRO corresponding to the latest allowlist import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.

Property Value
Type	Description
String

LastDenylistImportOperation

public string LastDenylistImportOperation { get; set; }

Output only. Name of the LRO corresponding to the latest denylist import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.

Property Value
Type	Description
String

LastSuggestionsImportOperation

public string LastSuggestionsImportOperation { get; set; }

Output only. Name of the LRO corresponding to the latest suggestion terms list import.

Can use [GetOperation][google.longrunning.Operations.GetOperation] API to retrieve the latest state of the Long Running Operation.

Property Value
Type	Description
String

MatchingOrder

public string MatchingOrder { get; set; }

Specifies the matching order for autocomplete suggestions, e.g., a query consisting of 'sh' with 'out-of-order' specified would suggest "women's shoes", whereas a query of 'red s' with 'exact-prefix' specified would suggest "red shoes". Currently supported values:

• 'out-of-order'
• 'exact-prefix'

Default value: 'exact-prefix'.

Property Value
Type	Description
String

MaxSuggestions

public int MaxSuggestions { get; set; }

The maximum number of autocomplete suggestions returned per term. Default value is 20. If left unset or set to 0, then will fallback to default value.

Value range is 1 to 20.

Property Value
Type	Description
Int32

MinPrefixLength

public int MinPrefixLength { get; set; }

The minimum number of characters needed to be typed in order to get suggestions. Default value is 2. If left unset or set to 0, then will fallback to default value.

Value range is 1 to 20.

Property Value
Type	Description
Int32

Name

public string Name { get; set; }

Required. Immutable. Fully qualified name projects/*/locations/*/catalogs/*/completionConfig

Property Value
Type	Description
String

SuggestionsInputConfig

public CompletionDataInputConfig SuggestionsInputConfig { get; set; }

Output only. The source data for the latest import of the autocomplete suggestion phrases.

Property Value
Type	Description
CompletionDataInputConfig