Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec

Returns a new instance of GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec.



10968
10969
10970
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10968

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

Instance Attribute Details

#attribute_type ⇒ String

The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = ( time.now() - datetime_field_value). Corresponds to the JSON property attributeType

Returns:

  • (String) 


10948
10949
10950
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10948

def attribute_type
  @attribute_type
end

#control_points ⇒ Array<Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint>

The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. Corresponds to the JSON property controlPoints

Returns:



10955
10956
10957
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10955

def control_points
  @control_points
end

#field_name ⇒ String

The name of the field whose value will be used to determine the boost amount. Corresponds to the JSON property fieldName

Returns:

  • (String) 


10960
10961
10962
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10960

def field_name
  @field_name
end

#interpolation_type ⇒ String

The interpolation type to be applied to connect the control points listed below. Corresponds to the JSON property interpolationType

Returns:

  • (String) 


10966
10967
10968
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10966

def interpolation_type
  @interpolation_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10973
10974
10975
10976
10977
10978
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 10973

def update!(**args)
  @attribute_type = args[:attribute_type] if args.key?(:attribute_type)
  @control_points = args[:control_points] if args.key?(:control_points)
  @field_name = args[:field_name] if args.key?(:field_name)
  @interpolation_type = args[:interpolation_type] if args.key?(:interpolation_type)
end