オリジナルでデジタルヒューマンページを作る オリジナルでデジタルヒューマンページを作る

オリジナルでデジタルヒューマンページを作る

最終更新日:

始めるには

アプリの例 | Example App

uneeq-js NPM パッケージを使用して基本的な Web フロントエンドを作成する方法を示す Node アプリケーションの例をチェックしてください。

インストール | Install

npmを使ってインストールするには 

npm install uneeq-js

初期化 | Initialization 

デジタルヒューマンとの会話を開始するには、オプションパラメータを指定してUneeqクラスの新しいインスタンスを作成する必要があります。

let uneeq = new Uneeq(options);
uneeq.initWithToken(token);

initWithToken()メソッドで使用するトークンは、チャットボットプラットフォームがアクセストークンを要求したときに受け取るものです。

optionsパラメータは、UneeQプラットフォームが会話を開始するために必要な情報をすべて伝えます。このパラメータには、以下のプロパティを含める必要があります。

プロパティ 説明
conversationId 会話を開始したいペルソナを識別する ID です。
PersonaId は、UneeQ Creator の Personas エリアで確認できます。それ以外の場合は、カスタマーサクセスチームがこの ID を提供します。
48f0d553-f1ab-49c2-92d5-50328dad6041
url ペルソナがプロビジョニングされているUneeQプラットフォームのリージョンへのURLです。URL の一覧はこちらからご覧いただけます。 https://api.us.uneeq.io
avatarVideoContainerElement デジタルヒューマン動画が提示されるHTML Div要素。 document.getElementById('remoteVideo')
localVideoContainerElement ユーザーのローカルカメラが表示されるHTML Div要素。ユーザーのカメラを表示したくない場合は、ユーザーのカメラが表示されるHTML Div要素の値document.createElement('div') document.getElementById('localVideo')
messageHandler UneeQ プラットフォームからリアルタイムメッセージオブジェクトを処理するメソッド fmMessageHandler (a javascript method you have defined)
playWelcome ウェルカムメッセージを再生します。オプションのブール値。デフォルトはfalseです。 false
sendLocalVideo セッション開始時にユーザのローカルビデオストリーム(カメラ)を送信するかどうかを定義します。Boolean型。trueの場合、ユーザーは自分のデバイスの使用を許可する必要があります。デフォルト値はtrueです。 true
sendLocalAudio セッション開始時にユーザーのローカルオーディオストリーム(マイク)を送信するかどうかを定義します。trueの場合、ユーザーは自分のデバイスの使用を許可する必要があります。Boolean型。デフォルト値は true です。 true
const options = {
url: 'https://api.us.uneeq.io',
conversationId: 'YourPersonaId',
avatarVideoContainerElement: document.getElementById('your-div-element'),
localVideoContainerElement: document.getElementById('your-div-element'),
messageHandler: (msg) => messageHandler(msg),
playWelcome: false,
sendLocalVideo: false,
sendLocalAudio: true
};

リージョンURL | Region URLs

Digital Human セッションを初期化する際には、Digital Human がプロビジョニングされている URL を指定する必要があります。

UneeQ Creatorにアクセスできる場合は、開発者エリアのConnection URLで、正しいURLを見つけることができます。

https://creator.uneeq.io/developers



Digital Human がプロビジョニングされている地域がわからない場合は、カスタマーサクセスの担当者にお問い合わせください。

Region URL
North America https://api.us.uneeq.io
Europe https://api.eu.uneeq.io
Asia https://api.sg.uneeq.io
Oceania https://api.au.uneeq.io
Japan 現在準備中です。デジタルヒューマン株式会社までお問い合わせください。

 

音声送信 | Sending audio

JavaScript SDKを使用すると、顧客は「プッシュトゥトーク」対話モードを使用してデジタルヒューマンと話すことができます。

これは、ユーザーがデジタルヒューマンに話しかける間キーボードを押し続けることを意味します。

これを有効にするには、録音の最初と最後に、startRecording()メソッドとtopRecording()メソッドを呼び出す必要があります。

以下の例では、ユーザーがスペースバーを使用して話すことができます。

window.onkeydown = (e) => {
if( e.code === 'Space' && !e.repeat ) {
uneeq.startRecording();
}
};
window.onkeyup = (e) => {
if( e.code === 'Space' && !e.repeat ) {
uneeq.stopRecording();
}
};

 

会話のイベント | Conversation events

JavaScript SDKを使用すると、現在の会話に関するプラットフォームからのメッセージを購読する(subscribe)ことができます。

これらのメッセージを購読(subscribe)するには、Uneeqクラスをインスタンス化するときに、メソッド参照をパラメーターとして渡す必要があります。

let fmMessageHandler = (msg) => {
console.log('Uneeq Message: ', msg);
if( msg.uneeqMessageType === 'Ready' ) {
//The Digital Human is setup and streaming to the end user
} else if ( msg.uneeqMessageType === 'AvatarQuestionText' ) {
//Question asked of the Digital Human
} else if ( msg.uneeqMessageType === 'AvatarAnswer' ) {
//Response to the question, including meta data.
}
};

メッセージの特定のペイロードは、SDKリファレンスドキュメントで定義されています。

 

サポートブラウザ | Browser support

本SDKは、Windows 10とMacOS(High Sierra以降)でのChrome、MacOSでのSafariをサポートしています。また、Android(6.0以上)ではChrome、iOS(11以上)ではSafariをモバイルブラウザとしてサポートしています。


SDKのサポートするブラウザは、特に明記されていない限り、最新バージョンのOSで実行されている、最新バージョンのブラウザをサポートしています。

 

SDKリファレンス | SDK reference

SDKは最新版を参照してください

https://docs.uneeq.io/#/releaseNotes?id=sdk-reference

SDKリリースノート | SDKRelease Notes

Uneeq-jsに関連するリリースノートについては、以下を参照してください。

https://www.npmjs.com/package/uneeq-js