GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlBoostAction (google_api_discovery_engine v0.28.0)

View Source

Adjusts order of products in returned list.

Attributes

  • boost (type: number(), default: nil) - Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
  • dataStore (type: String.t, default: nil) - 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
  • filter (type: String.t, default: nil) - 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.
  • fixedBoost (type: number(), default: nil) - Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
  • interpolationBoostSpec (type: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.t, default: nil) - Optional. Complex specification for custom ranking based on customer defined attribute value.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlBoostAction{
    boost: number() | nil,
    dataStore: String.t() | nil,
    filter: String.t() | nil,
    fixedBoost: number() | nil,
    interpolationBoostSpec:
      GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1ControlBoostActionInterpolationBoostSpec.t()
      | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.