Interface de ligne de commande Dialogflow CX : l’interface de ligne de commande manquante pour interagir avec vos agents

Conditions préalables

Voici les technologies utilisées dans ce projet

1. Compte Google Cloud
2. API Dialogflow activée
3. Interface de ligne de commande Dialogflow CX

Qu’est-ce que c’est?

Interface de ligne de commande Dialogflow CX : l’interface de ligne de commande manquante pour vos projets Dialogflow CX

La CLI Dialogfow CX ou cxcli est un outil d’interface de ligne de commande que vous pouvez utiliser pour interagir avec vos projets Dialogflow CX dans un terminal. C’est un projet open-source que j’ai créé. Ce projet a été créé en raison de l’absence d’une CLI officielle existante pour le Dialogflow de nouvelle génération. Cet outil a été construit avec Golang et le framework Cobra. Vous pouvez trouver le code source sur GitHub pour vérifier l’implémentation de l’outil. Cette CLI est disponible pour MacOS, Linux et Windows.

Caractéristiques

Lorsque j’ai créé cet outil, ma première intention était uniquement à des fins de test. Puis une fois que je développais et évoluais cxcli J’ai réalisé que je pouvais ajouter un tas de fonctionnalités qui peuvent aider l’interaction et l’automatisation avec les agents Dialogflow CX. Par conséquent, vous pouvez effectuer toutes ces actions :

1. Interagissez avec vos intents en les créant ou en les supprimant.
2. Créez ou mettez à jour des types d’entités.
3. Jouez avec vos agents : vous pouvez les créer ou les supprimer.
4. Il dispose de quelques outils de test :
   1. Exécutez vos pipelines CI/CD.
   2. Exécutez un profileur NLU.
5. Speech-to-text : Vous pouvez reconnaître le texte d’un fichier audio à partir de votre CLI !
6. Text-to-speech : synthétisez la voix à partir du texte directement à partir d’une interface de ligne de commande. C’est vraiment cool!
7. Beaucoup d’autres à venir : consultez la feuille de route ci-dessous !

Installation

Vous pouvez installer le binaire pré-compilé (de plusieurs manières), en utilisant Docker ou en le compilant à partir de la source. Vous trouverez ci-dessous les étapes pour chacun.

homebrew-robinet

Ajouter le homebrew-tap:

brew tap xavidop/tap git@github.com:xavidop/homebrew-tap.git
brew update

Installez l’interface de ligne de commande Dialogflow CX :

brew install cxcli

snapcraft

sudo snap install cxcli

scoop

scoop bucket add cxcli https://github.com/xavidop/scoop-bucket.git
scoop install cxcli

apte

echo 'deb [trusted=yes] https://apt.fury.io/xavidop/ /' | sudo tee /etc/apt/sources.list.d/cxcli.list
sudo apt update
sudo apt install cxcli

Miam

echo '[cxcli]
name=Dialogflow CX CLI Repo
baseurl=https://yum.fury.io/xavidop/
enabled=1
gpgcheck=0' | sudo tee /etc/yum.repos.d/cxcli.repo
sudo yum install cxcli

or

yay -S cxcli-bin

Paquets deb, rpm et apk

Télécharger le .deb, .rpm ou alors .apk packages à partir de la page des versions OSS et installez-les avec les outils appropriés.

allez installer

go install github.com/xavidop/dialogflow-cx-cli@latest

Script Bash

curl -sfL https://cxcli.xavidop.me/static/run | bash

Manuellement

Téléchargez les fichiers binaires précompilés à partir de la page des versions et copiez-les à l’emplacement souhaité.

Exécuter avec Docker

Vous pouvez également l’utiliser dans un conteneur Docker. Pour ce faire, vous devrez exécuter quelque chose qui ressemble plus ou moins aux exemples ci-dessous. Exemple d’utilisation :

  docker run --rm \
      xavidop/cxcli cxcli version

Notez que l’image aura presque toujours la dernière version stable de Go. Si vous avez besoin de plus de choses, vous êtes encouragé à garder votre propre image. Vous pouvez toujours utiliser cxcli‘s propre Dockerfile comme exemple et itérer à partir de cela. Registres :

1. xavidop/cxcli
2. ghcr.io/xavidop/cxcli

Authentification

cxcli utilise certaines API Google Cloud. Par défaut, l’outil utilise la configuration par défaut qui utilise le gcloud CLI. Si vous souhaitez utiliser une autre clé d’authentification, vous pouvez fournir un json fichier avec le monde --credentials paramètre.

Les cxcli le code source est open source. Vous pouvez le consulter pour en savoir plus sur les actions effectuées par l’outil.

Vous trouverez ci-dessous les rôles et les API nécessaires pour utiliser l’outil.

Rôles nécessaires

Administrateur de l’API Dialogflow: fournit un accès complet pour créer, mettre à jour, interroger, détecter l’intention et supprimer l’agent de la console ou de l’API. Cliquez ici pour plus d’informations.

Nous utilisons le rôle d’administrateur car cxcli effectue la ListAgent action.

Ce rôle vous permet également d’exécuter des actions de synthèse vocale et de synthèse vocale.

API activées nécessaires Lien permanent

Ces API doivent être activées sur votre projet Google Cloud si vous souhaitez les utiliser cxcli capacités :

1. DialogflowCX: Vous devrez activer le Dialogflow API sur votre projet.
2. Discours en texte: Vous devrez activer le Cloud Speech-to-Text API sur votre projet.
3. Texte pour parler: Vous devrez activer le Cloud Text-to-Speech API sur votre projet.

Feuille de route

cxcli est en développement actif. Le produit de base fonctionne.

Notre objectif avec cet outil est de prouver qu’il existe un marché adapté à une solution comme celle-ci, et si c’est le cas, nous investirons plus de temps dans l’automatisation, l’expérience utilisateur et davantage de fonctionnalités.

Pour l’instant, si vous souhaitez participer et donner votre avis, nous pensons cxcli résout déjà la douleur à ce stade.

Expédié:

Bientôt disponible:

Ressources

Si vous souhaitez en savoir plus sur les tests Dialogflow CX, consultez la documentation officielle.

Conclusion

Il s’agissait d’une introduction à la CLI Dialogflow CX. Comme vous l’avez vu dans cet article, cxcli est un outil puissant qui vous aidera dans vos tâches quotidiennes pendant que vous développez vos bots !

C’est tout !

Bon codage !