Formats de webhooks Actions on Google (Dialogflow)

Ce document décrit le format du webhook pour la communication entre Actions on Google et un service de fulfillment qui définit une interface utilisateur conversationnelle personnalisée.

Il est important de comprendre comment Actions on Google et votre traitement communiquent via les formats de webhooks Actions on Google:

  • Pour participer à des conversations avec Actions on Google, votre traitement implémente un webhook qui peut répondre aux requêtes HTTP d'Actions on Google.
  • Lorsque des utilisateurs appellent votre action, votre traitement reçoit un objet HTTP POST avec une charge utile JSON décrivant la requête de l'utilisateur.
  • À son tour, votre traitement est chargé de lire les paramètres de la charge utile de la requête, de générer une réponse au format JSON appropriée et d'envoyer une réponse à l'Assistant avec cette réponse.

Types de requêtes

Ce tableau récapitule les types de requêtes que votre webhook peut recevoir de l'Assistant:

Type Description Exemples JSON
Requêtes d'appel Les énoncés de l'utilisateur qui lancent la conversation avec votre traitement ou déclenchent des actions de lien profond (par exemple, Parler à Personal Chef pour trouver des recettes pour le dîner).
  • Si vous utilisez Dialogflow, ces requêtes correspondent aux intents définis dans la section Discovery des paramètres d'intégration de l'Assistant Google.
  • Si vous utilisez le SDK Actions, ces requêtes correspondent aux intents définis dans votre package d'actions.
Demandes de conversation Énoncés par les utilisateurs dans la même session une fois que la conversation avec votre traitement a commencé. Au format webhook de conversation, il s'agit des réponses en texte brut de l'utilisateur correspondant aux intents actions.intent.TEXT demandés par votre traitement au tour précédent.
Résultats de l'outil d'aide Requêtes envoyées par l'Assistant à votre traitement lorsque le webhook a demandé un intent d'aide au tour précédent de la conversation pour gérer des parties de la conversation (par exemple, actions.intent.OPTION et actions.intent.PERMISSION).

Demandes et réponses de conversation

Dans un scénario d'interaction Actions on Google classique, les utilisateurs énoncent une expression pour appeler une action. Pour fournir une réponse, Actions on Google recherche le traitement correspondant à l'action appelée par l'utilisateur, puis y envoie la requête.

Une fois qu'Actions on Google établit que votre traitement correspond à l'appel de l'utilisateur, elle démarre une session de conversation en envoyant une requête HTTP contenant une charge utile JSON avec les informations de requête de l'utilisateur à votre point de terminaison de traitement. Le traitement analyse la requête et renvoie une réponse contenant une charge utile JSON. Actions on Google convertit ensuite la charge utile en contenu vocal et en sortie multimédia pour les utilisateurs.

Figure 1 : Actions on Google qui appelle votre traitement via le SDK Actions

Pour en savoir plus sur le format de la charge utile JSON lorsqu'Actions on Google appelle votre traitement via le SDK Actions, consultez Format du webhook de conversation.

Requêtes et réponses Dialogflow

Lorsque vous créez des actions, vous pouvez éventuellement utiliser Dialogflow pour simplifier la création d'interfaces de conversation. Dans ce scénario, Dialogflow sert de proxy entre Actions on Google et votre traitement. Au lieu d'envoyer la requête HTTP/JSON directement à votre point de terminaison de fulfillment, Actions on Google l'envoie à Dialogflow.

Dialogflow encapsule la charge utile JSON contenue dans la requête d'origine au format de webhook Dialogflow et transfère la requête obtenue à votre traitement Dialogflow.

À l'inverse, lorsque le fulfillment envoie une réponse à Dialogflow, la charge utile JSON de la réponse doit être conforme au format du webhook Dialogflow. Le traitement analyse les paramètres de la requête JSON Dialogflow et génère une réponse au format webhook Dialogflow. Dialogflow convertit ensuite la réponse de votre traitement en un message de réponse compris par l'Assistant.

Figure 2. Actions on Google qui appelle votre traitement via Dialogflow

Pour en savoir plus sur le format de la charge utile JSON lorsque Actions on Google appelle votre traitement via Dialogflow, consultez Format du webhook Dialogflow.