Menggunakan QnA Maker untuk menjawab pertanyaan

BERLAKU UNTUK: SDK v4

QnA Maker menyediakan lapisan pertanyaan dan jawaban percakapan atas data Anda. Ini memungkinkan bot Anda untuk mengirim pertanyaan ke QnA Maker dan menerima jawaban tanpa perlu mengurai dan menafsirkan maksud pertanyaan.

Salah satu persyaratan dasar dalam membuat layanan QnA Maker Anda sendiri adalah mengisinya dengan pertanyaan dan jawaban. Dalam banyak kasus, pertanyaan dan jawaban sudah ada dalam konten seperti Tanya Jawab Umum (FAQ) atau dokumentasi lainnya; di lain waktu, Anda mungkin ingin menyesuaikan jawaban Anda atas pertanyaan dengan cara percakapan yang lebih alami.

Prasyarat

• Akun QnA Maker
• Pengetahuan tentang dasar-dasar bot dan QnA Maker.
• Salinan sampel QnA Maker (sederhana) di C#, JavaScript, Java, atau Python.

Tentang sampel ini

Untuk menggunakan QnA Maker di bot, Anda perlu membuat Pangkalan Pengetahuan di portal QnA Maker, seperti yang ditunjukkan di bagian berikutnya. Bot Anda kemudian dapat menggunakan Pangkalan Pengetahuan untuk menjawab pertanyaan pengguna.

C#

OnMessageActivityAsync dipanggil untuk setiap input pengguna yang diterima. Saat dipanggil, ia mengakses informasi yang _configuration disimpan dalam file appsetting.json kode sampel untuk menemukan nilai untuk terhubung ke Pangkalan Pengetahuan QnA Maker yang telah dikonfigurasi sebelumnya.

JavaScript

OnMessage dipanggil untuk setiap input pengguna yang diterima. Saat dipanggil, konektor Anda qnamaker yang telah dikonfigurasi sebelumnya menggunakan nilai yang disediakan dari file .env kode sampel Anda. Metode qnamaker getAnswers menghubungkan bot Anda ke Pangkalan Pengetahuan QnA Maker eksternal Anda.

Java

onMessageActivity dipanggil untuk setiap input pengguna yang diterima. Ketika dipanggil, ia mengakses informasi yang configuration disimpan dalam file application.properties kode sampel untuk menemukan nilai untuk terhubung ke Pangkalan Pengetahuan QnA Maker yang telah dikonfigurasi sebelumnya.

Python

on_message_activity dipanggil untuk setiap input pengguna yang diterima. Saat dipanggil, konektor Anda qna_maker yang telah dikonfigurasi sebelumnya menggunakan nilai yang disediakan dari file config.py kode sampel Anda. Metode qna_maker.getAnswers ini menghubungkan bot Anda ke Pangkalan Pengetahuan QnA Maker eksternal Anda.

Input pengguna dikirim ke Pangkalan Pengetahuan Anda dan jawaban terbaik yang dikembalikan ditampilkan kembali kepada pengguna Anda.

Membuat layanan QnA Maker dan menerbitkan Pangkalan Pengetahuan

1. Membuat layanan QnA Maker.
2. Buat Pangkalan Pengetahuan menggunakan file smartLightFAQ.tsv yang terletak di folder CognitiveModels dari proyek sampel. Beri nama Pangkalan Pengetahuan qna Anda, dan gunakan file smartLightFAQ.tsv untuk mengisinya.

Anda juga dapat menggunakan langkah-langkah ini untuk mengakses pangkalan pengetahuan QnA Maker Anda sendiri.

Catatan

Dokumentasi QnA Maker memiliki instruksi tentang cara membuat layanan di Azure dan untuk membuat, melatih, dan menerbitkan Pangkalan Pengetahuan Anda.

Mendapatkan nilai untuk menyambungkan bot Anda ke Pangkalan Pengetahuan

1. Di situs QnA Maker, pilih Pangkalan Pengetahuan Anda.
2. Dengan Pangkalan Pengetahuan Terbuka, pilih tab PENGATURAN. Catat nilai yang ditampilkan untuk nama layanan. Nilai ini berguna untuk menemukan Pangkalan Pengetahuan minat Anda saat menggunakan antarmuka portal QnA Maker. Ini tidak digunakan untuk menghubungkan aplikasi bot Anda ke Pangkalan Pengetahuan ini.
3. Gulir ke bawah untuk menemukan detail Penyebaran dan rekam nilai berikut dari contoh permintaan HTTP Postman:
   • POST /knowledgebases/<knowledge-base-id>/generateAnswer
   • Host: <your-host-url>
   • Otorisasi: EndpointKey <your-endpoint-key>

URL host Anda akan dimulai dengan https:// dan diakhbungi dengan /qnamaker, seperti https://<hostname>.azure.net/qnamaker. Bot Anda akan memerlukan ID Pangkalan Pengetahuan, URL host, dan kunci titik akhir untuk terhubung ke Pangkalan Pengetahuan QnA Maker Anda.

Memperbarui file pengaturan

Pertama, tambahkan informasi yang diperlukan untuk mengakses Pangkalan Pengetahuan Anda termasuk nama host, kunci titik akhir, dan ID Pangkalan Pengetahuan (kbId) ke dalam file pengaturan. Ini adalah nilai yang Anda simpan dari tab PENGATURAN Pangkalan Pengetahuan Anda di QnA Maker.

Jika Anda tidak menyebarkan ini untuk produksi, ID aplikasi dan bidang kata sandi bot Anda dapat dibiarkan kosong.

Catatan

Untuk menambahkan Pangkalan Pengetahuan QnA Maker ke dalam aplikasi bot yang ada, pastikan untuk menambahkan judul informatif untuk entri QnA Anda. Nilai "nama" dalam bagian ini menyediakan kunci yang diperlukan untuk mengakses informasi ini dari dalam aplikasi Anda.

C#

appsettings.json

{
  "MicrosoftAppType": "",
  "MicrosoftAppId": "",
  "MicrosoftAppPassword": "",
  "MicrosoftAppTenantId": "",
  "QnAKnowledgebaseId": "",
  "QnAEndpointKey": "",
  "QnAEndpointHostName": ""
}

JavaScript

.env

MicrosoftAppType=
MicrosoftAppId=
MicrosoftAppPassword=
MicrosoftAppTenantId=

QnAKnowledgebaseId=
QnAEndpointKey=
QnAEndpointHostName=

Java

application.properties

MicrosoftAppId=
MicrosoftAppPassword=
QnAKnowledgebaseId=
QnAEndpointKey=
QnAEndpointHostName=
server.port=3978

Python

config.py

class DefaultConfig:
    """ Bot Configuration """

    PORT = 3978
    APP_ID = os.environ.get("MicrosoftAppId", "")
    APP_PASSWORD = os.environ.get("MicrosoftAppPassword", "")
    QNA_KNOWLEDGEBASE_ID = os.environ.get("QnAKnowledgebaseId", "")
    QNA_ENDPOINT_KEY = os.environ.get("QnAEndpointKey", "")
    QNA_ENDPOINT_HOST = os.environ.get("QnAEndpointHostName", "")

Menyiapkan instans QnA Maker

Pertama, kami membuat objek untuk mengakses Pangkalan Pengetahuan QnA Maker kami.

C#

Pastikan bahwa paket NuGet Microsoft.Bot.Builder.AI.QnA diinstal untuk proyek Anda.

Di QnABot.cs, dalam OnMessageActivityAsync metode , buat instans QnAMaker. Kelas QnABot ini juga merupakan tempat nama informasi koneksi, disimpan dalam appsettings.json di atas, ditarik masuk. Jika Anda telah memilih nama yang berbeda untuk informasi koneksi Pangkalan Pengetahuan dalam file pengaturan Anda, pastikan untuk memperbarui nama di sini untuk mencerminkan nama yang Anda pilih.

Bot/QnABot.cs

var qnaMaker = new QnAMaker(new QnAMakerEndpoint
{
    KnowledgeBaseId = _configuration["QnAKnowledgebaseId"],
    EndpointKey = _configuration["QnAEndpointKey"],
    Host = _configuration["QnAEndpointHostName"]
},
null,
httpClient);

JavaScript

Pastikan bahwa botbuilder-ai paket npm diinstal untuk proyek Anda.

Dalam sampel, kode untuk logika bot ada dalam file QnABot.js .

Dalam file QnABot.js , kami menggunakan informasi koneksi yang disediakan oleh file .env Anda untuk membuat koneksi ke layanan QnA Maker: this.qnaMaker.

bot/QnABot.js

this.qnaMaker = new QnAMaker({
    knowledgeBaseId: process.env.QnAKnowledgebaseId,
    endpointKey: process.env.QnAEndpointKey,
    host: process.env.QnAEndpointHostName
});

Java

Di QnABot.java, dalam onMessageActivity metode , buat instans QnAMaker. Kelas QnABot ini juga merupakan tempat nama informasi koneksi, disimpan dalam application.properties di atas, ditarik masuk. Jika Anda telah memilih nama yang berbeda untuk informasi koneksi Pangkalan Pengetahuan dalam file pengaturan Anda, pastikan untuk memperbarui nama di sini untuk mencerminkan nama yang Anda pilih.

QnABot.java

QnAMakerEndpoint qnAMakerEndpoint = new QnAMakerEndpoint();
qnAMakerEndpoint.setKnowledgeBaseId(configuration.getProperty("QnAKnowledgebaseId"));
qnAMakerEndpoint.setEndpointKey(configuration.getProperty("QnAEndpointKey"));
qnAMakerEndpoint.setHost(configuration.getProperty("QnAEndpointHostName"));

QnAMaker qnaMaker = new QnAMaker(qnAMakerEndpoint, null);

Python

Dalam file qna_bot.py , gunakan informasi koneksi yang disediakan oleh file config.py untuk membuat koneksi ke layanan QnA Maker: self.qna_maker.

bot/qna_bot.py

self.qna_maker = QnAMaker(
    QnAMakerEndpoint(
        knowledge_base_id=config.QNA_KNOWLEDGEBASE_ID,
        endpoint_key=config.QNA_ENDPOINT_KEY,
        host=config.QNA_ENDPOINT_HOST,
    )
)

Memanggil QnA Maker dari bot Anda

C#

Saat bot Anda memerlukan jawaban dari QnAMaker, panggil GetAnswersAsync metode dari kode bot Anda untuk mendapatkan jawaban yang sesuai berdasarkan konteks saat ini. Jika Anda mengakses Pangkalan Pengetahuan Anda sendiri, ubah pesan tidak ada jawaban yang ditemukan di bawah ini untuk memberikan instruksi yang berguna bagi pengguna Anda.

Bot/QnABot.cs

var options = new QnAMakerOptions { Top = 1 };

// The actual call to the QnA Maker service.
var response = await qnaMaker.GetAnswersAsync(turnContext, options);
if (response != null && response.Length > 0)
{
    await turnContext.SendActivityAsync(MessageFactory.Text(response[0].Answer), cancellationToken);
}
else
{
    await turnContext.SendActivityAsync(MessageFactory.Text("No QnA Maker answers were found."), cancellationToken);
}

JavaScript

Dalam file QnABot.js, kami meneruskan input pengguna ke metode layanan getAnswers QnA Maker untuk mendapatkan jawaban dari Pangkalan Pengetahuan. Jika QnA Maker mengembalikan respons, ini ditampilkan kepada pengguna. Jika tidak, pengguna menerima pesan 'Tidak ada jawaban QnA Maker yang ditemukan.'

bot/QnABot.js

const qnaResults = await this.qnaMaker.getAnswers(context);

// If an answer was received from QnA Maker, send the answer back to the user.
if (qnaResults[0]) {
    await context.sendActivity(qnaResults[0].answer);

// If no answers were returned from QnA Maker, reply with help.
} else {
    await context.sendActivity('No QnA Maker answers were found.');
}

Java

Saat bot Anda memerlukan jawaban dari QnAMaker, panggil getAnswers metode dari kode bot Anda untuk mendapatkan jawaban yang sesuai berdasarkan konteks saat ini. Jika Anda mengakses Pangkalan Pengetahuan, ubah pesan tidak ada jawaban yang ditemukan untuk memberikan instruksi bermanfaat bagi pengguna Anda.

QnABot.java

QnAMakerOptions options = new QnAMakerOptions();
options.setTop(1);

// The actual call to the QnA Maker service.
return qnaMaker.getAnswers(turnContext, options)
    .thenCompose(response -> {
        if (response != null && response.length > 0) {
            return turnContext.sendActivity(MessageFactory.text(response[0].getAnswer()))
                .thenApply(sendResult -> null);
        }
        else {
            return turnContext.sendActivity(MessageFactory.text("No QnA Maker answers were found."))
                .thenApply(sendResult -> null);
        }

Python

Dalam file qna_bot.py, kami meneruskan input pengguna ke metode layanan get_answers QnA Maker untuk mendapatkan jawaban dari Pangkalan Pengetahuan. Jika QnA Maker mengembalikan respons, ini ditampilkan kepada pengguna. Jika tidak, pengguna menerima pesan Tidak ada jawaban QnA Maker yang ditemukan.

bot/qna_bot.py

# The actual call to the QnA Maker service.
response = await self.qna_maker.get_answers(turn_context)
if response and len(response) > 0:
    await turn_context.send_activity(MessageFactory.text(response[0].answer))
else:
    await turn_context.send_activity("No QnA Maker answers were found.")

Menguji bot

Jalankan sampel secara lokal di komputer Anda. Jika Anda belum melakukannya, instal Bot Framework Emulator. Untuk petunjuk lebih lanjut, lihat sampel README (C#, JavaScript, Python).

Mulai Emulator, sambungkan ke bot Anda, dan kirim pesan seperti yang ditunjukkan di bawah ini.

Informasi Tambahan

Sampel multi-giliran QnA Maker (C#, JavaScript, Java, Python) menunjukkan cara menggunakan dialog QnA Maker untuk mendukung perintah tindak lanjut QnA Maker dan fitur pembelajaran aktif.

• QnA Maker mendukung petunjuk tindak lanjut, juga dikenal sebagai perintah multi-giliran. Jika QnA Maker Pangkalan Pengetahuan memerlukan respons tambahan dari pengguna, QnA Maker mengirimkan informasi konteks yang dapat Anda gunakan untuk meminta pengguna. Informasi ini juga digunakan untuk melakukan panggilan tindak lanjut ke layanan QnA Maker. Di versi 4.6, Bot Framework SDK menambahkan dukungan untuk fitur ini.

  Untuk membuat Pangkalan Pengetahuan seperti itu, lihat dokumentasi QnA Maker tentang cara Menggunakan perintah tindak lanjut untuk membuat beberapa giliran percakapan.

• QnA Maker juga mendukung saran pembelajaran aktif, memungkinkan Pangkalan Pengetahuan meningkat dari waktu ke waktu. Dialog QnA Maker mendukung umpan balik eksplisit untuk fitur pembelajaran aktif.

  Untuk mengaktifkan fitur ini pada Pangkalan Pengetahuan, lihat dokumentasi QnA Maker tentang Saran pembelajaran aktif.

Langkah berikutnya

QnA Maker dapat dikombinasikan dengan Cognitive Services lainnya, untuk membuat bot Anda lebih kuat. Alat Pengiriman menyediakan cara untuk menggabungkan QnA dengan Pemahaman Bahasa (LUIS) di bot Anda.

Menggabungkan layanan LUIS dan QnA menggunakan alat Pengiriman