Class Control (1.14.0)

Version 1.14.0

• 1.23.0 (latest)
• 1.22.0
• 1.21.2
• 1.20.1
• 1.19.1
• 1.18.0
• 1.17.0
• 1.16.3
• 1.15.1
• 1.14.1
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.2
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.1
• 1.5.0
• 1.4.1
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.2
• 0.4.2
• 0.3.1
• 0.2.0
• 0.1.0

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

Configures dynamic metadata that can be linked to a ServingConfig and affect search or recommendation results at serving time.

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
facet_spec	google.cloud.retail_v2alpha.types.SearchRequest.FacetSpec A facet specification to perform faceted search. Note that this field is deprecated and will throw NOT_IMPLEMENTED if used for creating a control. This field is a member of oneof_ control.
rule	google.cloud.retail_v2alpha.types.Rule A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes". This field is a member of oneof_ control.
name	str Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*
display_name	str Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
associated_serving_config_ids	MutableSequence[str] Output only. List of [serving config][google.cloud.retail.v2alpha.ServingConfig] ids that are associated with this control in the same Catalog. Note the association is managed via the ServingConfig, this is an output only denormalized view.
solution_types	MutableSequence[google.cloud.retail_v2alpha.types.SolutionType] Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only SOLUTION_TYPE_SEARCH value is supported at the moment. If no solution type is provided at creation time, will default to SOLUTION_TYPE_SEARCH.
search_solution_use_case	MutableSequence[google.cloud.retail_v2alpha.types.SearchSolutionUseCase] Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to SEARCH_SOLUTION_USE_CASE_SEARCH if not specified. Currently only allow one search_solution_use_case per control.