ライフサイクルメソッド

init

SDK を初期化し、ソケットとストリーミングを接続します。

window.KlleonChat.init({
  sdk_key: "your sdk key",
  avatar_id: "your avatar id",
  subtitle_code: 'ko_kr',
  voice_code: 'ko_kr',
  voice_tts_speech_speed: 1.0,
  enable_microphone: true
  log_level: 'debug'
  user_key: 'your user key'
});

パラメータ	型	必須	デフォルト値	説明
sdk_key	string	O	-	SDK キーを指定します。
avatar_id	string	O	-	使用するアバター ID を指定します。
subtitle_code	string	X	ko_kr	アバターが発話するテキストの言語を調整します。 ko_kr: 韓国語 en_us: 英語 ja_jp: 日本語 id_id: インドネシア語
voice_code	string	X	ko_kr	アバターが発話する音声の言語を調整します。 ko_kr: 韓国語 en_us: 英語 ja_jp: 日本語 id_id: インドネシア語
voice_tts_speech_speed	number	X	1.0	アバターの発話速度を調整します。 範囲: (0.5 ~ 2.0)
enable_microphone	boolean	X	true	ブラウザのマイク許可なしで接続します。
log_level	string	X	debug	SDK ログのレベルを設定します。 debug: debug レベル以上のログを出力。 info: info レベル以上のログを出力。 warn: 警告レベル以上のログを出力。 error: エラーレベルのみ出力。 silent: ログを出力しません。
user_key	string	X	-	endUser作成APIを通じて生成されたキー値をマッピングします。 このキー値には、endUserキーと有効期限のタイムスタンプが含まれます。

user_key 発行

API 情報

request url	method	description
https://saas.klleon.io/api/v1/app/end-user	POST	エンドユーザー作成API

説明

エンドユーザー作成APIは、アプリケーションのapiKeyを使用してendUserを作成するAPIです。 デジタルヒューマンにアクセスするエンドユーザーをWASが認証した後、WASがエンドユーザー作成APIを呼び出します。 WASは有効期限を秒単位で指定し、レスポンスにはendUserキーと有効期限のタイムスタンプが含まれます。

要求

1. Headers

該当アプリケーションのapiKeyは、リクエストヘッダーでx-api-keyというキーとして提供される必要があります。 apiKeyはサービスクライアントに公開されないように秘密に保持する必要があります。 x-api-keyの発行については、別途お問い合わせ（[e-mail]）にて対応可能です。

name	type	required	description
x-api-key	string	O	アプリケーションのapiKeyを使用した認証方式

1. Request Body

field	type	required	description
duration	number	O	有効期限（秒単位）

1. 例

// request

curl --location 'https://saas.klleon.io/api/v1/app/end-user' \
--header 'x-api-key: d/LMMMThvOxszvfWZxdXDweXz2TsefaegggBI8=' \
--header 'Content-Type: application/json' \
--data '{
    "duration" : 120
}'

// response

{
    "data": {
        "userKey": "USER-FebxNRyFi1BSZDnXCDwa",
        "expiredAt": "2024-12-09T02:16:37.778977274"
    },
    "success": true
}

---

destroy

SDK を破棄し、登録されているすべてのイベントリスナーを削除し、現在のセッションを切断します。

window.KlleonChat.destroy();