ComponentDialog Kelas

Referensi

Dialog yang terdiri dari dialog lain

Menginisialisasi instans baru ComponentDialog

Konstruktor

ComponentDialog(dialog_id: str)

Parameter

Nama	Deskripsi
dialog_id Diperlukan	str ID yang akan ditetapkan ke dialog baru dalam kumpulan dialog induk.

Variabel

Nama	Deskripsi
state	<xref:persisted_dialog>

Metode

add_dialog	Menambahkan Dialog ke dialog komponen dan mengembalikan komponen yang diperbarui.
begin_dialog	Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog induk. Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog.
continue_dialog	Dipanggil saat dialog dilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan aktivitas baru.
end_component	Mengakhiri dialog komponen dalam konteks induknya.
end_dialog	Dipanggil saat dialog berakhir.
find_dialog	Menemukan dialog menurut ID.
on_begin_dialog	Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog induk.
on_continue_dialog	Dipanggil saat dialog dilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan aktivitas baru.
on_end_dialog	Mengakhiri dialog komponen dalam konteks induknya.
on_reprompt_dialog
reprompt_dialog	Dipanggil ketika dialog harus meminta kembali input kepada pengguna.
resume_dialog	Dipanggil ketika dialog turunan pada tumpukan dialog induk menyelesaikan giliran ini, mengembalikan kontrol ke komponen dialog ini.

add_dialog

Menambahkan Dialog ke dialog komponen dan mengembalikan komponen yang diperbarui.

add_dialog(dialog: Dialog) -> object

Parameter

Nama	Deskripsi
dialog Diperlukan	Dialog yang akan ditambahkan.

Mengembalikan

Jenis	Deskripsi
ComponentDialog	ComponentDialogyang diperbarui.

begin_dialog

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog induk.

Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog.

async begin_dialog(dialog_context: DialogContext, options: object = None) -> DialogTurnResult

Parameter

Nama	Deskripsi
dialog_context Diperlukan	DialogContext DialogContext untuk pergantian percakapan saat ini.
options	object Informasi awal opsional untuk diteruskan ke dialog. Nilai default: None

Mengembalikan

Jenis	Deskripsi
end_of_turn	Memberi sinyal akhir belokan

continue_dialog

Dipanggil saat dialog dilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan aktivitas baru.

async continue_dialog(dialog_context: DialogContext) -> DialogTurnResult

Parameter

Nama	Deskripsi
dialog_context Diperlukan	DialogContext Konteks dialog induk untuk pergantian percakapan saat ini.

Mengembalikan

Jenis	Deskripsi
end_of_turn	Memberi sinyal akhir belokan

Keterangan

Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog. Hasilnya mungkin juga berisi nilai pengembalian.

Jika metode ini tidak menimpa dialog komponen memanggil metode continue_dialog pada konteks dialog dalamnya. Jika tumpukan dialog dalam kosong, dialog komponen berakhir, dan jika result tersedia, dialog komponen menggunakannya sebagai nilai pengembalian.

end_component

Mengakhiri dialog komponen dalam konteks induknya.

async end_component(outer_dc: DialogContext, result: object) -> DialogTurnResult

Parameter

Nama	Deskripsi
outer_dc Diperlukan	Konteks dialog induk untuk pergantian percakapan saat ini.
result Diperlukan	object Opsional, nilai untuk dikembalikan dari komponen dialog ke konteks induk.

Mengembalikan

Jenis	Deskripsi
result	Nilai yang akan dikembalikan.

Keterangan

Jika tugas berhasil, hasilnya menunjukkan bahwa dialog berakhir setelah giliran diproses oleh dialog.

end_dialog

Dipanggil saat dialog berakhir.

async end_dialog(context: TurnContext, instance: DialogInstance, reason: DialogReason) -> None

Parameter

Nama	Deskripsi
context Diperlukan	TurnContext Objek konteks untuk giliran ini.
instance Diperlukan	DialogInstance Informasi status yang terkait dengan instans dialog komponen ini.
reason Diperlukan	DialogReason Alasan mengapa dialog berakhir.

find_dialog

Menemukan dialog menurut ID.

async find_dialog(dialog_id: str) -> Dialog

Parameter

Nama	Deskripsi
dialog_id Diperlukan	Dialog yang akan ditambahkan.

Mengembalikan

Jenis	Deskripsi
Dialog	Dialog; atau Tidak Ada jika tidak ada kecocokan untuk ID.

on_begin_dialog

Dipanggil saat dialog dimulai dan didorong ke tumpukan dialog induk.

async on_begin_dialog(inner_dc: DialogContext, options: object) -> DialogTurnResult

Parameter

Nama	Deskripsi
inner_dc Diperlukan	DialogContext Konteks dialog dalam untuk pergantian percakapan saat ini.
options Diperlukan	object Informasi awal opsional untuk diteruskan ke dialog.

Keterangan

Jika tugas berhasil, hasilnya menunjukkan apakah dialog masih aktif setelah giliran diproses oleh dialog.

Secara default, ini memanggil metode begin_dialog dialog awal dialog komponen.

Ambil alih metode ini dalam kelas turunan untuk mengimplementasikan logika interupsi.

on_continue_dialog

Dipanggil saat dialog dilanjutkan, di mana dialog tersebut adalah dialog aktif dan pengguna membalas dengan aktivitas baru.

async on_continue_dialog(inner_dc: DialogContext) -> DialogTurnResult

Parameter

Nama	Deskripsi
inner_dc Diperlukan	DialogContext Konteks dialog dalam untuk pergantian percakapan saat ini.

on_end_dialog

Mengakhiri dialog komponen dalam konteks induknya.

async on_end_dialog(context: TurnContext, instance: DialogInstance, reason: DialogReason) -> None

Parameter

Nama	Deskripsi
turn_context Diperlukan	TurnContext TurnContext untuk pergantian percakapan saat ini.
instance Diperlukan	DialogInstance Informasi status yang terkait dengan tumpukan dialog dalam dialog komponen ini.
reason Diperlukan	DialogReason Alasan mengapa dialog berakhir.
context Diperlukan

on_reprompt_dialog

async on_reprompt_dialog(turn_context: TurnContext, instance: DialogInstance) -> None

Parameter

Nama	Deskripsi
turn_context Diperlukan	DialogInstance TurnContext untuk pergantian percakapan saat ini.
instance Diperlukan	DialogInstance Informasi status yang terkait dengan tumpukan dialog dalam dialog komponen ini.

reprompt_dialog

Dipanggil ketika dialog harus meminta kembali input kepada pengguna.

async reprompt_dialog(context: TurnContext, instance: DialogInstance) -> None

Parameter

Nama	Deskripsi
context Diperlukan	TurnContext Objek konteks untuk giliran ini.
instance Diperlukan	DialogInstance Informasi status untuk dialog ini.

resume_dialog

Dipanggil ketika dialog turunan pada tumpukan dialog induk menyelesaikan giliran ini, mengembalikan kontrol ke komponen dialog ini.

async resume_dialog(dialog_context: DialogContext, reason: DialogReason, result: object = None) -> DialogTurnResult

Parameter

Nama	Deskripsi
dialog_context Diperlukan	DialogContext Konteks dialog untuk pergantian percakapan saat ini.
reason Diperlukan	DialogReason Alasan mengapa dialog dilanjutkan.
result	object Opsional, nilai yang dikembalikan dari dialog yang dipanggil. Nilai default: None

Mengembalikan

Jenis	Deskripsi
end_of_turn	Memberi sinyal akhir belokan

Keterangan

Kontainer biasanya adalah simpul daun pada tumpukan tetapi dev bebas untuk mendorong dialog lain di atas tumpukan yang akan mengakibatkan kontainer menerima panggilan tak terduga ke resume_dialog ketika didorong pada dialog berakhir. Untuk menghindari kontainer berakhir sebelum waktunya, kita perlu menerapkan metode ini dan hanya meminta tumpukan dialog dalam kita untuk meminta kembali.

Atribut

persisted_dialog_state

persisted_dialog_state = 'dialogs'

Saran dan Komentar

Apakah halaman ini membantu?