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

セッションを削除します。

削除する Session が存在しない場合は、NOT_FOUND エラーが返されます。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
name

string

必須。削除する Session のリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStoreId}/sessions/{sessionId}

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文は空の JSON オブジェクトになります。

認可スコープ

次の 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.delete

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