OpenQCoreAI
ابدأ الآن

الموارد · Knowledge API

توثيق Knowledge API

مرجع شامل لفهرسة معرفة مساحة العمل، والاسترجاع، ومسارات ask، مع ضوابط تشغيل مناسبة للإنتاج.

الرجوع للتوثيقاذهب إلى الـ Endpoints

نقاط النهاية

GET /api/v1/console/knowledge
POST /api/v1/console/knowledge
POST /api/v1/console/knowledge/upload
GET /api/v1/console/knowledge/{item_id}
PATCH /api/v1/console/knowledge/{item_id}
DELETE /api/v1/console/knowledge/{item_id}
POST /api/v1/console/knowledge/ask

الهيدرز المطلوبة

Authorization: Bearer [token] أو API key authX-Scope-Type: workspaceX-Workspace-ID: [workspace_uuid]Content-Type: application/json (أو multipart/form-data للرفع)

مثال الرفع

bash
curl -X POST "/api/v1/console/knowledge/upload" \
  -H "Authorization: Bearer [token]" \
  -H "X-Scope-Type: workspace" \
  -H "X-Workspace-ID: [workspace_uuid]" \
  -F "file=@handbook.pdf" \
  -F "title=Team Handbook" \
  -F "tags=hr,policy"

مثال ask

json
{
  "question": "What is our remote-work policy?",
  "top_k": 5,
  "filters": {
    "tags": ["hr", "policy"]
  },
  "session_id": "sess_123"
}

مثال الاستجابة

json
{
  "success": true,
  "answer": "Employees may work remotely up to 3 days per week...",
  "citations": [
    {
      "item_id": "kb_456",
      "title": "Team Handbook",
      "score": 0.91
    }
  ],
  "usage": {
    "input_tokens": 180,
    "output_tokens": 72
  },
  "metadata": {
    "retrieved_items": 5
  }
}

قيود المعرفة

  • الحد الأقصى لحجم الملف: 20MB لكل عملية رفع.
  • الأنواع المدعومة: PDF و DOC و DOCX و TXT و Markdown.
  • الفهرسة تعمل بشكل غير متزامن عبر workers في الخلفية.
  • نطاق workspace إلزامي لعمليات معرفة الكونسول.

دورة حياة الفهرسة

  1. pending: تم قبول الملف وإضافته للطابور.
  2. processing: جارٍ الاستخراج والتقسيم وبناء embeddings.
  3. processed: تمت الفهرسة وأصبح العنصر جاهزًا للاستعلام.
  4. failed: فشلت الفهرسة مع بيانات تشخيصية.

نماذج الأخطاء

400

طلب غير صالح أو فلاتر غير صحيحة.

401

مصادقة مفقودة أو غير صحيحة.

403

تم رفض الوصول لمساحة العمل بسبب الدور/النطاق.

404

عنصر المعرفة غير موجود.

413

حجم الملف المرفوع أكبر من المسموح.

415

نوع الملف غير مدعوم.

422

فشل التحقق في مخطط الطلب/السياق.

429

تم تجاوز حد المعدل.