Robot létrehozása a Bot Framework SDK-val

A KÖVETKEZŐKRE VONATKOZIK: SDK v4

Ez a cikk bemutatja, hogyan hozhatja létre első robotját a Bot Framework SDK for C#, Java, JavaScript vagy Python használatával, és hogyan tesztelheti a robotot a Bot Framework Emulator használatával.

Az első robot létrehozásához nincs szükség Azure-előfizetésre vagy Azure AI Bot Service-erőforrásra. Ez a rövid útmutató az első robot helyi létrehozására összpontosít. Ha szeretné megtudni, hogyan hozhat létre robotot az Azure-ban, olvassa el az Azure Bot-erőforrás létrehozása című témakört.

Feljegyzés

A Bot Framework JavaScript, C# és Python SDK-k továbbra is támogatottak lesznek, a Java SDK-t azonban 2023 novemberében végső hosszú távú támogatással kivonják.

A Java SDK-val létrehozott meglévő robotok továbbra is működni fognak.

Új robotépítéshez fontolja meg a Power Virtual Agents használatát, és olvassa el a megfelelő csevegőrobot-megoldás kiválasztását.

További információ: A robotépítés jövője.

Előfeltételek

C#

• .NET 6.0 SDK
• Bot Framework Emulator
• A ASP.NET Core és aszinkron programozás ismerete a C-ben#

C#-sablonok

Az aktuális robotminták .NET Core 3.1-sablonokat használnak.

Visual Studio

• Visual Studio 2022 vagy újabb
• Bot Framework v4 SDK-sablonok a Visual Studióhoz

Ha hozzá szeretné adni a robotsablonokat a Visual Studióhoz, töltse le és telepítse a Bot Framework v4 SDK Templates for Visual Studio VSIX fájlt.

Feljegyzés

A sablonokat a Visual Studióban telepítheti.

1. A menüben válassza a Bővítmények , majd a Bővítmények kezelése lehetőséget.
2. A Bővítmények kezelése párbeszédpanelen keresse meg és telepítse a Bot Framework v4 SDK-sablonokat a Visual Studióhoz.

A .NET-robotok Azure-ban való üzembe helyezésével kapcsolatos információkért tekintse meg a robotok üzembe helyezésének és közzétételének módját.

VS Code /CLI

A .NET Core-sablonok segítségével gyorsan létrehozhat új beszélgetési AI-robotokat a Bot Framework v4 használatával. 2020 májusától ezek a sablonok és az általuk létrehozott kód megkövetelik a .NET Core 3.1 vagy újabb verzióját.

A Bot Framework-sablonok telepítése:

1. Nyisson meg egy konzolablakot.

2. Töltse le és telepítse a .NET Core SDK 3.1-es vagy újabb verzióját.

3. Ezzel a paranccsal meghatározhatja, hogy a .NET Core parancssori felület mely verziói vannak telepítve.

   dotnet --version
   

4. Telepítse a három Bot Framework C#-sablont: az echo, a mag és az üres robotsablonokat.

   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. Ellenőrizze, hogy a sablonok megfelelően lettek-e telepítve.

   dotnet new --list
   

Feljegyzés

A fenti lépések mind a három Bot Framework-sablont telepítik. Nem kell telepítenie az összes sablont, és csak a használni kívánt sablonokat telepítheti. Ez a cikk az echo robotsablont használja.

Java

• Java 1.8 vagy újabb verzió
• Bot Framework Emulator
• A Visual Studio Code-ot vagy a kedvenc IDE-t, ha szerkeszteni szeretné a robotkódot.
• A Maven telepítése
• Telepítse node.js 12.10-es vagy újabb verzióját.
• Azure-fiók, ha üzembe szeretne helyezni az Azure-ban.

Java-sablonok

A Yeoman generátorral gyorsan létrehozhat egy beszélgetési AI-robotot a Bot Framework v4 alapvető AI-képességeinek használatával. További információ: yeoman.io.

A generátor három különböző sablonbeállítást támogat az alábbiak szerint.

Sablon	Leírás
Echo Bot	Egy jó sablon, ha egy kicsit többet szeretne, mint a ""Helló világ!" alkalmazás!", de nem sokkal több. Ez a sablon kezeli az üzenetek robotnak való küldésének alapvető alapjait, és azt, hogy a robot feldolgozhassa az üzeneteket úgy, hogy ismételi őket a felhasználónak. Ez a sablon létrehoz egy robotot, amely egyszerűen "visszhangot" ad vissza a felhasználónak, amit a felhasználó a robotnak mond.
Üres robot	Jó sablon, ha ismeri a Bot Framework v4-et, és egyszerűen egy alapszintű csontvázprojektet szeretne. Akkor is jó megoldás, ha mintakódot szeretne venni a dokumentációból, és beilleszteni egy minimális robotba a tanuláshoz.
Alapvető robot	Egy jó sablon, ha speciális robotokat szeretne létrehozni, mivel többfordulós párbeszédpaneleket és Azure AI LUIS-t használ a nyelvfelismerés implementálásához. Ez a sablon létrehoz egy robotot, amely képes helyeket és dátumokat kinyerni egy járat lefoglalásához.

Feljegyzés

A Language Understanding (LUIS) 2025. október 1-jén megszűnik. 2023. április 1-től nem hozhat létre új LUIS-erőforrásokat. Az Azure AI Language részeként már elérhető a nyelvértés újabb verziója.

Az Azure AI Language egyik funkciója, a beszélgetési nyelv megértése (CLU) a LUIS frissített verziója. További információ a Bot Framework SDK nyelvfelismerési támogatásáról: Természetes nyelvfelismerés.

A Yeoman telepítése

1. Győződjön meg arról, hogy telepítette node.js 12.10-es vagy újabb verzióját.

2. Telepítse a legújabb npm-et.

   npm install -g npm
   

3. Telepítse a Yeoman-t. Ügyeljen arra, hogy globálisan telepítsen.

   npm install -g yo
   

4. Telepítse a generator-botbuilder-java elemet. Ügyeljen arra, hogy globálisan telepítsen.

   npm install -g generator-botbuilder-java
   

5. Ellenőrizze, hogy a Yeoman és a generator-botbuilder-java megfelelően lett-e telepítve.

   yo botbuilder-java --help
   

JavaScript

• Node.js
• Bot Framework Emulator
• Restify és aszinkron programozás ismerete JavaScriptben
• A Visual Studio Code-ot vagy a kedvenc IDE-t, ha szerkeszteni szeretné a robotkódot.

JavaScript- és TypeScript-sablonok

A Yeoman és a Yeoman generátor telepítése a Bot Framework v4-hez:

1. Nyisson meg egy terminált vagy egy emelt szintű parancssort.

2. Váltson a JavaScript-robotok könyvtárára. Hozza létre először, ha még nincs ilyenje.

   mkdir myJsBots
   cd myJsBots
   

3. Győződjön meg arról, hogy az npm és a Yeoman legújabb verzióival rendelkezik.

   npm install -g npm
   npm install -g yo
   

4. Telepítse a Yeoman generátort. A Yeoman egy eszköz alkalmazások létrehozásához. További információ: yeoman.io.

   npm install -g generator-botbuilder
   

   Feljegyzés

   Az alább felsorolt Windows buildeszközök telepítése csak akkor szükséges, ha a Windowst használja fejlesztési operációs rendszerként. Egyes telepítések esetében a restify telepítési lépése hibát jelez a következőhöz node-gyp: . Ebben az esetben megpróbálhatja futtatni ezt a parancsot emelt szintű engedélyekkel. Ez a hívás kilépés nélkül is lefagyhat, ha a Python már telepítve van a rendszeren:

   Ezt a parancsot csak Windows rendszeren futtathatja.

   npm install -g windows-build-tools
   

Python

• Python 3.8.3
• Bot Framework Emulator
• Az aszinkron programozás ismerete a Pythonban

Virtuális környezet létrehozása és engedélyezése

A virtuális környezet egy adott Python-értelmező és kódtár kombinációja, amely eltér a globális beállításoktól. A virtuális környezet egy projektre jellemző, és a projektmappában van fenntartva. A virtuális környezetek használatának egyik előnye, hogy a projekt idővel történő fejlesztése során a virtuális környezet mindig tükrözi a projekt pontos függőségeit. A virtuális környezetekkel kapcsolatos további információkért lásd a virtuális környezetek létrehozását ismertető témakört.

Lépjen arra a könyvtárra, ahol létre szeretné hozni a robotot. Ezután futtassa az alábbi parancsokat az előnyben részesített platformhoz. A virtuális környezet aktiválása után a parancssornak/terminálnak előtaggal kell rendelkeznie (venv). Ez tudatja Önvel, hogy a virtuális környezet aktív. A virtuális környezetet bármikor inaktiválhatja a következő beírással: deactivate.

macOS/Linux

python3 -m venv venv
source venv/bin/activate

Windows

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

Python-sablonok

Telepítse a szükséges csomagokat a következő pip install parancsok futtatásával:

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

Fontos

Ha a Python 32 bites verzióját használja, győződjön meg arról, hogy a futtatás is történik pip install cryptography==2.8.

Robot létrehozása

C#

Visual Studio

A Visual Studióban hozzon létre egy új robotprojektet, és használja az Echo Bot (Bot Framework v4 - .NET Core 3.1) sablont. Ha csak a robotsablonokat szeretné megtekinteni, válassza ki az AI-robotok projekttípust .

VS Code

Győződjön meg arról, hogy a .NET Core 3.1 vagy újabb verziója telepítve van.

1. A Visual Studio Code-ban nyisson meg egy új terminálablakot.

2. Lépjen arra a könyvtárra, amelyben létre szeretné hozni a robotprojektet.

3. Hozzon létre egy új echo robotprojektet az alábbi paranccsal. Cserélje le <your-bot-name> a robotprojekthez használandó névre.

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

Parancssori felület

1. Nyisson meg egy új terminálablakot.

2. Lépjen arra a könyvtárra, amelyben létre szeretné hozni a robotprojektet.

3. Hozzon létre egy új echo robotprojektet az alábbi paranccsal. Cserélje le <your-bot-name> a robotprojekthez használandó névre.

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

A sablonnak köszönhetően a projekt tartalmazza a robot létrehozásához szükséges összes kódot ebben a rövid útmutatóban. A robot teszteléséhez nincs szükség több kódra.

Létrehoztam egy echo-robotot, amely problémába ütközött

Java

Futtassa a következő parancsot egy echo-robot sablonokból való létrehozásához. A parancs az alapértelmezett beállításokat használja a paramétereihez.

yo botbuilder-java -T "echo"

Yeoman kéri, hogy néhány információt, amellyel létre a robot. Ebben az oktatóanyagban használja az alapértelmezett értékeket.

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

A generátor számos parancssori lehetőséget támogat, amelyek segítségével módosíthatja a generátor alapértelmezett beállításait, vagy előre beírhat egy parancssort. A beállítások megkülönböztetik a kis- és nagybetűket.

Parancssori lehetőség	Leírás
--help, -h	Az összes támogatott parancssori beállítás súgószövegének listázása
--botName, -N	A robotprojektnek adott név
--packageName, -P	A robothoz használandó Java-csomag neve
--template, -T	A projekt létrehozásához használt sablon. A beállítások a következőkecho: , emptycore. A különböző sablonokról további információt a nyelvhez, C#-hoz, JavaScripthez, Pythonhoz vagy Java-hoz készült GitHub-adattárban talál.
--noprompt	A generátor nem kér megerősítést egy új robot létrehozása előtt. A parancssorban nem átadott követelménybeállítások ésszerű alapértelmezett értéket használnak. Ez a beállítás az automatizált robotlétrehozás tesztelési célokra való engedélyezésére szolgál.

A sablonnak köszönhetően a projekt tartalmazza a robot létrehozásához szükséges összes kódot ebben a rövid útmutatóban. A robot teszteléséhez nincs szükség más kódra.

Létrehoztam egy echo-robotot, amely problémába ütközött

JavaScript

1. A generátor használatával hozzon létre egy echo robotot.

   yo botbuilder
   

   Yeoman kéri, hogy néhány információt, amellyel létre a robot. Ebben az oktatóanyagban használja az alapértelmezett értékeket.

   ? 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
   

A sablonnak köszönhetően a projekt tartalmazza a robot létrehozásához szükséges összes kódot ebben a rövid útmutatóban. A robot teszteléséhez nincs szükség más kódra.

Létrehoztam egy echo-robotot, amely problémába ütközött

Python

1. A munkakönyvtárból futtassa a következő parancsot az echo robotsablon és függőségei letöltéséhez:

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

2. A rendszer kérni fogja, hogy adjon nevet és leírást a robotnak. Írja be a következő értékeket:

   • bot_name: echo_bot
   • bot_description: Egy robot, amely visszajelezi a felhasználói választ.

   

Létrehoztam egy echo-robotot, amely problémába ütközött

A robot indítása

C#

Visual Studio

A Visual Studióban:

1. Nyissa meg a robotprojektet.
2. Futtassa a projektet hibakeresés nélkül.
3. A Visual Studio létrehozza az alkalmazást, üzembe helyezi a localhostban, és elindítja a webböngészőt az alkalmazás oldalának default.htm megjelenítéséhez.

Ezen a ponton a robot helyileg fut a 3978-os porton.

VS Code

A Visual Studio Code-ban:

1. Nyissa meg a robotprojekt mappát.

   Ha a rendszer egy projekt kiválasztására kéri, válassza ki a létrehozott robotot.

2. A menüben válassza a Futtatás, majd a Futtatás hibakeresés nélkül lehetőséget.

   • Ha a rendszer arra kéri, hogy válasszon ki egy környezetet, válassza a .Net Core lehetőséget.
   • Ha ez a parancs frissítette az indítási beállításokat, mentse a módosításokat, és futtassa újra a parancsot.

   A futtatási parancs létrehozza az alkalmazást, üzembe helyezi a localhostban, és elindítja a webböngészőt az alkalmazás lapjának default.htm megjelenítéséhez.

Ezen a ponton a robot helyileg fut a 3978-os porton.

Parancssori felület

Parancssorból vagy terminálból:

1. Módosítsa a könyvtárakat a robot projektmappájába.

2. A robot elindításához használható dotnet run .

   dotnet run
   

3. Ez a parancs létrehozza az alkalmazást, és üzembe helyezi a localhostban.

Az alkalmazás alapértelmezett weblapja nem jelenik meg, de jelenleg a robot helyileg fut a 3978-os porton.

Elindítottam az echo robotot, és problémába ütköztem

Java

1. Egy terminálból lépjen arra a könyvtárra, ahová a robotot mentette, majd hajtsa végre az alábbi parancsokat.

2. Hozza létre a Maven-projektet, és csomagolja egy .jar fájlba (archívumba).

   mvn package
   

3. Futtassa a robotot helyileg. Cserélje le az archív nevet az előző parancs tényleges nevére.

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

Most már készen áll az Emulátor elindítására.

Elindítottam az echo robotot, és problémába ütköztem

JavaScript

Egy terminálban vagy parancssorban módosítsa a címtárakat a robot számára létrehozott könyvtárra, és kezdje a következővel npm start: .

cd my-chat-bot
npm start

Ezen a ponton a robot helyileg fut a 3978-os porton.

Elindítottam az echo robotot, és problémába ütköztem

Python

1. A parancssorból/terminálból módosítsa a címtárakat a következőre echo_bot: .

   cd echo_bot
   

2. Telepítse az echorobot-sablon függőségeit.

   pip install -r requirements.txt 
   

3. A függőségek telepítése után futtassa a következő parancsot a robot elindításához:

   python app.py
   

   Tudni fogja, hogy a robot készen áll a tesztelésre, amikor az alábbi képernyőképen látható utolsó sort látja:

   

4. Másolja a http-címet az utolsó sorba. Szüksége lesz rá, amikor az Emulatort használja a robottal való interakcióhoz.

Elindítottam az echo robotot, és problémába ütköztem

Indítsa el az Emulátort, és csatlakoztassa a robotot

1. Indítsa el a Bot Framework Emulatort.

2. Válassza a Robot megnyitása lehetőséget az Emulátor Üdvözlő lapján.

3. Adja meg a robot URL-címét, amely a helyi gazdagép és port, és /api/messages adja hozzá az elérési úthoz. A cím általában a következő: http://localhost:3978/api/messages.

   

4. Ezután válassza a Csatlakozás.

   Küldjön üzenetet a robotnak, és a robot válaszol.

   

Elindítottam az Emulátort, és csatlakoztam a robotomhoz, és problémába ütköztem

Következő lépések

• A Visual Studio vagy a Visual Studio Code és a Bot Framework Emulator használatával történő hibakeresésről további információt a robot hibakeresése című témakörben talál.
• Az ngrokkal kapcsolatos információkért lásd: Bújtatás (ngrok).

Robot üzembe helyezése az Azure-ban