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

الحصول على قائمة بالمستندات في متجر المتجهات

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

List all documents in a vector store.

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

Responses

  • 200 — A list of documents.

طلبات مثال

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

Info

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

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

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

getVectorStoreDocuments('vs_abc123');

Info

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

import requests

def get_vector_store_documents(vector_store_id):
    headers = {
        "x-api-key": "YOUR_API_KEY"
    }

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

    data = response.json()
    print(data)

get_vector_store_documents('vs_abc123')

Info

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

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

المعلمة النوع الوصف
vector-store-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"
  },
  {
    "id": 1235,
    "name": "المواصفات الفنية.docx",
    "type": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    "vector_store": "vs_abc123",
    "size": 125000,
    "status": "مفهرس",
    "processing_status": "مكتمل",
    "indexed_on": "2023-06-15T11:45:00Z",
    "status_error_message": null,
    "created": "2023-06-15T11:30:00Z",
    "modified": "2023-06-15T11:45:00Z"
  }
]

المصادقة

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

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

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

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