マイグレーションガイド

P2ではホステッドエクスペリエンスのパラメータやメソッド、イベントが変更されており、旧プラットフォームPlatform 1.0からPlatform 2.0への移行をサポートするためのガイドです。

設定オプション

主な変更点として下記があります。

スプリットスクリーンは廃止されました。

enableTransparentBackground はアルファチャネルを使用した処理や陰影の品質を高いレベルで維持することが技術的に困難なため、P2ではサポートしません。

cameraPosition は cameraAnchorHorizontal と cameraAnchorDistanceに変更され、カメラ位置の数値指定は未対応です。

SpeakAPIは事実上廃止され、フロントエンドからのuneeq.speak()リクエストに変わりました。互換性を維持するために、擬似的なP1互換のSpeakAPIを提供予定です。

デジタルヒューマンのユーザー体験を向上させるため、P2では各プロジェクトの要件に応じてデジタルヒューマンが存在する空間自体をカスタマイズできる様になることがロードマップで計画されています（プロフェッショナルサービスとして提供予定）。

Platform 1.0	Platform 2.0	移行状況
`リージョンURL`	`connectionUrl`	`リージョンURL`を廃止し`connectionUrl`で統一
`personaShareId`	`personaId`	`personaShareId` を廃止し`personaId` に統一
`layoutMode`	`layoutMode`	`splitScreen` を廃止し`overlay` `fullScreen` `contained`を継続サポート
`displayCallToAction`	`displayCallToAction`	変更なし
`position`	`-`	廃止
`renderContent`	`renderContent`	変更なし
`ctaThumbnailUrl`	`ctaThumbnailUrl`	変更なし
`cameraPosition`	`cameraAnchorHorizontal`	`cameraPosition`から`cameraAnchorHorizontal`に名称変更し、数値設定から下記に変更 `left` `right` `center`
`cameraPosition`	`cameraAnchorDistance`	`cameraPosition`から`cameraAnchorDistance`に名称変更し、数値設定から下記に変更 `close_up` `loose_close_up` `tight_medium_shot` `medium_shot` `medium_full_shot` `full_shot`
`customStyles`	`customStyles`	変更なし
`playWelcome`	`-`	廃止
`mobileViewWidthBreakpoint`	`mobileViewWidthBreakpoint`	変更なし
`backgroundImageUrl`	`-`	廃止アドミンパネルで設定する仕様に変更
`enableTransparentBackground`	`-`	廃止
`containedAutoLayout`	`containedAutoLayout`	変更なし
`logging`	`logLevel`	ログレベルを `error` `warn` `info` `debug` `trace` に指定出来るように変更
`enableMicrophone`	`enableMicrophone`	変更なし。セッション開始時のマイクアクセスを切り替え
`showUserInputInterface`	`showUserInputInterface`	変更なし
`customStyles`	`customStyles`	変更なし
`voiceInputMode`	`-`	`PUSH_TO_TALK` `VOICE_ACTIVITY` は廃止し`SPEECH_RECOGNITION` のみサポート。BYO STTを使用する場合はお客様にて独自実装してください。
`enableVad`	`enableVad`	変更なし
`enableInterruptBySpeech`	`enableInterruptBySpeech`	変更なし
`autoStart`	`autoStart`	変更なし
`showClosedCaptions`	`showClosedCaptions`	変更なし
`initLoadHandler`	`initLoadHandler`	変更なし
`speechToTextLocales`	`speechRecognitionLocales`	名称変更
`speechRecognitionHintPhrases`	`speechRecognitionHintPhrases`	変更なし
`speechRecognitionHintPhrasesBoost`	`speechRecognitionHintPhrasesBoost`	変更なし
`languageStrings`	`languageStrings`	変更なし
`-`	`captionsPosition`	新設
`-`	`welcomePrompt`	新設
`-`	`customMetadata`	新設

メソッド

Platform 2.0では、メソッドの呼び出し方法が大きく変更されます。従来のようにwindowオブジェクト（例：window.uneeqAskやuneeqAsk）を介したメソッド呼び出しは廃止され、代わりにUneeqクラスのインスタンスを生成し、そのインスタンスメソッドを通じて対話を行う方式が採用されます。

const uneeqInstance = new Uneeq(options)
uneeqInstance.init()

// ... later in the session
uneeqInstace.chatPrompt()

Platform 1.0	Platform 2.0	移行状況
`uneeqAsk`	`chatPrompt`	名称変更
`uneeqSetLayoutMode`	`setLayoutMode`	名称変更
`uneeqSetShowClosedCaptions`	`setShowClosedCaptions`	名称変更
`uneeqStartSession`	`startSession`	名称変更
`uneeqEnableMicrophone`	`enableMicrophone`	名称変更
`uneeqSetCallToActionText`	`-`	廃止
`uneeqOpenStartSessionPopup`	`-`	廃止
`uneeqEndSession`	`endSession`	名称変更
`uneeqStartRecording`	`-`	廃止 `resumeSpeechRecognition`を使用してください。
`uneeqStopRecording`	`-`	廃止 `pauseSpeechRecognition`を使用してください。
`uneeqPauseSpeechRecognition`	`pauseSpeechRecognition`	名称変更
`uneeqResumeSpeechRecognition`	`resumeSpeechRecognition`	名称変更
`uneeqSetShowUserInputInterface`	`setShowUserInputInterface`	名称変更
`uneeqStopSpeaking`	`stopSpeaking`	名称変更
`uneeqUnmuteDigitalHuman`	`unmuteDigitalHuman`	名称変更
`uneeqUpdateDisplayContent`	`updateDisplayContent`	名称変更
`uneeqSetCustomChatMetadata`	`setCustomChatMetadata`	名称変更
`uneeq.init`	`init`	名称変更

イベントハンドリング (draft)

Platform 1.0	Platform 2.0	移行状況
`ReadyToStart`	`FrameReady`	名称変更
`SessionStateUpdate`	`SessionStateUpdate`	変更なし
`LayoutModeUpdate`	`-`	廃止
`SessionId`	`-`	Platform 2.0では直接利用できません。`UneeQ Session Created with ID`で確認できます。
`AvatarAvailable`	`-`	廃止
`AvatarUnavailable`	`AvatarUnavailable`	変更なし
`AvatarQuestionText`	`-`	廃止 `PromptResult`を使用してください。
`AvatarAnswer`	`-`	廃止 `PromptResult`を使用してください。
`AvatarAnswerContent`	`AvatarAnswerContent`	変更なし
`CustomData`	`CustomData`	変更なし
`StartedSpeaking`	`AvatarStartedSpeaking`	名称変更
`FinishedSpeaking`	`AvatarStoppedSpeaking`	名称変更
`DeviceEnabled`	`-`	廃止
`RecordingStarted`	`RecordingStarted`	変更なし
`RecordingStopped`	`RecordingStopped`	変更なし
`DigitalHumanPlayedInMutedModeSuccess`	`DigitalHumanPlayedInMutedModeSuccess`	変更なし
`DigitalHumanUnmuted`	`DigitalHumanUnmuted`	変更なし
`DigitalHumanVideoError`	`DeviceError`	名称変更
`DigitalHumanFailedToPlay`	`-`	廃止
`ServiceUnavailable`	`ServiceUnavailable`	変更なし
`SpeechTranscription`	`SpeechTranscription`	変更なし
`CustomMetadataUpdated`	`CustomMetadataUpdated`	変更なし
`CallToActionDismissed`	`CallToActionDismissed`	変更なし
`DevicePermissionAllowed`	`EnableMicrophoneUpdated`	名称変更追加の機能を伴って更新されました。
`AvatarTextInputFinished`	`-`	廃止
`Instructions`	`Instructions`	廃止予定変更付きでまだ利用可能です。
`-`	`UserStartedSpeaking`	新設
`-`	`UserStoppedSpeaking`	新設
`SessionLive`	`SessionLive`	変更なし
`SessionEnded`	`SessionEnded`	変更なし
`-`	`PromptResult`	新設
`-`	`SessionError`	新設
`-`	`VadInterruptionAllowed`	新設
`-`	`SessionReconnecting`	新設
`-`	`SessionDisconnected`	新設
`-`	`Notification`	新設
`-`	`MicPermissionDenied`	新設
`-`	`PromptRequest`	新設
`-`	`SpeechEvent`	新設
`-`	`WaitingInQueue`	新設

インラインタグ

カメラ制御はインラインタグではなく、cameraAnchor(position, duration)メソッドへ変更されました。

	Platform 1.0	Platform 2.0	移行状況
アクション	○	○	発話文にタグを挿入（インラインタグ）して使用できます。
感情表現	○	○	発話文にタグを挿入（インラインタグ）して使用できます。
カメラ制御	○	メソッド	`cameraAnchor(position, duration)`メソッドへ変更されました。

マイグレーション ガイド

設定オプション

メソッド

イベントハンドリング (draft)

インラインタグ