強制発話:SpeakAPI(スピークAPI)

SpeakAPI(スピークAPI)はデジタルヒューマンを非同期(ユーザーからのリクエストなしに)で喋らせたいときに利用できます。下記のAPI経由あてに発話させたい文字列をPOSTしてください。

circle-exclamation
<link rel="stylesheet" href="https://hosted-experience.jp/css/dhx.css">

<script>
      window.dhxOptions = {
            "personaIdentifier": 'デジタルヒューマン株式会社から提供',
            "uneeq": uneeq
        }
</script>

<script src="https://hosted-experience.jp/js/dhx.js"></script>
circle-exclamation

メソッド

POST

/api/v1/{uuid}/speak

エンドポイント

デジタルヒューマンが稼働するプラットフォームによって変わります。DIP上か担当に確認してください。

URL(Connection BaseUrl)
パス

https://{DIP上のペルソナの情報か、担当に確認してください}

/api/v1/{uuid}/speak

リクエストパラメータ

キー
必須
備考

uuid

DHKKが発行した識別子(persona Identifier

デジタルヒューマン株式会社から提供しない限り確認する方法はありません。

POSTデータ(JSON形式)

キー
必須
備考

session_id

アバターのセッションID

speak_text

発話させたい文字列

プレーンな発話文字列に追加して、SynAnim (シンアニム) - シンセティック アニメーションエンジン の制御タグやSSMLが利用可能です。

instructions

インストラクション

任意、JSON文字列をセットしてください。ただしフロントエンドの種類によって異なります。 ・ ホステッドエクスペリエンスの場合

レスポンス(JSON形式)

キー
備考

result

success または error

speak_text

DHKK内で処理が行われた後の発話リクエスト文字列

後続の処理で整形、SSMLアクションタグ等が付与される場合があります。最終的な処理された文字列はフロントエンドのJavaScriptコンソールに表示されるログをご確認ください。

metadata

DHKK内で処理が行われた後の発話リクエストメタデータ

type

resultがerrorの場合にエラーの原因を特定する値。

以下のエラーが存在します。 - PersonaNotFoundError : 指定したpersonaIdentifierのペルソナが存在しません。 - PersonaSuspendError : ペルソナがサスペンドされています。 - SessionNotLiveError : 指定したsession_idと接続できません。 - SpeakQueryError : Bodyの内容に誤りがあります。

detail

resultがerrorの場合にエラーの詳細を特定する値。

Crulサンプル

セキュリティについて

このAPIはフロントエンドアプリからではなく、常にバックエンドサービスからリクエストしてください。フロントエンドから制御したい場合はホステッドエクスペリエンスのメソッドを使用してください。

最終更新