Method: projects.locations.collections.dataStores.sessions.create

Session を作成します。

作成する Session がすでに存在する場合は、ALREADY_EXISTS エラーが返されます。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/collections/*/dataStores/*}/sessions

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

パスパラメータ

パラメータ
parent

string

必須。親データストアの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}

クエリ パラメータ

パラメータ
sessionId

string

省略可。セッションに使用する ID。セッションのリソース名の最終的なコンポーネントになります。

この値は 1 ～ 63 文字で、有効な文字は /[a-z0-9][a-z0-9-]{0,61}[a-z0-9]/ です。指定しない場合は、一意の ID が生成されます。

リクエストの本文

リクエストの本文には Session のインスタンスが含まれます。

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.sessions.create

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