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 during serving and must be attached to a ServingConfig to be active.\u003c/p\u003e\n"],["\u003cp\u003eThe JSON representation of a Control includes fields like \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003edisplayName\u003c/code\u003e, \u003ccode\u003eassociatedServingConfigIds\u003c/code\u003e, \u003ccode\u003esolutionType\u003c/code\u003e, \u003ccode\u003euseCases\u003c/code\u003e, and \u003ccode\u003econditions\u003c/code\u003e, along with a union field \u003ccode\u003eaction\u003c/code\u003e that can be one of \u003ccode\u003eboostAction\u003c/code\u003e, \u003ccode\u003efilterAction\u003c/code\u003e, \u003ccode\u003eredirectAction\u003c/code\u003e, \u003ccode\u003esynonymsAction\u003c/code\u003e, or \u003ccode\u003epromoteAction\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eEach control belongs to a specific \u003ccode\u003esolutionType\u003c/code\u003e and may have associated \u003ccode\u003euseCases\u003c/code\u003e, affecting the available condition fields and actions.\u003c/p\u003e\n"],["\u003cp\u003eControls can be created, deleted, retrieved, listed, and updated using the provided methods.\u003c/p\u003e\n"],["\u003cp\u003eControls can be used to define various actions such as boosting, filtering, redirecting, defining synonyms, and promoting, each tailored to specific needs.\u003c/p\u003e\n"]]],[],null,["# REST Resource: projects.locations.dataStores.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/v1/ServingConfig) to be considered at serving time. Permitted actions dependent on `SolutionType`."]]
