跳轉到

獲取文件的信息

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 內部伺服器錯誤

此端點檢索有關向量儲存中特定文件的詳細資訊。它對於檢查單個文件的處理狀態以及檢索元數據（如文件類型、大小和時間戳）非常有用。在排除文件處理問題或需要驗證文件是否正確編入索引時，這特別有幫助。