Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec

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

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

Returns a new instance of GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec.



6863
6864
6865
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6863

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) 


6843
6844
6845
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6843

def attribute_type
  @attribute_type
end

#control_points ⇒ Array<Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint>

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:



6850
6851
6852
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6850

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) 


6855
6856
6857
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6855

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) 


6861
6862
6863
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6861

def interpolation_type
  @interpolation_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6868
6869
6870
6871
6872
6873
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 6868

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