Dialogflow CX V3 API - Class Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec (v1.2.0)

Reference documentation and code samples for the Dialogflow CX V3 API class Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec.

Boost applies to documents which match a condition.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#boost

def boost() -> ::Float
Returns
  • (::Float) — Optional. 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.

#boost=

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

Returns
  • (::Float) — Optional. 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.

#boost_control_spec

def boost_control_spec() -> ::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec
Returns

#boost_control_spec=

def boost_control_spec=(value) -> ::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec
Parameter
Returns

#condition

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

    Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples:

    • To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue":
      • (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))

#condition=

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

    Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples:

    • To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue":
      • (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))
Returns
  • (::String) —

    Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples:

    • To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue":
      • (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue"))