Bagikan melalui

AdaptiveDialog class

  • Referensi
Paket:
botbuilder-dialogs-adaptive

Dialog Adaptif memodelkan percakapan menggunakan peristiwa dan peristiwa untuk beradaptasi secara dinamis dengan mengubah alur percakapan.

Memperluas

DialogContainer<O>

Konstruktor

AdaptiveDialog(string)

Membuat instans AdaptiveDialog baru.

Properti

$kind
autoEndDialog

Apakah akan mengakhiri dialog ketika tidak ada tindakan untuk dijalankan.
conditionTracker
defaultResultProperty

Properti yang akan dikembalikan sebagai hasil ketika dialog berakhir ketika tidak ada lagi Tindakan dan AutoEndDialog = true.
generator

Fakultatif. Pengalih Bahasa Generator.
recognizer

Fakultatif. Recognizer digunakan untuk menganalisis ucapan pesan apa pun.
schema

Mengatur Skema JSON untuk dialog. Mendapatkan Skema JSON untuk dialog.
selector

Fakultatif. Pemilih untuk memilih kemungkinan peristiwa yang akan dijalankan.
triggers

Picu handler untuk merespons kondisi yang memodifikasi rencana eksekusi.

Properti yang Diwariskan

dialogs

Kumpulan dialog kontainer.
EndOfTurn

Mendapatkan hasil akhir giliran default.
id
telemetryClient

Metode

beginDialog(DialogContext, O)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.
continueDialog(DialogContext)

Dipanggil ketika dialog dilanjutkan, di mana dialog aktif dan pengguna membalas dengan aktivitas baru.
createChildContext(DialogContext)

Membuat Dialogcontext turunan untuk konteks yang diberikan.
endDialog(TurnContext, DialogInstance, DialogReason)

Dipanggil saat dialog berakhir.
getConverter(Object)
getDependencies()

Mendapatkan Dialog dependensi enumerasi.
repromptDialog(DialogContext | TurnContext, DialogInstance)

Memprompesi ulang pengguna.
resumeDialog(DialogContext, DialogReason, any)

Dipanggil ketika dialog turunan menyelesaikan gilirannya, mengembalikan kontrol ke dialog ini.

Metode yang Diwarisi

configure(Record<string, unknown>)

Metode fasih untuk mengonfigurasi objek.
findDialog(string)

Menemukan dialog anak yang sebelumnya ditambahkan ke kontainer.
getVersion()

String yang dikodekan yang digunakan untuk membantu dalam deteksi perubahan bot pada penyebaran ulang.
onDialogEvent(DialogContext, DialogEvent)

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

Detail Konstruktor

AdaptiveDialog(string)

Membuat instans AdaptiveDialog baru.

new AdaptiveDialog(dialogId?: string)

Parameter

dialogId

string

(Opsional) ID unik komponen dalam kumpulan dialog induknya.

Detail Properti

$kind 

static $kind: string

Nilai Properti

string

autoEndDialog

Apakah akan mengakhiri dialog ketika tidak ada tindakan untuk dijalankan.

autoEndDialog: BoolExpression

Nilai Properti

BoolExpression

Keterangan

Jika true, ketika tidak ada tindakan untuk dijalankan, dialog saat ini akan berakhir. Jika false, ketika tidak ada tindakan untuk dijalankan, dialog saat ini hanya akan mengakhiri giliran dan masih aktif. Default ke nilai true.

conditionTracker 

static conditionTracker: string

Nilai Properti

string

defaultResultProperty

Properti yang akan dikembalikan sebagai hasil ketika dialog berakhir ketika tidak ada lagi Tindakan dan AutoEndDialog = true.

defaultResultProperty: string

Nilai Properti

string

Keterangan

Default ke nilai dialog.result.

generator

Fakultatif. Pengalih Bahasa Generator.

generator?: LanguageGenerator

Nilai Properti

LanguageGenerator

recognizer

Fakultatif. Recognizer digunakan untuk menganalisis ucapan pesan apa pun.

recognizer?: Recognizer

Nilai Properti

Recognizer

schema

Mengatur Skema JSON untuk dialog. Mendapatkan Skema JSON untuk dialog.

object schema

Nilai Properti

object

Skema dialog.

selector

Fakultatif. Pemilih untuk memilih kemungkinan peristiwa yang akan dijalankan.

selector: TriggerSelector

Nilai Properti

TriggerSelector

triggers

Picu handler untuk merespons kondisi yang memodifikasi rencana eksekusi.

triggers: OnCondition[]

Nilai Properti

OnCondition[]

Detail Properti yang Diwariskan

dialogs

Kumpulan dialog kontainer.

dialogs: DialogSet

Nilai Properti

DialogSet

Diwariskan Dari DialogContainer.dialogs

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 DialogContainer.telemetryClient

Detail Metode

beginDialog(DialogContext, O)

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog.

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

Parameter

dc

DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

options

O

Informasi awal opsional untuk diteruskan ke dialog.

Mengembalikan

Promise<DialogTurnResult>

Janji yang mewakili operasi asinkron.

continueDialog(DialogContext)

Dipanggil ketika dialog dilanjutkan, di mana dialog aktif dan pengguna membalas dengan aktivitas baru.

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

Parameter

dc

DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

Mengembalikan

Promise<DialogTurnResult>

Janji yang mewakili operasi asinkron.

createChildContext(DialogContext)

Membuat Dialogcontext turunan untuk konteks yang diberikan.

function createChildContext(dc: DialogContext): DialogContext

Parameter

dc

DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

Mengembalikan

DialogContext

DialogContext turunan atau null jika tidak ada AdaptiveDialogState.actions yang ditemukan untuk konteks tertentu.

endDialog(TurnContext, DialogInstance, DialogReason)

Dipanggil saat dialog berakhir.

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

Parameter

turnContext

TurnContext

Objek konteks untuk giliran ini.

instance

DialogInstance

Informasi status yang terkait dengan instans dialog ini pada tumpukan dialog.

reason

DialogReason

Alasan mengapa dialog berakhir.

Mengembalikan

Promise<void>

Janji yang mewakili operasi asinkron.

getConverter(Object) 

function getConverter(property: Object): Converter | ConverterFactory

Parameter

property

Object

Kunci konfigurasi pemilih bersyarah.

Mengembalikan

Converter | ConverterFactory

Pengonversi untuk konfigurasi pemilih.

getDependencies()

Mendapatkan Dialog dependensi enumerasi.

function getDependencies(): Dialog[]

Mengembalikan

Dialog[]

(xref:botbuilder-dialogs. Dependensi yang dijumlahkan dialog.

repromptDialog(DialogContext | TurnContext, DialogInstance)

Memprompesi ulang pengguna.

function repromptDialog(context: DialogContext | TurnContext, instance: DialogInstance): Promise<void>

Parameter

context

DialogContext | TurnContext

Objek konteks untuk giliran.

instance

DialogInstance

Informasi status saat ini untuk dialog ini.

Mengembalikan

Promise<void>

Janji yang mewakili operasi asinkron.

resumeDialog(DialogContext, DialogReason, any)

Dipanggil ketika dialog turunan menyelesaikan gilirannya, mengembalikan kontrol ke dialog ini.

function resumeDialog(dc: DialogContext, _reason?: DialogReason, _result?: any): Promise<DialogTurnResult>

Parameter

dc

DialogContext

Konteks dialog untuk pergantian percakapan saat ini.

_reason

DialogReason

Alasan 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.

Detail Metode yang Diwarisi

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

findDialog(string)

Menemukan dialog anak yang sebelumnya ditambahkan ke kontainer.

function findDialog(dialogId: string): Dialog | undefined

Parameter

dialogId

string

ID dialog untuk pencarian.

Mengembalikan

Dialog | undefined

Dialog jika ditemukan; jika tidak, null.

Diwariskan Dari DialogContainer.findDialog

getVersion()

String yang dikodekan yang digunakan untuk membantu dalam deteksi perubahan bot pada penyebaran ulang.

function getVersion(): string

Mengembalikan

string

String unik yang seharusnya hanya berubah ketika dialog telah berubah dengan cara yang harus menghidupkan ulang dialog.

Keterangan

Ini default untuk mengembalikan dialog id tetapi dapat ditimpa untuk memberikan logika deteksi perubahan yang lebih tepat. Setiap dialog pada tumpukan yang memiliki perubahan versinya akan mengakibatkan peristiwa versionChanged akan dinaikkan. Jika kejadian ini tidak ditangani oleh bot, kesalahan akan dilemparkan yang mengakibatkan logika handler kesalahan bot dijalankan.

Mengembalikan string kosong akan menonaktifkan pelacakan versi untuk komponen bersama-sama.

Diwariskan Dari Dialog.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 DialogContainer.onDialogEvent