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}

長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。
displayName

string

事前定義されたクエリの表示名。長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。
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.
}
Fields
共用体フィールド capability。アシスタントの機能（アクションまたはツール）。capability は次のいずれかになります。
actionName

string

この定型クエリを使用するためにアシスタントで設定する必要があるアクションの名前。

メソッド

create

 CannedQuery を作成します。

delete

 CannedQuery を削除します。

get

 CannedQuery を取得します。

list

 Assistant のすべての CannedQuery を一覧表示します。

listActiveCannedQueryUserViews

 アクティブなすべての CannedQuery の CannedQueryUserView を一覧表示します。

patch

 CannedQuery を更新します。