Class BoostAction (0.13.11) 

BoostAction(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Adjusts order of products in returned list.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
fixed_boost float
Optional. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). This field is a member of oneof_ boost_spec.
interpolation_boost_spec google.cloud.discoveryengine_v1.types.Control.BoostAction.InterpolationBoostSpec
Optional. Complex specification for custom ranking based on customer defined attribute value. This field is a member of oneof_ boost_spec.
boost float
Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).
filter str
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.
data_store str
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

Classes

InterpolationBoostSpec

InterpolationBoostSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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