public sealed class Control.Types.BoostAction : IMessage<Control.Types.BoostAction>, IEquatable<Control.Types.BoostAction>, IDeepCloneable<Control.Types.BoostAction>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1 API class Control.Types.BoostAction.
Adjusts order of products in returned list.
Implements
IMessageControlTypesBoostAction, IEquatableControlTypesBoostAction, IDeepCloneableControlTypesBoostAction, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
BoostAction()
public BoostAction()BoostAction(BoostAction)
public BoostAction(Control.Types.BoostAction other)| Parameter | |
|---|---|
| Name | Description |
other |
ControlTypesBoostAction |
Properties
Boost
[Obsolete]
public float Boost { get; set; }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 |
|
BoostSpecCase
public Control.Types.BoostAction.BoostSpecOneofCase BoostSpecCase { get; }| Property Value | |
|---|---|
| Type | Description |
ControlTypesBoostActionBoostSpecOneofCase |
|
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 |
|
DataStoreAsDataStoreName
public DataStoreName DataStoreAsDataStoreName { get; set; }DataStoreName-typed view over the DataStore resource name property.
| Property Value | |
|---|---|
| Type | Description |
DataStoreName |
|
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 |
|
FixedBoost
public float FixedBoost { get; set; }Optional. 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 |
|
HasFixedBoost
public bool HasFixedBoost { get; }Gets whether the "fixed_boost" field is set
| Property Value | |
|---|---|
| Type | Description |
bool |
|
InterpolationBoostSpec
public Control.Types.BoostAction.Types.InterpolationBoostSpec InterpolationBoostSpec { get; set; }Optional. Complex specification for custom ranking based on customer defined attribute value.
| Property Value | |
|---|---|
| Type | Description |
ControlTypesBoostActionTypesInterpolationBoostSpec |
|