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.



9490
9491
9492
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9490

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) 


9460
9461
9462
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9460

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) 


9467
9468
9469
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9467

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) 


9475
9476
9477
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9475

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) 


9481
9482
9483
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9481

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:



9488
9489
9490
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9488

def interpolation_boost_spec
  @interpolation_boost_spec
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9495
9496
9497
9498
9499
9500
9501
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 9495

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