Dialogflow Webhook 形式 {:#dialogflow-webhook-format}（Dialogflow）

ここでは、Actions on Google が Dialogflow v2 を通じてフルフィルメントを呼び出すときの JSON ペイロードの形式について説明します。

Dialogflow を使用してアクションを作成している場合、フルフィルメントは、Actions on Google の会話 Webhook 形式ではなく、独自の標準 Webhook 形式で Dialogflow とやり取りします。Dialogflow Webhook 形式には、会話 Webhook 形式のすべての情報と、コンテキストやパラメータに関する情報などのその他の Dialogflow 固有のデータが含まれています。

Dialogflow Webhook の JSON メッセージの他の例は、この GitHub プロジェクトをご覧ください。

リクエスト本文

Dialogflow からのリクエスト メッセージには、Dialogflow Webhook 形式のデータが含まれています。このオブジェクトには、Actions on Google 固有の情報が含まれています。その内容を以下にまとめます。

  • originalDetectIntentRequest.source の値は「google」です。
  • originalDetectIntentRequest.version は Actions on Google を示します。 バージョンを指定します。
  • originalDetectIntentRequest.payload には、Actions on Google 固有の主なアクションが含まれています。 会話の内容や、 リクエスト アシスタントからの JSON。
  • Conversation.conversationToken フィールドは Dialogflow Webhook ではサポートされていません できます。代わりに、フルフィルメントで Dialogflow を コンテキストを使用して、プロジェクト間でデータを 維持します

単純な呼び出しリクエストの例

以下のスニペットは、Dialogflow での呼び出しリクエストの例を示しています。 Webhook 形式を使用します。

{
  "responseId": "c4b863dd-aafe-41ad-a115-91736b665cb9",
  "queryResult": {
    "queryText": "GOOGLE_ASSISTANT_WELCOME",
    "action": "input.welcome",
    "parameters": {},
    "allRequiredParamsPresent": true,
    "fulfillmentText": "",
    "fulfillmentMessages": [],
    "outputContexts": [
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/google_assistant_welcome"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_capability_screen_output"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/google_assistant_input_type_voice"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_capability_audio_output"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_capability_web_browser"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_capability_media_response_audio"
      }
    ],
    "intent": {
      "name": "projects/${PROJECTID}/agent/intents/8b006880-0af7-4ec9-a4c3-1cc503ea8260",
      "displayName": "Default Welcome Intent"
    },
    "intentDetectionConfidence": 1,
    "diagnosticInfo": {},
    "languageCode": "en-us"
  },
  "originalDetectIntentRequest": {
    "source": "google",
    "version": "2",
    "payload": {
      "isInSandbox": true,
      "surface": {
        "capabilities": [
          {
            "name": "actions.capability.SCREEN_OUTPUT"
          },
          {
            "name": "actions.capability.AUDIO_OUTPUT"
          },
          {
            "name": "actions.capability.WEB_BROWSER"
          },
          {
            "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
          }
        ]
      },
      "inputs": [
        {
          "rawInputs": [
            {
              "query": "Talk to my test app",
              "inputType": "VOICE"
            }
          ],
          "intent": "actions.intent.MAIN"
        }
      ],
      "user": {
        "lastSeen": "2018-03-16T22:08:48Z",
        "permissions": [
          "UPDATE"
        ],
        "locale": "en-US",
        "userId": "ABwppHEvwoXs18xBNzumk18p5h02bhRDp_riW0kTZKYdxB6-LfP3BJRjgPjHf1xqy1lxqS2uL8Z36gT6JLXSrSCZ"
      },
      "conversation": {
        "conversationId": "${SESSIONID}",
        "type": "NEW"
      },
      "availableSurfaces": [
        {
          "capabilities": [
            {
              "name": "actions.capability.SCREEN_OUTPUT"
            },
            {
              "name": "actions.capability.AUDIO_OUTPUT"
            }
          ]
        }
      ]
    }
  },
  "session": "projects/${PROJECTID}/agent/sessions/${SESSIONID}"
}

単純な会話リクエストの例

以下のスニペットは、ユーザー入力がテキスト文字列である Dialogflow Webhook 形式の会話リクエストの例を示しています。

{
  "responseId": "68efa569-4ba1-4b7f-9b1b-ac2865deb539",
  "queryResult": {
    "queryText": "query from the user",
    "action": "action.name.of.matched.dialogflow.intent",
    "parameters": {},
    "allRequiredParamsPresent": true,
    "outputContexts": [
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_capability_screen_output"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_capability_audio_output"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/google_assistant_input_type_keyboard"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_capability_media_response_audio"
      },
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_capability_web_browser"
      }
    ],
    "intent": {
      "name": "projects/${PROJECTID}/agent/intents/1f4e5bd9-a670-4161-a22e-2c97b077f29f",
      "displayName": "Name of Dialogflow Intent"
    },
    "intentDetectionConfidence": 1,
    "diagnosticInfo": {},
    "languageCode": "en-us"
  },
  "originalDetectIntentRequest": {
    "source": "google",
    "version": "2",
    "payload": {
      "isInSandbox": true,
      "surface": {
        "capabilities": [
          {
            "name": "actions.capability.SCREEN_OUTPUT"
          },
          {
            "name": "actions.capability.AUDIO_OUTPUT"
          },
          {
            "name": "actions.capability.WEB_BROWSER"
          },
          {
            "name": "actions.capability.MEDIA_RESPONSE_AUDIO"
          }
        ]
      },
      "inputs": [
        {
          "rawInputs": [
            {
              "query": "query from the user",
              "inputType": "KEYBOARD"
            }
          ],
          "arguments": [
            {
              "rawText": "query from the user",
              "textValue": "query from the user",
              "name": "text"
            }
          ],
          "intent": "actions.intent.TEXT"
        }
      ],
      "user": {
        "lastSeen": "2017-10-06T01:06:56Z",
        "locale": "en-US",
        "userId": "AI_yXq-AtrRh3mJX5D-G0MsVhqun"
      },
      "conversation": {
        "conversationId": "1522951193000",
        "type": "ACTIVE",
        "conversationToken": "[]"
      },
      "availableSurfaces": [
        {
          "capabilities": [
            {
              "name": "actions.capability.SCREEN_OUTPUT"
            },
            {
              "name": "actions.capability.AUDIO_OUTPUT"
            }
          ]
        }
      ]
    }
  },
  "session": "projects/${PROJECTID}/agent/sessions/${SESSIONID}"
}

ヘルパー結果の例

以下のスニペットは、Dialogflow Webhook 形式のヘルパー結果の例を示しています。 この例は、Webhook がアシスタントに指示した後のユーザーのレスポンスを示しています。 ユーザーの確認を取得する必要があります。

{
  "responseId": "cb6f5ec2-c26e-4349-b561-a9ddd6a0e495",
  "queryResult": {
    "queryText": "actions_intent_CONFIRMATION",
    "action": "Dialogflow action name of matched intent",
    "parameters": {},
    "allRequiredParamsPresent": true,
    "outputContexts": [
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_intent_confirmation",
        "parameters": {
          "CONFIRMATION": true
        }
      }
    ],
    "intent": {
      "name": "projects/${PROJECTID}/agent/intents/1777d616-a5f7-4838-a9a9-870f2956bd14",
      "displayName": "Dialogflow action name of matched intent"
    },
    "intentDetectionConfidence": 1,
    "diagnosticInfo": {},
    "languageCode": "en-us"
  },
  "originalDetectIntentRequest": {
    "source": "google",
    "version": "2",
    "payload": {
      "isInSandbox": true,
      "surface": {},
      "inputs": [
        {
          "rawInputs": [
            {
              "query": "yes",
              "inputType": "VOICE"
            }
          ],
          "arguments": [
            {
              "name": "CONFIRMATION",
              "boolValue": true
            }
          ],
          "intent": "actions.intent.CONFIRMATION"
        }
      ],
      "user": {},
      "conversation": {},
      "availableSurfaces": []
    }
  },
  "session": "projects/${PROJECTID}/agent/sessions/${SESSIONID}"
}

レスポンスの本文

フルフィルメント エンドポイントからの HTTP POST のヘッダーにある Content-Type application/json に設定する必要があります。

フルフィルメントが Dialogflow に送信するレスポンス メッセージは、Dialogflow Webhook 形式にする必要があります。

アシスタントとやり取りする際、通常、レスポンスには payload が含まれます 「google」をカプセル化するオブジェクト渡されます。「google」ペイロード オブジェクトには、 Actions on Google 固有の情報。少なくとも expectUserResponse フィールドと、richResponse フィールドまたは systemIntent フィールド。

「google」のキーフィールドペイロード オブジェクトの概要を以下に示します。

フィールド 説明
expectUserResponse フルフィルメントがユーザーのレスポンスを期待するかどうかを示します。値を次のように設定します。 会話を続ける時間 true、終了タイミング false 表示されます。
userStorage 特定のユーザーに関連付けられた永続データを格納します。合計容量は 10,000 バイトです。
richResponse このフィールドには、アシスタントがレンダリングする音声、テキスト、カード、提案、または構造化データが含まれています。リッチ レスポンスの使い方について詳しくは、 Actions on Google については、以下をご覧ください。 リッチ レスポンス
systemIntent このフィールドは ExpectedInput.possibleIntents。通常、レスポンスには systemIntent: フルフィルメントで ヘルパー インテント。「 possibleIntents systemIntent のフィールドには、 ExpectedIntent オブジェクトで、inputValueData フィールド名が data に変更されました。

ExpectedIntent 内 次の値を指定します。

  • intent: ユーザーに提供させる情報の種類を示すヘルパーのインテント名。
  • data: 値の仕様。アシスタントがヘルパーを実行するために必要なデータを説明する文字列です。

たとえば、ユーザーの許可を求める場合は、intent を次のように設定します。 actions.intent.PERMISSSION と data を値の仕様に追加し、 "@type": "type.googleapis.com/google.actions.v2.PermissionValueSpec"、および 作成します。

次のリストは、 systemIntent: Dialogflow Webhook レスポンス。Actions on Google のインテントの完全なリスト 会話のコントロールについては、 インテント リファレンス。

インテントの名前 Dialogflow イベントの名前 値の仕様 説明
actions.intent.CONFIRMATION actions_intent_CONFIRMATION "@type": "type.googleapis.com/google.actions.v2.ConfirmationValueSpec" ユーザーから確認を取得します（例: 「はい」か「いいえ」で答える質問）。
actions.intent.DATETIME actions_intent_DATETIME "@type": "type.googleapis.com/google.actions.v2.DateTimeValueSpec" ユーザーが入力した日時を取得します。
actions.intent.DELIVERY_ADDRESS actions_intent_DELIVERY_ADDRESS "@type": "type.googleapis.com/google.actions.v2.DeliveryAddressValueSpec" ユーザーが入力した配送先住所を取得します。
actions.intent.LINK actions_intent_LINK "@type": "type.googleapis.com/google.actions.v2.LinkValueSpec" Android アプリへのディープリンク フローをリクエストします。
actions.intent.OPTION actions_intent_OPTION "@type": "type.googleapis.com/google.actions.v2.OptionValueSpec" リストまたはカルーセル UI から選択した項目を取得します。
actions.intent.PERMISSION actions_intent_PERMISSION "@type": "type.googleapis.com/google.actions.v2.PermissionValueSpec" 氏名、大まかな現在地、 正確な位置情報
actions.intent.SIGN_IN actions_intent_SIGN_IN "@type": "type.googleapis.com/google.actions.v2.SignInValueSpec" ユーザーのアカウントをリンクするアカウントのリンクフローをリクエストします。

単純なレスポンス例

以下のスニペットは、Dialogflow Webhook 形式の単純なレスポンスの例を示しています。

{
  "payload": {
    "google": {
      "expectUserResponse": true,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "this is a simple response"
            }
          }
        ]
      }
    }
  }
}

ヘルパーの例

以下のスニペットは、Dialogflow Webhook 形式でヘルパー インテントを使用する例を示しています。この例では、Webhook は actions.intent.OPTIONS ヘルパー インテントを使用して、アシスタントに ユーザーが 2 つのオプションから選択できるようになるためです。

{
  "payload": {
    "google": {
      "expectUserResponse": true,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "Choose a item"
            }
          }
        ]
      },
      "systemIntent": {
        "intent": "actions.intent.OPTION",
        "data": {
          "@type": "type.googleapis.com/google.actions.v2.OptionValueSpec",
          "listSelect": {
            "title": "Hello",
            "items": [
              {
                "optionInfo": {
                  "key": "first title key"
                },
                "description": "first description",
                "image": {
                  "url": "/assistant/images/badges/XPM_BADGING_GoogleAssistant_VER.png",
                  "accessibilityText": "first alt"
                },
                "title": "first title"
              },
              {
                "optionInfo": {
                  "key": "second"
                },
                "description": "second description",
                "image": {
                  "url": "https://lh3.googleusercontent.com/Nu3a6F80WfixUqf_ec_vgXy_c0-0r4VLJRXjVFF_X_CIilEu8B9fT35qyTEj_PEsKw",
                  "accessibilityText": "second alt"
                },
                "title": "second title"
              }
            ]
          }
        }
      }
    }
  }
}

前の例からのメッセージを受け取ると、アシスタントは一時的に会話を引き継ぎ、与えられたオプションに基づいて選択するようにユーザーに促します。必要なユーザー入力をすべて収集すると、アシスタントは Dialogflow Webhook リクエストでこのヘルパー結果をフルフィルメントに返します。

以下のスニペットは、ユーザーが選択肢から選択した場合のヘルパー結果の例を示しています。

{
  "responseId": "ea166558-615a-48f3-ae5b-7f55d895784b",
  "queryResult": {
    "queryText": "actions_intent_OPTION",
    "action": "",
    "parameters": {},
    "allRequiredParamsPresent": true,
    "fulfillmentText": "",
    "fulfillmentMessages": [],
    "outputContexts": [
      {
        "name": "projects/${PROJECTID}/agent/sessions/${SESSIONID}/contexts/actions_intent_option",
        "parameters": {
          "OPTION": "key of selected item"
        }
      }
    ],
    "intent": {
      "name": "projects/${PROJECTID}/agent/intents/1777d616-a5f7-4838-a9a9-870f2956bd14",
      "displayName": "Dialogflow intent name of matched intent"
    },
    "intentDetectionConfidence": 1,
    "diagnosticInfo": {},
    "languageCode": "en-us"
  },
  "originalDetectIntentRequest": {
    "source": "google",
    "version": "2",
    "payload": {
      "isInSandbox": true,
      "surface": {
        "capabilities": []
      },
      "inputs": [
        {
          "rawInputs": [
            {
              "query": "Title of selected item",
              "inputType": "TOUCH"
            }
          ],
          "arguments": [
            {
              "textValue": "Key of selected item",
              "name": "OPTION"
            }
          ],
          "intent": "actions.intent.OPTION"
        }
      ],
      "user": {},
      "conversation": {},
      "availableSurfaces": []
    }
  },
  "session": "projects/${PROJECTID}/agent/sessions/${SESSIONID}"
}

会話の終了の例

以下のスニペットは、Dialogflow Webhook 形式で会話セッションを終了する単純なレスポンスの例を示しています。「 expectUserResponse アシスタントへの応答メッセージ シグナルに含まれる false の値 それ以上のユーザー入力は期待されず、現在の状態が終了 あります。

{
  "payload": {
    "google": {
      "expectUserResponse": false,
      "richResponse": {
        "items": [
          {
            "simpleResponse": {
              "textToSpeech": "Goodbye!"
            }
          }
        ]
      }
    }
  }
}

ユーザーが標準の アシスタントとの会話を終了するには、 会話終了ガイドをご覧ください。