コンテンツにスキップ

ベクターストアからドキュメントを削除する

DELETE /vector-stores/{vector-store-id}/documents/{document-id}/

Delete a specific document from a vector store.

Parameter In Type Required Description
vector-store-id path string yes The ID of the vector store.
document-id path integer yes The ID of the document.
x-api-key header string yes The API key for authentication.

Responses

  • 204 — Document deleted successfully.

例リクエスト

curl -X DELETE   
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234/   
  -H "x-api-key: YOUR_API_KEY"

Info

YOUR_API_KEY を実際のベクターストアAPIキーに、vs_abc123 をベクターストアIDに、1234 をドキュメントIDに置き換えてください。

const deleteDocument = async (vectorStoreId, documentId) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/${documentId}/`, {
    method: 'DELETE',
    headers: {
      'x-api-key': 'YOUR_API_KEY'
    }
  });

  if (response.status === 204) {
    console.log("ドキュメントが正常に削除されました");
  } else {
    console.error("ドキュメントの削除に失敗しました");
  }
};

deleteDocument('vs_abc123', 1234);

Info

YOUR_API_KEY を実際のベクターストアAPIキーに、vs_abc123 をベクターストアIDに、1234 をドキュメントIDに置き換えてください。

import requests

def delete_document(vector_store_id, document_id):
    headers = {
        "x-api-key": "YOUR_API_KEY"
    }

    response = requests.delete(
        f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents/{document_id}/",
        headers=headers
    )

    if response.status_code == 204:
        print("ドキュメントが正常に削除されました")
    else:
        print(f"ドキュメントの削除に失敗しました: {response.text}")

delete_document('vs_abc123', 1234)

Info

YOUR_API_KEY を実際のベクターストアAPIキーに、vs_abc123 をベクターストアIDに、1234 をドキュメントIDに置き換えてください。

パスパラメータ

パラメータ タイプ 説明
vector-store-id 文字列 必須。 ドキュメントを含むベクトルストアのID。
document-id 整数 必須。 削除するドキュメントのID。

レスポンス

成功したリクエストは、レスポンスボディなしで204 No Contentステータスコードを返します。

認証

このエンドポイントは、x-api-key ヘッダーを使用して API キーによる認証を必要とします。

エラー応答

ステータスコード 説明
401 認証エラー - 無効または欠落しているAPIキー
404 未発見 - ベクターストアまたはドキュメントが見つかりません
500 サーバ内部エラー

このエンドポイントを使用すると、ベクターストアからドキュメントを削除できます。一度削除されると、そのドキュメントとそのベクター埋め込みは検索操作に利用できなくなります。これは、古くなった、関連性のない、または機密性の高いコンテンツをナレッジベースから削除するのに役立ちます。

Warning

警告: ドキュメントの削除は永久的であり、元に戻すことはできません。削除する前に重要なドキュメントのバックアップを取っておいてください。