الحصول على قائمة الوثائق في متجر المتجهات

get

List all documents in a vector store.

Path parameters
vector-store-idstringRequired

The ID of the vector store.

Header parameters
x-api-keystringRequired

The API key for authentication.

Responses
chevron-right
200

A list of documents.

application/json
idintegerOptional

Document ID.

namestringOptional

Document name.

typestringOptional

Document type.

vector_storestringOptional

The ID of the vector store.

sizeintegerOptional

Document size in bytes.

statusstringOptional

Document status.

processing_statusstringOptional

Processing status.

indexed_onstring · date-time · nullableOptional

Time when the document was indexed.

status_error_messagestring · nullableOptional

Error message for status.

createdstring · date-timeOptional

Creation timestamp.

modifiedstring · date-timeOptional

Modification timestamp.

get
/vector-stores/{vector-store-id}/documents
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"
circle-info

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

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

المعلمة
النوع
الوصف

vector-store-id

سلسلة

مطلوب. معرف متجر المتجهات الذي سيتم سرد الوثائق منه.

تنسيق الاستجابة

المصادقة

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

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

رمز الحالة
الوصف

401

غير مصرح - مفتاح API غير صالح أو مفقود

404

غير موجود - لم يتم العثور على متجر المتجهات

500

خطأ في الخادم الداخلي

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

Last updated