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-06-27 UTC."],[[["\u003cp\u003eControls define conditioned behaviors that are applied during serving, and they must be attached to a ServingConfig to be considered.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esolutionType\u003c/code\u003e field determines the control's compatible solution and must be set appropriately.\u003c/p\u003e\n"],["\u003cp\u003eA Control can have various actions, including \u003ccode\u003eboostAction\u003c/code\u003e, \u003ccode\u003efilterAction\u003c/code\u003e, \u003ccode\u003eredirectAction\u003c/code\u003e, \u003ccode\u003esynonymsAction\u003c/code\u003e, and \u003ccode\u003epromoteAction\u003c/code\u003e, which are limited by the solution and vertical.\u003c/p\u003e\n"],["\u003cp\u003eControls allow specifying \u003ccode\u003econditions\u003c/code\u003e that determine when the associated action triggers, and omitting this field means the action is always applied.\u003c/p\u003e\n"],["\u003cp\u003eSeveral methods are available for managing Controls, including creating, deleting, getting, listing, and updating.\u003c/p\u003e\n"]]],[],null,["# REST Resource: projects.locations.collections.engines.controls\n\n- [Resource: Control](#Control)\n - [JSON representation](#Control.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: Control\n-----------------\n\nDefines a conditioned behavior to employ during serving. Must be attached to a [ServingConfig](/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.collections.dataStores.servingConfigs#ServingConfig) to be considered at serving time. Permitted actions dependent on `SolutionType`."]]
