Method: projects.locations.collections.engines.assistants.assist

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

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:assist

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
name

string

必須。Assistant のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "query": {
    object (Query)
  },
  "session": string,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "languageCode": string,
  "webGroundingEnabled": boolean,
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "assistGenerationConfig": {
    object (AssistGenerationConfig)
  },
  "googleSearchGroundingEnabled": boolean
}
フィールド
query

object (Query)

省略可。現在のユーザークエリ。

空のクエリは、fileIds が指定されている場合にのみサポートされます。この場合、回答はこれらのコンテキスト ファイルに基づいて生成されます。
session

string

省略可。リクエストに使用するセッション。指定した場合、アシスタントはセッション履歴にアクセスでき、クエリと回答がそこに保存されます。

セッション ID として - が指定されている場合、または空のままになっている場合は、自動生成された ID を持つ新しいセッションが作成されます。

形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
assistSkippingMode

enum (AssistSkippingMode)

省略可。アシスタントがクエリに回答しないケースを決定します。回答がスキップされた場合、理由は AssistResponse.answer 内の AssistAnswer.assist_skipped_reasons にリストされます。
fileIds[]

string

省略可。リクエストへの回答に使用するファイルの ID。ファイルをアップロードすると、その ID が AddContextFileResponse.file_id で返されます。
userMetadata

object (AssistUserMetadata)

省略可。クエリを開始したユーザーに関する情報。
languageCode

string

省略可。言語検出に失敗した場合に回答に使用する言語。言語検出の結果にかかわらず、アクションによって作成されたエラー メッセージの言語としても使用されます。
webGroundingEnabled

boolean

省略可。true に設定すると、ウェブ検索によるグラウンディングが有効になります。Assistant.web_grounding_type が [WEB_GROUNDING_TYPE_GOOGLE_SEARCH][] または [WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH][] の場合にのみ機能します。
dataStoreSpecs[]

object (DataStoreSpec)

省略可。検索呼び出しでフィルタする DataStore と、それらのデータストアの構成を定義する仕様。これは、複数のデータストアを持つ Engine でのみ考慮されます。

このフィールドを設定しないと、ignoreDataStores が true に設定されている場合を除き、エンジン内のすべてのデータストアが使用されます。
assistGenerationConfig

object (AssistGenerationConfig)

省略可。リクエスト レベルの生成構成。これは、エンジンレベルでデフォルトの生成構成をオーバーライドするために使用されます。
googleSearchGroundingEnabled
(deprecated)

boolean

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

レスポンスの本文

AssistantService.Assist メソッドに対するレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string
}
フィールド
answer

object (AssistAnswer)

クエリに対するレスポンスで生成された AssistAnswer リソース。
sessionInfo

object (SessionInfo)

セッション情報。
assistToken

string

現在のリクエストとレスポンスのペアを識別するグローバル一意の ID。フィードバックとサポートに使用されます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

name リソースに対する次の IAM 権限が必要です。

  • discoveryengine.assistants.assist

詳細については、IAM のドキュメントをご覧ください。

AssistSkippingMode

アシスト リクエストで使用可能なスキップ動作。

列挙型
ASSIST_SKIPPING_MODE_UNSPECIFIED デフォルト値。クエリがサポートを求めていない場合は、回答をスキップできます。
REQUEST_ASSIST アシスタントの回答をリクエストします。クエリがポリシー チェックに失敗した場合、回答はスキップされることがあります。

SessionInfo

セッションに関する情報。

JSON 表現 
{
  "session": string,
  "queryId": string
}
フィールド
session

string

新たに生成されたセッションまたは継続されたセッションの名前。

形式: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
queryId

string

このアシスト API 呼び出しに対応するクエリ ID。1 つのセッションに複数のターンを含めることができ、各ターンには一意のクエリ ID があります。

assistants.assist API 呼び出しでセッション名とこのクエリ ID を指定すると、この検索呼び出しの検索結果のコンテキストでアシスト リクエストが発生します。