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 符號程式庫圖示名稱。
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。