Method: projects.locations.collections.engines.sessions.get

セッションを取得します。

HTTP リクエスト

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/sessions/*}

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

パスパラメータ

パラメータ
name

string

必須。取得するセッションのリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/sessions/{sessionId}

クエリ パラメータ

パラメータ
includeAnswerDetails

boolean

省略可。true に設定すると、すべての回答の詳細を含む完全なセッションが返されます。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Session のインスタンスが含まれます。

認可スコープ

次の 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.sessions.get

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