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

Class GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec

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.GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Boost applies to documents which match a condition.

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
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec	clone()
Float	getBoost() Strength of the condition boost, which should be in [-1, 1].
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec	getBoostControlSpec() Complex specification for custom ranking based on customer defined attribute value.
String	getCondition() An expression which specifies a boost condition.
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec	setBoost(Float boost) Strength of the condition boost, which should be in [-1, 1].
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec	setBoostControlSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec boostControlSpec) Complex specification for custom ranking based on customer defined attribute value.
GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec	setCondition(String condition) An expression which specifies a boost condition.

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

GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec

public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec()

Method Detail

getBoost

public Float getBoost()

Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.

Returns:

value or null for none

setBoost

public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec setBoost(Float boost)

Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.

Parameters:

boost - boost or null for none

getBoostControlSpec

public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec getBoostControlSpec()

Complex specification for custom ranking based on customer defined attribute value.

Returns:

value or null for none

setBoostControlSpec

public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec setBoostControlSpec(GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec boostControlSpec)

Complex specification for custom ranking based on customer defined attribute value.

Parameters:

boostControlSpec - boostControlSpec or null for none

getCondition

public String getCondition()

An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`

Returns:

value or null for none

setCondition

public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec setCondition(String condition)

An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`

Parameters:

condition - condition or null for none

set

public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec set(String fieldName,
                                                                                     Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec clone()

Overrides:

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