com.google.cloud.discoveryengine.v1beta

Interface CompletionSuggestionOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CompletionSuggestion, CompletionSuggestion.Builder

public interface CompletionSuggestionOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAlternativePhrases(int index) Alternative matching phrases for this suggestion.
com.google.protobuf.ByteString	getAlternativePhrasesBytes(int index) Alternative matching phrases for this suggestion.
int	getAlternativePhrasesCount() Alternative matching phrases for this suggestion.
List<String>	getAlternativePhrasesList() Alternative matching phrases for this suggestion.
long	getFrequency() Frequency of this suggestion.
double	getGlobalScore() Global score of this suggestion.
String	getGroupId() If two suggestions have the same groupId, they will not be returned together.
com.google.protobuf.ByteString	getGroupIdBytes() If two suggestions have the same groupId, they will not be returned together.
double	getGroupScore() The score of this suggestion within its group.
String	getLanguageCode() BCP-47 language code of this suggestion.
com.google.protobuf.ByteString	getLanguageCodeBytes() BCP-47 language code of this suggestion.
CompletionSuggestion.RankingInfoCase	getRankingInfoCase()
String	getSuggestion() Required.
com.google.protobuf.ByteString	getSuggestionBytes() Required.
boolean	hasFrequency() Frequency of this suggestion.
boolean	hasGlobalScore() Global score of this suggestion.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasGlobalScore

boolean hasGlobalScore()

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

double global_score = 2;

Returns:

Whether the globalScore field is set.

getGlobalScore

double getGlobalScore()

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

double global_score = 2;

Returns:

The globalScore.

hasFrequency

boolean hasFrequency()

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

int64 frequency = 3;

Returns:

Whether the frequency field is set.

getFrequency

long getFrequency()

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

int64 frequency = 3;

Returns:

The frequency.

getSuggestion

String getSuggestion()

 Required. The suggestion text.
 

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

Returns:

The suggestion.

getSuggestionBytes

com.google.protobuf.ByteString getSuggestionBytes()

 Required. The suggestion text.
 

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

Returns:

The bytes for suggestion.

getLanguageCode

String getLanguageCode()

 BCP-47 language code of this suggestion.
 

string language_code = 4;

Returns:

The languageCode.

getLanguageCodeBytes

com.google.protobuf.ByteString getLanguageCodeBytes()

 BCP-47 language code of this suggestion.
 

string language_code = 4;

Returns:

The bytes for languageCode.

getGroupId

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:

The groupId.

getGroupIdBytes

com.google.protobuf.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:

The bytes for groupId.

getGroupScore

double getGroupScore()

 The score of this suggestion within its group.
 

double group_score = 6;

Returns:

The groupScore.

getAlternativePhrasesList

List<String> getAlternativePhrasesList()

 Alternative matching phrases for this suggestion.
 

repeated string alternative_phrases = 7;

Returns:

A list containing the alternativePhrases.

getAlternativePhrasesCount

int getAlternativePhrasesCount()

 Alternative matching phrases for this suggestion.
 

repeated string alternative_phrases = 7;

Returns:

The count of alternativePhrases.

getAlternativePhrases

String getAlternativePhrases(int index)

 Alternative matching phrases for this suggestion.
 

repeated string alternative_phrases = 7;

Parameters:

index - The index of the element to return.

Returns:

The alternativePhrases at the given index.

getAlternativePhrasesBytes

com.google.protobuf.ByteString getAlternativePhrasesBytes(int index)

 Alternative matching phrases for this suggestion.
 

repeated string alternative_phrases = 7;

Parameters:

index - The index of the value to return.

Returns:

The bytes of the alternativePhrases at the given index.

getRankingInfoCase

CompletionSuggestion.RankingInfoCase getRankingInfoCase()