In diesem Schnellstart erfahren Sie, wie Sie Ihren ersten Bot mit dem Bot Framework SDK für C#, Java, Java, JavaScript oder Python erstellen und wie Sie Ihren Bot mit dem Bot Framework Emulator testen.
Das Erstellen Ihres ersten Bots erfordert kein Azure-Abonnement oder eine Azure-Bot Service-Ressource. Dieser Schnellstart konzentriert sich auf das lokale Erstellen Ihres ersten Bots. Wenn Sie erfahren möchten, wie Sie einen Bot in Azure erstellen möchten, finden Sie unter Erstellen einer Azure Bot-Ressource.
Das VSIX-Paket enthält sowohl .NET Core 2.1 als auch .NET Core 3.1-Versionen der C#-Vorlagen.
Wenn Sie neue Bots in Visual Studio 2019 oder höher erstellen, sollten Sie die .NET Core 3.1-Vorlagen verwenden.
Für die aktuellen Botbeispiele werden .NET Core 3.1-Vorlagen verwendet.
Beispiele mit .NET Core 2.1-Vorlagen finden Sie im Branch 4.7-archive des Repositorys mit Bot Builder-Beispielen.
Um die Vorlagen in Visual Studio zu installieren, navigieren Sie in der oberen Menüleiste zu Erweiterungen>verwalten. Suchen Sie dann nach bot Framework v4 SDK für Visual Studio.
.NET Core-Vorlagen helfen Ihnen dabei, schnell neue KI-Bots mit Bot Framework v4 zu erstellen. Ab Mai 2020 erfordern diese Vorlagen und den code, den sie generieren, .NET Core 3.1.
So installieren Sie die Bot Framework-Vorlagen:
Öffnen Sie ein Konsolenfenster.
Laden Sie .NET Core SDK herunter, und installieren Sie Version 3.1 oder höher.
Sie können diesen Befehl verwenden, um zu ermitteln, welche Version der Befehlszeilenschnittstelle .NET Core sie installiert haben.
dotnet --version
Installieren Sie die drei Bot Framework C#-Vorlagen: das Echo, den Kern und die leeren Botvorlagen.
dotnet new -i Microsoft.Bot.Framework.CSharp.EchoBot
dotnet new -i Microsoft.Bot.Framework.CSharp.CoreBot
dotnet new -i Microsoft.Bot.Framework.CSharp.EmptyBot
Überprüfen Sie, ob die Vorlagen ordnungsgemäß installiert wurden.
dotnet new --list
Hinweis
Die obigen Installationsschritte installieren alle drei Bot Framework-Vorlagen. Sie müssen nicht alle Vorlagen installieren und können nur die von Ihnen verwendeten installieren. In diesem Artikel wird die Echo-Bot-Vorlage verwendet.
Installieren Sie node.js Version 12.10 oder höher.
Ein Azure-Konto, wenn Sie Azure bereitstellen möchten.
Vorlagen
Verwenden Sie den Yeoman-Generator, um schnell einen Unterhaltungs-KI-Bot mit kernen KI-Funktionen im Bot Framework v4 einzurichten. Weitere Informationen finden Sie unter yeoman.io.
Der Generator unterstützt drei verschiedene Vorlagenoptionen wie unten dargestellt.
Vorlage
BESCHREIBUNG
Echo Bot
Eine gute Vorlage, wenn Sie etwas mehr als "Hallo Welt!" möchten, aber nicht viel mehr. Diese Vorlage behandelt die Grundlagen des Sendens von Nachrichten an einen Bot, und der Bot verarbeitet die Nachrichten, indem sie sie wieder an den Benutzer wiederholen. Diese Vorlage erzeugt einen Bot, der einfach "echos" zurück an den Benutzer zurückgibt, was der Benutzer dem Bot sagt.
Leerer Bot
Eine gute Vorlage, wenn Sie mit Bot Framework v4 vertraut sind und einfach ein grundlegendes Skelettprojekt wünschen. Auch eine gute Option, wenn Sie Beispielcode aus der Dokumentation nehmen möchten, und fügen Sie sie in einen minimalen Bot ein, um zu lernen.
Core Bot
Eine gute Vorlage, wenn Sie erweiterte Bots erstellen möchten, da es mehrstufige Dialogfelder und LUIS, einen KI-basierten kognitiven Dienst, verwendet, um Sprachverständnis zu implementieren. Diese Vorlage erstellt einen Bot, der Orte und Datumsangaben extrahieren kann, um einen Flug zu buchen.
Installieren von Yeoman
Stellen Sie sicher, dass Sie node.js Version 12.10 oder höher installiert haben.
Kenntnisse von restify und asynchroner Programmierung in JavaScript
Visual Studio Code oder Ihre bevorzugte IDE, wenn Sie den Code des Bots bearbeiten möchten.
Vorlagen
So installieren Sie Yeoman und den Yeoman-Generator für Bot Framework v4:
Öffnen Sie ein Terminalfenster oder eine Eingabeaufforderung mit erhöhten Rechten.
Wechseln Sie zum Verzeichnis mit Ihren JavaScript-Bots. Erstellen Sie es zuerst, wenn es noch nicht vorhanden ist.
mkdir myJsBots
cd myJsBots
Stellen Sie sicher, dass Sie über die neuesten Versionen von npm und Yeoman verfügen.
npm install -g npm
npm install -g yo
Installieren Sie den Yeoman-Generator.
Yeoman ist ein Tool zum Erstellen von Anwendungen. Weitere Informationen finden Sie unter yeoman.io.
npm install -g generator-botbuilder
Hinweis
Die Installation der unten aufgeführten Windows-Buildtools ist nur erforderlich, wenn Sie Windows als Entwicklungsbetriebssystem verwenden.
Für einige Installationen gibt der Installationsschritt für restify einen Fehler im Zusammenhang mit node-gyp.
Wenn dies der Fall ist, können Sie versuchen, den folgenden Befehl mit erhöhten Berechtigungen auszuführen.
Dieser Aufruf kann auch hängen, ohne zu beenden, wenn Python bereits auf Ihrem System installiert ist:
Führen Sie diesen Befehl nur aus, wenn Sie Windows sind.
Erstellen und Aktivieren einer virtuellen Umgebung
Eine virtuelle Umgebung ist eine Kombination aus einem bestimmten Python-Dolmetscher und Bibliotheken, die sich von Ihren globalen Einstellungen unterscheiden. Die virtuelle Umgebung ist speziell für ein Projekt und wird im Projektordner beibehalten. Ein Vorteil für die Verwendung einer virtuellen Umgebung ist, dass während der Entwicklung eines Projekts im Laufe der Zeit die virtuelle Umgebung immer die genauen Abhängigkeiten des Projekts widerspiegelt. Weitere Informationen zu virtuellen Umgebungen finden Sie unter Erstellung virtueller Umgebungen.
Navigieren Sie zum Verzeichnis, in dem Sie Ihren Bot erstellen möchten. Führen Sie dann die folgenden Befehle für Ihre bevorzugte Plattform aus. Nachdem Sie Ihre virtuelle Umgebung aktiviert haben, sollte Die Befehlszeile/das Terminal vorgestellt (venv)sein. Auf diese Weise können Sie wissen, dass die virtuelle Umgebung aktiv ist. Sie können Ihre virtuelle Umgebung jederzeit deaktivieren, indem Sie Folgendes eingeben: deactivate
macOS/Linux
python3 -m venv venv
source venv/bin/activate
Windows
python -m venv venv
venv\Scripts\activate.bat
Vorlagen
Installieren Sie die erforderlichen Pakete, indem Sie die folgenden pip install Befehle ausführen:
Erstellen Sie in Visual Studio mithilfe der Vorlage Echo Bot (Bot Framework v4 – .NET Core 3.1) ein neues Botprojekt. Um nur Bot-Vorlagen anzuzeigen, wählen Sie KI-Bots aus den Projekttypen aus.
Dank der Vorlage enthält Ihr Projekt den gesamten erforderlichen Code, um den Bot in dieser Schnellstartanleitung zu erstellen. Zum Testen des Bots benötigen Sie keinen zusätzlichen Code.
Stellen Sie sicher, dass .NET Core 3.1 installiert ist.
Öffnen Sie in Visual Studio Code ein neues Terminalfenster.
Navigieren Sie zum Verzeichnis, in dem Sie Ihr Botprojekt erstellen möchten.
Erstellen Sie ein neues Echo-Bot-Projekt mit dem folgenden Befehl. Ersetzen Sie <your-bot-name> den Namen, der für Ihr Botprojekt verwendet werden soll.
dotnet new echobot -n <your-bot-name>
Öffnen Sie ein neues Terminalfenster.
Navigieren Sie zum Verzeichnis, in dem Sie Ihr Botprojekt erstellen möchten.
Erstellen Sie ein neues Echo-Bot-Projekt mit dem folgenden Befehl. Ersetzen Sie <your-bot-name> den Namen, der für Ihr Botprojekt verwendet werden soll.
dotnet new echobot -n <your-bot-name>
Tipp
Wenn Sie einen Core-Bot erstellen:
Nur das Lösungsverzeichnis empfängt den Botnamen.
Sie benötigen ein LUIS-Sprachmodell. Sie können ein Sprachmodell bei luis.ai erstellen. Aktualisieren Sie die Konfigurationsdatei, nachdem Sie das Modell erstellt haben.
Führen Sie den folgenden Befehl aus, um einen Echo-Bot aus Vorlagen zu erstellen. Der Befehl verwendet Standardoptionen für seine Parameter.
yo botbuilder-java -T "echo"
Yeoman fordert Sie zur Eingabe einiger Informationen auf, um Ihren Bot zu erstellen. Verwenden Sie für dieses Tutorial die Standardwerte.
? 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"
Der Generator unterstützt eine Reihe von Befehlszeilenoptionen, die verwendet werden können, um die Standardoptionen des Generators zu ändern oder eine Eingabeaufforderung vorab zu erstellen. Bei den Optionen wird die Groß-/Kleinschreibung beachtet.
Befehlszeilenoption
BESCHREIBUNG
--help, -h
Hilfetext für alle unterstützten Befehlszeilenoptionen auflisten
--botName, -N
Der Name, der dem Bot-Projekt zugewiesen wird
--packageName, -P
Der Java-Paketname, der für den Bot verwendet werden soll
Der Generator wird vor dem Erstellen eines neuen Bots nicht zur Bestätigung aufgefordert. Alle Anforderungsoptionen, die nicht an die Befehlszeile übergeben werden, verwenden einen angemessenen Standardwert. Diese Option soll die automatisierte Bot-Generation zu Testzwecken aktivieren.
Dank der Vorlage enthält Ihr Projekt sämtlichen Code, der zum Erstellen des Bots in dieser Schnellstartanleitung erforderlich ist. Zum Testen des Bots benötigen Sie keinen zusätzlichen Code.
Hinweis
Wenn Sie einen Core-Bot erstellen, benötigen Sie ein LUIS-Sprachmodell (Language Understanding). Sie können ein Sprachmodell bei luis.ai erstellen. Aktualisieren Sie die Konfigurationsdatei, nachdem Sie das Modell erstellt haben.
Verwenden Sie den Generator, um einen Echo-Bot zu erstellen.
yo botbuilder
Yeoman fordert Sie zur Eingabe einiger Informationen auf, um Ihren Bot zu erstellen. Verwenden Sie für dieses Tutorial die Standardwerte.
? 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
Dank der Vorlage enthält Ihr Projekt sämtlichen Code, der zum Erstellen des Bots in dieser Schnellstartanleitung erforderlich ist. Zum Testen des Bots benötigen Sie keinen zusätzlichen Code.
Hinweis
Wenn Sie einen Core-Bot erstellen, benötigen Sie ein LUIS-Sprachmodell (Language Understanding). Sie können ein Sprachmodell bei luis.ai erstellen. Aktualisieren Sie die Konfigurationsdatei, nachdem Sie das Modell erstellt haben.
Dadurch wird die Anwendung erstellt, auf „localhost“ bereitgestellt der Webbrowser mit der Seite default.htm der Anwendung geöffnet. Zu diesem Zeitpunkt wird Ihr Bot lokal an Port 3978 ausgeführt.
So führen Sie Ihren Bot von VS Code aus:
Öffnen Sie Ihren Bot-Projektordner.
Wenn Sie aufgefordert werden, ein Projekt auszuwählen, wählen Sie das Projekt für den soeben erstellten Bot aus.
Wechseln Sie zu "Ausführen", und wählen Sie dann " Ohne Debuggen ausführen" aus.
Wählen Sie die .NET Core Umgebung aus.
Wenn dieser Befehl Die Starteinstellungen aktualisiert hat, speichern Sie die Änderungen, und führen Sie den Befehl erneut aus.
Dadurch wird die Anwendung erstellt, auf „localhost“ bereitgestellt der Webbrowser mit der Seite default.htm der Anwendung geöffnet. Zu diesem Zeitpunkt wird Ihr Bot lokal an Port 3978 ausgeführt.
So führen Sie Ihren Bot lokal an einer Eingabeaufforderung oder einem Terminal aus:
Ändern Sie Verzeichnisse in den Projektordner für Ihren Bot.
Verwenden Sie dotnet run den Bot, um den Bot zu starten.
dotnet run
Dadurch wird die Anwendung erstellt und auf localhost bereitgestellt. Die Standardwebseite der Anwendung wird nicht angezeigt, aber an diesem Punkt wird Ihr Bot lokal auf Port 3978 ausgeführt.
Wechseln Sie in einem Terminalfenster oder einer Eingabeaufforderung in das Verzeichnis, das Sie für Ihren Bot erstellt haben, und starten Sie ihn mit npm start.
cd my-chat-bot
npm start
Zu diesem Zeitpunkt wird Ihr Bot lokal an Port 3978 ausgeführt.
Starten des Emulators und Herstellen einer Verbindung mit Ihrem Bot
Starten Sie den Bot Framework-Emulator.
Wählen Sie "Bot öffnen" auf der Registerkarte "Willkommen" Emulator aus.
Geben Sie die URL Ihres Bots ein, die Ihr lokaler Host und Port ist, der /api/messages dem Pfad hinzugefügt wurde. Die Adresse lautet in der Regel: http://localhost:3978/api/messages.
Wählen Sie dann Verbinden aus.
Senden Sie eine Nachricht an Ihren Bot, und der Bot antwortet zurück.
