Riconnettiti a un piano di lezione

Parametri

Lingara-Versionheaderstringfacoltativo

La versione dell'API con cui rispondere a questa richiesta. Senza di essa, un token di accesso riceve la versione a cui è associato il suo client e una richiesta senza token riceve la versione corrente. La versione ancora in sviluppo si raggiunge solo indicandola qui. Una versione sconosciuta risponde 400 con il codice api_version_unknown. GET /v1/versions elenca le versioni.

idpathstringobbligatorio

Risposte

200 L'avanzamento restante del piano, poi il piano

Eventi dello stream text/event-stream

Invia un commento keepalive ogni 15 secondi.

started PlanStarted

plan_idstringobbligatorio

phase PlanPhase

phasestringobbligatorio

attemptintegerobbligatorio

result PlanResult Termina lo stream

planLessonPlanobbligatorio

idstringobbligatorio

statusPlanStatusobbligatorio

titlestring | nullfacoltativo

source_langstringobbligatorio

target_langstringobbligatorio

levelintegerobbligatorio

created_atstringobbligatorio

completed_atstring | nullfacoltativo

ai_generatedbooleanobbligatorio

contentLessonPlanContent | nullfacoltativo

introductionstring | nullfacoltativo

learning_objectivesarray of stringobbligatorio

vocabularyarray of PlanWordobbligatorio

wordstringobbligatorio

pronunciationstring | nullfacoltativo

translationstringobbligatorio

setsarray of PlanSetobbligatorio

numberintegerobbligatorio

contextstring | nullfacoltativo

questionsarray of PlanQuestionobbligatorio

typestringobbligatorio

promptstringobbligatorio

optionsarray of string | nullfacoltativo

answerstringobbligatorio

explanationstringobbligatorio

hintstring | nullfacoltativo

pending PlanPending Termina lo stream

plan_idstringobbligatorio

statusPlanStatusobbligatorio

error StreamError Termina lo stream

Arriva all'interno della risposta 200. La riga di stato è già stata inviata, quindi un errore dopo l'apertura dello stream viene segnalato come questo evento.

codestringobbligatorio

messagestringobbligatorio

plan_idstring | nullfacoltativo

Errori

410application/json

La versione dell'API con cui si risponde a questa richiesta è stata dismessa. Invia una versione supportata in Lingara-Version, oppure associa il client a un'altra versione.

4XXapplication/json

La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.

503application/json · text/plain

Il servizio è temporaneamente non disponibile; riprova dopo il numero di secondi indicato in Retry-After. Durante la manutenzione il corpo è testo semplice anziché l'envelope di errore.

5XXapplication/json

La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.

codestringobbligatorio

Perché la richiesta è stata rifiutata, come codice stabile su cui diramare la logica: per esempio insufficient_scope (403), rate_limited (429) e, per un client con fatturazione a consumo, spend_cap_reached (402) e metered_billing_inactive (402).

errorstringobbligatorio

Esempio

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

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");
}

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),
        _ => {}
    }
}

// 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")
	}
}

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());
    }
  }
}

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
        }
    }
}

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

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";
    }
}

Preferisci una libreria? Vedi la sezione Librerie.

Esempio di stream

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