public static final class SearchResponse.SearchResult.RankSignals.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder> implements SearchResponse.SearchResult.RankSignalsOrBuilder
A set of ranking signals.Protobuf type
google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignalsaddRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>public SearchResponse.SearchResult.RankSignals.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>public SearchResponse.SearchResult.RankSignals getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic SearchResponse.SearchResult.RankSignals build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic SearchResponse.SearchResult.RankSignals buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic SearchResponse.SearchResult.RankSignals.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>public SearchResponse.SearchResult.RankSignals.Builder mergeFrom(SearchResponse.SearchResult.RankSignals other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>public SearchResponse.SearchResult.RankSignals.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchResponse.SearchResult.RankSignals.Builder>IOExceptionpublic 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 SearchResponse.SearchResult.RankSignals.Builder setKeywordSimilarityScore(float value)
Optional. Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
value - The keywordSimilarityScore to set.public SearchResponse.SearchResult.RankSignals.Builder clearKeywordSimilarityScore()
Optional. Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
public 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 SearchResponse.SearchResult.RankSignals.Builder setRelevanceScore(float value)
Optional. Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
value - The relevanceScore to set.public SearchResponse.SearchResult.RankSignals.Builder clearRelevanceScore()
Optional. Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
public 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 SearchResponse.SearchResult.RankSignals.Builder setSemanticSimilarityScore(float value)
Optional. Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
value - The semanticSimilarityScore to set.public SearchResponse.SearchResult.RankSignals.Builder clearSemanticSimilarityScore()
Optional. Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
public 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 SearchResponse.SearchResult.RankSignals.Builder setPctrRank(float value)
Optional. Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];value - The pctrRank to set.public SearchResponse.SearchResult.RankSignals.Builder clearPctrRank()
Optional. Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];public 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 SearchResponse.SearchResult.RankSignals.Builder setTopicalityRank(float value)
Optional. Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
value - The topicalityRank to set.public SearchResponse.SearchResult.RankSignals.Builder clearTopicalityRank()
Optional. Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
public 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 SearchResponse.SearchResult.RankSignals.Builder setDocumentAge(float value)
Optional. Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];value - The documentAge to set.public SearchResponse.SearchResult.RankSignals.Builder clearDocumentAge()
Optional. Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];public 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 SearchResponse.SearchResult.RankSignals.Builder setBoostingFactor(float value)
Optional. Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
value - The boostingFactor to set.public SearchResponse.SearchResult.RankSignals.Builder clearBoostingFactor()
Optional. Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
public float getDefaultRank()
Optional. The default rank of the result.
float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];getDefaultRank in interface SearchResponse.SearchResult.RankSignalsOrBuilderpublic SearchResponse.SearchResult.RankSignals.Builder setDefaultRank(float value)
Optional. The default rank of the result.
float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];value - The defaultRank to set.public SearchResponse.SearchResult.RankSignals.Builder clearDefaultRank()
Optional. The default rank of the result.
float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];public 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 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.Builder setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.Builder setCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(SearchResponse.SearchResult.RankSignals.CustomSignal value)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal value)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.Builder addCustomSignals(int index, SearchResponse.SearchResult.RankSignals.CustomSignal.Builder builderForValue)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.Builder addAllCustomSignals(Iterable<? extends SearchResponse.SearchResult.RankSignals.CustomSignal> values)
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.Builder clearCustomSignals()
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.Builder removeCustomSignals(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];
public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder getCustomSignalsBuilder(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];
public 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 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 SearchResponse.SearchResult.RankSignals.CustomSignal.Builder addCustomSignalsBuilder()
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
public SearchResponse.SearchResult.RankSignals.CustomSignal.Builder addCustomSignalsBuilder(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];
public List<SearchResponse.SearchResult.RankSignals.CustomSignal.Builder> getCustomSignalsBuilderList()
Optional. A list of custom clearbox signals.
repeated .google.cloud.discoveryengine.v1.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];
Copyright © 2026 Google LLC. All rights reserved.