Guide de démarrage rapide pour le SDK Actions et le compilateur

Ce guide vous explique comment configurer votre environnement pour créer des actions à l'aide du SDK Actions et d'Actions Builder. Vous allez effectuer les tâches suivantes:

  • Installer Node.js:vous avez besoin de cet environnement d'exécution pour utiliser notre bibliothèque de traitement Node.js.
  • Installer la CLI Firebase:cet outil de ligne de commande vous permet de développer et de déployer des dépendances Firebase, telles que des applications Web pour Interactive Canvas, sur Firebase Hosting.
  • Installer l'outil de ligne de commande gactions:lorsque vous développez avec le SDK Actions, cet outil vous permet de créer, gérer et déployer le package d'action pour votre action.
  • Créer un projet Actions:un projet Actions est le conteneur logique pour vos actions conversationnelles. Vous devez en créer un dans la console Actions avant de pouvoir commencer à créer.
  • Initialisez et déployez un exemple:cet exemple simple vous montre comment créer des actions basées sur Interactive Canvas.

Une fois ce démarrage rapide effectué, vous pouvez synchroniser votre projet Actions entre votre environnement de développement local et l'expérience Web d'Actions Builder.

Installer Node.js et la CLI Firebase

Téléchargez et installez Node.js conformément à la documentation de Node.js pour utiliser notre bibliothèque de fulfillment. L'installation de Node.js vous permet également d'installer la CLI Firebase avec npm et plus tard pour exécuter votre implémentation du traitement des conversations en local.

Installez et configurez la CLI Firebase en suivant la documentation Firebase. La CLI Firebase vous permet de déployer une application Web Interactive Canvas sur Firebase Hosting et, si nécessaire, de déployer manuellement le traitement dans Cloud Functions for Firebase.

Installer l'outil de ligne de commande gactions

Installez l'outil de ligne de commande (CLI) gactions en téléchargeant un package d'installation, en le décompressant et en configurant votre chemin d'exécution.

Pour installer et configurer des gactions, procédez comme suit:

  1. Téléchargez le package correspondant à votre système d'exploitation:

    Plate-forme Empaqueter Total
    Windows Télécharger SHA256
    Linux Télécharger SHA256
    macOS Télécharger SHA256

  2. Extrayez le package à l'emplacement de votre choix et ajoutez le binaire à la variable PATH de votre environnement. Vous pouvez également extraire le package à un emplacement déjà présent dans votre variable PATH (par exemple, /usr/local/bin).

  3. Sous Linux et Mac, activez les autorisations d'exécution si nécessaire:

    chmod +x PATH_TO/gactions

  4. Exécutez la commande suivante pour authentifier la CLI. Cette commande lance un flux d'authentification et nécessite un navigateur Web:

    gactions login

    Une fois le flux terminé, la CLI s'authentifie automatiquement.

Créer et configurer un projet

Avant de pouvoir utiliser l'outil de ligne de commande gactions, vous devez créer un projet dans la console Actions et autoriser l'accès gactions à ce projet. Pour créer et configurer un projet, procédez comme suit:

  1. Accédez à la console Actions.
  2. Cliquez sur Nouveau projet, saisissez un nom de projet, puis cliquez sur Créer un projet.
  3. Sélectionnez une catégorie, puis cliquez sur Next (Suivant).
  4. Sélectionnez Projet vide, puis cliquez sur Démarrer la compilation.
  5. Activez l'API Actions dans la console Google Cloud en suivant les instructions de la section Activer et désactiver des API. Cela permet aux gactions d'interagir avec votre projet.

Obtenir l'exemple Hello World

L'exemple interactif Hello World vous montre comment créer un projet Actions simple à l'aide d'une seule action optimisée par Interactive Canvas.

  1. Créez un répertoire vide et initialisez l'exemple Interactive Canvas dans ce répertoire. Par exemple, le code suivant initialise l'exemple dans un répertoire interactive-canvas-sample/, qui est utilisé comme exemple dans ce document:

    gactions init interactive-canvas --dest interactive-canvas-sample
cd interactive-canvas-sample

  2. Ouvrez le fichier interactive-canvas-sample/sdk/settings/settings.yaml et remplacez la valeur du champ projectId par l'ID de votre projet.

Déployer et tester l'exemple

Après avoir configuré l'exemple, vous pouvez déployer l'application Web Interactive Canvas et votre projet Actions. Ce processus crée une version brouillon de votre projet Actions que vous pouvez déployer dans le simulateur Actions pour la prévisualisation et le test:

  1. À partir du répertoire interactive-canvas-sample/, exécutez la commande suivante pour déployer l'application Web Interactive Canvas (le contenu du répertoire public/).

    firebase deploy --project PROJECT_ID --only hosting

    Vous pouvez voir une version rendue de l'application Web à l'URL renvoyée par la CLI Firebase dans un navigateur : https://PROJECT_ID.web.app.

  2. Ouvrez le fichier interactive-canvas-sample/sdk/webhooks/ActionsOnGoogleFulfillment/index.js et remplacez la valeur de la variable CANVAS_URL par l'URL de l'application Web de votre projet.

    const CANVAS_URL = 'https://PROJECT_ID.web.app';

  3. À partir du répertoire interactive-canvas-sample/sdk/, exécutez la commande suivante pour transférer la version locale de votre projet Actions vers la console en tant que version brouillon:

    gactions push

  4. Depuis le répertoire interactive-canvas-sample/sdk/, exécutez la commande suivante pour tester votre projet Actions dans le simulateur:

    gactions deploy preview

  5. Ouvrez le lien renvoyé par l'outil de ligne de commande pour accéder au simulateur.

  6. Dans le simulateur, saisissez Talk to Interactive Canvas Sample pour lancer l'action. Vous devriez voir un triangle tournant sur lequel repose l'application Web https://PROJECT_ID.web.app.

    Figure 1. Le simulateur prévisualise le projet Actions