LiteRT-LM Web API

ブラウザの JavaScript と TypeScript 用の LiteRT-LM の Web API。これは、WebGPU で実行されるテキスト入力 / テキスト出力をサポートする早期プレビューです。

はじめに

JavaScript API で構築された REPL チャットアプリのサンプルを次に示します。

<div id="out" style="white-space: pre-wrap; font-family: monospace;"></div>
<input id="in" onkeydown="if(event.key === 'Enter') repl(this)">

<script type="module">
  import { Engine } from 'https://cdn.jsdelivr.net/npm/@litert-lm/core/+esm';
  const engine = await Engine.create({ model: '/path/to/model.litertlm' });
  const chat = await engine.createConversation();

  window.repl = async (el) => {
    const text = el.value;
    el.value = ''; // Clear immediately
    out.append(`\n>>> ${text}\nAI: `);

    for await (const chunk of chat.sendMessageStreaming(text)) {
      out.append(chunk.content[0].text);
    }
  };
</script>

スタートガイド

LiteRT-LM は npm パッケージとして提供されています。最新バージョンは npm からインストールするか、CDN から直接インポートできます。

# From npm
npm i --save @litert-lm/core

# From a CDN (in your JavaScript file)
import * as litertlm from 'https://cdn.jsdelivr.net/npm/@litert-lm/core/+esm';

Engine を初期化する

Engine は、API のエントリ ポイントです。モデルの読み込み、セッションの作成、リソース管理を処理します。モデルが不要になったら、リソースを解放するためにエンジンを delete することを忘れないでください。

注: エンジンを初期化すると、モデルの読み込みに数秒かかることがあります。

import {Engine, EngineSettings} from '@litert-lm/core';

const engineSettings = {
  model: 'url/path/to/model.litertlm', // or a ReadableStream, or a Blob
} satisfies EngineSettings;

const engine = await Engine.create(engineSettings);

// ... Use the engine to create a conversation ...

// Delete the engine when done.
await engine.delete();

会話を作成する

エンジンを初期化したら、Conversation インスタンスを作成します。ConversationConfig を指定して、その動作をカスタマイズできます。

const conversation = await engine.createConversation({
  preface: {
    messages: [
      {role: 'system', content: 'You are a helpful assistant'}
    ]
  }
});

conversation.sendMessage({
  role: 'user',
  content: 'Write a poem',
});

メッセージの送信

ストリーミングの有無にかかわらずメッセージを送信できます。

非ストリーミングの例

// Simple string input
let response = await conversation.sendMessage("What is the capital of France?");
console.log(response.content[0].text);

// Or with full message structure
response = await conversation.sendMessage({role: 'user', content: '...'});

ストリーミングの例

// sendMessageStreaming returns a ReadableStream of response chunks
const stream = conversation.sendMessageStreaming('Tell me a long story.');

for await (const chunk of stream) {
  // Chunks are Records containing pieces of the response
  for (const item of chunk.content) {
    if (item.type === 'text') {
      console.log(item.text);
    }
  }
}

生成をキャンセル

進行中の生成を明示的にキャンセルするには、Conversation インスタンスで cancel() を呼び出します。

// Cancel any ongoing generation
conversation.cancel();

レスポンスをストリーミングしている場合、for await...of ループを早期に終了（break などを使用）すると、進行中の生成も自動的にキャンセルされます。

for await (const chunk of stream) {
  if (shouldStop()) {
    break; // Cancels the stream and underlying generation
  }
}