Discovery Engine v1 API - Class CompletionSuggestion (1.5.0)

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

Reference documentation and code samples for the Discovery Engine v1 API class CompletionSuggestion.

Autocomplete suggestions that are imported from Customer.

Inheritance

object > CompletionSuggestion

Implements

IMessage CompletionSuggestion, IEquatable CompletionSuggestion, IDeepCloneable CompletionSuggestion, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

CompletionSuggestion()

public CompletionSuggestion()

CompletionSuggestion(CompletionSuggestion)

public CompletionSuggestion(CompletionSuggestion other)

Parameter
Name	Description
`other`	`CompletionSuggestion`

Properties

AlternativePhrases

public RepeatedField<string> AlternativePhrases { get; }

Alternative matching phrases for this suggestion.

Property Value
Type	Description
`RepeatedFieldstring`

Frequency

public long Frequency { get; set; }

Frequency of this suggestion. Will be used to rank suggestions when score is not available.

Property Value
Type	Description
`long`

GlobalScore

public double GlobalScore { get; set; }

Global score of this suggestion. Control how this suggestion would be scored / ranked.

Property Value
Type	Description
`double`

GroupId

public string GroupId { get; set; }

If two suggestions have the same groupId, they will not be returned together. Instead the one ranked higher will be returned. This can be used to deduplicate semantically identical suggestions.

Property Value
Type	Description
`string`

GroupScore

public double GroupScore { get; set; }

The score of this suggestion within its group.

Property Value
Type	Description
`double`

HasFrequency

public bool HasFrequency { get; }

Gets whether the "frequency" field is set

Property Value
Type	Description
`bool`

HasGlobalScore

public bool HasGlobalScore { get; }

Gets whether the "global_score" field is set

Property Value
Type	Description
`bool`

LanguageCode

public string LanguageCode { get; set; }

BCP-47 language code of this suggestion.

Property Value
Type	Description
`string`

RankingInfoCase

public CompletionSuggestion.RankingInfoOneofCase RankingInfoCase { get; }

Property Value
Type	Description
`CompletionSuggestionRankingInfoOneofCase`

Suggestion

public string Suggestion { get; set; }

Required. The suggestion text.

Property Value
Type	Description
`string`