ログの確認方法、ログイベント一覧、セッションIDの取得 – ヘルプセンター

デジタルヒューマンを設定していたり、運用しているとフロントエンド（UI）でどのような事が発生しているのか、あるいはNLPからのメッセージをどの様に受け取っているのかを確認したい場合があります。

ここでは、Chromeを例にしてログの確認方法と、表示されているイベントの一覧を説明します。SafariやFirefox、その他のブラウザでも基本は同じです。

ログの確認

1. Javascriptコンソールを開く

Macの場合 ( Cmd+Opt+J ) Google Chromeのメニューから「表示」>「開発/管理」>「デベロッパーツール」を選択して起動し、Javascriptコンソールを開きます。

Windowsの場合 ( Ctrl+Shift+I ) Google Chromeの右上のメニューから「Google Chromeの設定」>「その他のツール」>「デベロッパーツール」を選択して起動し、Javascriptコンソールを開きます。

2. Javascriptコンソールからイベントを確認する

デジタルヒューマンのページを開くと様々なイベントがJavascriptコンソールに出力されています。イベントは主に下記のようなものがあります。

Javascriptコンソールに出力されるメッセージ	説明
ReadyToStart	アプリケーションがロードされ、設定が検証されました。セッションは、`uneeqStartSession()`を呼び出すことで開始することができます。
SessionStateUpdate	セッションの状態が更新されました
LayoutModeUpdate	レイアウトモードが更新されました
SessionId	デジタルヒューマンのセッションID
AvatarAvailable	少なくとも1人のデジタルヒューマンを起動することができます
AvatarUnavailable	起動可能なデジタルヒューマンがいません
AvatarQuestionText	デジタルヒューマンに質問された文字列
AvatarAnswer	デジタルヒューマンからの回答
AvatarAnswerContent	NLPシステムからレンダリングされるコンテンツが提供されました
CustomData	NLPシステムから'instruction'フィールドに提供されたJSONデータ。このデータは、NLPシステムからあなたのフロントエンドアプリケーションにカスタム命令を渡すために使用することができます。例えば、Webサイトに表示したい商品のcustomDataをいくつか設定することができます。
StartedSpeaking	デジタルヒューマンが話し始めました
FinishedSpeaking	デジタルヒューマンからの話が終わりました
DeviceEnabled	ユーザーから録音機器の使用が許可されました
RecordingStarted	音声認識のための録音が開始されました
RecordingStopped	音声認識のための録音が終了しました
DigitalHumanPlayedInMutedModeSuccess	ブラウザの自動再生ポリシーにより、デジタルヒューマンの音声を再生することができませんでした。デジタルヒューマンは、音声がミュートされた状態で起動しました。ユーザークリック・キーイベントの後に`uneeqUnmuteDigitalHuman()`を呼び出すと、デジタルヒューマンのミュートが解除される場合があります。
DigitalHumanVideoError	デジタルヒューマンのビデオでエラーが発生しました。詳細はメッセージの内容を参照してください。
DigitalHumanFailedToPlay	デジタルヒューマンのビデオは何らかの理由で再生できませんでした。おそらく、ブラウザの自動再生ポリシーによってブロックされています（音声を再生しようとする前に、ユーザーがページとインタラクトしていない）。
DigitalHumanUnmuted	デジタルヒューマンのミュートが解除されました
DevicePermissionAllowed	[非推奨・廃止予定]
AvatarTextInputFinished	[非推奨・廃止予定]
Instructions	[非推奨・廃止予定]

SDKが出力するメッセージ

SDK Messages

ホステッドエクスペリエンスでログが取得できない

セキュリティー対策のため、デフォルトでは詳細なログを出力しません。下記のコードをデジタルヒューマンが表示されているページに埋め込んでいただくと詳細なログを取得可能です。

# ホステッドエクスペリエンスで詳細なログを出力する

<script>
    window.addEventListener('UneeqMessage', (event) => {
        const msg = event.detail;
        console.log('UneeQ Message: ', msg);

    })
</script>

セッションIDを確認するには？

デジタルヒューマンのプラットフォームは同時接続が可能です。その際、全ての接続に対してセッションIDが付与されています。サポートを行う際に、セッションIDが必要になる場合があります。

1.JavaScriptコンソールを開くの手順でコンソールを表示します。

2.コンソールが開いたら、UUID形式のUneeQ Session ID:を探してください。（緑枠の様に、他のセッションIDも存在します）

フロントエンド以外のその他ログを確認するには？

音声合成のログやその他色々なログを取得したい場合があります。その場合は、デジタルヒューマンプラットフォームとチャットボットを接続しているオーケストレーションレイヤーでもログを取得することが可能です。

利用形態によって構成は様々ですので、詳しくは担当のカスタマーサクセス等へお問い合わせくださいください。