一般的なチャットボットへのリクエスト例

DHプラットフォームからのリクエストパラメータ例

{
    "bot_id": "string",
    "api_key": "string",
    "session_id": "string",
    "question": "string",
    "stream": true,
}

パラメーター解説

他リクエストパラメーターとして渡せる値

• 言語

チャットボットからのレスポンス(streamなし)

streamを行わない場合のレスポンス

{
   "question": "string",
   "session_id": "string",
   "answer": "string",
   "metadata":"json string",
   "suggest":[{
           "label":"string1",
           "utterance":"string1"
       },
       {
           "label":"string2",
           "utterance":"string2"
       },
       {
           "label":"string3",
           "utterance":"string3"
       }],
}

パラメーター解説

チャットボットからのレスポンス(stream)

stream生成中

streamで生成中のレスポンス

{
    "chunk": "string"
    "text": "string",
    "final": false,
}

パラメーター解説

stream生成終了

streamで生成が終了したレスポンス

{
   "question": "string",
   "session_id": "string",
   "chunk": "string",
   "text": "string",
   "metadata": "json string",
   "suggest":[{
           "label": "string1",
           "utterance": "string1"
       },
       {
           "label": "string2",
           "utterance": "string2"
       },
       {
           "label": "string3",
           "utterance": "string3"
       }
   ],
   "final": true,
}

パラメーター解説

チャットボットの機能

起動時の回答設定

• 機能説明: 初回のセッション開始時に、設定された挨拶や案内メッセージを返す機能です。

• メリット:
1. デジタルヒューマン起動時に発話する文言を設定することができます。
2. ユーザーはすぐにチャットボットがどのように役立つかを理解しやすくなります。

サジェステッドレスポンス（クイックリプライ）機能

• 機能説明: ユーザーに選択肢を提示し、クリックで簡単に応答できる機能です。

• メリット:
1. デジタルヒューマンのUIで、クイックリプライを表示できる機能を利用可能になります。
2. ユーザーは、提示された選択肢から一つを選ぶだけで、次のステップに進むことができます。

• 補足: レスポンス例のsuggestに利用することが想定されます。表示文字・実際値の２つを設定できるとさらに幅が広がります。

拡張データ機能

• 機能説明: 回答のほかに、レスポンスに含めるデータをJSONサポートサイト形式で登録できる機能です。

• メリット:
1. デジタルヒューマンのUIで、コンテンツ表示を行うことが可能になります。
2. 会話に関連する画像やグラフ、動画などを表示することで、ユーザーの理解が深まります。

• 補足: レスポンス例のextensionsに利用されることが想定されます。

タグ装飾対応

多言語対応

• 機能説明: ユーザーの言語に合わせた言語で回答を生成する機能です。

• メリット:
1. デジタルヒューマンの音声認識優先言語選択・言語特定を利用した正確な言語を取得できます。
2. グローバルなユーザーに対応できます。

• 補足: リクエストパラメータとして、ユーザーの言語を渡すことが可能です。

state管理機能

• 機能説明: ユーザーの質問・回答やLLMの回答を特定の名前の変数として、保持する機能です。

• メリット:
1. ユーザーは一貫性のある会話を楽しむことができ、途中で情報が途切れることがありません。

state管理の拡張

• 品詞抽出

ユーザーの質問・回答から主となる品詞を抽出して、　stateに格納する機能。

画像認識機能

• 機能説明: ユーザーの質問とともに画像データをリクエストすることで、画像も認識した回答を生成する機能です。

• 補足: リクエストパラメータとして、ユーザーのWebカメラ画像を渡すことが可能です。

会話リセット機能

1. デジタルヒューマンのUIに会話をリセットするボタンがあります。ユーザーはボタンを押すことで会話をリセットすることが可能です。

応答拡張機能

• 機能説明: LLMが生成した特定の文字列を認識し、その内容をレスポンスに自動的に組み込む機能です。

• 例 : 「@suggest{リスト型のサジェスト}」という形式で生成されたサジェストを、レスポンスの「suggest」欄に登録します。

• メリット:
1. LLMのプロンプト次第で、動的サジェステッドレスポンス（クイックリプライ）・動的拡張データのような機構を作成できます。
2. LLMによる自動化の幅が大幅に増えます。