v1からv2へのマイグレーション
CDNパス変更
diff
- <script src="https://web.sdk.klleon.io/1.3.0/klleon-chat.umd.js"></script>
+ <script src="https://klleon.k1.klleon.io/{VERSION}/klleon-sdk.umd.js"></script>グローバル変数変更
diff
- window.KlleonChat
+ window.KlleonSDKAPI変更事項
互換API（そのまま使用可能）
<avatar-container>、<chat-container>— 同一
init(option) の変更点
init() の呼び出し方法は同一ですが、オプションが変更されました。
| v1 オプション | v2 オプション | 備考 |
|---|---|---|
sdk_key | sdk_key | 同一 |
avatar_id | avatar_id | 同一 |
enable_microphone | enable_microphone | 同一 |
log_level | log_level | "silent" 追加 |
voice_code | — | 削除 |
subtitle_code | — | 削除。language に統合 |
| — | language | 新規。TTS音声 + 字幕言語を統合 ("ko_kr", "en_us", "ja_jp", "id_id") |
| — | auto_send | 新規。true でサーバーVAD自動応答 |
| — | stt_only | 新規。true でSTT結果のみ返却 |
削除されたAPI
| v1 | 代替方法 |
|---|---|
reconnect() | await destroy() → await init(options) |
changeAvatar(option) | 削除 |
wakeUpAvatar() | 削除 |
変更されたAPI（名前変更）
| v1 | v2 | 備考 |
|---|---|---|
onChatEvent(cb) | onSignal(cb) | すべてのサーバーシグナル受信 |
onStatusEvent(cb) | onStatus(cb) | |
onErrorEvent(cb) | onError(cb) | |
destroy() (sync) | await destroy() | async変更 |
sendTextMessage(text) | sendMessage(text) | |
echo(text) | speak(text) | |
startAudioEcho(audio) | sendSpeakAudio(audio) | |
endAudioEcho() | endSpeakAudio() | |
startStt() | startListening() | |
endStt() | endListening() | |
cancelStt() | cancelListening() | |
stopSpeech() | stopSpeaking() | |
clearMessageList() | clearMessages() |
新しいAPI
| API | 説明 |
|---|---|
setVolume(volume) | ボリューム制御（0-100） |
getStatus() | 現在のSDK状態照会 |
コード変更例
diff
// グローバル変数変更
- const SDK = window.KlleonChat;
+ const SDK = window.KlleonSDK;
// destroyがasyncに変更
- SDK.destroy();
+ await SDK.destroy();
// イベント名変更 + init前に登録
- SDK.onStatusEvent(cb);
+ SDK.onStatus(cb);
- SDK.onChatEvent(cb);
+ SDK.onSignal(cb);
- SDK.onErrorEvent(cb);
+ SDK.onError(cb);
await SDK.init(option);
// メソッド名変更
- SDK.sendTextMessage('こんにちは');
+ SDK.sendMessage('こんにちは');
- SDK.echo('繰り返すテキスト');
+ SDK.speak('繰り返すテキスト');
- SDK.startStt();
+ SDK.startListening();
- SDK.endStt();
+ SDK.endListening();
- SDK.stopSpeech();
+ SDK.stopSpeaking();注意事項
- v2はES2018+環境が必要です
- IE11はサポートされません
destroy()には必ずawaitを使用してください