Package com.google.cloud.discoveryengine.v1beta

Class SearchResponse.SearchResult.RankSignals

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals

All Implemented Interfaces:

SearchResponse.SearchResult.RankSignalsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

SearchResponse.SearchResult

public static final class SearchResponse.SearchResult.RankSignals
extends com.google.protobuf.GeneratedMessage
implements SearchResponse.SearchResult.RankSignalsOrBuilder

 A set of ranking signals.
 

Protobuf type google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	SearchResponse.SearchResult.RankSignals.Builder	A set of ranking signals.
static final class	SearchResponse.SearchResult.RankSignals.CustomSignal	Custom clearbox signal represented by name and value pair.
static interface	SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BOOSTING_FACTOR_FIELD_NUMBER
static final int	CUSTOM_SIGNALS_FIELD_NUMBER
static final int	DEFAULT_RANK_FIELD_NUMBER
static final int	DOCUMENT_AGE_FIELD_NUMBER
static final int	KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER
static final int	PCTR_RANK_FIELD_NUMBER
static final int	RELEVANCE_SCORE_FIELD_NUMBER
static final int	SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER
static final int	TOPICALITY_RANK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
float	getBoostingFactor()	Combined custom boosts for a doc.
SearchResponse.SearchResult.RankSignals.CustomSignal	getCustomSignals(int index)	A list of custom clearbox signals.
int	getCustomSignalsCount()	A list of custom clearbox signals.
List<SearchResponse.SearchResult.RankSignals.CustomSignal>	getCustomSignalsList()	A list of custom clearbox signals.
SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder	getCustomSignalsOrBuilder(int index)	A list of custom clearbox signals.
List<? extends SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder>	getCustomSignalsOrBuilderList()	A list of custom clearbox signals.
static SearchResponse.SearchResult.RankSignals	getDefaultInstance()
SearchResponse.SearchResult.RankSignals	getDefaultInstanceForType()
float	getDefaultRank()	The default rank of the result.
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
float	getDocumentAge()	Age of the document in hours.
float	getKeywordSimilarityScore()	Keyword matching adjustment.
com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals>	getParserForType()
float	getPctrRank()	Predicted conversion rate adjustment as a rank.
float	getRelevanceScore()	Semantic relevance adjustment.
float	getSemanticSimilarityScore()	Semantic similarity adjustment.
int	getSerializedSize()
float	getTopicalityRank()	Topicality adjustment as a rank.
boolean	hasBoostingFactor()	Combined custom boosts for a doc.
boolean	hasDocumentAge()	Age of the document in hours.
int	hashCode()
boolean	hasKeywordSimilarityScore()	Keyword matching adjustment.
boolean	hasPctrRank()	Predicted conversion rate adjustment as a rank.
boolean	hasRelevanceScore()	Semantic relevance adjustment.
boolean	hasSemanticSimilarityScore()	Semantic similarity adjustment.
boolean	hasTopicalityRank()	Topicality adjustment as a rank.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static SearchResponse.SearchResult.RankSignals.Builder	newBuilder()
static SearchResponse.SearchResult.RankSignals.Builder	newBuilder(SearchResponse.SearchResult.RankSignals prototype)
SearchResponse.SearchResult.RankSignals.Builder	newBuilderForType()
protected SearchResponse.SearchResult.RankSignals.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static SearchResponse.SearchResult.RankSignals	parseDelimitedFrom(InputStream input)
static SearchResponse.SearchResult.RankSignals	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals	parseFrom(byte[] data)
static SearchResponse.SearchResult.RankSignals	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals	parseFrom(com.google.protobuf.ByteString data)
static SearchResponse.SearchResult.RankSignals	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals	parseFrom(com.google.protobuf.CodedInputStream input)
static SearchResponse.SearchResult.RankSignals	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals	parseFrom(InputStream input)
static SearchResponse.SearchResult.RankSignals	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static SearchResponse.SearchResult.RankSignals	parseFrom(ByteBuffer data)
static SearchResponse.SearchResult.RankSignals	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals>	parser()
SearchResponse.SearchResult.RankSignals.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER

public static final int KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER

See Also:

• Constant Field Values

RELEVANCE_SCORE_FIELD_NUMBER

public static final int RELEVANCE_SCORE_FIELD_NUMBER

See Also:

• Constant Field Values

SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER

public static final int SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER

See Also:

• Constant Field Values

PCTR_RANK_FIELD_NUMBER

public static final int PCTR_RANK_FIELD_NUMBER

See Also:

• Constant Field Values

TOPICALITY_RANK_FIELD_NUMBER

public static final int TOPICALITY_RANK_FIELD_NUMBER

See Also:

• Constant Field Values

DOCUMENT_AGE_FIELD_NUMBER

public static final int DOCUMENT_AGE_FIELD_NUMBER

See Also:

• Constant Field Values

BOOSTING_FACTOR_FIELD_NUMBER

public static final int BOOSTING_FACTOR_FIELD_NUMBER

See Also:

• Constant Field Values

DEFAULT_RANK_FIELD_NUMBER

public static final int DEFAULT_RANK_FIELD_NUMBER

See Also:

• Constant Field Values

CUSTOM_SIGNALS_FIELD_NUMBER

public static final int CUSTOM_SIGNALS_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

hasKeywordSimilarityScore

public boolean hasKeywordSimilarityScore()

 Keyword matching adjustment.
 

optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasKeywordSimilarityScore in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

Whether the keywordSimilarityScore field is set.

getKeywordSimilarityScore

public float getKeywordSimilarityScore()

 Keyword matching adjustment.
 

optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getKeywordSimilarityScore in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

The keywordSimilarityScore.

hasRelevanceScore

public boolean hasRelevanceScore()

 Semantic relevance adjustment.
 

optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRelevanceScore in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

Whether the relevanceScore field is set.

getRelevanceScore

public float getRelevanceScore()

 Semantic relevance adjustment.
 

optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRelevanceScore in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

The relevanceScore.

hasSemanticSimilarityScore

public boolean hasSemanticSimilarityScore()

 Semantic similarity adjustment.
 

optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasSemanticSimilarityScore in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

Whether the semanticSimilarityScore field is set.

getSemanticSimilarityScore

public float getSemanticSimilarityScore()

 Semantic similarity adjustment.
 

optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getSemanticSimilarityScore in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

The semanticSimilarityScore.

hasPctrRank

public boolean hasPctrRank()

 Predicted conversion rate adjustment as a rank.
 

optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasPctrRank in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

Whether the pctrRank field is set.

getPctrRank

public float getPctrRank()

 Predicted conversion rate adjustment as a rank.
 

optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getPctrRank in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

The pctrRank.

hasTopicalityRank

public boolean hasTopicalityRank()

 Topicality adjustment as a rank.
 

optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasTopicalityRank in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

Whether the topicalityRank field is set.

getTopicalityRank

public float getTopicalityRank()

 Topicality adjustment as a rank.
 

optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTopicalityRank in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

The topicalityRank.

hasDocumentAge

public boolean hasDocumentAge()

 Age of the document in hours.
 

optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasDocumentAge in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

Whether the documentAge field is set.

getDocumentAge

public float getDocumentAge()

 Age of the document in hours.
 

optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDocumentAge in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

The documentAge.

hasBoostingFactor

public boolean hasBoostingFactor()

 Combined custom boosts for a doc.
 

optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasBoostingFactor in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

Whether the boostingFactor field is set.

getBoostingFactor

public float getBoostingFactor()

 Combined custom boosts for a doc.
 

optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getBoostingFactor in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

The boostingFactor.

getDefaultRank

public float getDefaultRank()

 The default rank of the result.
 

float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDefaultRank in interface SearchResponse.SearchResult.RankSignalsOrBuilder

Returns:

The defaultRank.

getCustomSignalsList

public List<SearchResponse.SearchResult.RankSignals.CustomSignal> getCustomSignalsList()

 A list of custom clearbox signals.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomSignalsList in interface SearchResponse.SearchResult.RankSignalsOrBuilder

getCustomSignalsOrBuilderList

public List<? extends SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder> getCustomSignalsOrBuilderList()

 A list of custom clearbox signals.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomSignalsOrBuilderList in interface SearchResponse.SearchResult.RankSignalsOrBuilder

getCustomSignalsCount

public int getCustomSignalsCount()

 A list of custom clearbox signals.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomSignalsCount in interface SearchResponse.SearchResult.RankSignalsOrBuilder

getCustomSignals

public SearchResponse.SearchResult.RankSignals.CustomSignal getCustomSignals(int index)

 A list of custom clearbox signals.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomSignals in interface SearchResponse.SearchResult.RankSignalsOrBuilder

getCustomSignalsOrBuilder

public SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder getCustomSignalsOrBuilder(int index)

 A list of custom clearbox signals.
 

repeated .google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getCustomSignalsOrBuilder in interface SearchResponse.SearchResult.RankSignalsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(ByteBuffer data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(com.google.protobuf.ByteString data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(byte[] data)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(InputStream input)
                                                         throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.SearchResult.RankSignals parseDelimitedFrom(InputStream input)
                                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static SearchResponse.SearchResult.RankSignals parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                  throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(com.google.protobuf.CodedInputStream input)
                                                         throws IOException

Throws:

IOException

parseFrom

public static SearchResponse.SearchResult.RankSignals parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                         throws IOException

Throws:

IOException

newBuilderForType

public SearchResponse.SearchResult.RankSignals.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static SearchResponse.SearchResult.RankSignals.Builder newBuilder()

newBuilder

public static SearchResponse.SearchResult.RankSignals.Builder newBuilder(SearchResponse.SearchResult.RankSignals prototype)

toBuilder

public SearchResponse.SearchResult.RankSignals.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected SearchResponse.SearchResult.RankSignals.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static SearchResponse.SearchResult.RankSignals getDefaultInstance()

parser

public static com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals> parser()

getParserForType

public com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public SearchResponse.SearchResult.RankSignals getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder