Dialogflow Messenger JavaScript

Dialogflow Messenger は、関数を呼び出してその動作に影響を与えます。

`renderCustomText`

この関数は、単純なテキストレスポンスとしてエージェントから送られたものであるか、またはエンドユーザーによって入力されたものであるかのように、単純なテキストメッセージをレンダリングします。

引数:

string: テキストメッセージ
boolean: エージェントからのメッセージの場合は true、エンドユーザーからの場合は false

戻り値:

void

次に例を示します。

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.renderCustomText('Custom text', true);

`renderCustomCard`

この関数は、Dialogflow フルフィルメントから受け取ったものであるかのように、カスタムカードをレンダリングします。

引数:

payload: フルフィルメントセクションで定義されるカスタムペイロードレスポンスのリスト。

戻り値:

void

次に例を示します。

const dfMessenger = document.querySelector('df-messenger');
const payload = [
  {
    "type": "info",
    "title": "Info item title",
    "subtitle": "Info item subtitle",
    "image": {
      "rawUrl": "https://example.com/images/logo.png"
    },
    "anchor": {
      "href": "https://example.com",
      "target": "_blank"
    }
  }
];
dfMessenger.renderCustomCard(payload);

`sendQuery`

この関数は、Dialogflow API にクエリを送信し、レスポンスを待ちます。これにより、通常はエージェントダイアログに表示されるエンドユーザー入力がシミュレートされます。レスポンスは、エンドユーザーのクエリと同様に処理されます。

引数:

string: テキストクエリ

戻り値:

Promise<void>: 非同期オペレーションの戻り値

次に例を示します。

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendQuery('Describe shipping costs.');

`sendRequest`

この関数は、Dialogflow API にリクエストを送信し、レスポンスを待ちます。

引数:

string: リクエストタイプ。query（上記 sendQuery もご覧ください）および event（カスタムイベントをご覧ください）をサポートします
any: リクエストタイプに対応するペイロード。現在、サポートされている両方のリクエストタイプの文字列です

戻り値:

Promise<void>: 非同期オペレーションの戻り値

例:

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.sendRequest('query', 'Describe shipping costs.');

`setQueryParameters`

この関数は、Dialogflow API detectIntent リクエストの queryParams フィールドにデフォルト値を設定します。Dialogflow Messenger のその他のメソッドでは、クエリパラメータのそれぞれのデフォルト値が置き換えられる場合があります。

引数:

object: JSON データクエリパラメータのスキーマについては、QueryParameters をご覧ください。

戻り値:

void

例:

const dfMessenger = document.querySelector('df-messenger');
const queryParameters = {
  parameters: {
  timeZone: "America/New_York"
  }
};
dfMessenger.setQueryParameters(queryParameters);

`setContext`

この関数は、エンドユーザーに関する生成のパーソナライズを Dialogflow に送信します。この情報は、セッションの残りの期間で維持されます。

引数:

object: JSON データ。生成パーソナライズに関するドキュメントをご覧ください。

戻り値:

void

次に例を示します。

const dfMessenger = document.querySelector('df-messenger');
const metadata = {
  "subscription plan": "Business Premium Plus",
  "devices owned": [
    {
      model: "Google Pixel 7",
    },
    {
      model: "Google Pixel Tablet",
    },
  ],
};
dfMessenger.setContext(metadata);

`clearStorage`

この関数は、エージェントダイアログの永続ストレージを消去します。また、エージェントダイアログの現在の状態もクリアされます。

引数:

なし

戻り値:

void

例:

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearStorage();

`clearAuthentication`

この関数は、エージェントダイアログの認証をクリアします。

引数:

なし

戻り値:

void

例:

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.clearAuthentication();

startNewSession

この関数は、エージェントダイアログ内で新しいセッションを開始します。現在のメッセージ履歴は保持またはリセットできます。ユーザー認証はクリアされません。

引数:

名前	型	説明
`args`	`object?`	新しいセッションの作成を構成するための引数（省略可）。
`args.retainHistory`	`boolean?`	履歴を保持するオプションのフラグ。true に設定すると、履歴が保持されます。それ以外の場合は消去されます。

戻り値:

void

例:

const dfMessenger = document.querySelector('df-messenger');
dfMessenger.startNewSession({ retainHistory: true });

openChat

この関数はチャットを開始します。df-messenger-chat-bubble 要素でこの関数を呼び出してチャットを開始します。チャットがすでに開始されている場合は何もしません。

引数:

なし

戻り値:

void

次に例を示します。

const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.openChat();

closeChat

この関数はチャットを終了します。df-messenger-chat-bubble 要素でこの関数を呼び出してチャットを終了します。チャットがすでに終了されている場合は何もしません。

引数:

なし

戻り値:

void

次に例を示します。

const dfMessengerBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerBubble.closeChat();

openMinChat

Dialogflow Messenger でチャットを最小化

この関数は、最小化されたバージョンのチャットウィンドウを開きます。df-messenger-chat-bubble 要素でこの関数を呼び出して最小化されたチャットを開始します。チャットがすでに最小化されている場合は何もしません。

引数:

名前	型	説明
args	オブジェクト？	最小化されたチャットを構成する省略可能な引数
args.anchor	文字列?	省略可の `anchor`。最小化されたチャットを開始する場所を構成します。チャットのふきだし要素の `anchor` 属性と同じロジック。デフォルトは `left-top` です。
args.showActorImages	ブール値？	アクターの画像を表示するオプションのフラグ（`df-messenger-chat-bubble` 要素で指定された場合）。デフォルトは false です。

例:

const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.openMinChat({
  anchor: 'top-left'
});

`closeMinChat`

最小化されたチャットを終了します。df-messenger-chat-bubble 要素でこの関数を呼び出してチャットを終了します。チャットがすでに終了されている場合は何もしません。

例:

const dfMessengerChatBubble = document.querySelector('df-messenger-chat-bubble');
dfMessengerChatBubble.closeMinChat();