串流

呢頁係由英文翻譯過嚟嘅。如果兩個版本有出入，以英文頁為準。睇英文頁

有四個操作會用伺服器推送事件嘅形式串流返結果：產生詞彙、傳送導師訊息、建立課程計畫，同埋跟進課程計畫。每個函式庫都會將事件串流變成嗰種語言自己嘅迭代器，並將每個事件解碼成有型別嘅值先交畀你。

串流點樣完

做完嘢嗰陣。 迭代去到串流最後一個事件就會自己停。如果係課程計畫，最後嗰個事件帶住結果，所以你會喺個迴圈完之前收到佢。
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";
    }
}

串流

串流點樣完

永遠唔會重播

呢頁包裝咗乜嘢