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.
JSON representation
{"name": string,"displayName": string,"associatedServingConfigIds": [string],"solutionType": enum (SolutionType),"useCases": [enum (SearchUseCase)],"conditions": [{object (Condition)}],// Union field action can be only one of the following:"boostAction": {object (BoostAction)},"filterAction": {object (FilterAction)},"redirectAction": {object (RedirectAction)},"synonymsAction": {object (SynonymsAction)},"promoteAction": {object (PromoteAction)}// End of list of possible types for union field action.}
Fields
name
string
Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
displayName
string
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.
associatedServingConfigIds[]
string
Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
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 solutionType is SolutionType.SOLUTION_TYPE_SEARCH.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-19 UTC."],[[["Controls define conditioned behaviors during serving and must be attached to a ServingConfig to be active."],["Controls are configured with a name, display name, associated ServingConfig IDs, solution type, and use cases, with their permitted actions dependent on the solution type."],["The `action` field within a Control can be one of the following: `boostAction`, `filterAction`, `redirectAction`, `synonymsAction`, or `promoteAction`, each corresponding to a different type of control behavior."],["The `conditions` field determines when the control's associated action will be triggered, and if omitted, the action will always apply."],["Several methods are available for managing controls, including `create`, `delete`, `get`, `list`, and `patch`, enabling full control lifecycle management."]]],[]]