コンテンツにスキップ

ドキュメントの情報を取得する

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

Retrieve the information of a document in 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

  • 200 — Document details retrieved successfully.

例リクエスト

curl -X GET   
  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 getDocumentInfo = async (vectorStoreId, documentId) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/${documentId}`, {
    method: 'GET',
    headers: {
      'x-api-key': 'YOUR_API_KEY'
    }
  });

  const data = await response.json();
  console.log(data);
};

getDocumentInfo('vs_abc123', 1234);

Info

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

import requests

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

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

    data = response.json()
    print(data)

get_document_info('vs_abc123', 1234)

Info

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

パスパラメータ

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

レスポンス形式

{
  "id": 1234,
  "name": "製品マニュアル.pdf",
  "type": "application/pdf",
  "vector_store": "vs_abc123",
  "size": 250000,
  "status": "インデックス作成済み",
  "processing_status": "完了",
  "indexed_on": "2023-06-15T10:30:00Z",
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:30:00Z"
}

認証

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

エラー応答

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

このエンドポイントは、ベクターストア内の特定のドキュメントに関する詳細情報を取得します。これは、個々のドキュメントの処理状況を確認したり、ファイルタイプ、サイズ、タイムスタンプなどのメタデータを取得するのに役立ちます。これは、ドキュメント処理の問題をトラブルシューティングする際や、ドキュメントが正しくインデックスされていることを確認する必要がある場合に特に便利です。