SDK Messages – ヘルプセンター | デジタルヒューマン

デジタルヒューマンが使用されている間、UneeqOptions => messageHandlerによって発信される管理用のメッセージが存在します。以下のドキュメントでは、これらのメッセージについて詳しく説明しています。

AvatarAnswerContentMessage

質問に対するアバターの回答（HTMLコンテンツ）です。

uneeqMessageType:"AvatarAnswerContent"

content:string

hasDisplayHtml = trueの場合、このコンテンツには、displayHTML命令で提供されるHTMLが含まれます。

hasDisplayHtml = falseの場合、このコンテンツには回答値が含まれます。

hasDisplayHtml:boolean

transcriptId:string

AvatarAnswer

質問に対するアバターの回答です。

uneeqMessageType:"AvatarAnswer"

answer:string

answerAvatar:string

answerSpeech:string

transcriptId:string

AvatarAvailable

アバターが利用可能です。

uneeqMessageType:"AvatarAvailable"

AvatarQuestion

ユーザーからの質問です。

uneeqMessageType:"AvatarQuestion"

question:any

transcriptId:any

AvatarRequestCompleted

アバターがテキストまたは命令要求の処理を完了しました。

uneeqMessageType:"AvatarRequestCompleted"

reason:string

AvatarRequestIgnored

アバターが発言要求を無視しました。

uneeqMessageType:"AvatarRequestIgnored"

reason:string

AvatarTextInputFinished

[終息予定・非推奨】アバターがメッセージを話し終えました。

※AvatarTextInputFinishedは非推奨ですので、FinishedSpeakingを使ってください。

uneeqMessageType:"AvatarTextInputFinished"

AvatarUnavailable

現在、アバターは利用できません。

uneeqMessageType:"AvatarUnavailable"

ClientMediaStreamUpdate

クライアント側とサーバー側の両方で、ステータスのストリーミング更新を提供します。

uneeqMessageType:"ClientMediaStreamUpdate"

clientStreamingAudio:boolean

clientStreamingVideo:boolean

serverStreamingVideo:boolean

serverStreamingAudio:boolean

ClientPerformanceMessage

これらの WebRTC 統計情報は、セッションの品質がクライアント側の条件によって影響を受けているかどうかを特定するのに役立ちます。

メッセージは 5 秒ごとに送信され、enableClientPerformanceMessage = true の場合、コンソールに表示されます。

uneeqMessageType:"ClientPerformanceMessage"

clientPerformance:ClientPerformanceStats

ConnectionLost

接続が切断されました。

uneeqMessageType:"ConnectionLost"

connectionState:PublishSubscribeState

CustomMetadataUpdated

uneeqMessageType: "CustomMetadataUpdated"

chatMetadata: string

DeviceError

ユーザー端末でエラーが発生しました。

uneeqMessageType:"DeviceError"

error:Error

DeviceListUpdated

デバイスリストが初めて変更されました、または検索されました。

uneeqMessageType:"DeviceListUpdated"

devices:Devices

DeviceNotFoundError

選択されたデバイスが見つかりません。

uneeqMessageType:"DeviceNotFoundError"

deviceId:string

msg:string

DevicePermissionAllowed

ユーザーがデバイスの使用を許可しています。

uneeqMessageType:"DevicePermissionAllowed"

DigitalHumanUnmuted

デジタルヒューマンのミュートが解除されました。セッション開始時にデジタルヒューマンがミュート解除状態で開始された場合も、このメッセージを受け取ります。

uneeqMessageType: "DigitalHumanUnmuted"

EnableMicrophoneUpdated

マイクの有効化状態が更新されました。有効化された値がtrueの場合、マイクが有効になりました。有効化された値がfalseの場合、マイクが解放されました。

uneeqMessageType: "EnableMicrophoneUpdated"

enabled: boolean

FinishedSpeaking

デジタルヒューマンがメッセージを話し終えました。

uneeqMessageType:"FinishedSpeaking"

Instructions

チャットボットやNLPからHTML拡張等の指示（Instructions）ペイロードが送信されました。一般的には指示はJSONでNLPの応答時のオプションに設定することができます。

uneeqMessageType:"Instructions"

instructions: NLPやチャットボットのJSONフィールドに設定された内容を含むJSON文字列化されたオブジェクトです。

MicActivityError

マイクのアクティビティメッセージでエラーが発生しました。

uneeqMessageType:"MicActivityError"

MicActivity

ユーザーマイクの操作により、メッセージを送信します。

uneeqMessageType:"MicActivity"

level:integer

MicActivityNotSupported

マイクアクティビティメッセージは、ユーザーのブラウザではサポートされていません。

uneeqMessageType:"MicActivityNotSupported"

OnlineStatusUpdate

クライアントのネットワーク状態が変更されました。

uneeqMessageType:"OnlineStatusUpdate"

online:boolean

Ready

サービスはすぐに利用可能です。

uneeqMessageType:"Ready"

RecordingStarted

ユーザーが録音を正常に開始しました。

uneeqMessageType:"RecordingStarted"

RecordingStopped

ユーザーが録音を正常に停止しました。

uneeqMessageType:"RecordingStopped"

ServiceUnavailable

サービス停止中

uneeqMessageType:"ServiceUnavailable"

error:any

SessionEnded

セッションは正常に終了しました。

uneeqMessageType:"SessionEnded"

SessionError

セッションエラーが発生しました。

uneeqMessageType:"SessionError"

error:string

SessionInfo

テストに使用されるセッション情報メッセージ。

uneeqMessageType:"SessionInfo"

info:string

SessionLive

セッションはライブで、アバタービデオはアクティブです。

uneeqMessageType:"SessionLive"

SessionPaused

セッションの一時停止に成功しました。

uneeqMessageType:"SessionPaused"

SessionResumed

セッションは正常に再開されました。

uneeqMessageType:"SessionResumed"

SetCameraSuccess

ユーザーカメラが正常に設定されました。

uneeqMessageType:"SetCameraSuccess"

deviceId:string

SetMicSuccess

ユーザーマイクが正常に設定されました。

uneeqMessageType:"SetMicSuccess"

deviceId:string

SetSpeakerSuccess

ユーザースピーカーの設定に成功しました。

uneeqMessageType:"SetSpeakerSuccess"

deviceId:string

StartedSpeaking

デジタルヒューマンがメッセージを語り始めました。

uneeqMessageType:"StartedSpeaking"

SessionError

セッションでエラーが発生しました。提供されたメッセージを参照してください。

uneeqMessageType: "SessionError"

error: string

SpeechTranscription

音声認識した結果を返します。

uneeqMessageType: "SpeechTranscription"

speechTranscription: SpeechTranscriptionResult

SpeechTranscriptionResult {
    confidence: number; // 認識結果の信頼値: 0から1の間の値
    final: boolean; // 音声認識の完了結果か、中間結果を表示
    language_code: string; // ユーザーが話し、認識した言語（ロケール）
    transcript: string; // 音声認識 結果
}

UserStartedSpeaking

SPEECH_RECOGNITION を使用している場合、このメッセージはユーザーが話し始めたことを示します。

uneeqMessageType: "UserStartedSpeaking"

UserStoppedSpeaking

SPEECH_RECOGNITION を使用している場合、このメッセージはユーザーが発話を停止したことを示します。

uneeqMessageType: "UserStoppedSpeaking"

Warning

一般的な警告メッセージです。

uneeqMessageType:"Warning"

msg:string

WebRtcData

WebRTC データチャネルメッセージ。

uneeqMessageType:"WebRtcData"

data:any

WebRtcData

WebRTCのstatsメッセージ（診断）。

uneeqMessageType:"WebRtcStats"

stats:any