View Source GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec (google_api_discovery_engine v0.27.0)

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

Attributes

  • attributeType (type: String.t, default: nil) - 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).
  • controlPoints (type: list(GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint.t), default: nil) - The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
  • fieldName (type: String.t, default: nil) - The name of the field whose value will be used to determine the boost amount.
  • interpolationType (type: String.t, default: nil) - The interpolation type to be applied to connect the control points listed below.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpec{
    attributeType: String.t() | nil,
    controlPoints:
      [
        GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1SearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint.t()
      ]
      | nil,
    fieldName: String.t() | nil,
    interpolationType: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.