Class: Google::Cloud::DiscoveryEngine::V1::Control::BoostAction

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

Overview

Adjusts order of products in returned list.

Instance Attribute Summary collapse

Instance Attribute Details

#boost ⇒ ::Float

Returns Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

Returns:

  • (::Float) —

    Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).



161
162
163
164
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 161

class BoostAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#data_store ⇒ ::String

Returns Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store.

Returns:

  • (::String) —

    Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store



161
162
163
164
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 161

class BoostAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filter ⇒ ::String

Returns Required. Specifies which products to apply the boost to.

If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.

Returns:

  • (::String) —

    Required. Specifies which products to apply the boost to.

    If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.



161
162
163
164
 
# File 'proto_docs/google/cloud/discoveryengine/v1/control.rb', line 161

class BoostAction
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end