Vytvoření robota pomocí sady SDK služby Bot Framework

PLATÍ PRO: SDK v4

Tento článek popisuje, jak sestavit svého prvního robota pomocí sady Bot Framework SDK pro C#, Javu, JavaScript nebo Python a jak otestovat robota pomocí bot Framework Emulatoru.

Vytvoření prvního robota nevyžaduje předplatné Azure ani prostředek Azure AI Bot Service. Tento rychlý start se zaměřuje na místní vytvoření prvního robota. Pokud chcete zjistit, jak vytvořit robota v Azure, přečtěte si téma Vytvoření prostředku robota Azure.

Poznámka:

Sady SDK služby Bot Framework JavaScript, C# a Python budou nadále podporovány, ale sada Java SDK se vyřazuje s konečnou dlouhodobou podporou končící v listopadu 2023. V tomto úložišti budou provedeny pouze kritické opravy zabezpečení a chyb.

Stávající roboti sestavení pomocí sady Java SDK budou i nadále fungovat.

Pro nové vytváření robotů zvažte použití Power Virtual Agents a přečtěte si o výběru správného řešení chatovacího robota.

Další informace najdete v tématu Budoucnost vytváření robotů.

Předpoklady

C#

• Sada .NET 6.0 SDK
• Bot Framework Emulator
• Znalost ASP.NET jádra a asynchronního programování v jazyce C#

Šablony jazyka C#

Aktuální ukázky robotů používají šablony .NET Core 3.1.

Visual Studio

• Visual Studio 2022 nebo novější
• Šablony sady SDK služby Bot Framework v4 pro Visual Studio

Pokud chcete přidat šablony robota do sady Visual Studio, stáhněte a nainstalujte šablony sady SDK sady Bot Framework v4 pro soubor Visual Studio VSIX.

Poznámka:

Šablony můžete nainstalovat ze sady Visual Studio.

1. V nabídce vyberte Rozšíření a pak Spravovat rozšíření.
2. V dialogovém okně Spravovat rozšíření vyhledejte a nainstalujte šablony sady Bot Framework v4 SDK pro Visual Studio.

Informace o nasazení robotů .NET do Azure najdete v tématu zřízení a publikování robota.

VS Code / CLI

Šablony .NET Core vám pomůžou rychle vytvářet nové konverzační roboty AI pomocí bot Frameworku v4. Od května 2020 tyto šablony a kód, které vygenerují, vyžadují .NET Core 3.1 nebo novější.

Instalace šablon bot Frameworku:

1. Otevřete okno konzoly.

2. Stáhněte a nainstalujte sadu .NET Core SDK verze 3.1 nebo novější.

3. Tento příkaz můžete použít k určení verzí rozhraní příkazového řádku .NET Core.

   dotnet --version
   

4. Nainstalujte tři šablony bot Framework C#: echo, jádro a prázdné šablony robotů.

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

5. Ověřte, že jsou šablony správně nainstalované.

   dotnet new --list
   

Poznámka:

Výše uvedené kroky nainstalují všechny tři šablony služby Bot Framework. Nemusíte instalovat všechny šablony a můžete nainstalovat jenom ty, které budete používat. Tento článek využívá šablonu robota echo.

Java

• Java 1.8 nebo novější
• Bot Framework Emulator
• Visual Studio Code nebo vaše oblíbené integrované vývojové prostředí (IDE), pokud chcete upravit kód robota.
• Instalace Mavenu
• Nainstalujte node.js verze 12.10 nebo novější.
• Účet Azure, pokud chcete nasadit do Azure.

Šablony Java

Pomocí generátoru Yeoman můžete rychle vytvořit konverzačního robota AI pomocí základních funkcí umělé inteligence v bot Frameworku v4. Další informace najdete v tématu yeoman.io.

Generátor podporuje tři různé možnosti šablony, jak je znázorněno níže.

Template	Popis
Echo Bot	Dobrá šablona, pokud chcete něco víc než "Hello World!", ale ne mnohem více. Tato šablona zpracovává základní informace o odesílání zpráv robotovi a zpracování zpráv robotem jejich opakováním zpět uživateli. Tato šablona vytvoří robota, který jednoduše "ozvěna" zpět uživateli, cokoli uživatel řekne robotovi.
Prázdný robot	Dobrá šablona, pokud znáte Bot Framework v4, a jednoduše chcete základní kostru projektu. Dobrá možnost, pokud chcete z dokumentace vzít vzorový kód a vložit ho do minimálního robota, abyste se naučili.
Core Bot	Dobrá šablona, pokud chcete vytvořit pokročilé roboty, protože k implementaci porozumění jazyku používá dialogová okna s vícenásobným otáčením a Azure AI LUIS . Tato šablona vytvoří robota, který může extrahovat místa a data pro rezervaci letu.

Poznámka:

Služba Language Understanding (LUIS) bude vyřazena 1. října 2025. Od 1. dubna 2023 nebudete moct vytvářet nové prostředky LUIS. Novější verze language understanding je teď dostupná jako součást jazyka Azure AI.

Konverzační jazyk understanding (CLU), funkce jazyka Azure AI, je aktualizovaná verze služby LUIS. Další informace o podpoře porozumění jazyku v sadě SDK služby Bot Framework najdete v tématu Principy přirozeného jazyka.

Nainstalovat Yeoman

1. Ujistěte se, že máte nainstalovaný node.js verze 12.10 nebo novější.

2. Nainstalujte nejnovější npm.

   npm install -g npm
   

3. Nainstalujte Yeomana. Nezapomeňte nainstalovat globálně.

   npm install -g yo
   

4. Nainstalujte generátor-botbuilder-java. Nezapomeňte nainstalovat globálně.

   npm install -g generator-botbuilder-java
   

5. Ověřte, že jste správně nainstalovali Yeoman a generator-botbuilder-java .

   yo botbuilder-java --help
   

JavaScript

• Node.js
• Bot Framework Emulator
• Znalost restify a asynchronního programování v JavaScriptu
• Visual Studio Code nebo vaše oblíbené integrované vývojové prostředí (IDE), pokud chcete upravit kód robota.

JavaScript a šablony TypeScriptu

Instalace Yeomanu a generátoru Yeoman pro Bot Framework v4:

1. Otevřete terminál nebo příkazový řádek se zvýšenými oprávněními.

2. Přepněte do adresáře pro roboty JavaScriptu. Nejprve ho vytvořte, pokud ho ještě nemáte.

   mkdir myJsBots
   cd myJsBots
   

3. Ujistěte se, že máte nejnovější verze npm a Yeoman.

   npm install -g npm
   npm install -g yo
   

4. Nainstalujte generátor Yeoman. Yeoman je nástroj pro vytváření aplikací. Další informace najdete v tématu yeoman.io.

   npm install -g generator-botbuilder
   

   Poznámka:

   Instalace níže uvedených nástrojů sestavení systému Windows se vyžaduje jenom v případě, že jako vývojový operační systém používáte Windows. U některých instalací se v kroku instalace pro restify zobrazí chyba související s node-gyp. V takovém případě můžete zkusit spustit tento příkaz se zvýšenými oprávněními. Toto volání může také přestat reagovat, pokud je Python již ve vašem systému nainstalovaný:

   Tento příkaz spusťte jenom v případě, že používáte Windows.

   npm install -g windows-build-tools
   

Python

• Python 3.8.3
• Bot Framework Emulator
• Znalost asynchronního programování v Pythonu

Vytvoření a povolení virtuálního prostředí

Virtuální prostředí je kombinací konkrétního interpreta Pythonu a knihoven, které se liší od globálního nastavení. Virtuální prostředí je specifické pro projekt a udržuje se ve složce projektu. Výhodou použití virtuálního prostředí je, že při vývoji projektu v průběhu času bude virtuální prostředí vždy odrážet přesné závislosti projektu. Další informace o virtuálních prostředích najdete v tématu Vytváření virtuálních prostředí.

Přejděte do adresáře, do kterého chcete robota vytvořit. Pak spusťte následující příkazy pro preferovanou platformu. Po aktivaci virtuálního prostředí by měl být příkazový řádek nebo terminál předcházet (venv). To vám umožní zjistit, že virtuální prostředí je aktivní. Virtuální prostředí můžete kdykoli deaktivovat zadáním: deactivate.

macOS/Linux

python3 -m venv venv
source venv/bin/activate

Windows

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

Šablony Pythonu

Nainstalujte potřebné balíčky spuštěním následujících pip install příkazů:

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

Důležité

Pokud používáte 32bitovou verzi Pythonu, nezapomeňte také spustit pip install cryptography==2.8.

Vytvoření robota

C#

Visual Studio

V sadě Visual Studio vytvořte nový projekt robota a použijte šablonu Echo Bot (Bot Framework v4 – .NET Core 3.1). Pokud chcete zobrazit jenom šablony robotů, zvolte typ projektu robotů AI.

VS Code

Ujistěte se, že je nainstalované rozhraní .NET Core 3.1 nebo novější.

1. V editoru Visual Studio Code otevřete nové okno terminálu.

2. Přejděte do adresáře, ve kterém chcete vytvořit projekt robota.

3. Pomocí následujícího příkazu vytvořte nový projekt robota echo. Nahraďte <your-bot-name> názvem, který se má použít pro projekt robota.

   dotnet new echobot -n <your-bot-name>
   

Rozhraní příkazového řádku

1. Otevřete nové okno terminálu.

2. Přejděte do adresáře, ve kterém chcete vytvořit projekt robota.

3. Pomocí následujícího příkazu vytvořte nový projekt robota echo. Nahraďte <your-bot-name> názvem, který se má použít pro projekt robota.

   dotnet new echobot -n <your-bot-name>
   

Díky šabloně obsahuje váš projekt veškerý potřebný kód k vytvoření robota v tomto rychlém startu. K otestování robota nepotřebujete žádný další kód.

Vytvořil(a) jsem robotaecho, na který jsem narazil(a) na problém

Java

Spuštěním následujícího příkazu vytvořte z šablon robota echo. Příkaz používá výchozí možnosti pro své parametry.

yo botbuilder-java -T "echo"

Yeoman vás vyzve k zadání některých informací, se kterými chcete robota vytvořit. Pro účely tohoto kurzu použijte výchozí hodnoty.

? 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"

Generátor podporuje mnoho možností příkazového řádku, které můžete použít ke změně výchozích hodnot generátoru nebo k předběžnému zadání výzvy. V možnostech se rozlišují malá a velká písmena.

Možnost příkazového řádku	Popis
--help, -h	Seznam textu nápovědy pro všechny podporované možnosti příkazového řádku
--botName, -N	Název udělený projektu robota
--packageName, -P	Název balíčku Java, který se má použít pro robota
--template, -T	Šablona použitá k vygenerování projektu. Možnosti jsou echo, empty, core. Další informace o různých šablonách najdete v úložišti GitHub pro váš jazyk, C#, JavaScript, Python nebo Javu.
--noprompt	Generátor před vytvořením nového robota nezobrazí výzvu k potvrzení. Všechny možnosti požadavků, které nejsou předány na příkazovém řádku, budou používat rozumnou výchozí hodnotu. Tato možnost je určená k povolení automatizovaného generování robotů pro účely testování.

Díky šabloně obsahuje váš projekt veškerý kód, který je nezbytný k vytvoření robota v tomto rychlém startu. K otestování robota nepotřebujete žádný jiný kód.

Vytvořil(a) jsem robotaecho, na který jsem narazil(a) na problém

JavaScript

1. Pomocí generátoru vytvořte robota echo.

   yo botbuilder
   

   Yeoman vás vyzve k zadání některých informací, se kterými chcete robota vytvořit. Pro účely tohoto kurzu použijte výchozí hodnoty.

   ? 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
   

Díky šabloně obsahuje váš projekt veškerý kód, který je nezbytný k vytvoření robota v tomto rychlém startu. K otestování robota nepotřebujete žádný jiný kód.

Vytvořil(a) jsem robotaecho, na který jsem narazil(a) na problém

Python

1. Z pracovního adresáře spusťte následující příkaz, který stáhne šablonu robota echo a její závislosti:

   cookiecutter https://github.com/microsoft/BotBuilder-Samples/releases/download/Templates/echo.zip
   

2. Zobrazí se výzva, abyste robotovi dali název a popis. Zadejte následující hodnoty:

   • bot_name: echo_bot
   • bot_description: Robot, který vrací odpověď uživatele.

   

Vytvořil(a) jsem robotaecho, na který jsem narazil(a) na problém

Spuštění robota

C#

Visual Studio

V sadě Visual Studio:

1. Otevřete projekt robota.
2. Spusťte projekt bez ladění.
3. Visual Studio aplikaci sestaví, nasadí ji na localhost a spustí webový prohlížeč, aby se zobrazila default.htm stránka aplikace.

V tuto chvíli robot běží místně na portu 3978.

VS Code

V editoru Visual Studio Code:

1. Otevřete složku projektu robota.

   Pokud se zobrazí výzva k výběru projektu, vyberte projekt, který jste vytvořili.

2. V nabídce vyberte Spustit a potom Spustit bez ladění.

   • Pokud se zobrazí výzva k výběru prostředí, vyberte .Net Core.
   • Pokud tento příkaz aktualizoval nastavení spuštění, uložte změny a spusťte příkaz znovu.

   Příkaz spustit sestaví aplikaci, nasadí ji do místního hostitele a spustí webový prohlížeč, aby se zobrazila default.htm stránka aplikace.

V tuto chvíli robot běží místně na portu 3978.

Rozhraní příkazového řádku

Z příkazového řádku nebo terminálu:

1. Změňte adresáře do složky projektu robota.

2. Slouží dotnet run ke spuštění robota.

   dotnet run
   

3. Tento příkaz sestaví aplikaci a nasadí ji na localhost.

Výchozí webová stránka aplikace se nezobrazí, ale v tuto chvíli robot běží místně na portu 3978.

Spustil(a) jsem robotaecho, na který jsem narazil(a) na problém

Java

1. V terminálu přejděte do adresáře, do kterého jste robota uložili, a spusťte níže uvedené příkazy.

2. Sestavte projekt Maven a zabalí ho do souboru .jar (archiv).

   mvn package
   

3. Spusťte robota místně. Nahraďte název archivu skutečným názvem z předchozího příkazu.

   java -jar .\target\<archive-name>.jar
   

Teď jste připraveni spustit emulátor.

Spustil(a) jsem robotaecho, na který jsem narazil(a) na problém

JavaScript

V terminálu nebo příkazovém řádku změňte adresáře na adresář vytvořený pro robota a spusťte ho .npm start

cd my-chat-bot
npm start

V tuto chvíli robot běží místně na portu 3978.

Spustil(a) jsem robotaecho, na který jsem narazil(a) na problém

Python

1. Z příkazového řádku nebo terminálu změňte adresáře na echo_bot.

   cd echo_bot
   

2. Nainstalujte závislosti šablony robota echo.

   pip install -r requirements.txt 
   

3. Po instalaci závislostí spusťte robota spuštěním následujícího příkazu:

   python app.py
   

   Jakmile uvidíte poslední řádek zobrazený na následujícím snímku obrazovky, budete vědět, že robot je připravený k otestování:

   

4. Zkopírujte adresu HTTP na posledním řádku. Budete ho potřebovat, když k interakci s robotem použijete emulátor.

Spustil(a) jsem robotaecho, na který jsem narazil(a) na problém

Spuštění emulátoru a připojení robota

1. Spusťte bot Framework Emulator.

2. Na úvodní kartě emulátoru vyberte Otevřít robota.

3. Zadejte adresu URL vašeho robota, což je místní hostitel a port, s přidanou /api/messages cestou. Adresa je obvykle: http://localhost:3978/api/messages.

   

4. Pak vyberte Připojení.

   Pošlete robotovi zprávu a robot odpoví zpět.

   

Spustil(a) jsem emulátor a připojil(a) jsem se k robotovi, na který jsem narazil(a) na problém

Další kroky

• Informace o ladění pomocí sady Visual Studio nebo editoru Visual Studio Code a bot Framework Emulatoru naleznete v tématu Ladění robota.
• Informace o nástroji ngrok naleznete v tématu Tunelování (ngrok).

Nasazení robota do Azure