Class: Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v3/classes.rb,
lib/google/apis/dialogflow_v3/representations.rb,
lib/google/apis/dialogflow_v3/representations.rb

Overview

Boost applies to documents which match a condition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec

Returns a new instance of GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpec.



832
833
834
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 832

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

Instance Attribute Details

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

Returns:

  • (Float) 


815
816
817
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 815

def boost
  @boost
end

#boost_control_spec ⇒ Google::Apis::DialogflowV3::GoogleCloudDialogflowCxV3BoostSpecConditionBoostSpecBoostControlSpec

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. Corresponds to the JSON property boostControlSpec

Returns:



822
823
824
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 822

def boost_control_spec
  @boost_control_spec
end

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

Returns:

  • (String) 


830
831
832
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 830

def condition
  @condition
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



837
838
839
840
841
 
# File 'lib/google/apis/dialogflow_v3/classes.rb', line 837

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