Buat bot dengan Bot Framework SDK

BERLAKU UNTUK: SDK v4

Dalam mulai cepat ini, Anda akan mempelajari cara membuat bot pertama Anda dengan Bot Framework SDK untuk C#, Java, JavaScript, atau Python, dan cara menguji bot Anda dengan Bot Framework Emulator.

Membuat bot pertama Anda tidak memerlukan langganan Azure atau sumber daya Azure Bot Service. Mulai cepat ini berfokus pada pembuatan bot pertama Anda secara lokal. Jika Anda ingin mempelajari cara membuat bot di Azure, lihat Membuat sumber daya Azure Bot.

Prasyarat

C#

• Runtime ASP.NET Core 3.1
• Emulator Kerangka Kerja Bot
• Pengetahuan tentang ASP.NET Core dan pemrograman asinkron di C#

Templat

Visual Studio

• Visual Studio 2019 atau yang lebih baru
• Templat Bot Framework v4 SDK untuk Visual Studio

Untuk menambahkan templat bot ke Visual Studio, unduh dan instal Templat Bot Framework v4 SDK untuk file VSIX Visual Studio.

Catatan

Paket VSIX mencakup versi .NET Core 2.1 dan .NET Core 3.1 dari templat C#. Saat membuat bot baru di Visual Studio 2019 atau yang lebih baru, Anda harus menggunakan templat .NET Core 3.1. Sampel bot saat ini menggunakan templat .NET Core 3.1. Anda dapat menemukan sampel yang menggunakan templat .NET Core 2.1 di cabang arsip 4.7 dari repositori BotBuilder-Samples.

Untuk menginstal templat di Visual Studio, di bilah menu atas, navigasikan ke Ekstensi>Kelola Ekstensi. Kemudian cari dan instal Bot Framework v4 SDK untuk Visual Studio.

Untuk informasi tentang menyebarkan bot .NET Core 3.1 ke Azure, lihat cara menyebarkan bot Anda ke Azure.

Visual Studio Code / CLI

Templat .NET Core akan membantu Anda membangun bot AI percakapan baru dengan cepat menggunakan Bot Framework v4. Pada Mei 2020, templat dan kode yang dihasilkan memerlukan .NET Core 3.1.

Untuk menginstal templat Bot Framework:

1. Buka jendela konsol.

2. Unduh dan instal .NET Core SDK unduh versi 3.1 atau yang lebih baru.

3. Anda dapat menggunakan perintah ini untuk menentukan versi antarmuka baris perintah .NET Core mana yang telah Anda instal.

   dotnet --version
   

4. Instal tiga templat Bot Framework C#: templat bot echo, core, dan kosong.

   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. Pastikan templat telah diinstal dengan benar.

   dotnet new --list
   

Catatan

Langkah-langkah penginstalan di atas akan menginstal ketiga templat Bot Framework. Anda tidak perlu menginstal semua templat dan hanya dapat menginstal templat yang akan Anda gunakan. Artikel ini menggunakan templat bot echo .

Java

• Java 1.8 atau yang lebih baru
• Emulator Kerangka Kerja Bot
• Visual Studio Code atau IDE favorit Anda, jika Anda ingin mengedit kode bot.
• Menginstal Maven
• Instal node.js versi 12.10 atau yang lebih baru.
• Akun Azure jika Anda ingin menyebarkan ke Azure.

Templat

Gunakan generator Yeoman untuk menyiapkan bot AI percakapan dengan cepat menggunakan kemampuan AI inti di Bot Framework v4. Untuk informasi selengkapnya, lihat yeoman.io.

Generator mendukung tiga opsi templat yang berbeda seperti yang ditunjukkan di bawah ini.

Templat	Deskripsi
Echo Bot	Templat yang baik jika Anda menginginkan sedikit lebih dari "Halo Dunia!", tetapi tidak jauh lebih. Templat ini menangani dasar-dasar pengiriman pesan ke bot, dan meminta bot memproses pesan dengan mengulanginya kembali kepada pengguna. Templat ini menghasilkan bot yang hanya "menggema" kembali ke pengguna apa pun yang dikatakan pengguna ke bot.
Bot Kosong	Templat yang baik jika Anda terbiasa dengan Bot Framework v4, dan hanya menginginkan proyek kerangka dasar. Juga opsi yang baik jika Anda ingin mengambil kode sampel dari dokumentasi dan menempelkannya ke bot minimal untuk dipelajari.
Bot Inti	Templat yang baik jika Anda ingin membuat bot tingkat lanjut, karena menggunakan dialog multi-giliran dan LUIS, layanan kognitif berbasis AI, untuk menerapkan pemahaman bahasa. Templat ini membuat bot yang dapat mengekstrak tempat dan tanggal untuk memesan penerbangan.

Pasang Yeoman

1. Pastikan Anda telah menginstal node.js versi 12.10 atau yang lebih baru.

2. Instal npm terbaru.

   npm install -g npm
   

3. Pasang Yeoman. Pastikan untuk menginstal secara global.

   npm install -g yo
   

4. Pasang generator-botbuilder-java. Pastikan untuk menginstal secara global.

   npm install -g generator-botbuilder-java
   

5. Verifikasi bahwa Yeoman dan generator-botbuilder-java telah diinstal dengan benar.

   yo botbuilder-java --help
   

JavaScript

• Node.js
• Emulator Kerangka Kerja Bot
• Pengetahuan tentang memulihkan dan pemrograman asinkron di JavaScript
• Visual Studio Code atau IDE favorit Anda, jika Anda ingin mengedit kode bot.

Templat

Untuk menginstal Yeoman dan generator Yeoman untuk Bot Framework v4:

1. Buka terminal atau prompt perintah yang ditingkatkan.

2. Beralih ke direktori untuk bot JavaScript Anda. Buat terlebih dahulu jika Anda belum memilikinya.

   mkdir myJsBots
   cd myJsBots
   

3. Pastikan Anda memiliki versi terbaru npm dan Yeoman.

   npm install -g npm
   npm install -g yo
   

4. Pasang generator Yeoman. Yeoman adalah alat untuk membuat aplikasi. Untuk informasi selengkapnya, lihat yeoman.io.

   npm install -g generator-botbuilder
   

   Catatan

   Penginstalan alat build Windows yang tercantum di bawah ini hanya diperlukan jika Anda menggunakan Windows sebagai sistem operasi pengembangan Anda. Untuk beberapa penginstalan, langkah penginstalan untuk pemulihan adalah memberikan kesalahan yang terkait dengan node-gyp. Jika demikian, Anda dapat mencoba menjalankan perintah ini dengan izin yang ditingkatkan. Panggilan ini juga dapat macet tanpa keluar jika Python sudah diinstal pada sistem Anda:

   Hanya jalankan perintah ini jika Anda berada di Windows.

   npm install -g windows-build-tools
   

Python

• Python 3.8.3
• Emulator Kerangka Kerja Bot
• Pengetahuan tentang pemrograman asinkron di Python

Membuat dan mengaktifkan lingkungan virtual

Lingkungan virtual adalah kombinasi dari penerjemah dan pustaka Python tertentu yang berbeda dari pengaturan global Anda. Lingkungan virtual khusus untuk proyek dan dipertahankan di folder proyek. Manfaat untuk menggunakan lingkungan virtual adalah bahwa saat Anda mengembangkan proyek dari waktu ke waktu, lingkungan virtual selalu mencerminkan dependensi proyek yang tepat. Untuk mempelajari selengkapnya tentang lingkungan virtual, lihat Pembuatan lingkungan virtual.

Navigasikan ke direktori tempat Anda ingin membuat bot. Kemudian jalankan perintah berikut untuk platform pilihan Anda. Setelah Mengaktifkan lingkungan virtual, baris perintah/terminal Anda harus diawali dengan (venv). Ini memungkinkan Anda mengetahui bahwa lingkungan virtual aktif. Anda dapat menonaktifkan lingkungan virtual kapan saja dengan mengetik: deactivate.

macOS/Linux

python3 -m venv venv
source venv/bin/activate

Windows

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

Templat

Instal paket yang diperlukan dengan menjalankan perintah berikut pip install :

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

Penting

Jika Anda menggunakan Python versi 32-bit, pastikan Anda juga menjalankan pip install cryptography==2.8.

Buat bot

C#

Visual Studio

Di Visual Studio, buat proyek bot baru menggunakan templat Echo Bot (Bot Framework v4 - .NET Core 3.1). Untuk melihat hanya templat bot, pilih Bot AI dari jenis proyek.

Berkat templat, proyek Anda berisi semua kode yang diperlukan untuk membuat bot dalam mulai cepat ini. Anda tidak memerlukan kode tambahan untuk menguji bot Anda.

Visual Studio Code

Pastikan bahwa .NET Core 3.1 diinstal.

1. Di Visual Studio Code, buka jendela terminal baru.

2. Navigasikan ke direktori tempat Anda ingin membuat proyek bot Anda.

3. Buat proyek bot echo baru menggunakan perintah berikut. Ganti <your-bot-name> dengan nama yang akan digunakan untuk proyek bot Anda.

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

CLI

1. Buka jendela terminal baru.

2. Navigasikan ke direktori tempat Anda ingin membuat proyek bot Anda.

3. Buat proyek bot echo baru menggunakan perintah berikut. Ganti <your-bot-name> dengan nama yang akan digunakan untuk proyek bot Anda.

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

Tip

Jika Anda membuat bot Core :

• Hanya direktori solusi yang menerima nama bot.
• Anda akan memerlukan model bahasa LUIS. Anda dapat membuat model bahasa di luis.ai. Setelah membuat model, perbarui file konfigurasi.

Saya membuat bot gemasaya mengalami masalah

Java

Jalankan perintah berikut untuk membuat bot echo dari templat. Perintah menggunakan opsi default untuk parameternya.

yo botbuilder-java -T "echo"

Yeoman meminta Anda untuk beberapa informasi untuk membuat bot Anda. Untuk tutorial ini, gunakan nilai default.

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

Generator mendukung sejumlah opsi baris perintah yang dapat digunakan untuk mengubah opsi default generator atau untuk melakukan pra-seed prompt. Opsinya peka huruf besar/kecil.

Opsi baris perintah	Deskripsi
--help, -h	Mencantumkan teks bantuan untuk semua opsi baris perintah yang didukung
--botName, -N	Nama yang diberikan ke proyek bot
--packageName, -P	Nama paket Java yang akan digunakan untuk bot
--template, -T	Templat yang digunakan untuk menghasilkan proyek. Opsinya adalah echo, empty, core. Lihat https://github.com/Microsoft/BotBuilder-Samples/tree/main/generators untuk informasi tambahan mengenai berbagai opsi templat perbedaan fungsionalnya.
--noprompt	Generator tidak akan meminta konfirmasi sebelum membuat bot baru. Opsi persyaratan apa pun yang tidak diteruskan pada baris perintah akan menggunakan nilai default yang wajar. Opsi ini dimaksudkan untuk mengaktifkan pembuatan bot otomatis untuk tujuan pengujian.

Berkat templat, proyek Anda berisi semua kode yang diperlukan untuk membuat bot dalam mulai cepat ini. Anda tidak memerlukan kode tambahan untuk menguji bot Anda.

Catatan

Jika Anda membuat Core bot, Anda memerlukan model bahasa LUIS. Anda dapat membuat model bahasa di luis.ai. Setelah membuat model, perbarui file konfigurasi.

Saya membuat bot gemasaya mengalami masalah

JavaScript

1. Gunakan generator untuk membuat bot echo.

   yo botbuilder
   

   Yeoman meminta Anda untuk beberapa informasi untuk membuat bot Anda. Untuk tutorial ini, gunakan nilai default.

   ? 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
   

Berkat templat, proyek Anda berisi semua kode yang diperlukan untuk membuat bot dalam mulai cepat ini. Anda tidak memerlukan kode tambahan untuk menguji bot Anda.

Catatan

Jika Anda membuat Core bot, Anda memerlukan model bahasa LUIS. Anda dapat membuat model bahasa di luis.ai. Setelah membuat model, perbarui file konfigurasi.

Saya membuat bot gemasaya mengalami masalah

Python

1. Dari direktori kerja Anda, jalankan perintah berikut untuk mengunduh templat bot echo dan dependensinya:

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

2. Anda akan diminta untuk memberi nama dan deskripsi kepada bot Anda. Masukkan nilai berikut:

   • bot_name: echo_bot
   • bot_description: Bot yang menggemakan kembali respons pengguna.

   

Saya membuat bot gemasaya mengalami masalah

Memulai bot Anda

C#

Visual Studio

Di Visual Studio

1. Buka proyek bot Anda.
2. Jalankan proyek tanpa penelusuran kesalahan.

Ini akan membangun aplikasi, menyebarkannya ke localhost, dan meluncurkan browser web untuk menampilkan halaman aplikasi default.htm . Pada titik ini, bot Anda berjalan secara lokal pada port 3978.

Visual Studio Code

Untuk menjalankan bot Anda dari Visual Studio Code:

1. Buka folder proyek bot Anda.

   Jika Anda diminta untuk memilih proyek, pilih proyek untuk bot yang baru saja Anda buat.

2. Buka Jalankan, lalu pilih Jalankan Tanpa Penelusuran Kesalahan.

   

   • Pilih lingkungan .Net Core .

   

   • Jika perintah ini memperbarui pengaturan peluncuran Anda, simpan perubahan dan jalankan ulang perintah.

Ini akan membangun aplikasi, menyebarkannya ke localhost, dan meluncurkan browser web untuk menampilkan halaman aplikasi default.htm . Pada titik ini, bot Anda berjalan secara lokal pada port 3978.

CLI

Untuk menjalankan bot Anda secara lokal di prompt perintah atau terminal:

1. Ubah direktori ke folder proyek untuk bot Anda.

2. Gunakan dotnet run untuk memulai bot.

   dotnet run
   

Ini akan membangun aplikasi dan menyebarkannya ke localhost. Halaman web default aplikasi tidak akan ditampilkan, tetapi pada titik ini, bot Anda berjalan secara lokal pada port 3978.

Saya memulai bot gemasaya mengalami masalah

Java

1. Dari terminal, navigasikan ke direktori tempat Anda menyimpan bot, lalu jalankan perintah yang tercantum di bawah ini.

2. Buat proyek Maven dan kemas ke dalam file .jar (arsip).

   mvn package
   

3. Jalankan bot secara lokal. Ganti nama arsip dengan nama aktual dari perintah sebelumnya.

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

Anda sekarang siap untuk memulai Emulator.

Saya memulai bot gemasaya mengalami masalah

JavaScript

Di terminal atau prompt perintah ubah direktori ke direktori yang dibuat untuk bot Anda, dan mulai dengan npm start.

cd my-chat-bot
npm start

Pada titik ini, bot Anda berjalan secara lokal pada port 3978.

Saya memulai bot gemasaya mengalami masalah

Python

1. Dari baris perintah/terminal, ubah direktori menjadi echo_bot.

   cd echo_bot
   

2. Instal dependensi untuk templat bot echo.

   pip install -r requirements.txt 
   

3. Setelah dependensi diinstal, jalankan perintah berikut untuk memulai bot Anda:

   python app.py
   

   Anda akan tahu bot Anda siap untuk diuji ketika Anda melihat baris terakhir yang ditunjukkan pada cuplikan layar di bawah ini:

   

4. Salin alamat http di baris terakhir. Anda akan membutuhkannya saat menggunakan Emulator untuk berinteraksi dengan bot Anda.

Saya memulai bot gemasaya mengalami masalah

Mulai Emulator dan sambungkan bot Anda

1. Mulai Emulator Kerangka Kerja Bot.

2. Pilih Buka Bot pada tab Selamat Datang Emulator.

3. Masukkan URL bot Anda, yang merupakan host dan port lokal Anda, dengan /api/messages ditambahkan ke jalur. Alamatnya biasanya: http://localhost:3978/api/messages.

   

4. Kemudian pilih Sambungkan.

   Kirim pesan ke bot Anda, dan bot akan merespons kembali.

   

Saya memulai Emulator dan terhubung ke bot saya mengalami masalah

Sumber Daya Tambahan

• Lihat Men-debug bot untuk cara men-debug menggunakan Visual Studio atau Visual Studio Code dan Emulator Kerangka Kerja Bot.
• Lihat Penerowongan (ngrok) untuk informasi tentang cara menginstal ngrok.

Langkah berikutnya

Menyebarkan bot Anda ke Azure