Class: Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec

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

Overview

Boost applies to documents which match a condition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec

Returns a new instance of GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec.



16689
16690
16691
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 16689

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) 


16672
16673
16674
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 16672

def boost
  @boost
end

#boost_control_spec ⇒ Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec

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:



16679
16680
16681
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 16679

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) 


16687
16688
16689
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 16687

def condition
  @condition
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16694
16695
16696
16697
16698
 
# File 'lib/google/apis/dialogflow_v2/classes.rb', line 16694

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