Class: Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs

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

Overview

Boost specifications for data stores.

Defined Under Namespace

Classes: BoostSpec

Instance Attribute Summary collapse

Instance Attribute Details

#data_stores ⇒ ::Array<::String> 



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 619

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

  # 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
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
  #     Optional. Condition boost specifications. If a document matches
  #     multiple conditions in the specifications, boost scores from these
  #     specifications are all applied and combined in a non-linear way.
  #     Maximum number of specifications is 20.
  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.
    # @!attribute [rw] boost_control_spec
    #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
    #     Optional. Complex specification for custom ranking based on
    #     customer defined attribute value.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Specification for custom ranking based on customer specified
      # attribute
      # value. It provides more controls for customized ranking than the
      # simple (condition, boost) combination above.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Optional. The name of the field whose value will be used to
      #     determine the boost amount.
      # @!attribute [rw] attribute_type
      #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
      #     Optional. The attribute type to be used to determine the boost
      #     amount. The attribute value can be derived from the field value
      #     of the specified field_name. In the case of numerical it is
      #     straightforward i.e. attribute_value = numerical_field_value. In
      #     the case of freshness however, attribute_value = (time.now() -
      #     datetime_field_value).
      # @!attribute [rw] interpolation_type
      #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
      #     Optional. The interpolation type to be applied to connect the
      #     control points listed below.
      # @!attribute [rw] control_points
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
      #     Optional. The control points used to define the curve. The
      #     monotonic function (defined through the interpolation_type above)
      #     passes through the control points listed here.
      class BoostControlSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The control points used to define the curve. The curve defined
        # through these control points can only be monotonically increasing
        # or decreasing(constant values are acceptable).
        # @!attribute [rw] attribute_value
        #   @return [::String]
        #     Optional. Can be one of:
        #     1. The numerical field value.
        #     2. The duration spec for freshness:
        #     The value must be formatted as an XSD `dayTimeDuration` value
        #     (a restricted subset of an ISO 8601 duration value). The
        #     pattern for this is: `[nD][T[nH][nM][nS]]`.
        # @!attribute [rw] boost_amount
        #   @return [::Float]
        #     Optional. The value between -1 to 1 by which to boost the score
        #     if the attribute_value evaluates to the value specified above.
        class ControlPoint
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # The attribute(or function) for which the custom ranking is to be
        # applied.
        module AttributeType
          # Unspecified AttributeType.
          ATTRIBUTE_TYPE_UNSPECIFIED = 0

          # The value of the numerical field will be used to dynamically
          # update the boost amount. In this case, the attribute_value (the
          # x value) of the control point will be the actual value of the
          # numerical field for which the boost_amount is specified.
          NUMERICAL = 1

          # For the freshness use case the attribute value will be the
          # duration between the current time and the date in the datetime
          # field specified. The value must be formatted as an XSD
          # `dayTimeDuration` value (a restricted subset of an ISO 8601
          # duration value). The pattern for this is:
          # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
          FRESHNESS = 2
        end

        # The interpolation type to be applied. Default will be linear
        # (Piecewise Linear).
        module InterpolationType
          # Interpolation type is unspecified. In this case, it defaults to
          # Linear.
          INTERPOLATION_TYPE_UNSPECIFIED = 0

          # Piecewise linear interpolation will be applied.
          LINEAR = 1
        end
      end
    end
  end
end

#spec ⇒ ::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec> 



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
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
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
 
# File 'proto_docs/google/cloud/dialogflow/v2/conversation.rb', line 619

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

  # 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
  # @!attribute [rw] condition_boost_specs
  #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec>]
  #     Optional. Condition boost specifications. If a document matches
  #     multiple conditions in the specifications, boost scores from these
  #     specifications are all applied and combined in a non-linear way.
  #     Maximum number of specifications is 20.
  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.
    # @!attribute [rw] boost_control_spec
    #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec]
    #     Optional. Complex specification for custom ranking based on
    #     customer defined attribute value.
    class ConditionBoostSpec
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods

      # Specification for custom ranking based on customer specified
      # attribute
      # value. It provides more controls for customized ranking than the
      # simple (condition, boost) combination above.
      # @!attribute [rw] field_name
      #   @return [::String]
      #     Optional. The name of the field whose value will be used to
      #     determine the boost amount.
      # @!attribute [rw] attribute_type
      #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
      #     Optional. The attribute type to be used to determine the boost
      #     amount. The attribute value can be derived from the field value
      #     of the specified field_name. In the case of numerical it is
      #     straightforward i.e. attribute_value = numerical_field_value. In
      #     the case of freshness however, attribute_value = (time.now() -
      #     datetime_field_value).
      # @!attribute [rw] interpolation_type
      #   @return [::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
      #     Optional. The interpolation type to be applied to connect the
      #     control points listed below.
      # @!attribute [rw] control_points
      #   @return [::Array<::Google::Cloud::Dialogflow::V2::SearchKnowledgeRequest::SearchConfig::BoostSpecs::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
      #     Optional. The control points used to define the curve. The
      #     monotonic function (defined through the interpolation_type above)
      #     passes through the control points listed here.
      class BoostControlSpec
        include ::Google::Protobuf::MessageExts
        extend ::Google::Protobuf::MessageExts::ClassMethods

        # The control points used to define the curve. The curve defined
        # through these control points can only be monotonically increasing
        # or decreasing(constant values are acceptable).
        # @!attribute [rw] attribute_value
        #   @return [::String]
        #     Optional. Can be one of:
        #     1. The numerical field value.
        #     2. The duration spec for freshness:
        #     The value must be formatted as an XSD `dayTimeDuration` value
        #     (a restricted subset of an ISO 8601 duration value). The
        #     pattern for this is: `[nD][T[nH][nM][nS]]`.
        # @!attribute [rw] boost_amount
        #   @return [::Float]
        #     Optional. The value between -1 to 1 by which to boost the score
        #     if the attribute_value evaluates to the value specified above.
        class ControlPoint
          include ::Google::Protobuf::MessageExts
          extend ::Google::Protobuf::MessageExts::ClassMethods
        end

        # The attribute(or function) for which the custom ranking is to be
        # applied.
        module AttributeType
          # Unspecified AttributeType.
          ATTRIBUTE_TYPE_UNSPECIFIED = 0

          # The value of the numerical field will be used to dynamically
          # update the boost amount. In this case, the attribute_value (the
          # x value) of the control point will be the actual value of the
          # numerical field for which the boost_amount is specified.
          NUMERICAL = 1

          # For the freshness use case the attribute value will be the
          # duration between the current time and the date in the datetime
          # field specified. The value must be formatted as an XSD
          # `dayTimeDuration` value (a restricted subset of an ISO 8601
          # duration value). The pattern for this is:
          # `[nD][T[nH][nM][nS]]`. E.g. `5D`, `3DT12H30M`, `T24H`.
          FRESHNESS = 2
        end

        # The interpolation type to be applied. Default will be linear
        # (Piecewise Linear).
        module InterpolationType
          # Interpolation type is unspecified. In this case, it defaults to
          # Linear.
          INTERPOLATION_TYPE_UNSPECIFIED = 0

          # Piecewise linear interpolation will be applied.
          LINEAR = 1
        end
      end
    end
  end
end