Class: Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec

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

Overview

Boost specification to boost certain documents.

Defined Under Namespace

Classes: ConditionBoostSpec

Instance Attribute Summary collapse

Instance Attribute Details

#condition_boost_specs ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec>

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



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
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 512

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

  # Boost applies to documents which match a condition.
  # @!attribute [rw] condition
  #   @return [::String]
  #     An expression which specifies a boost condition. The syntax and
  #     supported fields are the same as a filter expression. See
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest#filter 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"))`
  # @!attribute [rw] boost
  #   @return [::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.
  # @!attribute [rw] boost_control_spec
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec::ConditionBoostSpec::BoostControlSpec]
  #     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]
    #     The name of the field whose value will be used to determine the
    #     boost amount.
    # @!attribute [rw] attribute_type
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::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::V1beta::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
end