Vector Stores - Delete Vector Store

サービス:

AI Foundry

API バージョン:

v1

指定した ID に一致するベクター ストア オブジェクトを削除します。

DELETE {endpoint}/vector_stores/{vectorStoreId}?api-version=v1

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	次の形式のプロジェクトエンドポイント: https://.services.ai.azure.com/api/projects/
vectorStoreId	path	True	string	ベクトル ストアの識別子。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	VectorStoreDeletionStatus	要求は成功しました。
Other Status Codes	AgentV1Error	予期しないエラー応答。

セキュリティ

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://ai.azure.com/.default

例

VectorStores_DeleteVectorStore_MaximumSet

VectorStores_DeleteVectorStore_MinimumSet

VectorStores_DeleteVectorStore_MaximumSet

要求のサンプル

HTTP

DELETE {endpoint}/vector_stores/adggfpiwtnuqbudbchfgjanwddr?api-version=v1

応答のサンプル

状態コード:

200

{
  "id": "ekp",
  "deleted": true,
  "object": "vector_store.deleted"
}

VectorStores_DeleteVectorStore_MinimumSet

要求のサンプル

HTTP

DELETE {endpoint}/vector_stores/uyijywdytqsuxqirrqa?api-version=v1

応答のサンプル

状態コード:

200

{
  "id": "ekp",
  "deleted": true,
  "object": "vector_store.deleted"
}

定義

名前	説明
AgentErrorDetail	エージェント API によって返されるエラー情報について説明します。
AgentV1Error	エージェント API によって返されたエラー ペイロード。
VectorStoreDeletionStatus	ベクター ストアを削除するための応答オブジェクト。

AgentErrorDetail

Object

エージェント API によって返されるエラー情報について説明します。

名前	型	説明
code	string	機械可読のエラーコード。
message	string	エラーの人間が判読できる説明。
param	string	エラーの原因となったパラメータの名前 (該当する場合)。
type	string	エラータイプ識別子(例: invalid_request_error)。

AgentV1Error

Object

エージェント API によって返されたエラー ペイロード。

名前	型	説明
error	AgentErrorDetail	エラーを表します。

VectorStoreDeletionStatus

Object

ベクター ストアを削除するための応答オブジェクト。

名前	型	説明
deleted	boolean	削除が成功したかどうかを示す値。
id	string	削除対象として指定されたリソースの ID。
object	enum: vector_store.deleted	常に 'vector_store.deleted' であるオブジェクト型。