Interface SearchResponse.SearchResult.RankSignalsOrBuilder (0.70.0)

public static interface SearchResponse.SearchResult.RankSignalsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.SearchResponse.SearchResult.RankSignals.CustomSignal custom_signals = 33 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1alpha.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.