Web SDK

@sorisdk/web-audio は、Webサービスやブラウザベースの製品にSORI音声認識を 組み込むためのブラウザSDKです。

Beta

Web SDK は現在 Beta 段階です。実装はまだ発展途上のため、一部の API や 連携フローは変更される可能性があります。

前提条件

• https:// または http://localhost などのsecure context
• AudioContext と MediaDevices.getUserMedia をサポートする最新ブラウザ
• SORIが提供するephemeral keyフローへのアクセス
• ユーザーが許可したマイク権限

連携フロー

1. appId を指定して AudioRecognizer を作成します。
2. ephemeralKey に文字列または独自のasync callbackとしてephemeral keyを渡します。
3. campaign、match、error など必要なイベントを購読します。
4. start() を呼んで認識を開始します。
5. 認識を止めるときやページ破棄時には stop() または destroy() を呼びます。

メイン API

AudioRecognizer は Web パートナー連携の基本 API です。認証 ブートストラップ、セッション管理、pack caching、マイク認識フローを内部的に 処理します。

最小例

import { AudioRecognizer } from "@sorisdk/web-audio";

const recognizer = new AudioRecognizer({
  appId: "YOUR_APP_ID",
  ephemeralKey: async () => {
    const response = await fetch("/api/ephemeral-key", {
      method: "POST"
    });

    if (!response.ok) {
      throw new Error(`Ephemeral key request failed: HTTP ${response.status}`);
    }

    const { ephemeral_key } = await response.json();
    return ephemeral_key;
  }
});

recognizer.on("campaign", (event) => {
  console.log(event.campaign);
});

await recognizer.start();

キー発行とrelayパターンは Ephemeral Key を 参照してください。

次のステップ

• セットアップ
• Ephemeral Key
• UI接続