REST Resource: projects.locations.collections.engines.assistants.cannedQueries

资源：CannedQuery

Assistant 的预设查询资源。它代表一个预定义对话开始内容的快捷方式。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "defaultTexts": {
    object (CannedQueryTexts)
  },
  "localizedTexts": {
    string: {
      object (CannedQueryTexts)
    },
    ...
  },
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "enabled": boolean,
  "googleDefined": boolean
}
字段
name

string

不可变。预设查询的资源名称。格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/cannedQueries/{cannedQuery}

此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。
displayName

string

预设查询的显示名称。此字段必须是采用 UTF-8 编码的字符串，长度上限为 128 个字符。
defaultTexts

object (CannedQueryTexts)

必需。文本属性的默认（非本地化）值。
localizedTexts

map (key: string, value: object (CannedQueryTexts))

可选。文本属性的本地化翻译。键应为 BCP-47 语言代码。
requiredCapabilities[]

object (AssistantCapability)

可选。助理使用相应预设查询所需具备的功能。
enabled

boolean

指示相应预设查询是否已启用。
googleDefined

boolean

仅限输出。指示相应查询是否为 Google 定义的只读预设查询。

CannedQueryTexts

相应预设查询的文本片段，可以进行本地化。

JSON 表示法 
{
  "title": string,
  "prefix": string,
  "suggestedPrompts": [
    {
      object (SuggestedPrompt)
    }
  ]
}
字段
title

string

必需。面向最终用户的标题。
prefix

string

可选。指定 suggestedPrompts 应以什么前缀开头。
suggestedPrompts[]

object (SuggestedPrompt)

必需。预设查询将向用户提供的提示。

SuggestedPrompt

预设查询的建议提示。

JSON 表示法 
{
  "promptText": string
}
字段
promptText

string

必需。建议提示的文本。

AssistantCapability

使用相应预设查询所需具备的助理功能。

JSON 表示法 
{

  // Union field capability can be only one of the following:
  "actionName": string
  // End of list of possible types for union field capability.
}
字段
联合字段 capability。助理功能，可以是操作或工具之一。capability 只能是下列其中一项：
actionName

string

助理使用相应预设查询所需设置的操作的名称。

方法

create

 创建 CannedQuery。

delete

 删除一个 CannedQuery。

get

 获取 CannedQuery。

list

 列出某个 Assistant 下的所有 CannedQuery。

listActiveCannedQueryUserViews

 列出所有有效 CannedQuery 的 CannedQueryUserView。

patch

 更新一个 CannedQuery。