إضافة وثيقة نصية جديدة إلى تخزين المتجهات

post

Create a new text document 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.

Body

namestringOptional

The name of the document.

textstringOptional

The text content of the document.

Responses

201

Document created successfully.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/vector-stores/{vector-store-id}/documents/create HTTP/1.1
Host: api.rememberizer.ai
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "text",
  "text": "text"
}

201

Document created successfully.

{
  "id": 1,
  "name": "text",
  "type": "text",
  "vector_store": "text",
  "size": 1,
  "status": "text",
  "processing_status": "text",
  "indexed_on": "2025-05-04T08:19:29.917Z",
  "status_error_message": "text",
  "created": "2025-05-04T08:19:29.917Z",
  "modified": "2025-05-04T08:19:29.917Z"
}

طلبات مثال

cURL

curl -X POST \
  https://api.rememberizer.ai/api/v1/vector-stores/vs_abc123/documents/create \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "نظرة عامة على المنتج",
    "text": "منتجنا هو حل مبتكر لإدارة تضمينات المتجهات. يوفر تكاملًا سلسًا مع أنظمتك الحالية ويقدم قدرات بحث دلالي قوية."
  }'

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

JavaScript

const addTextDocument = async (vectorStoreId, name, text) => {
  const response = await fetch(`https://api.rememberizer.ai/api/v1/vector-stores/${vectorStoreId}/documents/create`, {
    method: 'POST',
    headers: {
      'x-api-key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      name: name,
      text: text
    })
  });
  
  const data = await response.json();
  console.log(data);
};

addTextDocument(
  'vs_abc123',
  'نظرة عامة على المنتج',
  'منتجنا هو حل مبتكر لإدارة تضمينات المتجهات. يوفر تكاملًا سلسًا مع أنظمتك الحالية ويقدم قدرات بحث دلالي قوية.'
);

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

Python

import requests
import json

def add_text_document(vector_store_id, name, text):
    headers = {
        "x-api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    }
    
    payload = {
        "name": name,
        "text": text
    }
    
    response = requests.post(
        f"https://api.rememberizer.ai/api/v1/vector-stores/{vector_store_id}/documents/create",
        headers=headers,
        data=json.dumps(payload)
    )
    
    data = response.json()
    print(data)

add_text_document(
    'vs_abc123',
    'نظرة عامة على المنتج',
    'منتجنا هو حل مبتكر لإدارة تضمينات المتجهات. يوفر تكاملًا سلسًا مع أنظمتك الحالية ويقدم قدرات بحث دلالي قوية.'
)

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

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

المعلمة	النوع	الوصف
vector-store-id	سلسلة	مطلوب. معرف مخزن المتجهات الذي سيتم إضافة المستند إليه.

جسم الطلب

{
  "name": "نظرة عامة على المنتج",
  "text": "منتجنا هو حل مبتكر لإدارة تضمينات المتجهات. يوفر تكاملًا سلسًا مع أنظمتك الحالية ويقدم قدرات بحث دلالي قوية."
}

المعامل	النوع	الوصف
name	سلسلة	مطلوب. اسم الوثيقة.
text	سلسلة	مطلوب. المحتوى النصي للوثيقة.

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

{
  "id": 1234,
  "name": "نظرة عامة على المنتج",
  "type": "text/plain",
  "vector_store": "vs_abc123",
  "size": 173,
  "status": "قيد المعالجة",
  "processing_status": "في قائمة الانتظار",
  "indexed_on": null,
  "status_error_message": null,
  "created": "2023-06-15T10:15:00Z",
  "modified": "2023-06-15T10:15:00Z"
}

المصادقة

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

ردود الأخطاء

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

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