انتقل إلى المحتوى

الحصول على معلومات مستند

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 بمعرف متجر المتجهات الخاص بك، و1234 بمعرف الوثيقة.

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 بمعرف متجر المتجهات الخاص بك، و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)

Info

استبدل YOUR_API_KEY بمفتاح API الخاص بك لمتجر المتجهات الفعلي، وvs_abc123 بمعرف متجر المتجهات الخاص بك، و1234 بمعرف الوثيقة.

معلمات المسار

المعلمة النوع الوصف
vector-store-id سلسلة مطلوب. معرف مخزن المتجهات الذي يحتوي على الوثيقة.
document-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"
}

المصادقة

تتطلب هذه النقطة النهائية المصادقة باستخدام مفتاح API في رأس x-api-key.

استجابات الخطأ

رمز الحالة الوصف
401 غير مصرح - مفتاح API غير صالح أو مفقود
404 غير موجود - لم يتم العثور على متجر المتجهات أو الوثيقة
500 خطأ في الخادم الداخلي

تسترجع هذه النقطة النهائية معلومات مفصلة حول وثيقة معينة في متجر المتجهات. إنها مفيدة للتحقق من حالة معالجة الوثائق الفردية واسترجاع البيانات الوصفية مثل نوع الملف، والحجم، والطوابع الزمنية. يمكن أن تكون هذه المعلومات مفيدة بشكل خاص عند استكشاف المشكلات المتعلقة بمعالجة الوثائق أو عندما تحتاج إلى التحقق من أن الوثيقة تم فهرستها بشكل صحيح.