Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1ControlBoostAction

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/representations.rb

Overview

Adjusts order of products in returned list.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1ControlBoostAction

Returns a new instance of GoogleCloudDiscoveryengineV1ControlBoostAction.



3454
3455
3456
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3454

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#boost ⇒ Float

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

Returns:

  • (Float) 


3431
3432
3433
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3431

def boost
  @boost
end

#data_store ⇒ 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 Corresponds to the JSON property dataStore

Returns:

  • (String) 


3438
3439
3440
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3438

def data_store
  @data_store
end

#filter ⇒ 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. Corresponds to the JSON property filter

Returns:

  • (String) 


3446
3447
3448
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3446

def filter
  @filter
end

#fixed_boost ⇒ Float

Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). Corresponds to the JSON property fixedBoost

Returns:

  • (Float) 


3452
3453
3454
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3452

def fixed_boost
  @fixed_boost
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3459
3460
3461
3462
3463
3464
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 3459

def update!(**args)
  @boost = args[:boost] if args.key?(:boost)
  @data_store = args[:data_store] if args.key?(:data_store)
  @filter = args[:filter] if args.key?(:filter)
  @fixed_boost = args[:fixed_boost] if args.key?(:fixed_boost)
end