Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec::ConditionBoostSpec (v0.21.0)

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::AdvancedCompleteQueryRequest::BoostSpec::ConditionBoostSpec.

Boost applies to suggestions which match a condition.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#boost

def boost() -> ::Float
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.

#boost=

def boost=(value) -> ::Float
Parameter
  • value (::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.

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.

#condition

def condition() -> ::String
Returns
  • (::String) —

    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"))

#condition=

def condition=(value) -> ::String
Parameter
  • value (::String) —

    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"))
Returns
  • (::String) —

    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"))