Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec

Inherits:

Object

• Object
• Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

Boost applies to documents which match a condition.

Instance Attribute Summary

• #boost ⇒ Float

  Strength of the condition boost, which should be in [-1, 1].

• #condition ⇒ String

  An expression which specifies a boost condition.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec constructor

  A new instance of GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec

Returns a new instance of GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpec.

# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3801

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boost ⇒ Float

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. Corresponds to the JSON property boost

Returns:

• (Float)

# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3790

def boost
  @boost
end

#condition ⇒ String

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")) Corresponds to the JSON property condition

Returns:

• (String)

# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3799

def condition
  @condition
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3806

def update!(**args)
  @boost = args[:boost] if args.key?(:boost)
  @condition = args[:condition] if args.key?(:condition)
end