Class: Google::Cloud::Dialogflow::CX::V3::BoostSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/session.rb

Overview

Boost specification to boost certain documents. A copy of google.cloud.discoveryengine.v1main.BoostSpec, field documentation is available at https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/BoostSpec

Defined Under Namespace

Classes: ConditionBoostSpec

Instance Attribute Summary collapse

Instance Attribute Details

#condition_boost_specs ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec>

Returns Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

Returns:



648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 648

class BoostSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Boost applies to documents which match a condition.
  # @!attribute [rw] condition
  #   @return [::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"))
  # @!attribute [rw] boost
  #   @return [::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.
  class ConditionBoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end