Class Control (0.12.2)

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

Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on SolutionType.

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
boost_action google.cloud.discoveryengine_v1alpha.types.Control.BoostAction
Defines a boost-type control This field is a member of oneof_ action.
filter_action google.cloud.discoveryengine_v1alpha.types.Control.FilterAction
Defines a filter-type control Currently not supported by Recommendation This field is a member of oneof_ action.
redirect_action google.cloud.discoveryengine_v1alpha.types.Control.RedirectAction
Defines a redirect-type control. This field is a member of oneof_ action.
synonyms_action google.cloud.discoveryengine_v1alpha.types.Control.SynonymsAction
Treats a group of terms as synonyms of one another. This field is a member of oneof_ action.
name str
Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
display_name str
Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
associated_serving_config_ids MutableSequence[str]
Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
solution_type google.cloud.discoveryengine_v1alpha.types.SolutionType
Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
use_cases MutableSequence[google.cloud.discoveryengine_v1alpha.types.SearchUseCase]
Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
conditions MutableSequence[google.cloud.discoveryengine_v1alpha.types.Condition]
Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.

Classes

BoostAction

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

Adjusts order of products in returned list.

FilterAction

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

Specified which products may be included in results. Uses same filter as boost.

RedirectAction

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

Redirects a shopper to the provided URI.

SynonymsAction

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

Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy".