- 0.74.0 (latest)
- 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 interface SearchResponse.SearchResult.RankSignalsOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBoostingFactor()
public abstract 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 abstract 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 | 
| index | int | 
| Returns | |
|---|---|
| Type | Description | 
| SearchResponse.SearchResult.RankSignals.CustomSignal | |
getCustomSignalsCount()
public abstract 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 abstract 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];
 
| Returns | |
|---|---|
| Type | Description | 
| List<CustomSignal> | |
getCustomSignalsOrBuilder(int index)
public abstract 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 | 
| index | int | 
| Returns | |
|---|---|
| Type | Description | 
| SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder | |
getCustomSignalsOrBuilderList()
public abstract 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> | |
getDefaultRank()
public abstract 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 abstract 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 abstract float getKeywordSimilarityScore()Keyword matching adjustment.
 
 optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
| float | The keywordSimilarityScore. | 
getPctrRank()
public abstract 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 abstract float getRelevanceScore()Semantic relevance adjustment.
 optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description | 
| float | The relevanceScore. | 
getSemanticSimilarityScore()
public abstract float getSemanticSimilarityScore()Semantic similarity adjustment.
 
 optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
 
| Returns | |
|---|---|
| Type | Description | 
| float | The semanticSimilarityScore. | 
getTopicalityRank()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |