Class: Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec::ConditionBoostSpec

Inherits:

Object

Object
Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec::ConditionBoostSpec

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb

Overview

Boost applies to suggestions which match a condition.

Instance Attribute Summary collapse

#boost ⇒ ::Float
Strength of the boost, which should be in [-1, 1].
#condition ⇒ ::String
An expression which specifies a boost condition.

Instance Attribute Details

#boost ⇒ `::Float`

Returns Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.

Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion.

Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown.

Setting to 0.0 means no boost applied. The boosting condition is ignored.

Returns:

(::Float) —
Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.

Setting to 1.0 gives the suggestions a big promotion. However, it does not necessarily mean that the top result will be a boosted suggestion.

Setting to -1.0 gives the suggestions a big demotion. However, other suggestions that are relevant might still be shown.

Setting to 0.0 means no boost applied. The boosting condition is ignored.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/completion_service.rb', line 233

class ConditionBoostSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#condition ⇒ `::String`

Returns An expression which specifies a boost condition. The syntax is the same as filter expression syntax. Currently, the only supported condition is a list of BCP-47 lang codes.

Example:

To boost suggestions in languages en or fr: (lang_code: ANY("en", "fr")).