Class: Google::Apis::DialogflowV3beta1::GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpec

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

Overview

Boost applies to documents which match a condition.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpec

Returns a new instance of GoogleCloudDialogflowCxV3beta1BoostSpecConditionBoostSpec.



4597
4598
4599
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4597

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

Instance Attribute Details

#boostFloat

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)


4587
4588
4589
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4587

def boost
  @boost
end

#conditionString

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)


4595
4596
4597
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4595

def condition
  @condition
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4602
4603
4604
4605
# File 'lib/google/apis/dialogflow_v3beta1/classes.rb', line 4602

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