CompletionConfig

JSON 表示法
EnableMode

用于自定义引擎和数据存储区的 Autocomplete API 响应的配置。部分字段仅适用于二者之一。

JSON 表示法

JSON 表示法
{ "name": string, "matchingOrder": string, "maxSuggestions": integer, "minPrefixLength": integer, "queryModel": string, "queryFrequencyThreshold": integer, "numUniqueUsersThreshold": integer, "shouldServeContentSuggestions": boolean, "filterPiiSuggestionsUsingDlp": boolean, "enableMode": enum (`EnableMode`) }

{
  "name": string,
  "matchingOrder": string,
  "maxSuggestions": integer,
  "minPrefixLength": integer,
  "queryModel": string,
  "queryFrequencyThreshold": integer,
  "numUniqueUsersThreshold": integer,
  "shouldServeContentSuggestions": boolean,
  "filterPiiSuggestionsUsingDlp": boolean,
  "enableMode": enum (EnableMode)
}

字段
`name`	`string` 必需。不可变。完全限定名称 `projects//locations//dataStores//completionConfig` `projects//locations//collections//dataStores//completionConfig` `projects//locations//collections//engines/*/completionConfig`
`matchingOrder`	`string` 自动补全建议的匹配顺序。例如，如果查询包含 `sh` 并指定了 `out-of-order`，则会建议 `women's shoes`；如果查询包含 `red s` 并指定了 `exact-prefix`，则会建议 `red shoes`。目前支持的值： `out-of-order` `exact-prefix` 默认值：`exact-prefix`。
`maxSuggestions`	`integer` 每个字词返回的自动补全建议的数量上限。 maxSuggestions 必须在 [1, 20] 的范围内。如果未设置或设置为 0，则默认设置为 20 条建议。
`minPrefixLength`	`integer` 获取建议所需输入的最少字符数。 minPrefixLength 必须在 [1, 20] 的范围内。如果未设置或设置为 0，则默认设置为 1 个字符。
`queryModel`	`string` 用于服务的查询建议的数据模型。目前支持的值： `automatic` - 自动补全后端自动选择或混合来自不同模型的建议。 `document` - 使用根据用户导入的文档生成的建议。 `search-history` - 使用根据 `SearchService.Search` API 调用的过往历史记录生成的建议。如果 Search API 没有流量，请勿使用该值。 `user-event` - 使用根据用户导入的搜索事件生成的建议。 `document-completable` - 使用直接从用户导入的标记为“可补全”的文档字段中获取的建议。如果查询模型为空，服务默认应用“自动”模型。
`queryFrequencyThreshold`	`integer` 此字段仅对从用户事件或搜索历史生成的建议有意义。如果某个查询出现的次数低于此阈值，可能表明该查询很少被搜索，因此不会生成为建议。此字段有助于防止 PII（个人身份信息）查询成为建议，因为这些查询通常是具有唯一性的搜索。如果未设置，则生成流水线中使用的默认值为 8。
`numUniqueUsersThreshold`	`integer` 此字段仅对从用户事件或搜索历史生成的建议有意义（这些记录可能附带用户 ID）。如果搜索某项查询的唯一身份用户数低于此阈值，则不会将该查询生成为建议。此字段有助于防止 PII（个人身份信息）查询成为建议，因为这些查询通常是具有唯一性的搜索。如果未设置，则生成流水线中使用的默认值为 3。
`shouldServeContentSuggestions`	`boolean` 指示是否生成并提供内容建议。这允许在查询建议之外还提供内容建议。
`filterPiiSuggestionsUsingDlp`	`boolean` 如果为 true，则系统会尽力尝试检测并移除包含特定类型 PII（个人身份信息）的建议。此检测在底层由 DLP 执行。
`enableMode`	`enum (EnableMode)` 自动补全生成流水线的启用模式。如果未设置此字段，服务器行为将默认为 `CompletionConfig.EnableMode.AUTOMATIC`。仅适用于数据存储区。对于引擎，系统会忽略此字段。

EnableMode

指定自动补全生成流水线的启用模式。

枚举
`ENABLE_MODE_UNSPECIFIED`	如果未指定自动补全启用模式，则默认为 AUTOMATIC 模式。
`AUTOMATIC`	当数据存储区满足条件时，系统会启用自动补全功能。
`MANUAL`	无论 UCS 数据要求如何，系统都会启用自动补全功能。