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

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 specification to boost certain documents.

Defined Under Namespace

Classes: ConditionBoostSpec

Instance Attribute Summary collapse

Instance Attribute Details

#condition_boost_specs ⇒ ::Array<::Google::Cloud::DiscoveryEngine::V1::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:



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 377

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::V1::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.
  class ConditionBoostSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end