Lingara Lingara 說明文件 學習指南 API 函式庫 App 建立 網頁版
語言: 繁體中文

重新連線到課程計畫

API 版本 2026-10-affable-towhee

get https://api.getlingara.com/v1/lesson-plans/{id}/stream

重新加入仍在產生中的計畫的進度串流。已完成的計畫會傳回一個 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 註解。

started PlanStarted
plan_idstring必填
phase PlanPhase
phasestring必填
attemptinteger必填
result PlanResult 結束資料流
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選填
pending PlanPending 結束資料流
plan_idstring必填
statusPlanStatus必填
error StreamError 結束資料流

在 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必填

範例

程式碼範例語言

curl

curl -N "https://api.getlingara.com/v1/lesson-plans/$ID/stream" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

TypeScript

for await (const ev of client.streamLessonPlan({ id: planId })) {
  if (ev.event === "result") console.log("ready:", ev.data.plan.title);
  if (ev.event === "pending") console.log("still", ev.data.status, "- try again later");
}

Rust

use lingara::models::StreamLessonPlanEvent;

let mut stream = client.stream_lesson_plan(&plan_id).await?;
while let Some(event) = stream.next().await {
    match event? {
        StreamLessonPlanEvent::Result(result) => println!("ready: {}", result.plan.title.unwrap_or_default()),
        StreamLessonPlanEvent::Pending(pending) => println!("still {:?} - try again later", pending.status),
        _ => {}
    }
}

Go

// Rejoin a plan still generating, with the plan_id from its started event.
s, err := client.StreamLessonPlan(ctx, "3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37")
if err != nil {
	return err
}
defer s.Close()
for ev, err := range s.Events() {
	if err != nil {
		return err
	}
	switch e := ev.(type) {
	case lingara.StreamLessonPlanEventResult:
		fmt.Println("ready:", e.Data.Plan.ID)
	case lingara.StreamLessonPlanEventPending:
		fmt.Println("still", e.Data.Status, "- rejoin later")
	}
}

Java

import com.getlingara.client.model.StreamLessonPlanEvent;

try (EventStream<StreamLessonPlanEvent> stream = client.streamLessonPlan(planId)) {
  for (StreamLessonPlanEvent event : stream) {
    if (event instanceof StreamLessonPlanEvent.Result result) {
      System.out.println(result.data().getPlan().getTitle());
    } else if (event instanceof StreamLessonPlanEvent.Pending pending) {
      // Still generating elsewhere: ask again later.
      System.out.println("pending: " + pending.data().getStatus());
    }
  }
}

Kotlin

import com.getlingara.kotlin.LingaraClient
import com.getlingara.kotlin.model.StreamLessonPlanEvent

client.streamLessonPlan(planId).use { stream ->
    stream.collect { event ->
        when (event) {
            is StreamLessonPlanEvent.Result -> println(event.data.plan.title)
            // Still generating elsewhere: ask again later.
            is StreamLessonPlanEvent.Pending -> println("pending: ${event.data.status}")
            else -> Unit
        }
    }
}

Ruby

client.stream_lesson_plan(plan_id) do |event|
  case event
  in Lingara::StreamLessonPlanEventResult => result then puts "ready: #{result.data.plan.title}"
  in Lingara::StreamLessonPlanEventPending => pending then puts "still #{pending.data.status}, try again later"
  else nil
  end
end

PHP

use Lingara\Stream\StreamLessonPlanEvent;

foreach ($client->streamLessonPlan($planId) as $event) {
    if ($event instanceof StreamLessonPlanEvent\Result) {
        echo 'ready: ', $event->data->getPlan()->getTitle(), "\n";
    } elseif ($event instanceof StreamLessonPlanEvent\Pending) {
        echo 'still ', $event->data->getStatus()->value, ", try again later\n";
    }
}

想用函式庫?請參閱「函式庫」一節。

串流範例

event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}

如譯文與英文參考文件有出入,以英文參考文件為準。