SearchResponse.SearchResult.RankSignalsOrBuilder (proto-google-cloud-discoveryengine-v1 0.84.0 API)

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

SearchResponse.SearchResult.RankSignals, SearchResponse.SearchResult.RankSignals.Builder

Enclosing class:

SearchResponse.SearchResult
```
public static interface SearchResponse.SearchResult.RankSignalsOrBuilder
extends com.google.protobuf.MessageOrBuilder
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`float`	`getBoostingFactor()` Optional.
`SearchResponse.SearchResult.RankSignals.CustomSignal`	`getCustomSignals(int index)` Optional.
`int`	`getCustomSignalsCount()` Optional.
`List<SearchResponse.SearchResult.RankSignals.CustomSignal>`	`getCustomSignalsList()` Optional.
`SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder`	`getCustomSignalsOrBuilder(int index)` Optional.
`List<? extends SearchResponse.SearchResult.RankSignals.CustomSignalOrBuilder>`	`getCustomSignalsOrBuilderList()` Optional.
`float`	`getDefaultRank()` Optional.
`float`	`getDocumentAge()` Optional.
`float`	`getKeywordSimilarityScore()` Optional.
`float`	`getPctrRank()` Optional.
`float`	`getRelevanceScore()` Optional.
`float`	`getSemanticSimilarityScore()` Optional.
`float`	`getTopicalityRank()` Optional.
`boolean`	`hasBoostingFactor()` Optional.
`boolean`	`hasDocumentAge()` Optional.
`boolean`	`hasKeywordSimilarityScore()` Optional.
`boolean`	`hasPctrRank()` Optional.
`boolean`	`hasRelevanceScore()` Optional.
`boolean`	`hasSemanticSimilarityScore()` Optional.
`boolean`	`hasTopicalityRank()` Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

- Method Detail
  - hasKeywordSimilarityScore
```
boolean hasKeywordSimilarityScore()
```
```
 Optional. Keyword matching adjustment.
 
```
    optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the keywordSimilarityScore field is set.
  - getKeywordSimilarityScore
```
float getKeywordSimilarityScore()
```
```
 Optional. Keyword matching adjustment.
 
```
    optional float keyword_similarity_score = 1 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The keywordSimilarityScore.
  - hasRelevanceScore
```
boolean hasRelevanceScore()
```
```
 Optional. Semantic relevance adjustment.
 
```
    optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the relevanceScore field is set.
  - getRelevanceScore
```
float getRelevanceScore()
```
```
 Optional. Semantic relevance adjustment.
 
```
    optional float relevance_score = 2 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The relevanceScore.
  - hasSemanticSimilarityScore
```
boolean hasSemanticSimilarityScore()
```
```
 Optional. Semantic similarity adjustment.
 
```
    optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the semanticSimilarityScore field is set.
  - getSemanticSimilarityScore
```
float getSemanticSimilarityScore()
```
```
 Optional. Semantic similarity adjustment.
 
```
    optional float semantic_similarity_score = 3 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The semanticSimilarityScore.
  - hasPctrRank
```
boolean hasPctrRank()
```
```
 Optional. Predicted conversion rate adjustment as a rank.
 
```
    optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the pctrRank field is set.
  - getPctrRank
```
float getPctrRank()
```
```
 Optional. Predicted conversion rate adjustment as a rank.
 
```
    optional float pctr_rank = 4 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The pctrRank.
  - hasTopicalityRank
```
boolean hasTopicalityRank()
```
```
 Optional. Topicality adjustment as a rank.
 
```
    optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the topicalityRank field is set.
  - getTopicalityRank
```
float getTopicalityRank()
```
```
 Optional. Topicality adjustment as a rank.
 
```
    optional float topicality_rank = 6 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The topicalityRank.
  - hasDocumentAge
```
boolean hasDocumentAge()
```
```
 Optional. Age of the document in hours.
 
```
    optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the documentAge field is set.
  - getDocumentAge
```
float getDocumentAge()
```
```
 Optional. Age of the document in hours.
 
```
    optional float document_age = 7 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The documentAge.
  - hasBoostingFactor
```
boolean hasBoostingFactor()
```
```
 Optional. Combined custom boosts for a doc.
 
```
    optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    Whether the boostingFactor field is set.
  - getBoostingFactor
```
float getBoostingFactor()
```
```
 Optional. Combined custom boosts for a doc.
 
```
    optional float boosting_factor = 8 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The boostingFactor.
  - getDefaultRank
```
float getDefaultRank()
```
```
 Optional. The default rank of the result.
 
```
    float default_rank = 32 [(.google.api.field_behavior) = OPTIONAL];
    Returns:
    
    The defaultRank.
  - getCustomSignalsList
```
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];
  - getCustomSignals
```
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];
  - getCustomSignalsCount
```
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];
  - getCustomSignalsOrBuilderList
```
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];
  - getCustomSignalsOrBuilder
```
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];

Interface SearchResponse.SearchResult.RankSignalsOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Method Detail

hasKeywordSimilarityScore

getKeywordSimilarityScore

hasRelevanceScore

getRelevanceScore

hasSemanticSimilarityScore

getSemanticSimilarityScore

hasPctrRank

getPctrRank

hasTopicalityRank

getTopicalityRank

hasDocumentAge

getDocumentAge

hasBoostingFactor

getBoostingFactor

getDefaultRank

getCustomSignalsList

getCustomSignals

getCustomSignalsCount

getCustomSignalsOrBuilderList

getCustomSignalsOrBuilder