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}

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

string

事前定義されたクエリの表示名。長さの上限が 128 文字の UTF-8 でエンコードされた文字列にする必要があります。
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 を更新します。