إعادة الاتصال بخطة درس
إصدار API 2026-10-affable-towhee
يعيد الانضمام إلى بث تقدّم خطة لا يزال إنشاؤها جاريًا. الخطة المكتملة تجيب بـ result واحد. والخطة التي لا يزال إنشاؤها جاريًا دون بث حيّ للانضمام إليه تجيب بـ pending واحد؛ استعلم دوريًا عن GET /v1/lesson-plans/{id} حتى تكتمل.
النطاقات lesson_plans:read
المعاملات
Lingara-Versionheaderstringاختياري- إصدار API الذي يُجاب عن هذا الطلب به. بدونه، يحصل رمز الوصول على الإصدار الذي رُبط به عميله، ويحصل الطلب الذي لا رمز مميز فيه على الإصدار الحالي. لا يمكن الوصول إلى الإصدار الذي لا يزال قيد التطوير إلا بذكره هنا. الإصدار غير المعروف يُجاب عنه بـ
400مع الرمزapi_version_unknown. يسردGET /v1/versionsالإصدارات. idpathstringمطلوب
الاستجابات
200 ما تبقّى من تقدّم الخطة، ثم الخطة
أحداث البث text/event-stream
يرسل تعليق إبقاء الاتصال (keepalive) كل 15 ثانية.
-
startedPlanStarted -
plan_idstringمطلوب
-
phasePlanPhase -
phasestringمطلوبattemptintegerمطلوب
-
resultPlanResult ينهي البث -
planLessonPlanمطلوبidstringمطلوبstatusPlanStatusمطلوبtitlestring | nullاختياريsource_langstringمطلوبtarget_langstringمطلوبlevelintegerمطلوبcreated_atstringمطلوبcompleted_atstring | nullاختياريai_generatedbooleanمطلوبcontentLessonPlanContent | nullاختياريintroductionstring | nullاختياريlearning_objectivesarray of stringمطلوبvocabularyarray of PlanWordمطلوبwordstringمطلوبpronunciationstring | nullاختياريtranslationstringمطلوب
setsarray of PlanSetمطلوبnumberintegerمطلوبcontextstring | nullاختياريquestionsarray of PlanQuestionمطلوبtypestringمطلوبpromptstringمطلوبoptionsarray of string | nullاختياريanswerstringمطلوبexplanationstringمطلوبhintstring | nullاختياري
-
pendingPlanPending ينهي البث -
plan_idstringمطلوبstatusPlanStatusمطلوب
-
errorStreamError ينهي البث -
يصل داخل استجابة 200. سطر الحالة أُرسل بالفعل، لذا يُبلَّغ عن أي فشل بعد فتح البث على أنه هذا الحدث.
codestringمطلوبmessagestringمطلوبplan_idstring | nullاختياري
الأخطاء
410application/json- تم إيقاف إصدار API الذي يُجاب عن هذا الطلب به. أرسل إصدارًا مدعومًا في
Lingara-Version، أو اربط العميل بإصدار آخر. 4XXapplication/json- رُفض الطلب. يوضّح
codeالسبب، ويشرحهerrorبالكلمات. 503application/json · text/plain- الخدمة غير متاحة مؤقتًا؛ أعد المحاولة بعد عدد الثواني المذكور في
Retry-After. أثناء الصيانة يكون المتن نصًا عاديًا بدلًا من غلاف الخطأ. 5XXapplication/json- رُفض الطلب. يوضّح
codeالسبب، ويشرحهerrorبالكلمات.
codestringمطلوبسبب رفض الطلب، في صورة رمز ثابت يمكن التفرّع بناءً عليه: مثل
insufficient_scope(403) وrate_limited(429)، ولعميل يُفوتَر بحسب الاستهلاكspend_cap_reached(402) وmetered_billing_inactive(402).errorstringمطلوب
مثال
تفضّل مكتبة؟ راجع قسم المكتبات.
مثال على البث
event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}إذا اختلفت ترجمةٌ عن المرجع الإنجليزي، فالمرجع الإنجليزي هو الصحيح.