流式传输

本页译自英文。如两者有出入，以英文页面为准。阅读英文页面

有四个操作以服务器发送事件的形式流式返回结果：生成词汇、发送导师消息、创建课程计划以及跟进课程计划。每个库都会把事件流转换为该语言自身的迭代器，并把每个事件解码成带类型的值再交给你。

流如何结束

工作完成时。 迭代会在流的最后一个事件处自动停止。对于课程计划，最后一个事件携带结果，所以你会在循环结束之前收到它。
API 报告错误时。 在流中到达的错误会作为 API 错误抛出，与在流开始之前到达的错误类型相同。
连接失败时。 在最后一个事件之前就结束的流，或者 120 秒内什么都没发送的流，会作为传输错误抛出。
你主动停止时。 用你所用语言的常规方式取消调用，或者停止读取，连接就会立即关闭。

保活注释以及库尚不认识的事件类型都会被跳过，所以更新的 API 永远不会破坏旧版本的库。

绝不重放

已经送出过哪怕一个事件的流，库永远不会重试，因为重复它可能让你的额度被扣两次。如果课程计划的流在开始后中断，请用 streamLessonPlan 和它第一个事件中的 plan_id 跟进同一个计划。

TypeScriptRustGoJavaKotlinRubyPHP

TypeScript

const stream = client.generateVocabulary({ level: 2, source_lang: "en", target_lang: "zh", count: 8 });
for await (const ev of stream) {
  if (ev.event === "item") console.log(ev.data.word, ev.data.translation);
}

Rust

use lingara::models::{GenerateVocabularyEvent, VocabRequest};
use std::num::NonZeroU8;

let request = VocabRequest { level: 2, source_lang: "en".into(), target_lang: "zh".into(), count: NonZeroU8::new(8) };
let mut stream = client.generate_vocabulary(&request).await?;
while let Some(event) = stream.next().await {
    if let GenerateVocabularyEvent::Item(item) = event? {
        println!("{} {}", item.word, item.translation);
    }
}

count := uint8(8)
s, err := client.GenerateVocabulary(ctx, lingara.VocabRequest{Level: 2, SourceLang: "en", TargetLang: "zh", Count: &count})
if err != nil {
	return err
}
defer s.Close()
for ev, err := range s.Events() {
	if err != nil {
		return err
	}
	if item, ok := ev.(lingara.GenerateVocabularyEventItem); ok {
		fmt.Println(item.Data.Word, item.Data.Translation)
	}
}

Java

import com.getlingara.client.model.GenerateVocabularyEvent;
import com.getlingara.client.model.VocabRequest;

VocabRequest request = new VocabRequest().level(2).sourceLang("en").targetLang("zh").count(8);
try (EventStream<GenerateVocabularyEvent> stream = client.generateVocabulary(request)) {
  for (GenerateVocabularyEvent event : stream) {
    if (event instanceof GenerateVocabularyEvent.Item item) {
      System.out.println(item.data().getWord() + " " + item.data().getTranslation());
    }
  }
}

Kotlin

import com.getlingara.kotlin.LingaraClient
import com.getlingara.kotlin.model.GenerateVocabularyEvent
import com.getlingara.kotlin.model.VocabRequest

val request = VocabRequest(level = 2, sourceLang = "en", targetLang = "zh", count = 8)
// The request is sent here; collect the stream once, inside use {}.
client.generateVocabulary(request).use { stream ->
    stream.collect { event ->
        when (event) {
            is GenerateVocabularyEvent.Item -> println("${event.data.word} ${event.data.translation}")
            is GenerateVocabularyEvent.Started -> Unit
        }
    }
}

Ruby

client.generate_vocabulary(level: 2, source_lang: "en", target_lang: "zh", count: 8) do |event|
  case event
  in Lingara::GenerateVocabularyEventItem => item then puts "#{item.data.word}: #{item.data.translation}"
  else nil
  end
end

PHP

use Lingara\Model\VocabRequest;
use Lingara\Stream\GenerateVocabularyEvent;

$request = new VocabRequest(['level' => 2, 'source_lang' => 'en', 'target_lang' => 'zh', 'count' => 8]);
foreach ($client->generateVocabulary($request) as $event) {
    if ($event instanceof GenerateVocabularyEvent\Item) {
        echo $event->data->getWord(), ': ', $event->data->getTranslation(), "\n";
    }
}

流式传输

流如何结束

绝不重放

本页封装的内容