الموارد · التوثيق

توثيق المنصة.

جاهز للإنتاج من الأساس.

توثيق OpenQCore للفرق التي تبني منتجات ذكاء اصطناعي موثوقة عبر المحادثة والصوت وتوليد الوسائط وإدارة المعرفة مع تحكم سياقي دقيق.

ابدأ البناء سطح الـ API

Runtime قائم على APIنطاق شخصي ومساحة عملStreaming و Non-StreamingRate-Limit + Dedup + Lockمسار صوتي (STT/LLM/TTS)واجهات معرفة الكونسول

بداية سريعة

من أول طلب إلى مسار إنتاجي خلال دقائق.

1) المصادقة

استخدم JWT/session أو API key مع التحكم حسب الصلاحيات.

2) اختيار نطاق التشغيل

حدد personal أو workspace عبر هيدرز السياق وقت الحاجة.

3) استدعاء chat completions

استخدم /api/v1/chat/completions لمسار المساعد الأساسي.

4) إضافة الصوت وتعدد الوسائط

استخدم /api/v1/voice ونقاط Iris للصورة والفيديو و OCR.

5) دمج المعرفة

استخدم /api/v1/console/knowledge للرفع والفهرسة والسؤال المعزز.

الرابط الأساسي

قاعدة الـ API العامة

/api/v1

كل نقاط المنصة العامة متاحة تحت /api/v1.

المصادقة والنطاق

وصول سياقي عبر النطاق الشخصي ومساحة العمل.

طرق المصادقة

JWT/session أو API key

هيدر النطاق

X-Scope-Type: personal | workspace

هيدر مساحة العمل

X-Workspace-ID: [uuid] (مطلوب في workspace)

هيدر الوكيل

X-Agent-ID: [uuid] (اختياري)

قواعد التحقق

إذا كان النطاق personal فلا يُسمح بـ workspace_id.
إذا كان النطاق workspace فـ workspace_id إلزامي.
الهيدرز غير الصحيحة تعيد 422.

حدود المعدل

سياسات throttling حسب نوع المصادقة.

API key

60 طلب / دقيقة

مفتاح القياس يعتمد على api_key_hash.

JWT/session

120 طلب / دقيقة

المفتاح يعتمد على workspace_id أو user_id.

هيدرز الاستجابة عند الحد

Retry-AfterX-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-Reset

Chat Runtime

/chat/completions بطبقات تحكم إنتاجية.

GET /api/v1/chat/health

POST /api/v1/chat/completions

سلوك التنفيذ

تتبع backpressure ورفض الأحمال الحرجة (503).
قفل موزع لمنع تكرار المعالجة المتزامنة (409).
ذاكرة dedup للاستجابات غير المتدفقة.
حفظ رسائل المستخدم والمساعد داخل الجلسة.
تحقق شامل للطلب والمرفقات وصلاحية الجلسة.

Voice Runtime

مسار STT → LLM → TTS مع بث مباشر وإمكانية الإيقاف.

POST /api/v1/voice/chat/meta

POST /api/v1/voice/chat

POST /api/v1/voice/interrupt/{session_id}

WS /api/v1/voice/ws

مزايا الصوت

توجيه مزودين مع fallback (OpenAI + Azure).
Circuit breakers لمراحل STT و LLM و TTS.
تحويل الصوت تلقائيًا عند عدم توافق WAV.
بث صوتي مع هيدرز ميتاداتا.
Cancellation context لإيقاف جلسة محددة.
Load shedding وخفض الجودة تحت الضغط.

Iris متعدد الوسائط

توجيه بالنموذج للصورة والفيديو و OCR والتحقق.

كتالوج النماذج

iris-orbit

توجيه تلقائي

iris-genesis

توليد الصور

iris-edit

تعديل الصور (غير منفذ حاليًا)

iris-lens

تحليل الصور (غير منفذ حاليًا)

iris-video

توليد الفيديو

iris-ocr

استخراج النص من المستندات

iris-verify

التحقق من الهوية

iris-guard

كشف الاحتيال (غير منفذ حاليًا)

iris-face

التحقق الحيوي للوجه (غير منفذ حاليًا)

معرفة الكونسول

واجهات معرفة الكونسول للفهرسة والسؤال.

/api/v1/console/knowledge

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

قيود المعرفة

الحد الأقصى لحجم الملف: 20MB
الأنواع المسموحة: PDF و DOC و DOCX و TXT و Markdown
الفهرسة تتم بشكل غير متزامن بالخلفية
حالات المعالجة: pending → processing → processed | failed

دلالات الأخطاء

تصنيفات الاستجابة الشائعة في المنصة.

400

طلب غير صالح أو بيانات ناقصة

401

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

403

صلاحيات/نطاق غير مسموح

404

المورد غير موجود

409

الطلب قيد المعالجة بالفعل

413

حجم المدخلات أكبر من المسموح

415

نوع المحتوى غير مدعوم

422

فشل التحقق (النطاق/السياق/الهيكل)

429

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

503

ضغط نظام أو مزود غير متاح

الرصد التشغيلي

تتبّع التنفيذ عبر دورة حياة المحادثة والصوت.

Trace IDs لربط الطلبات والتحليلات.
Middleware لتسجيل الاستخدام.
تهيئة OpenTelemetry مع OTLP export.
هيدرز زمنية واضحة في مسارات الصوت.

X-Trace-IDX-Session-IDX-STT-Time-MSX-LLM-Time-MSX-TTS-Time-MS

التنقل داخل التوثيق

استكشف أقسام التوثيق

انتقل مباشرة إلى أدلة التنفيذ والمراجع الإنتاجية لكل سطح تشغيل في المنصة.

Authentication

مصادقة JWT/API Key وهيدرز النطاق ونموذج التحقق.

Chat API

Completions وسلوك البث وضوابط التشغيل.

Voice API

مسار الصوت اللحظي وآلية الإيقاف وهيدرز الميتاداتا.

Iris API

نقاط نهاية الصورة/الفيديو/OCR/التحقق ومنطق التوجيه.

Knowledge API

الرفع ودورة الفهرسة والاسترجاع ومسارات ask.

Providers

مصفوفة القدرات وسياسة التوجيه واستراتيجية الـ failover.

Output Contracts

Envelope استجابة موحد عبر المزودين والوسائط.

Architecture

طبقات التشغيل وتجريد المزودين وضمانات النظام.

ابنِ بثقة على Runtime الخاص بـ OpenQCore.

استخدم التوثيق كخريطة تشغيل إنتاجية للمحادثة والصوت وتعدد الوسائط والمعرفة.

افتح مستكشف API اذهب إلى البنية التحتية