Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlBoostAction

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

Overview

Adjusts order of products in returned list.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaControlBoostAction

Returns a new instance of GoogleCloudDiscoveryengineV1alphaControlBoostAction.



9388
9389
9390
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9388

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) 


9358
9359
9360
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9358

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) 


9365
9366
9367
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9365

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) 


9373
9374
9375
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9373

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) 


9379
9380
9381
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9379

def fixed_boost
  @fixed_boost
end

#interpolation_boost_spec ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaControlBoostActionInterpolationBoostSpec

Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. Corresponds to the JSON property interpolationBoostSpec

Returns:



9386
9387
9388
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9386

def interpolation_boost_spec
  @interpolation_boost_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9393
9394
9395
9396
9397
9398
9399
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9393

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)
  @interpolation_boost_spec = args[:interpolation_boost_spec] if args.key?(:interpolation_boost_spec)
end