Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec

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

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) ⇒ GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec

Returns a new instance of GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.



1946
1947
1948
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1946

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

Instance Attribute Details

#attribute_type ⇒ String

Optional. 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) 


1925
1926
1927
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1925

def attribute_type
  @attribute_type
end

#control_points ⇒ Array<Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpecControlPoint>

Optional. 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:



1932
1933
1934
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1932

def control_points
  @control_points
end

#field_name ⇒ String

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

Returns:

  • (String) 


1938
1939
1940
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1938

def field_name
  @field_name
end

#interpolation_type ⇒ String

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

Returns:

  • (String) 


1944
1945
1946
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1944

def interpolation_type
  @interpolation_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1951
1952
1953
1954
1955
1956
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 1951

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