Class: Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/discoveryengine/v1/search_service.rb

Overview

Boost applies to documents which match a condition.

Defined Under Namespace

Classes: BoostControlSpec

Instance Attribute Summary collapse

Instance Attribute Details

#boost ⇒ ::Float

Returns 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. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.

Returns:

  • (::Float) —

    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. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 485

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]
  #     The name of the field whose value will be used to determine the
  #     boost amount.
  # @!attribute [rw] attribute_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
  #     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::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
  #     The interpolation type to be applied to connect the control points
  #     listed below.
  # @!attribute [rw] control_points
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
  #     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]
    #     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]
    #     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]]`.
      # For example, `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

#boost_control_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec

Returns Complex specification for custom ranking based on customer defined attribute value.

Returns:



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 485

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]
  #     The name of the field whose value will be used to determine the
  #     boost amount.
  # @!attribute [rw] attribute_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
  #     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::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
  #     The interpolation type to be applied to connect the control points
  #     listed below.
  # @!attribute [rw] control_points
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
  #     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]
    #     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]
    #     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]]`.
      # For example, `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

#condition ⇒ ::String

Returns An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

Examples:

  • To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue")).

Returns:

  • (::String) —

    An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

    Examples:

    • To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))


485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 485

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]
  #     The name of the field whose value will be used to determine the
  #     boost amount.
  # @!attribute [rw] attribute_type
  #   @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::AttributeType]
  #     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::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::InterpolationType]
  #     The interpolation type to be applied to connect the control points
  #     listed below.
  # @!attribute [rw] control_points
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec::ControlPoint>]
  #     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]
    #     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]
    #     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]]`.
      # For example, `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