Créer un bot à l’aide du kit de développement logiciel (SDK) Bot Framework

Article
11/16/2022
12 minutes de lecture

S’APPLIQUE À : KIT de développement logiciel (SDK) v4

Cet article explique comment créer votre premier bot avec le Kit de développement logiciel (SDK) Bot Framework pour C#, Java, JavaScript ou Python, et comment tester votre bot avec le Bot Framework Emulator.

La création de votre premier bot ne nécessite pas d’abonnement Azure ni de ressource Azure Bot Service. Ce guide de démarrage rapide se concentre sur la création de votre premier bot localement. Si vous souhaitez savoir comment créer un bot dans Azure, consultez Créer une ressource Azure Bot.

Notes

Les sdk Python et Java bot Framework sont mis hors service avec une prise en charge finale à long terme qui se termine en novembre 2023. Seuls les correctifs de sécurité et de bogues critiques au sein de ce dépôt seront entrepris. Les bots existants créés avec ces SDK continueront de fonctionner.

Pour le développement de nouveaux bots, envisagez d’utiliser Power Virtual Agents. Pour plus d’informations, consultez L’avenir de la génération de bots.

Prérequis

SDK .NET 6.0
Bot Framework Emulator
Connaissance des ASP.NET Core et de la programmation asynchrone en C#

Modèles C#

Les exemples de bot actuels utilisent des modèles .NET Core 3.1.

Visual Studio
VS Code / CLI

Pour ajouter les modèles de bot à Visual Studio, téléchargez et installez le fichier Bot Framework v4 SDK Templates for Visual Studio VSIX.

Notes

Vous pouvez installer les modèles à partir de Visual Studio.

Dans le menu, sélectionnez Extensions , puis Gérer les extensions.
Dans la boîte de dialogue Gérer les extensions , recherchez et installez les modèles du Kit de développement logiciel (SDK) Bot Framework v4 pour Visual Studio.

Pour plus d’informations sur le déploiement de bots .NET sur Azure, consultez Comment approvisionner et publier un bot.

Les modèles .NET Core vous aideront à créer rapidement de nouveaux bots d’IA conversationnels à l’aide de Bot Framework v4. À compter de mai 2020, ces modèles et le code qu’ils génèrent nécessitent .NET Core 3.1 ou version ultérieure.

Pour installer les modèles Bot Framework :

Ouvrez une fenêtre de console.
Téléchargez et installez le Kit de développement logiciel (SDK) .NET Core version 3.1 ou ultérieure.
Vous pouvez utiliser cette commande pour déterminer quelles versions de l’interface de ligne de commande .NET Core sont installées.
```
dotnet --version
```

Installez les trois modèles Bot Framework C# : les modèles d’écho, de cœur et de bot vide.

dotnet new -i Microsoft.Bot.Framework.CSharp.EchoBot
dotnet new -i Microsoft.Bot.Framework.CSharp.CoreBot
dotnet new -i Microsoft.Bot.Framework.CSharp.EmptyBot

Vérifiez que les modèles ont été installés correctement.
```
dotnet new --list
```

Notes

Les étapes ci-dessus installent les trois modèles Bot Framework. Vous n’avez pas besoin d’installer tous les modèles et ne pouvez installer que ceux que vous allez utiliser. Cet article utilise le modèle de bot d’écho .

Java 1.8 ou version ultérieure
Bot Framework Emulator
Visual Studio Code ou votre IDE favori, si vous souhaitez modifier le code de votre bot.
Installer Maven
Installez node.js version 12.10 ou ultérieure.
Un compte Azure si vous souhaitez déployer sur Azure.

Modèles Java

Utilisez le générateur Yeoman pour créer rapidement un bot d’IA conversationnel à l’aide des fonctionnalités d’IA de base dans Bot Framework v4. Pour plus d’informations, consultez yeoman.io.

Le générateur prend en charge trois options de modèle différentes, comme indiqué ci-dessous.

Modèle	Description
Echo Bot	Un bon modèle si vous voulez un peu plus que « Hello World! », mais pas beaucoup plus. Ce modèle gère les principes de base de l’envoi de messages à un bot et le fait que le bot traite les messages en les répétant à l’utilisateur. Ce modèle produit un bot qui « renvoie » simplement à l’utilisateur tout ce que l’utilisateur dit au bot.
Bot vide	Un bon modèle si vous êtes familiarisé avec Bot Framework v4 et que vous souhaitez simplement un projet squelette de base. Également une bonne option si vous souhaitez prendre un exemple de code dans la documentation et le coller dans un bot minimal afin d’apprendre.
Core Bot	Un bon modèle si vous souhaitez créer des bots avancés, car il utilise des boîtes de dialogue à plusieurs tours et LUIS, un service cognitif basé sur l’IA, pour implémenter la compréhension du langage. Ce modèle crée un bot qui peut extraire des lieux et des dates pour réserver un vol.

Notes

Language Understanding (LUIS) sera mis hors service le 1er octobre 2025. À compter du 1er avril 2023, vous ne pourrez pas créer de ressources LUIS. Une version plus récente de la compréhension du langage est désormais disponible dans le cadre d’Azure Cognitive Service for Language.

La compréhension du langage conversationnel (CLU), une fonctionnalité d’Azure Cognitive Service for Language, est la version mise à jour de LUIS. Pour plus d’informations sur la prise en charge de la compréhension du langage dans le Kit de développement logiciel (SDK) Bot Framework, consultez Compréhension du langage naturel.

Installer Yeoman

Vérifiez que vous avez installé node.js version 12.10 ou ultérieure.
Installez la dernière version de npm.
```
npm install -g npm
```
Installez Yeoman. Veillez à installer globalement.
```
npm install -g yo
```
Installez generator-botbuilder-java. Veillez à installer globalement.
```
npm install -g generator-botbuilder-java
```
Vérifiez que Yeoman et generator-botbuilder-java ont été installés correctement.
```
yo botbuilder-java --help
```

Node.JS
Bot Framework Emulator
Connaissances de restify et de la programmation asynchrone en JavaScript
Visual Studio Code ou votre IDE favori, si vous souhaitez modifier le code de votre bot.

Modèles JavaScript et TypeScript

Pour installer Yeoman et le générateur Yeoman pour Bot Framework v4 :

Ouvrez un terminal ou une invite de commandes avec élévation de privilèges.
Basculez vers le répertoire de vos bots JavaScript. Créez ce répertoire le cas échéant.
```
mkdir myJsBots
cd myJsBots
```
Vérifiez que vous disposez des dernières versions de npm et Yeoman.
```
npm install -g npm
npm install -g yo
```
Installez le générateur Yeoman. Yeoman est un outil de création d’applications. Pour plus d’informations, consultez yeoman.io.
```
npm install -g generator-botbuilder
```
Notes

L’installation des outils de build Windows listés ci-dessous n’est nécessaire que si vous utilisez Windows comme système d’exploitation de développement. Pour certaines installations, l’étape d’installation de restify donne une erreur liée à node-gyp. Si c’est le cas, vous pouvez essayer d’exécuter cette commande avec des autorisations élevées. Cet appel peut également se bloquer sans quitter si Python est déjà installé sur votre système :

Exécutez cette commande uniquement si vous utilisez Windows.
```
npm install -g windows-build-tools
```

Python 3.8.3
Bot Framework Emulator
Connaissance de la programmation asynchrone dans Python

Créer et activer un environnement virtuel

Un environnement virtuel est une combinaison d’un interpréteur Python spécifique et de bibliothèques qui sont différentes de vos paramètres globaux. L’environnement virtuel est spécifique à un projet et est conservé dans le dossier du projet. L’un des avantages de l’utilisation d’un environnement virtuel est que lorsque vous développez un projet au fil du temps, l’environnement virtuel reflète toujours les dépendances exactes du projet. Pour en savoir plus sur les environnements virtuels, consultez Création d’environnements virtuels.

Accédez au répertoire dans lequel vous souhaitez créer votre bot. Exécutez ensuite les commandes suivantes pour votre plateforme préférée. Une fois que vous avez activé votre environnement virtuel, votre ligne de commande/terminal doit être préfacé avec (venv). Cela vous permet de savoir que l’environnement virtuel est actif. Vous pouvez désactiver votre environnement virtuel à tout moment en tapant : deactivate.

macOS/Linux

python3 -m venv venv
source venv/bin/activate

Windows

python -m venv venv
venv\Scripts\activate.bat

Modèles Python

Installez les packages nécessaires en exécutant les commandes suivantes pip install :

pip install botbuilder-core
pip install asyncio
pip install aiohttp
pip install cookiecutter==1.7.0

Important

Si vous utilisez une version 32 bits de Python, assurez-vous d’exécuter pip install cryptography==2.8également .

Créer un bot

Dans Visual Studio, créez un projet de bot et utilisez le modèle Echo Bot (Bot Framework v4 - .NET Core 3.1). Pour afficher uniquement les modèles de bots, choisissez le type de projet AI Bots .

Assurez-vous que .NET Core 3.1 ou version ultérieure est installé.

Dans Visual Studio Code, ouvrez une nouvelle fenêtre de terminal.
Accédez au répertoire dans lequel vous souhaitez créer votre projet de bot.
Créez un projet de bot d’écho à l’aide de la commande suivante. Remplacez par <your-bot-name> le nom à utiliser pour votre projet de bot.
```
dotnet new echobot -n <your-bot-name>
```

Ouvrez une nouvelle fenêtre de terminal.
Accédez au répertoire dans lequel vous souhaitez créer votre projet de bot.
Créez un projet de bot d’écho à l’aide de la commande suivante. Remplacez par <your-bot-name> le nom à utiliser pour votre projet de bot.
```
dotnet new echobot -n <your-bot-name>
```

Grâce au modèle, votre projet contient tout le code nécessaire pour créer le bot dans ce guide de démarrage rapide. Vous n’avez plus besoin de code pour tester votre bot.

J’ai créé un bot d’écho j’ai rencontré un problème

Exécutez la commande suivante pour créer un bot d’écho à partir de modèles. La commande utilise les options par défaut pour ses paramètres.

yo botbuilder-java -T "echo"

Yeoman vous invite à entrer des informations afin de créer votre bot. Pour ce didacticiel, utilisez les valeurs par défaut.

? What's the name of your bot? (echo)
? What's the fully qualified package name of your bot? (com.mycompany.echo)
? Which template would you like to start with? (Use arrow keys) Select "Echo Bot"
? Looking good.  Shall I go ahead and create your new bot? (Y/n) Enter "y"

Le générateur prend en charge de nombreuses options de ligne de commande que vous pouvez utiliser pour modifier les valeurs par défaut du générateur ou pour prédéfinir une invite. Les options respectent la casse.

Option de ligne de commande	Description
`--help, -h`	Lister le texte d’aide pour toutes les options de ligne de commande prises en charge
`--botName, -N`	Nom donné au projet de bot
`--packageName, -P`	Nom du package Java à utiliser pour le bot
`--template, -T`	Modèle utilisé pour générer le projet. Options : `echo`, `empty`, `core`. Pour plus d’informations sur les différents modèles, consultez le référentiel GitHub pour votre langage, C#, JavaScript, Python ou Java.
`--noprompt`	Le générateur n’invite pas à confirmer avant de créer un bot. Toutes les options de configuration requise non transmises sur la ligne de commande utilisent une valeur par défaut raisonnable. Cette option est destinée à activer la génération automatisée de bots à des fins de test.

Grâce au modèle, votre projet contient tout le code nécessaire pour créer le bot dans ce guide de démarrage rapide. Vous n’avez pas besoin d’un autre code pour tester votre bot.

J’ai créé un bot d’écho j’ai rencontré un problème

Utilisez le générateur pour créer un bot d’écho.

yo botbuilder

Yeoman vous invite à entrer des informations afin de créer votre bot. Pour ce didacticiel, utilisez les valeurs par défaut.

? What's the name of your bot? my-chat-bot
? What will your bot do? Demonstrate the core capabilities of the Microsoft Bot Framework
? What programming language do you want to use? JavaScript
? Which template would you like to start with? Echo Bot - https://aka.ms/bot-template-echo
? Looking good.  Shall I go ahead and create your new bot? Yes

Grâce au modèle, votre projet contient tout le code nécessaire pour créer le bot dans ce guide de démarrage rapide. Vous n’avez pas besoin d’un autre code pour tester votre bot.

J’ai créé un bot d’écho j’ai rencontré un problème

À partir de votre répertoire de travail, exécutez la commande suivante pour télécharger le modèle de bot d’écho et ses dépendances :
```
cookiecutter https://github.com/microsoft/BotBuilder-Samples/releases/download/Templates/echo.zip
```
Vous serez invité à donner un nom et une description à votre bot. Saisissez les valeurs suivantes :
- bot_name : echo_bot
- bot_description : bot qui renvoie la réponse de l’utilisateur.

J’ai créé un bot d’écho j’ai rencontré un problème

Démarrer votre robot

Dans Visual Studio :

Ouvrez votre projet de bot.
Exécutez le projet sans débogage.
Visual Studio génère l’application, la déploie sur localhost et lance le navigateur web pour afficher la page de default.htm l’application.

À ce stade, votre bot s’exécute localement sur le port 3978.

Dans Visual Studio Code :

Ouvrez le dossier de projet de votre bot.

Si vous êtes invité à sélectionner un projet, sélectionnez celui du bot que vous avez créé.
Dans le menu, sélectionnez Exécuter, puis Exécuter sans débogage.
- Si vous êtes invité à sélectionner un environnement, sélectionnez .Net Core.
- Si cette commande a mis à jour vos paramètres de lancement, enregistrez les modifications et réexécutez la commande.
La commande run génère l’application, la déploie sur localhost et lance le navigateur web pour afficher la page de default.htm l’application.

À ce stade, votre bot s’exécute localement sur le port 3978.

À partir d’une invite de commandes ou d’un terminal :

Remplacez les répertoires par le dossier de projet de votre bot.
Utilisez dotnet run pour démarrer le bot.
```
dotnet run
```
Cette commande génère l’application et la déploie sur localhost.

La page web par défaut de l’application ne s’affiche pas, mais à ce stade, votre bot s’exécute localement sur le port 3978.

J’ai démarré le bot d’écho que j’ai rencontré un problème

À partir d’un terminal, accédez au répertoire dans lequel vous avez enregistré votre bot, puis exécutez les commandes répertoriées ci-dessous.
Générez le projet Maven et empaquetez-le dans un fichier .jar (archive).
```
mvn package
```
Exécutez le bot localement. Remplacez le nom d’archive par le nom réel de la commande précédente.
```
java -jar .\target\<archive-name>.jar
```

Vous êtes maintenant prêt à démarrer l’émulateur.

J’ai démarré le bot d’écho que j’ai rencontré un problème

Dans un terminal ou une invite de commandes, remplacez les répertoires par celui créé pour votre bot, puis démarrez-le avec npm start.

cd my-chat-bot
npm start

À ce stade, votre bot s’exécute localement sur le port 3978.

J’ai démarré le bot d’écho que j’ai rencontré un problème

À partir de la ligne de commande/terminal, remplacez les répertoires par echo_bot.
```
cd echo_bot
```
Installez les dépendances pour le modèle de bot d’écho.
```
pip install -r requirements.txt 
```
Une fois les dépendances installées, exécutez la commande suivante pour démarrer votre bot :
```
python app.py
```
Vous saurez que votre bot est prêt à être testé lorsque la dernière ligne apparaît dans la capture d’écran ci-dessous :
Copiez l’adresse http dans la dernière ligne. Vous en aurez besoin lorsque vous utiliserez l’émulateur pour interagir avec votre bot.

J’ai démarré le bot d’écho que j’ai rencontré un problème

Démarrer l’émulateur et connecter votre robot

Démarrez le Bot Framework Emulator.
Sélectionnez Ouvrir le bot sous l’onglet Bienvenue de l’émulateur.
Entrez l’URL de votre bot, qui est votre hôte local et votre port, avec /api/messages l’ajout au chemin d’accès. L’adresse est généralement : http://localhost:3978/api/messages.
Sélectionnez Connecter.

Envoyez un message à votre bot et celui-ci répondra.

J’ai démarré l’émulateur et connecté à mon bot , j’ai rencontré un problème

Étapes suivantes

Pour plus d’informations sur le débogage à l’aide de Visual Studio ou Visual Studio Code et de la Bot Framework Emulator, consultez Déboguer un bot.
Pour plus d’informations sur ngrok, consultez Tunneling (ngrok).

Déployer votre bot sur Azure