カスタムメタデータ：フロントエンドと会話AI間で情報をやり取りする

カスタムメタデータを送信する

ホステッドエクスペリエンスのcustomMetadataまたはuneeqInstance.customPromptMetadata()を使用すると、設定されたデータはユーザー発話時に対話AIに送信され、ログインユーザの識別や、応答を生成する際に使用することができます。

下記はDifyを例にして説明していますが、miiboでも同様に利用できます。

customMetadata

customMetadata

customPromptMetadata()

customPromptMetadata()

1. フロントエンド ホステッドエクスペリエンスコードスニペットのuneeqOptions.customMetadata にパラメータを設定する。 もしくは、uneeqInstance.customPromptMetadata()を使用してカスタムデータを動的に設定する。

2.接続するDify ChatBotのStartノード入力フィールドで、customMetadataやcustomPromptMetadata()に登録したパラメータと同名の入力フィールドを設定して変数として定義する。

miiboはStateに登録されるため、自動的に受け取ることができます。 ※ 必須の✓は運用にあわせてください。

3.変数をプロンプトや処理に埋め込んで使用する。

以上でカスタムメタデータの受け渡しが完了しました。変数を使用することで、ユーザーのIDや属性などを使用した　動的な制御が可能になります。

カスタムメタデータを更新する

会話AIからフロントエンドへカスタムメタデータを送信するには、instructions.customMetadata にキーと値のペア（例：{'test':'true'}）を指定します。これにより、uneeqInstance.setCustomPromptMetadata が自動的に動作し、カスタムメタデータが更新されます。

この方法でカスタムメタデータを登録した場合、既存のカスタムメタデータは消えず、新しいメタデータが追加される動きになります。もし、同じキーの値が既に存在する場合には、その値が上書きされます。

{
    "instructions": {
        "customMetadata": {
            "test": "true"
        }
    }
}

カスタムメタデータを送信直後の動作

"test": "true"を会話AIからフロントエンドへ送信して更新すると左図の様なログが出力され、カスタムメタデータが更新されます。ユーザーの発話・リクエストが行われると、customMetadata に "test": "true"が値で入って会話AIへ届けられます。

更新されたカスタムメタデータは、UneeQイベントのCustomMetadataUpdateイベントで取得できます。

イベントの取得方法

イベントの取得方法については イベント をご覧下さい。また、本件には直接関係ありませんが、 スピーチイベント：発話のタイミングにあわせてイベントを発生させる もあわせてご覧下さい。