botbuilder-dialogs package

Referensi

Kelas

ChoiceFactory	Sekumpulan fungsi utilitas untuk membantu memformat aktivitas 'pesan' yang berisi daftar pilihan.
ComponentDialog	Kelas dasar untuk dialog yang berisi dialog anak lainnya.
Configurable	Kelas dasar untuk semua kelas yang dapat dikonfigurasi.
Dialog	Menentukan perilaku inti untuk semua dialog.
DialogContainer	Kontainer untuk sekumpulan Dialog.
DialogContext	Konteks untuk giliran dialog saat ini sehubungan dengan DialogSet tertentu.
DialogContextError	Kesalahan yang menyertakan konteks dialog tambahan, termasuk tumpukan dialog.
DialogEvents	Mewakili peristiwa yang terkait dengan "siklus hidup" dialog.
DialogManager	Kelas yang menjalankan sistem dialog.
DialogSet	Sekumpulan dialog terkait yang semuanya dapat saling memanggil.
DialogTurnStateConstants	Menentukan konstanta status giliran dialog.
DialogsBotComponent	Komponen bot untuk Dialog bot.
DialogsComponentRegistration	Membuat komponen dialog tersedia untuk fungsionalitas pendaftaran sistem.
DialogPath	Menentukan jalur untuk dialog yang tersedia.
DialogStateManager	DialogStateManager mengelola cakupan memori dan pemecah jalur.
AliasPathResolver	Peta aliasXXX -> path.xxx ($foo => dialog.foo).
AtAtPathResolver	Peta @@ = array> turn.recognized.entitites.xxx.
AtPathResolver	Peta @@ => turn.recognized.entitites.xxx[0]
DollarPathResolver	Maps $xxx => dialog.xxx
HashPathResolver	Peta #xxx => turn.recognized.intents.xxx
PercentPathResolver	Maps %xxx => class.xxx (alias activeDialog.properties.xxx)
ScopePath	Menentukan jalur untuk cakupan yang tersedia.
BotStateMemoryScope	Kelas dasar untuk cakupan memori berdasarkan BotState.
ClassMemoryScope	ClassMemoryScope memetakan "class" -> dc.activeDialog.properties
ConversationMemoryScope	Memori yang terlingkup ke percakapan saat ini.
DialogClassMemoryScope	DialogClassMemoryScope memetakan "dialogClass" -> dc.parent.activeDialog.properties
DialogContextMemoryScope	`DialogContextMemoryScope` memetakan 'dialogcontext' - properti>.
DialogMemoryScope	DialogMemoryScope memetakan "dialog" -> dc.parent.activeDialog.state \|\| dc.activeDialog.state
MemoryScope	Kelas dasar abstrak untuk semua cakupan memori.
SettingsMemoryScope	SettingsMemoryScope memetakan "pengaturan" -> dc.context.turnState['settings']
ThisMemoryScope	ThisMemoryScope memetakan "ini" -> dc.activeDialog.state
TurnMemoryScope	TurnMemoryScope mewakili memori yang dilingkup ke giliran saat ini.
UserMemoryScope	Memori yang dilingkupkan ke pengguna saat ini.
ThisPath	Menentukan jalur yang diteruskan ke dialog aktif.
TurnPath	Menentukan jalur untuk belokan yang tersedia.
ActivityPrompt	Menunggu aktivitas diterima.
AttachmentPrompt	Meminta pengguna untuk mengunggah lampiran seperti gambar.
ChoicePrompt	Meminta pengguna untuk memilih dari daftar pilihan.
ConfirmPrompt	Meminta pengguna untuk mengonfirmasi sesuatu dengan respons "ya" atau "tidak".
DateTimePrompt	Meminta pengguna untuk memasukkan ekspresi tanggalwaktu.
NumberPrompt	Meminta pengguna untuk memasukkan angka.
OAuthPrompt	Membuat permintaan baru yang meminta pengguna untuk masuk menggunakan layanan Akses Menyeluruh (SSO) Bot Frameworks.
Prompt	Kelas dasar untuk semua perintah.
PromptCultureModels	Kontainer kelas untuk Model Budaya yang saat ini didukung di Konfirmasi dan Perintah Pilihan.
TextPrompt	Meminta pengguna untuk memasukkan beberapa teks.
Recognizer	Kelas dasar recognizer.
SkillDialog	Dialog khusus yang dapat membungkus panggilan jarak jauh ke keterampilan.
WaterfallDialog	Air terjun adalah dialog yang dioptimalkan untuk meminta pengguna dengan serangkaian pertanyaan.
WaterfallStepContext	Objek konteks diteruskan ke `WaterfallStep`.

Antarmuka

BeginSkillDialogOptions	Kelas dengan argumen dialog untuk SkillDialog.
ChoiceFactoryOptions	Opsi tambahan yang digunakan untuk mengubah pemformatan daftar pilihan.
Choice	Instans pilihan yang dapat digunakan untuk merender pilihan kepada pengguna atau mengenali sesuatu yang dipilih pengguna.
FindChoicesOptions	Opsi untuk mengontrol pengenalan yang dilakukan oleh `findChoices()`.
FoundChoice	Hasil dikembalikan oleh `findChoices()`.
FindValuesOptions	Opsi pencarian dasar yang digunakan untuk mengontrol bagaimana pilihan dikenali dalam ucapan pengguna.
FoundValue	INTERNAL: Hasil pencarian mentah dikembalikan oleh `findValues()`.
SortedValue	INTERNAL: Nilai yang dapat diurutkan dan masih merujuk ke posisi aslinya dalam array sumber. Fungsi `findChoices()` memperluas pilihan yang diteruskan ke instans `SortedValue` individual dan meneruskannya ke `findValues()`. Setiap `Choice` individu dapat menghasilkan beberapa sinonim yang harus dicari sehingga struktur data ini memungkinkan kita meneruskan setiap sinonim sebagai nilai untuk dicari sambil mempertahankan indeks pilihan asal nilai tersebut.
ModelResult	Hasil luar yang dikembalikan oleh pengenal entitas seperti `recognizeChoices()`.
Token	Token individual dikembalikan oleh `TokenizerFunction`.
Converter	Pengonversi mengonversi objek dari satu jenis ke jenis lainnya.
DialogConfiguration
DialogEvent
DialogInstance	Berisi informasi status untuk instans dialog pada tumpukan.
DialogTurnResult	Mewakili hasil upaya konteks dialog untuk memulai, melanjutkan, atau memanipulasi satu atau beberapa dialog.
DialogState	Berisi status dialog, informasi tentang status tumpukan dialog, untuk DialogSet tertentu.
DialogManagerConfiguration
DialogManagerResult
DialogDependencies
ComponentMemoryScopes	Antarmuka untuk menghitung cakupan memori.
ComponentPathResolvers	Antarmuka untuk mendeklarasikan pemecah masalah jalur.
DialogStateManagerConfiguration
PathResolver	Hak Cipta (c) Microsoft Corporation. Hak cipta dilindungi undang-undang. Dilisensikan di bawah Lisensi MIT.
ChoiceDefaultsChoicePrompt
ChoiceDefaultsConfirmPrompt
DateTimeResolution	Hasil yang dikembalikan oleh `DateTimePrompt`.
OAuthPromptSettings	Pengaturan yang digunakan untuk mengonfigurasi instans `OAuthPrompt`.
PromptOptions	Opsi konfigurasi dasar yang didukung oleh semua perintah.
PromptRecognizerResult	Hasil yang dikembalikan oleh fungsi pengenal perintah.
PromptValidatorContext	Informasi kontekstual diteruskan ke `PromptValidator`kustom .
PromptCultureModel
RecognizerConfiguration
SkillDialogOptions
TemplateInterface	Menentukan antarmuka Templat untuk mengikat data ke T.
WaterfallStepInfo	Nilai yang diteruskan ke konstruktor `WaterfallStepContext`.

Alias Jenis

TokenizerFunction	Tanda tangan untuk pemecah kata alternatif yang dapat diteruskan ke `recognizeChoices()`, `findChoices()`, atau `findValues()`. `type TokenizerFunction = (text: string, locale?: string) => Token[];`
ConverterFactory
PromptValidator	Tanda tangan fungsi untuk menyediakan validator prompt kustom. `type PromptValidator<T> = (prompt: PromptValidatorContext<T>) => Promise<boolean>;`
WaterfallStep	Tanda tangan fungsi dari langkah air terjun individual. `type WaterfallStep<O extends object = {}> = (step: WaterfallStepContext<O>) => Promise<DialogTurnResult>;`

Enum

DialogReason

Menunjukkan mengapa metode dialog dipanggil.

DialogTurnStatus

Mewakili status tumpukan dialog setelah konteks dialog mencoba memulai, melanjutkan, atau memanipulasi satu atau beberapa dialog. Lihat juga

ListStyle

Mengontrol cara pilihan untuk opsi ChoicePrompt atau ya/tidak untuk ConfirmPrompt disajikan kepada pengguna.

Fungsi

findChoices(string, string \| Choice[], FindChoicesOptions)	Fungsi pencarian tingkat menengah untuk mengenali pilihan dalam ucapan.
findValues(string, SortedValue[], FindValuesOptions)	INTERNAL: Fungsi tingkat rendah yang mencari sekumpulan nilai dalam ucapan. Fungsi tingkat yang lebih tinggi seperti `findChoices()` dan `recognizeChoices()` berlapis di atas fungsi ini. Dalam kebanyakan kasus, lebih mudah untuk hanya memanggil salah satu fungsi tingkat yang lebih tinggi, tetapi fungsi ini berisi algoritma pencarian fuzzy yang mendorong pengenalan pilihan.
recognizeChoices(string, string \| Choice[], FindChoicesOptions)	Fungsi tingkat tinggi untuk mengenali pilihan dalam ucapan pengguna.
defaultTokenizer(string, string)	Tokenizer sederhana yang memecah spasi dan tanda baca.
getActiveDialogContext(DialogContext)	Jalankan tumpukan DC secara rekursif untuk menemukan DC aktif.
internalRun(TurnContext, string, DialogContext, DialogStateManagerConfiguration)
isFromParentToSkill(TurnContext)	Menentukan apakah keterampilan bertindak sebagai induk keterampilan.
runDialog(Dialog, TurnContext, StatePropertyAccessor<DialogState>)	Menjalankan dialog dari konteks dan aksesor tertentu.
shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)	Pembantu untuk menentukan apakah kita harus mengirim EoC ke induk atau tidak.
isComponentMemoryScopes(unknown)	Periksa apakah ComponentRegistration ComponentMemoryScopes atau tidak.
isComponentPathResolvers(unknown)	Periksa apakah ComponentRegistration ComponentPathResolvers atau tidak.
createConnectorClient(TurnContext, string, ClaimsIdentity, string)
exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)
getSignInResource(TurnContext, OAuthPromptSettings)
getUserToken(TurnContext, OAuthPromptSettings, string)
signOutUser(TurnContext, OAuthPromptSettings)

Detail Fungsi

findChoices(string, string | Choice[], FindChoicesOptions)

Fungsi pencarian tingkat menengah untuk mengenali pilihan dalam ucapan.

function findChoices(utterance: string, choices: string | Choice[], options?: FindChoicesOptions): ModelResult<FoundChoice>[]

Parameter

utterance: string

Teks atau ucapan pengguna untuk dicari. Untuk aktivitas 'pesan' masuk, Anda cukup menggunakan context.activity.text.

choices: string | Choice[]

Daftar pilihan untuk dicari.

options: FindChoicesOptions

(Opsional) opsi yang digunakan untuk mengubah pencarian yang dilakukan.

Mengembalikan

ModelResult<FoundChoice>[]

Daftar pilihan yang ditemukan, diurutkan menurut yang paling relevan terlebih dahulu.

Keterangan

Fungsi ini berlapis di atas findValues() dan hanya menentukan semua sinonim yang harus dicari sebelum memanggil findValues() untuk melakukan pencarian aktual. Fungsi recognizeChoices() berlapis di atas fungsi ini dan menambahkan kemampuan untuk memilih pilihan berdasarkan indeks atau posisi ordinal dalam daftar. Memanggil fungsi khusus ini berguna ketika Anda tidak ingin pengenalan indeks dan posisi ordinal dilakukan oleh recognizeChoices().

const { findChoices } = require('botbuilder-choices');

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = findChoices(utterance, choices);
if (results.length == 1) {
    await context.sendActivity(`I like ${results[0].resolution.value} too!`);
} else if (results.length > 1) {
    const ambiguous = results.map((r) => r.resolution.value);
    await context.sendActivity(ChoiceFactory.forChannel(context, ambiguous, `Which one?`));
} else {
    await context.sendActivity(ChoiceFactory.forChannel(context, choices, `I didn't get that... Which color?`));
}

findValues(string, SortedValue[], FindValuesOptions)

INTERNAL: Fungsi tingkat rendah yang mencari sekumpulan nilai dalam ucapan. Fungsi tingkat yang lebih tinggi seperti findChoices() dan recognizeChoices() berlapis di atas fungsi ini. Dalam kebanyakan kasus, lebih mudah untuk hanya memanggil salah satu fungsi tingkat yang lebih tinggi, tetapi fungsi ini berisi algoritma pencarian fuzzy yang mendorong pengenalan pilihan.

function findValues(utterance: string, values: SortedValue[], options?: FindValuesOptions): ModelResult<FoundValue>[]

Parameter

utterance: string

Teks atau ucapan pengguna untuk dicari.

values: SortedValue[]

Daftar nilai yang akan dicari.

options: FindValuesOptions

(Opsional) opsi yang digunakan untuk mengubah pencarian yang dilakukan.

Mengembalikan

ModelResult<FoundValue>[]

Daftar nilai yang ditemukan.

recognizeChoices(string, string | Choice[], FindChoicesOptions)

Fungsi tingkat tinggi untuk mengenali pilihan dalam ucapan pengguna.

function recognizeChoices(utterance: string, choices: string | Choice[], options?: FindChoicesOptions): ModelResult<FoundChoice>[]

Parameter

utterance: string

Teks atau ucapan pengguna untuk dicari. Untuk aktivitas 'pesan' masuk, Anda cukup menggunakan context.activity.text.

choices: string | Choice[]

Daftar pilihan untuk dicari.

options: FindChoicesOptions

(Opsional) opsi yang digunakan untuk mengubah pencarian yang dilakukan.

Mengembalikan

ModelResult<FoundChoice>[]

Daftar pilihan yang ditemukan, diurutkan menurut yang paling relevan terlebih dahulu.

Keterangan

Ini berlapis di atas fungsi findChoices() dan menambahkan logika untuk membiarkan pengguna menentukan pilihan mereka berdasarkan indeks (mereka dapat mengatakan "satu" untuk memilih choice[0]) atau posisi ordinal (mereka dapat mengatakan "yang kedua" untuk memilih choice[1].) Ucapan pengguna dikenali dalam urutan berikut:

Berdasarkan nama menggunakan findChoices().
Berdasarkan posisi ordinal berbasis 1.
Berdasarkan posisi indeks berbasis 1.

const { recognizeChoices } = require('botbuilder-choices');

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = recognizeChoices(utterance, choices);
if (results.length == 1) {
    await context.sendActivity(`I like ${results[0].resolution.value} too!`);
} else if (results.length > 1) {
    const ambiguous = results.map((r) => r.resolution.value);
    await context.sendActivity(ChoiceFactory.forChannel(context, ambiguous, `Which one?`));
} else {
    await context.sendActivity(ChoiceFactory.forChannel(context, choices, `I didn't get that... Which color?`));
}

defaultTokenizer(string, string)

Tokenizer sederhana yang memecah spasi dan tanda baca.

function defaultTokenizer(text: string, _locale?: string): Token[]

Parameter

text: string

Teks input.

_locale: string

Opsional, mengidentifikasi lokal teks input.

Mengembalikan

Token[]

Daftar token.

Keterangan

Satu-satunya normalisasi yang dilakukan adalah menurunkan huruf kecil token. Pengembang dapat membungkus tokenizer ini dengan fungsi mereka sendiri untuk melakukan normalisasi tambahan seperti stemming.

const { recognizeChoices, defaultTokenizer } = require('botbuilder-choices');
const stemmer = require('stemmer');

function customTokenizer(text, locale) {
   const tokens = defaultTokenizer(text, locale);
   tokens.forEach((t) => {
       t.normalized = stemmer(t.normalized);
   });
   return tokens;
}

const choices = ['red', 'green', 'blue'];
const utterance = context.activity.text;
const results = recognizeChoices(utterance, choices, { tokenizer: customTokenizer });

getActiveDialogContext(DialogContext)

Jalankan tumpukan DC secara rekursif untuk menemukan DC aktif.

function getActiveDialogContext(dialogContext: DialogContext): DialogContext

Parameter

dialogContext: DialogContext

(xref:botbuilder-dialogs. DialogContext) untuk pergantian percakapan saat ini dengan pengguna.

Mengembalikan

DialogContext

DialogAktif .

internalRun(TurnContext, string, DialogContext, DialogStateManagerConfiguration)

function internalRun(context: TurnContext, dialogId: string, dialogContext: DialogContext, dialogStateManagerConfiguration?: DialogStateManagerConfiguration): Promise<DialogTurnResult>

Parameter

context: TurnContext

TurnContext untuk giliran tersebut.

dialogId: string

ID dialog.

dialogContext: DialogContext

Dialog Konteks untuk pergantian percakapan saat ini.

dialogStateManagerConfiguration: DialogStateManagerConfiguration

Konfigurasi untuk manajer status dialog.

Mengembalikan

Promise<DialogTurnResult>

janji yang menyelesaikan hasil giliran dialog.

isFromParentToSkill(TurnContext)

Menentukan apakah keterampilan bertindak sebagai induk keterampilan.

function isFromParentToSkill(context: TurnContext): boolean

Parameter

context: TurnContext

(xref:botbuilder-core. Objek TurnContext) untuk pergantian percakapan saat ini dengan pengguna.

Mengembalikan

boolean

Boolean yang mewakili apakah keterampilan bertindak sebagai induk keterampilan.

runDialog(Dialog, TurnContext, StatePropertyAccessor<DialogState>)

Menjalankan dialog dari konteks dan aksesor tertentu.

function runDialog(dialog: Dialog, context: TurnContext, accessor: StatePropertyAccessor<DialogState>): Promise<void>

Parameter

dialog: Dialog

Dialog yang akan dijalankan.

context: TurnContext

(xref:botbuilder-core. Objek TurnContext) untuk pergantian percakapan saat ini dengan pengguna.

accessor: StatePropertyAccessor<DialogState>

Metode yang ditentukan untuk mengakses properti status yang dibuat dalam objek BotState.

Mengembalikan

Promise<void>

shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)

Pembantu untuk menentukan apakah kita harus mengirim EoC ke induk atau tidak.

function shouldSendEndOfConversationToParent(context: TurnContext, turnResult: DialogTurnResult): boolean

Parameter

context: TurnContext

TurnContext untuk giliran tersebut.

turnResult: DialogTurnResult

Hasil giliran dialog.

Mengembalikan

boolean

Benar jika harus mengirim EoC, jika tidak salah.

isComponentMemoryScopes(unknown)

Periksa apakah ComponentRegistration ComponentMemoryScopes atau tidak.

function isComponentMemoryScopes(component: unknown): boolean

Parameter

component: unknown

Pendaftaran komponen.

Mengembalikan

boolean

Ketik hasil pemeriksaan.

isComponentPathResolvers(unknown)

Periksa apakah ComponentRegistration ComponentPathResolvers atau tidak.

function isComponentPathResolvers(component: unknown): boolean

Parameter

component: unknown

Pendaftaran komponen.

Mengembalikan

boolean

Ketik hasil pemeriksaan.

createConnectorClient(TurnContext, string, ClaimsIdentity, string)

function createConnectorClient(context: TurnContext, serviceUrl: string, claimsIdentity: ClaimsIdentity, audience: string): Promise<ConnectorClient>

Parameter

context: TurnContext

serviceUrl: string

claimsIdentity: ClaimsIdentity

audience: string

Mengembalikan

Promise<ConnectorClient>

exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)

function exchangeToken(context: TurnContext, settings: OAuthPromptSettings, tokenExchangeRequest: TokenExchangeRequest): Promise<TokenResponse>

Parameter

context: TurnContext

settings: OAuthPromptSettings

tokenExchangeRequest: TokenExchangeRequest

Mengembalikan

Promise<TokenResponse>

getSignInResource(TurnContext, OAuthPromptSettings)

function getSignInResource(context: TurnContext, settings: OAuthPromptSettings): Promise<SignInUrlResponse>

Parameter

context: TurnContext

settings: OAuthPromptSettings

Mengembalikan

Promise<SignInUrlResponse>

getUserToken(TurnContext, OAuthPromptSettings, string)

function getUserToken(context: TurnContext, settings: OAuthPromptSettings, magicCode: string): Promise<TokenResponse>

Parameter

context: TurnContext

settings: OAuthPromptSettings

magicCode: string

Mengembalikan

Promise<TokenResponse>

signOutUser(TurnContext, OAuthPromptSettings)

function signOutUser(context: TurnContext, settings: OAuthPromptSettings): Promise<void>

Parameter

context: TurnContext

settings: OAuthPromptSettings

Mengembalikan

Promise<void>

Bagikan melalui

botbuilder-dialogs package

Kelas

Antarmuka

Alias Jenis

Enum

Fungsi

Detail Fungsi

findChoices(string, string | Choice[], FindChoicesOptions)

Parameter

Mengembalikan

Keterangan

findValues(string, SortedValue[], FindValuesOptions)

Parameter

Mengembalikan

recognizeChoices(string, string | Choice[], FindChoicesOptions)

Parameter

Mengembalikan

Keterangan

defaultTokenizer(string, string)

Parameter

Mengembalikan

Keterangan

getActiveDialogContext(DialogContext)

Parameter

Mengembalikan

internalRun(TurnContext, string, DialogContext, DialogStateManagerConfiguration)

Parameter

Mengembalikan

isFromParentToSkill(TurnContext)

Parameter

Mengembalikan

runDialog(Dialog, TurnContext, StatePropertyAccessor<DialogState>)

Parameter

Mengembalikan

shouldSendEndOfConversationToParent(TurnContext, DialogTurnResult)

Parameter

Mengembalikan

isComponentMemoryScopes(unknown)

Parameter

Mengembalikan

isComponentPathResolvers(unknown)

Parameter

Mengembalikan

createConnectorClient(TurnContext, string, ClaimsIdentity, string)

Parameter

Mengembalikan

exchangeToken(TurnContext, OAuthPromptSettings, TokenExchangeRequest)

Parameter

Mengembalikan

getSignInResource(TurnContext, OAuthPromptSettings)

Parameter

Mengembalikan

getUserToken(TurnContext, OAuthPromptSettings, string)

Parameter

Mengembalikan

signOutUser(TurnContext, OAuthPromptSettings)

Parameter

Mengembalikan