com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals
extends com.google.api.client.json.GenericJson

A set of ranking signals.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	clone()
Float	getBoostingFactor() Optional.
List<GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal>	getCustomSignals() Optional.
Float	getDefaultRank() Optional.
Float	getDocumentAge() Optional.
Float	getKeywordSimilarityScore() Optional.
Float	getPctrRank() Optional.
List<Float>	getPrecomputedExpressionValues() Optional.
Float	getRelevanceScore() Optional.
Float	getSemanticSimilarityScore() Optional.
Float	getTopicalityRank() Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setBoostingFactor(Float boostingFactor) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setCustomSignals(List<GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal> customSignals) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setDefaultRank(Float defaultRank) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setDocumentAge(Float documentAge) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setKeywordSimilarityScore(Float keywordSimilarityScore) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setPctrRank(Float pctrRank) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setPrecomputedExpressionValues(List<Float> precomputedExpressionValues) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setRelevanceScore(Float relevanceScore) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setSemanticSimilarityScore(Float semanticSimilarityScore) Optional.
GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals	setTopicalityRank(Float topicalityRank) Optional.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals()

Method Detail

getBoostingFactor

public Float getBoostingFactor()

Optional. Combined custom boosts for a doc.

Returns:

value or null for none

setBoostingFactor

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setBoostingFactor(Float boostingFactor)

Optional. Combined custom boosts for a doc.

Parameters:

boostingFactor - boostingFactor or null for none

getCustomSignals

public List<GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal> getCustomSignals()

Optional. A list of custom clearbox signals.

Returns:

value or null for none

setCustomSignals

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setCustomSignals(List<GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignalsCustomSignal> customSignals)

Optional. A list of custom clearbox signals.

Parameters:

customSignals - customSignals or null for none

getDefaultRank

public Float getDefaultRank()

Optional. The default rank of the result.

Returns:

value or null for none

setDefaultRank

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setDefaultRank(Float defaultRank)

Optional. The default rank of the result.

Parameters:

defaultRank - defaultRank or null for none

getDocumentAge

public Float getDocumentAge()

Optional. Age of the document in hours.

Returns:

value or null for none

setDocumentAge

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setDocumentAge(Float documentAge)

Optional. Age of the document in hours.

Parameters:

documentAge - documentAge or null for none

getKeywordSimilarityScore

public Float getKeywordSimilarityScore()

Optional. Keyword matching adjustment.

Returns:

value or null for none

setKeywordSimilarityScore

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setKeywordSimilarityScore(Float keywordSimilarityScore)

Optional. Keyword matching adjustment.

Parameters:

keywordSimilarityScore - keywordSimilarityScore or null for none

getPctrRank

public Float getPctrRank()

Optional. Predicted conversion rate adjustment as a rank.

Returns:

value or null for none

setPctrRank

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setPctrRank(Float pctrRank)

Optional. Predicted conversion rate adjustment as a rank.

Parameters:

pctrRank - pctrRank or null for none

getPrecomputedExpressionValues

public List<Float> getPrecomputedExpressionValues()

Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`.

Returns:

value or null for none

setPrecomputedExpressionValues

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setPrecomputedExpressionValues(List<Float> precomputedExpressionValues)

Optional. A list of precomputed expression results for a given document, in the same order as requested in `SearchRequest.custom_ranking_params.expressions_to_precompute`.

Parameters:

precomputedExpressionValues - precomputedExpressionValues or null for none

getRelevanceScore

public Float getRelevanceScore()

Optional. Semantic relevance adjustment.

Returns:

value or null for none

setRelevanceScore

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setRelevanceScore(Float relevanceScore)

Optional. Semantic relevance adjustment.

Parameters:

relevanceScore - relevanceScore or null for none

getSemanticSimilarityScore

public Float getSemanticSimilarityScore()

Optional. Semantic similarity adjustment.

Returns:

value or null for none

setSemanticSimilarityScore

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setSemanticSimilarityScore(Float semanticSimilarityScore)

Optional. Semantic similarity adjustment.

Parameters:

semanticSimilarityScore - semanticSimilarityScore or null for none

getTopicalityRank

public Float getTopicalityRank()

Optional. Topicality adjustment as a rank.

Returns:

value or null for none

setTopicalityRank

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals setTopicalityRank(Float topicalityRank)

Optional. Topicality adjustment as a rank.

Parameters:

topicalityRank - topicalityRank or null for none

set

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals set(String fieldName,
                                                                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1SearchResponseSearchResultRankSignals clone()

Overrides:

clone in class com.google.api.client.json.GenericJson