اتصال دوباره به پلان درسی
نسخهٔ 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
هر 15 ثانیه یک یادداشت keepalive میفرستد.
-
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"}اگر ترجمه با مرجع انگلیسی فرق داشته باشد، مرجع انگلیسی درست است.