botbuilder-core package

Kelas

ActivityFactory	ActivityFactory untuk menghasilkan teks lalu menggunakan semantik markdown sederhana seperti chatdown untuk membuat Aktivitas.
ActivityHandler	Penanganan aktivitas pemancar peristiwa untuk bot. MemperluasActivityHandlerBase .
ActivityHandlerBase	Menentukan perilaku inti untuk penanganan aktivitas pemancar peristiwa untuk bot.
AutoSaveStateMiddleware	Middleware yang akan secara otomatis menyimpan perubahan status apa pun di akhir giliran.
BotAdapter	Menentukan perilaku inti adaptor bot yang dapat menghubungkan bot ke titik akhir layanan.
BotComponent	Definisi BotComponent yang memungkinkan pendaftaran layanan, tindakan kustom, cakupan memori, dan adaptor. Untuk membuat komponen Anda tersedia untuk sistem yang Anda dapatkan dari BotComponent dan mendaftarkan layanan untuk menambahkan fungsionalitas. Komponen-komponen ini kemudian dikonsumsi di tempat yang sesuai oleh sistem yang membutuhkannya. Saat menggunakan Composer, configureServices dipanggil secara otomatis pada komponen oleh runtime bot, selama komponen terdaftar dalam konfigurasi.
BotState	Kelas dasar untuk cakupan persistensi status kerangka kerja.
BotStatePropertyAccessor	Implementasi spesifik BotState antarmuka StatePropertyAccessor.
BotStateSet	Kumpulan plugin BotState yang harus dimuat atau disimpan secara paralel sebagai satu unit. Lihat AutoSaveStateMiddleware untuk implementasi kelas ini.
NullTelemetryClient	Klien telemetri bot null yang mengimplementasikan BotTelemetryClient.
BrowserLocalStorage	Penyedia penyimpanan yang menggunakan penyimpanan lokal browser.
BrowserSessionStorage	Penyedia penyimpanan yang menggunakan penyimpanan sesi browser.
CardFactory	Menyediakan metode untuk memformat berbagai jenis kartu yang dapat dikembalikan bot.
CloudAdapterBase	Adaptor yang mengimplementasikan Protokol Kerangka Kerja Bot dan dapat dihosting di lingkungan cloud yang berbeda baik publik maupun privat.
ComponentRegistration	ComponentRegistration adalah kelas tanda tangan untuk menemukan aset dari komponen.
ConfigurationBotFrameworkAuthentication	Membuat instans BotFrameworkAuthentication dari objek dengan nilai autentikasi atau instans Konfigurasi .
ConfigurationServiceClientCredentialFactory	ServiceClientCredentialsFactory yang menggunakan ConfigurationServiceClientCredentialFactoryOptions atau instans Konfigurasi untuk membangun ServiceClientCredentials dengan AppId dan Kata Sandi Aplikasi.
ConversationState	Membaca dan menulis status percakapan untuk bot Anda ke penyimpanan.
InvokeException	Pengecualian kustom untuk memanggil kesalahan respons.
MemoryStorage	Penyedia penyimpanan berbasis memori untuk bot.
MemoryTranscriptStore	Penyimpanan transkrip memori menyimpan transkrip dalam memori volatil di Peta.
MessageFactory	Sekumpulan fungsi utilitas untuk membantu pemformatan berbagai jenis pesan yang dapat dikembalikan bot.
MiddlewareSet	Satu set plugin Middleware.
PrivateConversationState	Membaca dan menulis status PrivateConversation untuk bot Anda ke penyimpanan.
QueueStorage	Kelas dasar untuk mengantre Aktivitas untuk diproses nanti.
RegisterClassMiddleware	Middleware untuk menambahkan objek ke atau mendaftarkan layanan dengan konteks giliran saat ini.
ShowTypingMiddleware	Middleware yang akan mengirim indikator pengetikan secara otomatis untuk setiap pesan.
SkillConversationIdFactory	SkillConversationIdFactory yang menyimpan dan mengambil instans ConversationReference .
SkillConversationIdFactoryBase	Menentukan metode pabrik yang digunakan untuk membuat ID percakapan unik untuk percakapan keterampilan.
SkypeMentionNormalizeMiddleware	Middleware untuk menambal menyebutkan Entitas dari Skype karena tidak sesuai dengan nilai yang diharapkan. Bot yang berinteraksi dengan Skype harus menggunakan middleware ini jika penyebutan digunakan.
StringUtils	Kelas pembantu yang berisi metode utilitas string.
TelemetryConstants	Menentukan nama properti umum untuk digunakan dengan objek BotTelemetryClient.
TelemetryLoggerMiddleware	Middleware untuk mencatat pesan Aktivitas masuk, keluar, diperbarui, atau dihapus. Menggunakan antarmuka botTelemetryClient.
TestAdapter	Adaptor pengujian yang digunakan untuk pengujian unit. Adaptor ini dapat digunakan untuk mensimulasikan pengiriman pesan dari pengguna ke bot.
TestFlow	Kelas dukungan untuk TestAdapter yang memungkinkan konstruksi sederhana dari urutan pengujian.
ConsoleTranscriptLogger	ConsoleTranscriptLogger , menulis aktivitas ke output Konsol.
TranscriptLoggerMiddleware	Mencatat aktivitas masuk dan keluar ke TranscriptStore.
TurnContext	Menyediakan konteks untuk pergantian bot.
TurnContextStateCollection	Nilai bertahan selama masa pakai giliran sebagai bagian dari TurnContext.
UserState	Membaca dan menulis status pengguna untuk bot Anda ke penyimpanan.

Antarmuka

CachedBotState	Informasi status di-cache dari objek konteks oleh instans BotState.
StatePropertyAccessor	Menentukan metode untuk mengakses properti status yang dibuat di objek BotState .
BotPageViewTelemetryClient
BotTelemetryClient
TelemetryDependency
TelemetryEvent
TelemetryException
TelemetryPageView
TelemetryTrace
CoreAppCredentials	CoreAppCredentials
CoreWebResource	Antarmuka internal yang mewakili "WebResource" dari @azure/ms-rest-js
ExtendedUserTokenProvider	Antarmuka untuk Akses Menyeluruh OAuth Token Pengguna dan API Pertukaran Token untuk BotAdapters
IntentScore	Skor ditambah informasi tambahan tentang niat.
Middleware	Antarmuka yang diimplementasikan oleh middleware berbasis objek.
PropertyManager	Antarmuka yang diimplementasikan oleh kelas yang mampu memperhitungkan pengakses properti.
RecognizerResult	Nilai yang dikembalikan dari pengenal.
BotFrameworkSkill	Pendaftaran untuk titik akhir Keterampilan berbasis BotFrameworkHttpProtocol.
SkillConversationIdFactoryOptions
SkillConversationReference
Storage	Antarmuka untuk penyedia penyimpanan yang menyimpan dan mengambil objek JSON lama biasa.
StoreItem	Objek yang disimpan di Storage dengan eTag opsional.
StoreItems	Peta objek StoreItem bernama.
PagedResult	Halaman hasil.
TranscriptInfo	Metadata untuk transkrip tersimpan.
TranscriptLogger	Pencatat Transkrip menyimpan aktivitas untuk percakapan untuk diingat.
TranscriptStore	Pencatat Transkrip menyimpan aktivitas untuk percakapan untuk diingat.
IUserTokenProvider	Antarmuka untuk API OAuth Token Pengguna untuk BotAdapters
TokenPollingSettings	Menyediakan detail untuk polling token.

Alias Jenis

BotHandler	Menjelaskan penanganan aktivitas aktivitas bot, untuk digunakan dengan objek ActivityHandler.
ConfigurationBotFrameworkAuthenticationOptions	Berisi pengaturan yang digunakan untuk mengonfigurasi instans ConfigurationBotFrameworkAuthentication.
ConfigurationServiceClientCredentialFactoryOptions	Berisi pengaturan yang digunakan untuk mengonfigurasi ConfigurationServiceClientCredentialFactory instans.
MiddlewareHandler	Tanda tangan diimplementasikan oleh middleware berbasis fungsi. type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;
StorageKeyFactory	Panggilan balik untuk menghitung kunci penyimpanan. type StorageKeyFactory = (context: TurnContext) => Promise<string>;
TestActivityInspector	Tanda tangan untuk fungsi yang dapat digunakan untuk memeriksa aktivitas individual yang dikembalikan oleh bot yang sedang diuji menggunakan TestAdapter. type TestActivityInspector = (activity: Partial<Activity>, description: string) => void;
DeleteActivityHandler	Handler yang dapat berpartisipasi dalam menghapus peristiwa aktivitas untuk giliran saat ini.
SendActivitiesHandler	Handler yang dapat berpartisipasi dalam mengirim peristiwa aktivitas untuk giliran saat ini.
UpdateActivityHandler	Handler yang dapat berpartisipasi dalam peristiwa aktivitas pembaruan untuk giliran saat ini.

Enum

Severity

Menentukan tingkat keparahan untuk peristiwa tersebut.

Fungsi

useBotState(BotAdapter, BotState[])	Menambahkan middleware ke adaptor untuk mendaftarkan satu atau beberapa objek BotState pada konteks giliran. Middleware mendaftarkan objek status pada konteks giliran pada awal setiap giliran.
assertBotComponent(unknown, unknown[])
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)	Mencatat DialogView menggunakan metode trackPageView pada BotTelemetryClient jika BotPageViewTelemetryClient telah diterapkan. Atau mencatat informasi melalui TrackTrace.
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)	Membuat instans baru kelas ConfigurationBotFrameworkAuthentication.
createServiceClientCredentialFactoryFromConfiguration(Configuration)	Membuat instans baru ConfigurationServiceClientCredentialFactory class.
assertStoreItems(unknown, unknown[])
calculateChangeHash(StoreItem)	Fungsi utilitas untuk menghitung hash perubahan untuk StoreItem.

Detail Fungsi

useBotState(BotAdapter, BotState[])

Menambahkan middleware ke adaptor untuk mendaftarkan satu atau beberapa objek BotState pada konteks giliran. Middleware mendaftarkan objek status pada konteks giliran pada awal setiap giliran.

function useBotState(botAdapter: BotAdapter, botStates: BotState[]): BotAdapter

Parameter

botAdapter

BotAdapter

Adaptor tempat mendaftarkan objek status.

botStates

BotState[]

Objek status yang akan didaftarkan.

Mengembalikan

BotAdapter

Adaptor yang diperbarui.

assertBotComponent(unknown, unknown[])

Peringatan

API ini sudah tidak digunakan lagi.

Use BotComponent.z.parse() instead.

function assertBotComponent(val: unknown, _args: unknown[]): asserts

Parameter

val

unknown

_args

unknown[]

Mengembalikan

asserts

telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)

Mencatat DialogView menggunakan metode trackPageView pada BotTelemetryClient jika BotPageViewTelemetryClient telah diterapkan. Atau mencatat informasi melalui TrackTrace.

function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, dialogName: string, properties?: [key: string]: any, metrics?: [key: string]: number)

Parameter

telemetryClient

BotTelemetryClient

TelemetryClient yang mengimplementasikan BotTelemetryClient.

dialogName

string

Nama dialog untuk mencatat entri / mulai.

properties

[key: string]: any

Nilai string bernama yang dapat Anda gunakan untuk mencari dan mengklasifikasikan peristiwa.

metrics

[key: string]: number

Pengukuran yang terkait dengan peristiwa ini.

createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)

Membuat instans baru kelas ConfigurationBotFrameworkAuthentication.

function createBotFrameworkAuthenticationFromConfiguration(configuration: Configuration, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions): BotFrameworkAuthentication

Parameter

configuration

Configuration

Instans Konfigurasi .

credentialsFactory

ServiceClientCredentialsFactory

Instans ServiceClientCredentialsFactory.

authConfiguration

AuthenticationConfiguration

Objek Konfigurasi .

botFrameworkClientFetch

(input: RequestInfo, init?: RequestInit) => Promise<Response>

Implementasi Fetch kustom yang akan digunakan dalam BotFrameworkClient.

connectorClientOptions

ConnectorClientOptions

Objek ConnectorClientOptions.

Mengembalikan

BotFrameworkAuthentication

Instans ConfigurationBotFrameworkAuthentication .

Keterangan

Instans Konfigurasi yang disediakan untuk konstruktor harus memiliki nilai autentikasi yang diinginkan yang tersedia di root, menggunakan properti ConfigurationBotFrameworkAuthenticationOptions sebagai kuncinya.

createServiceClientCredentialFactoryFromConfiguration(Configuration)

Membuat instans baru ConfigurationServiceClientCredentialFactory class.

function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory

Parameter

configuration

Configuration

Instans Konfigurasi .

Mengembalikan

ConfigurationServiceClientCredentialFactory

Instans ConfigurationServiceClientCredentialFactory.

Keterangan

Instans Konfigurasi yang disediakan untuk konstruktor harus memiliki nilai autentikasi yang diinginkan yang tersedia di root, menggunakan properti ConfigurationServiceClientCredentialFactoryOptions sebagai kuncinya.

assertStoreItems(unknown, unknown[])

Peringatan

API ini sudah tidak digunakan lagi.

Use zod.record(zod.unknown()) instead.

function assertStoreItems(val: unknown, _args: unknown[]): asserts

Parameter

val

unknown

_args

unknown[]

Mengembalikan

asserts

calculateChangeHash(StoreItem)

Fungsi utilitas untuk menghitung hash perubahan untuk StoreItem.

function calculateChangeHash(item: StoreItem): string

Parameter

item

StoreItem

Item untuk menghitung hash perubahan.

Mengembalikan

string

ubah string hash

Keterangan

Contoh ini menghitung hash perubahan untuk objek yang telah dibaca dan kemudian hanya menulisnya kembali jika telah dimodifikasi:

// Calculate state objects initial hash
const hash = calculateChangeHash(state);

// Process the received activity
await processActivity(context, state);

// Save state if changed
if (calculateChangeHash(state) !== hash) {
   await storage.write({ 'botState': state });
}