Interface CompletionSuggestionOrBuilder (0.47.0)

public interface CompletionSuggestionOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAlternativePhrases(int index)

public abstract String getAlternativePhrases(int index)

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The alternativePhrases at the given index.

getAlternativePhrasesBytes(int index)

public abstract ByteString getAlternativePhrasesBytes(int index)

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the alternativePhrases at the given index.

getAlternativePhrasesCount()

public abstract int getAlternativePhrasesCount()

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Returns
Type Description
int

The count of alternativePhrases.

getAlternativePhrasesList()

public abstract List<String> getAlternativePhrasesList()

Alternative matching phrases for this suggestion.

repeated string alternative_phrases = 7;

Returns
Type Description
List<String>

A list containing the alternativePhrases.

getFrequency()

public abstract long getFrequency()

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

int64 frequency = 3;

Returns
Type Description
long

The frequency.

getGlobalScore()

public abstract double getGlobalScore()

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

double global_score = 2;

Returns
Type Description
double

The globalScore.

getGroupId()

public abstract String getGroupId()

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.

string group_id = 5;

Returns
Type Description
String

The groupId.

getGroupIdBytes()

public abstract ByteString getGroupIdBytes()

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.

string group_id = 5;

Returns
Type Description
ByteString

The bytes for groupId.

getGroupScore()

public abstract double getGroupScore()

The score of this suggestion within its group.

double group_score = 6;

Returns
Type Description
double

The groupScore.

getLanguageCode()

public abstract String getLanguageCode()

BCP-47 language code of this suggestion.

string language_code = 4;

Returns
Type Description
String

The languageCode.

getLanguageCodeBytes()

public abstract ByteString getLanguageCodeBytes()

BCP-47 language code of this suggestion.

string language_code = 4;

Returns
Type Description
ByteString

The bytes for languageCode.

getRankingInfoCase()

public abstract CompletionSuggestion.RankingInfoCase getRankingInfoCase()
Returns
Type Description
CompletionSuggestion.RankingInfoCase

getSuggestion()

public abstract String getSuggestion()

Required. The suggestion text.

string suggestion = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The suggestion.

getSuggestionBytes()

public abstract ByteString getSuggestionBytes()

Required. The suggestion text.

string suggestion = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for suggestion.

hasFrequency()

public abstract boolean hasFrequency()

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

int64 frequency = 3;

Returns
Type Description
boolean

Whether the frequency field is set.

hasGlobalScore()

public abstract boolean hasGlobalScore()

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

double global_score = 2;

Returns
Type Description
boolean

Whether the globalScore field is set.