Class SearchResponse.SearchResult.RankSignals (0.77.0)
0.83.0 (latest)
0.81.0
0.79.0
0.78.0
0.77.0
0.76.0
0.74.0
0.72.0
0.71.0
0.70.0
0.69.0
0.68.0
0.66.0
0.64.0
0.63.0
0.60.0
0.59.0
0.58.0
0.56.0
0.55.0
0.54.0
0.53.0
0.52.0
0.51.0
0.50.0
0.49.0
0.48.0
0.47.0
0.45.0
0.44.0
0.43.0
0.42.0
0.41.0
0.40.0
0.39.0
0.38.0
0.37.0
0.36.0
0.35.0
0.33.0
0.32.0
0.31.0
0.30.0
0.29.0
0.28.0
0.27.0
0.26.0
0.25.0
0.24.0
0.23.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.0
0.5.0
0.4.0
0.3.0
0.2.0
0.1.0
public static final class SearchResponse . SearchResult . RankSignals extends GeneratedMessageV3 implements SearchResponse . SearchResult . RankSignalsOrBuilder
A set of ranking signals.
Protobuf type
google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BOOSTING_FACTOR_FIELD_NUMBER
public static final int BOOSTING_FACTOR_FIELD_NUMBER
Field Value
Type Description
int
CUSTOM_SIGNALS_FIELD_NUMBER
public static final int CUSTOM_SIGNALS_FIELD_NUMBER
Field Value
Type Description
int
DEFAULT_RANK_FIELD_NUMBER
public static final int DEFAULT_RANK_FIELD_NUMBER
Field Value
Type Description
int
DOCUMENT_AGE_FIELD_NUMBER
public static final int DOCUMENT_AGE_FIELD_NUMBER
Field Value
Type Description
int
KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER
public static final int KEYWORD_SIMILARITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int
PCTR_RANK_FIELD_NUMBER
public static final int PCTR_RANK_FIELD_NUMBER
Field Value
Type Description
int
RELEVANCE_SCORE_FIELD_NUMBER
public static final int RELEVANCE_SCORE_FIELD_NUMBER
Field Value
Type Description
int
SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER
public static final int SEMANTIC_SIMILARITY_SCORE_FIELD_NUMBER
Field Value
Type Description
int
TOPICALITY_RANK_FIELD_NUMBER
public static final int TOPICALITY_RANK_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static SearchResponse . SearchResult . RankSignals getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static SearchResponse . SearchResult . RankSignals . Builder newBuilder ()
newBuilder(SearchResponse.SearchResult.RankSignals prototype)
public static SearchResponse . SearchResult . RankSignals . Builder newBuilder ( SearchResponse . SearchResult . RankSignals prototype )
public static SearchResponse . SearchResult . RankSignals parseDelimitedFrom ( InputStream input )
public static SearchResponse . SearchResult . RankSignals parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static SearchResponse . SearchResult . RankSignals parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse . SearchResult . RankSignals parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static SearchResponse . SearchResult . RankSignals parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse . SearchResult . RankSignals parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static SearchResponse . SearchResult . RankSignals parseFrom ( CodedInputStream input )
public static SearchResponse . SearchResult . RankSignals parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static SearchResponse . SearchResult . RankSignals parseFrom ( InputStream input )
public static SearchResponse . SearchResult . RankSignals parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static SearchResponse . SearchResult . RankSignals parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchResponse . SearchResult . RankSignals parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<SearchResponse . SearchResult . RankSignals > parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getBoostingFactor()
public float getBoostingFactor ()
Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The boostingFactor.
getCustomSignals(int index)
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
int
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];
getCustomSignalsOrBuilder(int index)
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];
Parameter
Name Description
indexint
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];
Returns
Type Description
List <? extends com.google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder >
getDefaultInstanceForType()
public SearchResponse . SearchResult . RankSignals getDefaultInstanceForType ()
getDefaultRank()
public float getDefaultRank ()
The default rank of the result.
float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The defaultRank.
getDocumentAge()
public float getDocumentAge ()
Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The documentAge.
getKeywordSimilarityScore()
public float getKeywordSimilarityScore ()
Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The keywordSimilarityScore.
getParserForType()
public Parser<SearchResponse . SearchResult . RankSignals > getParserForType ()
Overrides
getPctrRank()
public float getPctrRank ()
Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The pctrRank.
getRelevanceScore()
public float getRelevanceScore ()
Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The relevanceScore.
getSemanticSimilarityScore()
public float getSemanticSimilarityScore ()
Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The semanticSimilarityScore.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getTopicalityRank()
public float getTopicalityRank ()
Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
float The topicalityRank.
hasBoostingFactor()
public boolean hasBoostingFactor ()
Combined custom boosts for a doc.
optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the boostingFactor field is set.
hasDocumentAge()
public boolean hasDocumentAge ()
Age of the document in hours.
optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the documentAge field is set.
hasKeywordSimilarityScore()
public boolean hasKeywordSimilarityScore ()
Keyword matching adjustment.
optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the keywordSimilarityScore field is set.
hasPctrRank()
public boolean hasPctrRank ()
Predicted conversion rate adjustment as a rank.
optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the pctrRank field is set.
hasRelevanceScore()
public boolean hasRelevanceScore ()
Semantic relevance adjustment.
optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the relevanceScore field is set.
hasSemanticSimilarityScore()
public boolean hasSemanticSimilarityScore ()
Semantic similarity adjustment.
optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the semanticSimilarityScore field is set.
hasTopicalityRank()
public boolean hasTopicalityRank ()
Topicality adjustment as a rank.
optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the topicalityRank field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public SearchResponse . SearchResult . RankSignals . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected SearchResponse . SearchResult . RankSignals . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public SearchResponse . SearchResult . RankSignals . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
