QnAMakerDialog class

Referensi

Paket:: botbuilder-ai

Dialog yang mendukung layanan QnA Maker multi-langkah dan pembelajaran adaptif.

Memperluas: WaterfallDialog

Konstruktor

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)	Menginisialisasi instans baru kelas QnAMakerDialog.
QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)	Menginisialisasi instans baru kelas QnAMakerDialog.

Properti

$kind
activeLearningCardTitle	Mendapatkan atau mengatur judul kartu yang akan digunakan saat menampilkan opsi pembelajaran aktif kepada pengguna. Catatan: Jika saranActivityFactory diteruskan, anggota ini tidak digunakan.
cardNoMatchResponse	Mendapatkan atau mengatur templat untuk dikirim ke pengguna jika mereka memilih opsi tidak cocok pada kartu pembelajaran aktif.
cardNoMatchText	Mendapatkan atau mengatur teks tombol yang akan digunakan dengan opsi pembelajaran aktif, memungkinkan pengguna untuk menunjukkan bahwa tidak ada opsi yang berlaku. Catatan: Jika saranActivityFactory diteruskan, anggota ini diperlukan.
displayPreciseAnswerOnly	Mendapatkan atau menetapkan nilai yang menunjukkan apakah respons dialog hanya akan menampilkan jawaban yang tepat.
enablePreciseAnswer	Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan menyertakan jawaban yang tepat sebagai respons.
endpointKey	Mendapatkan atau mengatur kunci titik akhir QnA Maker untuk digunakan untuk mengkueri pangkalan pengetahuan.
filters	Mendapatkan atau mengatur metadata dan sumber yang digunakan untuk memfilter hasil.
hostname	Mendapatkan atau mengatur URL host QnA Maker untuk pangkalan pengetahuan.
includeUnstructuredSources	Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan menyertakan sumber yang tidak terstruktur dalam mencari jawaban.
isTest	Mendapatkan atau menetapkan nilai yang menunjukkan apakah mendapatkan atau menetapkan lingkungan pangkalan pengetahuan yang akan dipanggil.
knowledgeBaseId	Mendapatkan atau mengatur ID pangkalan pengetahuan QnA Maker ke kueri.
logPersonalInformation	Mendapatkan atau mengatur bendera untuk menentukan apakah informasi pribadi harus dicatat dalam telemetri.
noAnswer	Mendapatkan atau mengatur templat untuk dikirim ke pengguna saat QnA Maker tidak menemukan jawaban.
qnaServiceType	Jenis layanan jawaban atas pertanyaan - qnaMaker atau bahasa
rankerType	Mendapatkan atau mengatur jenis ranker QnA Maker untuk digunakan.
strictFilters	Mendapatkan atau mengatur metadata QnA Maker untuk memfilter atau meningkatkan kueri ke pangkalan pengetahuan, atau null untuk menerapkan tidak ada.
strictFiltersJoinOperator	Mendapatkan atau menetapkan nilai - AND atau OR - operasi logis pada daftar metadata
threshold	Mendapatkan atau mengatur ambang untuk jawaban yang dikembalikan, berdasarkan skor.
top	Mendapatkan atau mengatur jumlah maksimum jawaban untuk dikembalikan dari pangkalan pengetahuan.

Properti yang Diwariskan

EndOfTurn	Mendapatkan hasil akhir giliran default.
id
telemetryClient

Metode

beginDialog(DialogContext, object)	Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.
continueDialog(DialogContext)	Dipanggil ketika dialog dilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan Aktivitasbaru.
getConverter(Object)

Metode yang Diwarisi

addStep(WaterfallStep<O>)	Menambahkan langkah baru ke air terjun.
configure(Record<string, unknown>)	Metode fasih untuk mengonfigurasi objek.
endDialog(TurnContext, DialogInstance, DialogReason)	Dipanggil saat dialog berakhir.
getVersion()	Mendapatkan versi dialog, terdiri dari ID dan jumlah langkah.
onDialogEvent(DialogContext, DialogEvent)	Dipanggil ketika peristiwa telah dinaikkan, menggunakan `DialogContext.emitEvent()`, dengan dialog saat ini atau dialog yang dimulai dialog saat ini.
repromptDialog(TurnContext, DialogInstance)	Saat ditimpa di kelas turunan, promporsi ulang pengguna untuk input.
resumeDialog(DialogContext, DialogReason, any)	Dipanggil ketika anak WaterfallDialog menyelesaikan gilirannya, mengembalikan kontrol ke dialog ini.

Detail Konstruktor

QnAMakerDialog(string, string, string, Activity, number, QnASuggestionsActivityFactory, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Menginisialisasi instans baru kelas QnAMakerDialog.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, suggestionsActivityFactory?: QnASuggestionsActivityFactory, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Parameter

knowledgeBaseId: string

ID pangkalan pengetahuan QnA Maker untuk dikueri.

endpointKey: string

Kunci titik akhir QnA Maker untuk digunakan untuk mengkueri pangkalan pengetahuan.

hostname: string

URL host QnA Maker untuk pangkalan pengetahuan, dimulai dengan "https://" dan diakhir dengan "/qnamaker".

noAnswer: Activity

(Opsional) Aktivitas untuk mengirim pengguna ketika QnA Maker tidak menemukan jawaban.

threshold: number

(Opsional) Ambang batas di atas untuk memperlakukan jawaban yang ditemukan dari pangkalan pengetahuan sebagai kecocokan.

suggestionsActivityFactory: QnASuggestionsActivityFactory

(xref:botbuilder-ai. QnASuggestionsActivityFactory) digunakan untuk pemformatan Aktivitas kustom.

cardNoMatchText: string

(Opsional) Teks tombol yang digunakan dengan opsi pembelajaran aktif, memungkinkan pengguna untuk menunjukkan tidak ada opsi yang berlaku.

top: number

(Opsional) Jumlah maksimum jawaban untuk dikembalikan dari pangkalan pengetahuan.

cardNoMatchResponse: Activity

(Opsional) Aktivitas untuk mengirim pengguna jika mereka memilih opsi tidak cocok pada kartu pembelajaran aktif.

rankerType: RankerTypes

strictFilters: QnAMakerMetadata[]

(Opsional) Metadata QnA Maker untuk memfilter atau meningkatkan kueri ke pangkalan pengetahuan; atau null untuk menerapkan tidak ada.

dialogId: string

(Opsional) Id dialog yang dibuat. Defaultnya adalah 'QnAMakerDialog'.

strictFiltersJoinOperator: JoinOperator

operator gabungan untuk filter ketat

enablePreciseAnswer: boolean

displayPreciseAnswerOnly: boolean

qnaServiceType: ServiceType

QnAMakerDialog(string, string, string, Activity, number, string, string, number, Activity, RankerTypes, QnAMakerMetadata[], string, JoinOperator, boolean, boolean, ServiceType)

Menginisialisasi instans baru kelas QnAMakerDialog.

new QnAMakerDialog(knowledgeBaseId?: string, endpointKey?: string, hostname?: string, noAnswer?: Activity, threshold?: number, activeLearningCardTitle?: string, cardNoMatchText?: string, top?: number, cardNoMatchResponse?: Activity, rankerType?: RankerTypes, strictFilters?: QnAMakerMetadata[], dialogId?: string, strictFiltersJoinOperator?: JoinOperator, enablePreciseAnswer?: boolean, displayPreciseAnswerOnly?: boolean, qnaServiceType?: ServiceType)

Parameter

knowledgeBaseId: string

ID pangkalan pengetahuan QnA Maker untuk dikueri.

endpointKey: string

Kunci titik akhir QnA Maker untuk digunakan untuk mengkueri pangkalan pengetahuan.

hostname: string

URL host QnA Maker untuk pangkalan pengetahuan, dimulai dengan "https://" dan diakhir dengan "/qnamaker".

noAnswer: Activity

(Opsional) Aktivitas untuk mengirim pengguna ketika QnA Maker tidak menemukan jawaban.

threshold: number

(Opsional) Ambang batas di atas untuk memperlakukan jawaban yang ditemukan dari pangkalan pengetahuan sebagai kecocokan.

activeLearningCardTitle: string

(Opsional) Judul kartu yang akan digunakan saat menampilkan opsi pembelajaran aktif kepada pengguna, jika pembelajaran aktif diaktifkan.

cardNoMatchText: string

(Opsional) Teks tombol yang digunakan dengan opsi pembelajaran aktif, memungkinkan pengguna untuk menunjukkan tidak ada opsi yang berlaku.

top: number

(Opsional) Jumlah maksimum jawaban untuk dikembalikan dari pangkalan pengetahuan.

cardNoMatchResponse: Activity

(Opsional) Aktivitas untuk mengirim pengguna jika mereka memilih opsi tidak cocok pada kartu pembelajaran aktif.

rankerType: RankerTypes

strictFilters: QnAMakerMetadata[]

(Opsional) Metadata QnA Maker untuk memfilter atau meningkatkan kueri ke pangkalan pengetahuan; atau null untuk menerapkan tidak ada.

dialogId: string

(Opsional) Id dialog yang dibuat. Defaultnya adalah 'QnAMakerDialog'.

strictFiltersJoinOperator: JoinOperator

operator gabungan untuk filter ketat

enablePreciseAnswer: boolean

displayPreciseAnswerOnly: boolean

qnaServiceType: ServiceType

Detail Properti

$kind

static $kind: string

Nilai Properti

string

activeLearningCardTitle

Mendapatkan atau mengatur judul kartu yang akan digunakan saat menampilkan opsi pembelajaran aktif kepada pengguna. Catatan: Jika saranActivityFactory diteruskan, anggota ini tidak digunakan.

activeLearningCardTitle: StringExpression

Nilai Properti

StringExpression

cardNoMatchResponse

Mendapatkan atau mengatur templat untuk dikirim ke pengguna jika mereka memilih opsi tidak cocok pada kartu pembelajaran aktif.

cardNoMatchResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Nilai Properti

TemplateInterface<Partial<Activity>, DialogStateManager>

cardNoMatchText

Mendapatkan atau mengatur teks tombol yang akan digunakan dengan opsi pembelajaran aktif, memungkinkan pengguna untuk menunjukkan bahwa tidak ada opsi yang berlaku. Catatan: Jika saranActivityFactory diteruskan, anggota ini diperlukan.

cardNoMatchText: StringExpression

Nilai Properti

StringExpression

displayPreciseAnswerOnly

Mendapatkan atau menetapkan nilai yang menunjukkan apakah respons dialog hanya akan menampilkan jawaban yang tepat.

displayPreciseAnswerOnly: boolean

Nilai Properti

boolean

enablePreciseAnswer

Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan menyertakan jawaban yang tepat sebagai respons.

enablePreciseAnswer: boolean

Nilai Properti

boolean

endpointKey

Mendapatkan atau mengatur kunci titik akhir QnA Maker untuk digunakan untuk mengkueri pangkalan pengetahuan.

endpointKey: StringExpression

Nilai Properti

StringExpression

filters

Mendapatkan atau mengatur metadata dan sumber yang digunakan untuk memfilter hasil.

filters: Filters

Nilai Properti

Filters

hostname

Mendapatkan atau mengatur URL host QnA Maker untuk pangkalan pengetahuan.

hostname: StringExpression

Nilai Properti

StringExpression

includeUnstructuredSources

Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan menyertakan sumber yang tidak terstruktur dalam mencari jawaban.

includeUnstructuredSources: boolean

Nilai Properti

boolean

isTest

Mendapatkan atau menetapkan nilai yang menunjukkan apakah mendapatkan atau menetapkan lingkungan pangkalan pengetahuan yang akan dipanggil.

isTest: boolean

Nilai Properti

boolean

knowledgeBaseId

Mendapatkan atau mengatur ID pangkalan pengetahuan QnA Maker ke kueri.

knowledgeBaseId: StringExpression

Nilai Properti

StringExpression

logPersonalInformation

Mendapatkan atau mengatur bendera untuk menentukan apakah informasi pribadi harus dicatat dalam telemetri.

logPersonalInformation: BoolExpression

Nilai Properti

BoolExpression

noAnswer

Mendapatkan atau mengatur templat untuk dikirim ke pengguna saat QnA Maker tidak menemukan jawaban.

noAnswer: TemplateInterface<Partial<Activity>, DialogStateManager>

Nilai Properti

TemplateInterface<Partial<Activity>, DialogStateManager>

qnaServiceType

Jenis layanan jawaban atas pertanyaan - qnaMaker atau bahasa

qnaServiceType: ServiceType

Nilai Properti

ServiceType

rankerType

Mendapatkan atau mengatur jenis ranker QnA Maker untuk digunakan.

rankerType: EnumExpression<RankerTypes>

Nilai Properti

EnumExpression<RankerTypes>

strictFilters

Mendapatkan atau mengatur metadata QnA Maker untuk memfilter atau meningkatkan kueri ke pangkalan pengetahuan, atau null untuk menerapkan tidak ada.

strictFilters: QnAMakerMetadata[]

Nilai Properti

QnAMakerMetadata[]

strictFiltersJoinOperator

Mendapatkan atau menetapkan nilai - AND atau OR - operasi logis pada daftar metadata

strictFiltersJoinOperator: JoinOperator

Nilai Properti

JoinOperator

threshold

Mendapatkan atau mengatur ambang untuk jawaban yang dikembalikan, berdasarkan skor.

threshold: NumberExpression

Nilai Properti

NumberExpression

top

Mendapatkan atau mengatur jumlah maksimum jawaban untuk dikembalikan dari pangkalan pengetahuan.

top: IntExpression

Nilai Properti

IntExpression

Detail Properti yang Diwariskan

EndOfTurn

Mendapatkan hasil akhir giliran default.

static EndOfTurn: DialogTurnResult

Nilai Properti

DialogTurnResult

Keterangan

Hasil ini menunjukkan bahwa dialog (atau langkah logis dalam dialog) telah menyelesaikan pemrosesan untuk giliran saat ini, masih aktif, dan menunggu lebih banyak input.

Diwariskan Dari dialog.EndOfTurn

id

id: string

Nilai Properti

string

Diwariskan Dari Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Nilai Properti

BotTelemetryClient

Diwariskan Dari Dialog.telemetryClient

Detail Metode

beginDialog(DialogContext, object)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.

function beginDialog(dc: DialogContext, options?: object): Promise<DialogTurnResult>

Parameter

dc: DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

options: object

(Opsional) Informasi awal untuk diteruskan ke dialog.

Mengembalikan

Promise<DialogTurnResult>

Janji yang menyelesaikan hasil giliran

continueDialog(DialogContext)

Dipanggil ketika dialog dilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan Aktivitasbaru.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Parameter

dc: DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

Mengembalikan

Promise<DialogTurnResult>

Janji yang mewakili operasi asinkron.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Parameter

property: Object

Properti yang memperluas QnAMakerDialogConfiguration.

Mengembalikan

Converter | ConverterFactory

Pengonversi ekspresi.

Detail Metode yang Diwarisi

addStep(WaterfallStep<O>)

Menambahkan langkah baru ke air terjun.

function addStep(step: WaterfallStep<O>): this

Parameter

step: WaterfallStep<O>

Fungsi langkah asinkron untuk dipanggil.

Mengembalikan

this

Dialog air terjun untuk panggilan fasih ke addStep().

Keterangan

Semua fungsi langkah harus asinkron dan mengembalikan DialogTurnResult. WaterfallStepContext yang diteruskan ke fungsi Anda berasal dari DialogContext dan berisi banyak metode manipulasi tumpukan yang mengembalikan DialogTurnResult sehingga Anda biasanya hanya dapat mengembalikan hasil dari metode DialogContext yang Anda panggil.

Fungsi langkah itu sendiri dapat berupa penutupan asinkron:

const helloDialog = new WaterfallDialog('hello');

helloDialog.addStep(async (step) => {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
});

Fungsi asinkron bernama:

async function helloWorldStep(step) {
    await step.context.sendActivity(`Hello World!`);
    return await step.endDialog();
}

helloDialog.addStep(helloWorldStep);

Atau metode kelas yang terikat ke penunjuk this:

helloDialog.addStep(this.helloWorldStep.bind(this));

Diwariskan Dari WaterfallDialog.addStep

configure(Record<string, unknown>)

Metode fasih untuk mengonfigurasi objek.

function configure(config: Record<string, unknown>): this

Parameter

config: Record<string, unknown>

Pengaturan konfigurasi yang akan diterapkan.

Mengembalikan

this

yang dapat dikonfigurasi setelah operasi selesai.

Diwariskan Dari Configurable.configure

endDialog(TurnContext, DialogInstance, DialogReason)

Dipanggil saat dialog berakhir.

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Parameter

context: TurnContext

Konteks untuk pergantian percakapan saat ini.

instance: DialogInstance

Instans dialog saat ini.

reason: DialogReason

Alasan dialog berakhir.

Mengembalikan

Promise<void>

Diwariskan Dari air terjun Dialog.endDialog

getVersion()

Mendapatkan versi dialog, terdiri dari ID dan jumlah langkah.

function getVersion(): string

Mengembalikan

string

Versi dialog, terdiri dari ID dan jumlah langkah.

Diwariskan Dari WaterfallDialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Dipanggil ketika peristiwa telah dinaikkan, menggunakan DialogContext.emitEvent(), dengan dialog saat ini atau dialog yang dimulai dialog saat ini.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Parameter

dc: DialogContext

Konteks dialog untuk pergantian percakapan saat ini.

e: DialogEvent

Peristiwa yang sedang dinaikkan.

Mengembalikan

Promise<boolean>

True jika peristiwa ditangani oleh dialog saat ini dan gelembung harus berhenti.

Diwariskan Dari dialog.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

Saat ditimpa di kelas turunan, promporsi ulang pengguna untuk input.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Parameter

_context: TurnContext

Objek konteks untuk giliran.

_instance: DialogInstance

Informasi status saat ini untuk dialog ini.

Mengembalikan

Promise<void>

Keterangan

Dialog turunan yang mendukung validasi dan logika permintaan ulang harus mengambil alih metode ini. Secara default, metode ini tidak berpengaruh.

DialogContext memanggil metode ini ketika dialog saat ini harus meminta kembali input dari pengguna. Metode ini diimplementasikan untuk dialog perintah.

Lihat juga

Diwariskan Dari dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

Dipanggil ketika anak WaterfallDialog menyelesaikan gilirannya, mengembalikan kontrol ke dialog ini.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Parameter

dc: DialogContext

DialogContext untuk pergantian percakapan saat ini.

reason: DialogReason

(xref:botbuilder-dialogs. DialogReason) mengapa dialog dilanjutkan.

result: any

Opsional, nilai yang dikembalikan dari dialog yang dipanggil. Jenis nilai yang dikembalikan tergantung pada dialog anak.

Mengembalikan

Promise<DialogTurnResult>

Janji yang mewakili operasi asinkron.

Diwariskan Dari WaterfallDialog.resumeDialog