REST Resource: projects.locations.collections.engines.controls

资源：控件

定义要在提供服务期间采用的附带条件的行为。必须附加到 ServingConfig 才会在提供服务期间予以考虑。允许的操作取决于 SolutionType。

JSON 表示法 
{
  "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.
}
字段
name

string

不可变。完全限定名称 projects/*/locations/global/dataStore/*/controls/*
displayName

string

必需。人类可读名称。界面视图中使用的标识符。

必须是采用 UTF-8 编码的字符串，且长度上限为 128 个字符。否则，系统会抛出 INVALID ARGUMENT 错误。
associatedServingConfigIds[]

string

仅限输出。此控件所附加到的所有 ServingConfig ID 的列表。更改后，最多可能需要 10 分钟才能更新。
solutionType

enum (SolutionType)

必需。不可变。控件所属的解决方案。

必须与资源的垂直行业兼容。否则，系统会抛出 INVALID ARGUMENT 错误。
useCases[]

enum (SearchUseCase)

指定控件的使用场景。该字段会影响可设置哪些条件字段。仅适用于 SOLUTION_TYPE_SEARCH。目前，每个控件只允许有一个使用场景。当 solutionType 为 SolutionType.SOLUTION_TYPE_SEARCH 时，必须设置该字段。
conditions[]

object (Condition)

确定关联的操作在何种条件下触发。

省略则始终应用该操作。目前，只能指定一个条件。否则，系统会抛出 INVALID ARGUMENT 错误。

联合字段 action。操作受垂直行业和解决方案的限制

必需。action 只能是下列其中一项：
boostAction

object (BoostAction)

定义提升类型控件
filterAction

object (FilterAction)

定义过滤类型控件，目前不支持推荐场景
redirectAction

object (RedirectAction)

定义重定向类型控件。
synonymsAction

object (SynonymsAction)

将一组字词视为彼此的同义词。
promoteAction

object (PromoteAction)

基于预定义的触发查询来推广特定链接。

方法

create

 创建一个控件。

delete

 删除一个控件。

get

 获取一个控件。

list

 列出其父级 DataStore 下的所有控件。

patch

 更新一个控件。