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

リソース: アシスタント

Discovery Engine Assistant リソース。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "description": string,
  "generationConfig": {
    object (GenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "enabledActions": {
    string: {
      object (ActionList)
    },
    ...
  },
  "enabledTools": {
    string: {
      object (ToolList)
    },
    ...
  },
  "customerPolicy": {
    object (CustomerPolicy)
  }
}
フィールド
name

string

変更不可。アシスタントのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

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

string

必須。アシスタントの表示名。

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

string

省略可。追加情報の説明。アシスタントのユーザーではなく、構成 UI に表示されることが想定されています。
generationConfig

object (GenerationConfig)

省略可。アシスタントの回答の生成に関する構成。
googleSearchGroundingEnabled
(deprecated)

boolean

省略可。非推奨。webGroundingType を代わりに使用してください。

webGroundingType

enum (WebGroundingType)

省略可。使用するウェブ グラウンディングのタイプ。
enabledActions
(deprecated)

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

省略可。非推奨: 代わりに enabledTools に置き換えられます。このアシスタントで有効になっているアクション。キーはコネクタ名（projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector など）です。値は、コネクタ インスタンスに対して管理者が有効にしたアクションで構成されます。管理者は、プロジェクトで作成したコネクタ インスタンスで複数のアクションを選択的に有効にできます。例: {"jira1ConnectorName": [(actionId1, "createTicket"), (actionId2, "transferTicket")], "gmail1ConnectorName": [(actionId3, "sendEmail"),..] }
enabledTools

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

省略可。注: まだ実装されていません。代わりに enabledActions を使用してください。 このアシスタントで有効になっているツール。キーはコネクタ名（projects/{projectId}/locations/{locationId}/collections/{collectionId}/dataconnector など）です。値は、コネクタ インスタンスに対して管理者が有効にしたツールで構成されます。管理者は、プロジェクトで作成したコネクタ インスタンスで複数のツールを選択的に有効にできます。例: {"jira1ConnectorName": [(toolId1, "createTicket"), (toolId2, "transferTicket")], "gmail1ConnectorName": [(toolId3, "sendEmail"),..] }
customerPolicy

object (CustomerPolicy)

省略可。アシスタントの顧客ポリシー。

GenerationConfig

アシスタントの回答の生成に関する構成。

JSON 表現 
{
  "systemInstruction": {
    object (SystemInstruction)
  },
  "defaultLanguage": string
}
フィールド
systemInstruction

object (SystemInstruction)

システム指示。LLM 呼び出しのプロンプトの序文とも呼ばれます。https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions もご覧ください。
defaultLanguage

string

アシスタントの回答の生成に使用するデフォルトの言語。en などの ISO 639-1 言語コードを使用します。指定しない場合、言語は自動的に検出されます。

SystemInstruction

システム指示。LLM 呼び出しのプロンプトの序文とも呼ばれます。

JSON 表現 
{
  "additionalSystemInstruction": string
}
フィールド
additionalSystemInstruction

string

省略可。デフォルトのシステム指示に追加される追加のシステム指示。

WebGroundingType

使用するウェブ グラウンディングのタイプ。

列挙型
WEB_GROUNDING_TYPE_UNSPECIFIED デフォルトの未指定の設定。これは無効と同じです。
WEB_GROUNDING_TYPE_DISABLED ウェブ グラウンディングが無効になっています。

ActionList

非推奨: 代わりに ToolList に置き換えられます。コネクタで有効になっているアクション

JSON 表現 
{
  "actionInfo": [
    {
      object (ActionInfo)
    }
  ]
}
フィールド
actionInfo[]

object (ActionInfo)

対応するアクション情報を含むアクションのリスト。

ActionInfo

非推奨: 代わりに ToolInfo に置き換えられます。アクションを識別するための情報。

JSON 表現 
{
  "actionName": string,
  "actionDisplayName": string
}
フィールド
actionName

string

DataConnectorService.QueryAvailableActions で定義されているアクションの名前。
actionDisplayName

string

アクションの表示名。

ToolList

コネクタで有効になっているツール

JSON 表現 
{
  "toolInfo": [
    {
      object (ToolInfo)
    }
  ]
}
フィールド
toolInfo[]

object (ToolInfo)

ツールと対応するツール情報のリスト。

ToolInfo

ツールを識別するための情報。

JSON 表現 
{
  "toolName": string,
  "toolDisplayName": string
}
フィールド
toolName

string

DataConnectorService.QueryAvailableActions で定義されているツールの名前。注: DataConnectorService API で action が使用されていますが、ここでは tool と同じです。
toolDisplayName

string

ツールの表示名。

CustomerPolicy

アシスタントのユーザー定義ポリシー。

JSON 表現 
{
  "bannedPhrases": [
    {
      object (BannedPhrase)
    }
  ],
  "modelArmorConfig": {
    object (ModelArmorConfig)
  }
}
フィールド
bannedPhrases[]

object (BannedPhrase)

省略可。禁止されたフレーズのリスト。
modelArmorConfig

object (ModelArmorConfig)

省略可。ユーザー プロンプトとアシスタント レスポンスのサニタイズに使用される Model Armor 構成。

BannedPhrase

お客様が定義した禁止フレーズの定義。禁止されたフレーズは、ユーザークエリまたは LLM レスポンスに含めることはできません。含めると、回答は拒否されます。

JSON 表現 
{
  "phrase": string,
  "matchType": enum (BannedPhraseMatchType),
  "ignoreDiacritics": boolean
}
フィールド
phrase

string

必須。禁止する未加工の文字列コンテンツ。
matchType

enum (BannedPhraseMatchType)

省略可。禁止フレーズのマッチタイプ。
ignoreDiacritics

boolean

省略可。true の場合、禁止フレーズのマッチング時に発音区別符号（アクセント、ウムラウトなど）が無視されます。たとえば、「cafe」は「café」と一致します。

BannedPhraseMatchType

禁止フレーズの照合方法。

列挙型
BANNED_PHRASE_MATCH_TYPE_UNSPECIFIED デフォルトは SIMPLE_STRING_MATCH です。
SIMPLE_STRING_MATCH 禁止フレーズは、テキスト内のどこかに完全な部分文字列として含まれている場合に一致します。
WORD_BOUNDARY_STRING_MATCH 禁止フレーズは、テキスト内のパターンが単語区切り文字で囲まれている場合にのみ一致します。フレーズ自体に単語区切り文字が含まれている場合もあります。

ModelArmorConfig

ユーザー プロンプトとアシスタント レスポンスのサニタイズに使用される、顧客定義の Model Armor テンプレートの構成。

JSON 表現 
{
  "userPromptTemplate": string,
  "responseTemplate": string,
  "failureMode": enum (FailureMode)
}
フィールド
userPromptTemplate

string

省略可。ユーザー プロンプトをサニタイズするための Model Armor テンプレートのリソース名。形式: projects/{project}/locations/{location}/templates/{templateId}

指定しない場合、ユーザー プロンプトにサニタイズは適用されません。
responseTemplate

string

省略可。アシスタント レスポンスをサニタイズするための Model Armor テンプレートのリソース名。形式: projects/{project}/locations/{location}/templates/{templateId}

指定しない場合、アシスタントのレスポンスにサニタイズは適用されません。
failureMode

enum (FailureMode)

省略可。Model Armor のサニタイズの障害モードを定義します。

FailureMode

Model Armor がリクエストの処理に失敗した場合の動作を決定します。

列挙型
FAILURE_MODE_UNSPECIFIED 未指定の障害モード。デフォルトの動作は FAIL_CLOSED です。
FAIL_OPEN Model Armor の処理が失敗した場合でも、リクエストは変更なしで続行できます。
FAIL_CLOSED Model Armor の処理が失敗した場合、リクエストは拒否されます。

メソッド

assist

 ユーザーのクエリを支援します。

create

 Assistant を作成します。

delete

 Assistant を削除します。

get

 Assistant を取得します。

list

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

patch

 Assistant を更新します

streamAssist

 ユーザーのクエリをストリーミング形式で支援します。