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

资源：CannedQuery

Assistant 的预制查询资源。它表示预定义对话开始的快捷方式。

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "defaultTexts": {
    object (CannedQueryTexts)
  },
  "localizedTexts": {
    string: {
      object (CannedQueryTexts)
    },
    ...
  },
  "activationBehavior": enum (ActivationBehavior),
  "requiredCapabilities": [
    {
      object (AssistantCapability)
    }
  ],
  "icon": string,
  "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 语言代码。
activationBehavior
(deprecated)

enum (ActivationBehavior)

启用此预设查询时的行为。已弃用。
requiredCapabilities[]

object (AssistantCapability)

可选。助理使用此预设查询所需具备的功能。
icon

string

Google Symbols 库中预设查询的图标名称。
enabled

boolean

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

boolean

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

CannedQueryTexts

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

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

  // Union field start_message can be only one of the following:
  "suggestedUserQuery": string,
  "assistantMessage": string,
  "userQuery": string
  // End of list of possible types for union field start_message.
}
字段
title

string

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

string

可选。suggestedPrompts 应以什么前缀开头。
description
(deprecated)

string

必需。面向最终用户的说明。已弃用。
suggestedPrompts[]

object (SuggestedPrompt)

必需。预设查询将向用户提供的提示。
联合字段 start_message。预设查询将用作对话开始的消息。已弃用。请改用 suggested_prompts。start_message 只能是下列其中一项：
suggestedUserQuery
(deprecated)

string

已弃用。请改用 userQuery。用户建议的第一轮对话的预设文本（例如，“生成一张猫的图片”）
assistantMessage
(deprecated)

string

助理在第一轮对话中的预设文本。此内容将显示给用户，可能会要求用户输入内容（例如，“您想创作什么类型的内容？（例如，电子邮件、文章、演示文稿）”。已弃用。
userQuery
(deprecated)

string

用户首次对话的预设文本。已弃用。请改用 suggestedPrompts。

SuggestedPrompt

预设查询的建议提示。

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

string

必需。建议提示的文本。

ActivationBehavior

启用此预设查询时的行为。已弃用。

枚举
ACTIVATION_BEHAVIOR_UNSPECIFIED 默认值，不应使用。默认值为 NEW_SESSION。
NEW_SESSION 使用此预设查询时，系统会启动新的助理会话。
NEW_RESEARCH_ASSISTANT_SESSION 使用此预设查询时，系统会启动新的研究助理会话。

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。