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.v1.SearchResponse.SearchResult.RankSignals| Modifier and Type | Class and Description |
|---|---|
static class |
SearchResponse.SearchResult.RankSignals.Builder
A set of ranking signals.
|
static class |
SearchResponse.SearchResult.RankSignals.CustomSignal
Custom clearbox signal represented by name and value pair.
|
static interface |
SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder |
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>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
BOOSTING_FACTOR_FIELD_NUMBER |
static int |
CUSTOM_SIGNALS_FIELD_NUMBER |
static int |
DEFAULT_RANK_FIELD_NUMBER |
static int |
DOCUMENT_AGE_FIELD_NUMBER |
static int |
KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER |
static int |
PCTR_RANK_FIELD_NUMBER |
static int |
RELEVANCE_SCORE_FIELD_NUMBER |
static int |
SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER |
static int |
TOPICALITY_RANK_FIELD_NUMBER |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashFields, toStringaddAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER
public static final int RELEVANCE_SCORE_FIELD_NUMBER
public static final int SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER
public static final int PCTR_RANK_FIELD_NUMBER
public static final int TOPICALITY_RANK_FIELD_NUMBER
public static final int DOCUMENT_AGE_FIELD_NUMBER
public static final int BOOSTING_FACTOR_FIELD_NUMBER
public static final int DEFAULT_RANK_FIELD_NUMBER
public static final int CUSTOM_SIGNALS_FIELD_NUMBER
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessagepublic boolean hasKeywordSimilarityScore()
Optional. Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
hasKeywordSimilarityScore in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic float getKeywordSimilarityScore()
Optional. Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
getKeywordSimilarityScore in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic boolean hasRelevanceScore()
Optional. Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];hasRelevanceScore in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic float getRelevanceScore()
Optional. Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];getRelevanceScore in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic boolean hasSemanticSimilarityScore()
Optional. Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
hasSemanticSimilarityScore in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic float getSemanticSimilarityScore()
Optional. Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
getSemanticSimilarityScore in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic boolean hasPctrRank()
Optional. Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];hasPctrRank in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic float getPctrRank()
Optional. Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];getPctrRank in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic boolean hasTopicalityRank()
Optional. Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];hasTopicalityRank in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic float getTopicalityRank()
Optional. Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];getTopicalityRank in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic boolean hasDocumentAge()
Optional. Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];hasDocumentAge in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic float getDocumentAge()
Optional. Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];getDocumentAge in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic boolean hasBoostingFactor()
Optional. Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];hasBoostingFactor in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic float getBoostingFactor()
Optional. Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];getBoostingFactor in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic float getDefaultRank()
Optional. The default rank of the result.
float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];getDefaultRank in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic List<SearchResponse.SearchResult.RankSignals.CustomSignal> getCustomSignalsList()
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
getCustomSignalsList in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic List<? extends SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder> getCustomSignalsOrBuilderList()
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
getCustomSignalsOrBuilderList in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic int getCustomSignalsCount()
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
getCustomSignalsCount in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic SearchResponse.SearchResult.RankSignals.CustomSignal getCustomSignals(int index)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
getCustomSignals in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder getCustomSignalsOrBuilder(int index)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
getCustomSignalsOrBuilder in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessagepublic void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageIOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessagepublic boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static SearchResponse.SearchResult.RankSignals parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(InputStream input) throws IOException
IOExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchResponse.SearchResult.RankSignals parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static SearchResponse.SearchResult.RankSignals parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static SearchResponse.SearchResult.RankSignals parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic SearchResponse.SearchResult.RankSignals.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static SearchResponse.SearchResult.RankSignals.Builder newBuilder()
public static SearchResponse.SearchResult.RankSignals.Builder newBuilder(SearchResponse.SearchResult.RankSignals prototype)
public SearchResponse.SearchResult.RankSignals.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected SearchResponse.SearchResult.RankSignals.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
newBuilderForType in class com.google.protobuf.AbstractMessagepublic static SearchResponse.SearchResult.RankSignals getDefaultInstance()
public static com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals> parser()
public com.google.protobuf.Parser<SearchResponse.SearchResult.RankSignals> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessagepublic SearchResponse.SearchResult.RankSignals getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2026 Google LLC. All rights reserved.