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

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

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

Defined Under Namespace

Modules: AttributeType, InterpolationType Classes: ControlPoint

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_type ⇒ ::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType

Returns 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).

Returns:



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
760
761
762
763
764
765
766
767
768
769
770
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 715

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

#control_points ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>

Returns 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.

Returns:



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
760
761
762
763
764
765
766
767
768
769
770
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 715

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

#field_name ⇒ ::String

Returns Optional. The name of the field whose value will be used to determine the boost amount.

Returns:

  • (::String) —

    Optional. The name of the field whose value will be used to determine the boost amount.



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
760
761
762
763
764
765
766
767
768
769
770
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 715

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

#interpolation_type ⇒ ::Google::Cloud::Dialogflow::CX::V3::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType

Returns Optional. The interpolation type to be applied to connect the control points listed below.

Returns:



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
760
761
762
763
764
765
766
767
768
769
770
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/session.rb', line 715

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