获取文档的信息
get
Retrieve the information of a document in a Vector Store.
Path parameters
vector-store-idstringRequired
The ID of the vector store.
document-idintegerRequired
The ID of the document.
Header parameters
x-api-keystringRequired
The API key for authentication.
Responses
200
Document details retrieved successfully.
application/json
get
/vector-stores/{vector-store-id}/documents/{document-id}GET /api/v1/vector-stores/{vector-store-id}/documents/{document-id} HTTP/1.1
Host: api.rememberizer.ai
x-api-key: text
Accept: */*
200
Document details retrieved successfully.
{
"id": 1,
"name": "text",
"type": "text",
"vector_store": "text",
"size": 1,
"status": "text",
"processing_status": "text",
"indexed_on": "2025-11-15T16:11:22.589Z",
"status_error_message": "text",
"created": "2025-11-15T16:11:22.589Z",
"modified": "2025-11-15T16:11:22.589Z"
}示例请求
curl -X GET \
https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/1234 \
-H "x-api-key: YOUR_API_KEY"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);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)路径参数
参数
类型
描述
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
服务器内部错误
此端点检索有关向量存储中特定文档的详细信息。它对于检查单个文档的处理状态以及检索元数据（如文件类型、大小和时间戳）非常有用。当排查文档处理问题或需要验证文档是否正确索引时，这尤其有帮助。
Last updated