Discovery Engine v1 API - Class Control.Types.BoostAction (1.1.0)

public sealed class Control.Types.BoostAction : IMessage<Control.Types.BoostAction>, IEquatable<Control.Types.BoostAction>, IDeepCloneable<Control.Types.BoostAction>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class Control.Types.BoostAction.

Adjusts order of products in returned list.

Inheritance

object > Control.Types.BoostAction

Implements

IMessage Control Types BoostAction, IEquatable Control Types BoostAction, IDeepCloneable Control Types BoostAction, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

BoostAction()

public BoostAction()

BoostAction(BoostAction)

public BoostAction(Control.Types.BoostAction other)

Parameter
Name	Description
`other`	`ControlTypesBoostAction`

Properties

Boost

public float Boost { get; set; }

Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).

Property Value
Type	Description
`float`

DataStore

public string DataStore { get; set; }

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

Property Value
Type	Description
`string`

Filter

public string Filter { get; set; }

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.

Property Value
Type	Description
`string`