botbuilder-core package

Классы

ActivityFactory	ActivityFactory создает текст, а затем использует простую семантику Markdown, например chatdown, для создания действия.
ActivityHandler	Обработчик действий, создающих события, для ботов. Расширяет ActivityHandlerBase.
ActivityHandlerBase	Определяет основное поведение обработчиков действий, создающих события, для ботов.
AutoSaveStateMiddleware	ПО промежуточного слоя, которое автоматически сохраняет все изменения состояния в конце поворота.
BotAdapter	Определяет основное поведение адаптера бота, который может подключать бота к конечной точке службы.
BotComponent	Определение BotComponent, которое позволяет регистрировать службы, пользовательские действия, области памяти и адаптеры. Чтобы сделать компоненты доступными для системы, наследуемой от BotComponent, и зарегистрируйте службы для добавления функциональных возможностей. Затем эти компоненты используются в соответствующих местах системами, которые в них нуждаются. При использовании Composer служба configureServices вызывается автоматически для компонентов средой выполнения бота, если компоненты зарегистрированы в конфигурации.
BotState	Базовый класс для областей сохранения состояния платформ.
BotStatePropertyAccessor	Конкретная BotState реализация StatePropertyAccessor интерфейса.
BotStateSet	Коллекция подключаемых BotState модулей, которые должны загружаться или сохраняться параллельно как единое целое. См. AutoSaveStateMiddleware сведения о реализации этого класса.
NullTelemetryClient	Пустой клиент телеметрии бота, реализующий BotTelemetryClient.
BrowserLocalStorage	Поставщик хранилища, использующий локальное хранилище браузера.
BrowserSessionStorage	Поставщик хранилища, использующий хранилище сеансов браузера.
CardFactory	Предоставляет методы для форматирования различных типов карточек, которые может возвращать бот.
CloudAdapterBase	Адаптер, который реализует протокол Bot Framework и может размещаться в разных облачных средах как общедоступных, так и частных.
ComponentRegistration	ComponentRegistration — это класс подписи для обнаружения ресурсов из компонентов.
ConfigurationBotFrameworkAuthentication	Создает экземпляр BotFrameworkAuthentication из объекта со значениями проверки подлинности или экземпляра конфигурации .
ConfigurationServiceClientCredentialFactory	ServiceClientCredentialsFactory, использующий ConfigurationServiceClientCredentialFactoryOptions или экземпляр Конфигурации для создания ServiceClientCredentials с идентификатором appId и паролем приложения.
ConversationState	Считывает и записывает состояние беседы для бота в хранилище.
InvokeException	Пользовательское исключение для ошибок ответа вызова.
MemoryStorage	Поставщик хранилища на основе памяти для бота.
MemoryTranscriptStore	Хранилище расшифровок памяти хранит расшифровки в энергонезависимой памяти на карте.
MessageFactory	Набор служебных функций, помогающих в форматировании различных типов сообщений, которые может возвращать бот.
MiddlewareSet	Набор подключаемых Middleware модулей.
PrivateConversationState	Считывает и записывает состояние PrivateConversation для бота в хранилище.
QueueStorage	Базовый класс для постановки в очередь действия для последующей обработки.
RegisterClassMiddleware	ПО промежуточного слоя для добавления объекта в службу или регистрации службы в контексте текущего шага.
ShowTypingMiddleware	ПО промежуточного слоя, которое автоматически отправляет индикатор ввода для каждого сообщения.
SkillConversationIdFactory	SkillConversationIdFactory, который хранит и извлекает экземпляры ConversationReference .
SkillConversationIdFactoryBase	Определяет методы фабрики, которая используется для создания уникальных идентификаторов бесед для бесед навыков.
SkypeMentionNormalizeMiddleware	ПО промежуточного слоя для исправления упоминает сущности из Skype, так как они не соответствуют ожидаемым значениям. Боты, взаимодействующие со Skype, должны использовать это ПО промежуточного слоя, если используются упоминания.
StringUtils	Вспомогательный класс, содержащий строковые служебные методы.
TelemetryConstants	Определяет имена общих свойств для использования с объектом BotTelemetryClient .
TelemetryLoggerMiddleware	ПО промежуточного слоя для ведения журнала входящих, исходящих, обновленных или удаленных сообщений об активности. Использует интерфейс botTelemetryClient.
TestAdapter	Адаптер тестирования, используемый для модульных тестов. Этот адаптер можно использовать для имитации отправки сообщений от пользователя боту.
TestFlow	Класс поддержки для TestAdapter , который позволяет просто построить последовательность тестов.
ConsoleTranscriptLogger	ConsoleTranscriptLogger записывает действия в выходные данные консоли.
TranscriptLoggerMiddleware	Регистрирует входящие и исходящие действия в TranscriptStore.
TurnContext	Предоставляет контекст для поворота бота.
TurnContextStateCollection	Значения, сохраняемые в течение всего времени существования поворота в составе turnContext.
UserState	Считывает и записывает пользовательское состояние бота в хранилище.

Интерфейсы

CachedBotState	Сведения о состоянии кэшируются экземпляром объекта контекста BotState .
StatePropertyAccessor	Определяет методы для доступа к свойству состояния, созданному в объекте BotState .
BotPageViewTelemetryClient
BotTelemetryClient
TelemetryDependency
TelemetryEvent
TelemetryException
TelemetryPageView
TelemetryTrace
CoreAppCredentials	CoreAppCredentials
CoreWebResource	Внутренний интерфейс, представляющий "WebResource" из @azure/ms-rest-js
ExtendedUserTokenProvider	Интерфейс для единого входа oAuth маркера пользователя и API-интерфейсов Обмена токенами для BotAdapters
IntentScore	Оценка плюс любая дополнительная информация о намерении.
Middleware	Интерфейс, реализованный ПО промежуточного слоя на основе объектов.
PropertyManager	Интерфейс, реализованный классами, способными факторы доступа к свойствам.
RecognizerResult	Значение, возвращаемое распознавателем.
BotFrameworkSkill	Регистрация конечной точки навыка на основе BotFrameworkHttpProtocol.
SkillConversationIdFactoryOptions
SkillConversationReference
Storage	Интерфейс для поставщика хранилища, который хранит и извлекает обычные старые объекты JSON.
StoreItem	Объект, хранящийся в хранилище с необязательным eTag.
StoreItems	Сопоставление именованных StoreItem объектов.
PagedResult	Страница результатов.
TranscriptInfo	Метаданные для сохраненной расшифровки.
TranscriptLogger	Средство ведения журнала расшифровок хранит действия для бесед для отзыва.
TranscriptStore	Средство ведения журнала расшифровок хранит действия для бесед для отзыва.
IUserTokenProvider	Интерфейс api OAuth маркера пользователя для BotAdapters
TokenPollingSettings	Предоставляет сведения для опроса маркеров.

Псевдонимы типа

BotHandler	Описывает обработчик событий действий бота для использования с объектом ActivityHandler .
ConfigurationBotFrameworkAuthenticationOptions	Содержит параметры, используемые для настройки экземпляра ConfigurationBotFrameworkAuthentication .
ConfigurationServiceClientCredentialFactoryOptions	Содержит параметры, используемые для настройки экземпляра ConfigurationServiceClientCredentialFactory .
MiddlewareHandler	Сигнатура, реализованная ПО промежуточного слоя на основе функций. type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;
StorageKeyFactory	Обратный вызов для вычисления ключа хранилища. type StorageKeyFactory = (context: TurnContext) => Promise<string>;
TestActivityInspector	Сигнатура для функции, которую можно использовать для проверки отдельных действий, возвращаемых ботом, который тестируется с помощью TestAdapter. type TestActivityInspector = (activity: Partial<Activity>, description: string) => void;
DeleteActivityHandler	Обработчик, который может участвовать в событиях действия удаления для текущего поворота.
SendActivitiesHandler	Обработчик, который может участвовать в отправке событий действий для текущего поворота.
UpdateActivityHandler	Обработчик, который может участвовать в событиях действия обновления для текущего поворота.

Перечисления

Severity

Определяет уровень серьезности для события.

Функции

useBotState(BotAdapter, BotState[])	Добавляет ПО промежуточного слоя в адаптер для регистрации одного или нескольких объектов BotState в контексте поворота. ПО промежуточного слоя регистрирует объекты состояния в контексте поворота в начале каждого шага.
assertBotComponent(unknown, unknown[])
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)	Регистрирует DialogView с помощью метода trackPageView в BotTelemetryClient , если botPageViewTelemetryClient был реализован. Кроме того, записывает данные в журнал с помощью TrackTrace.
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)	Создает новый экземпляр класса ConfigurationBotFrameworkAuthentication .
createServiceClientCredentialFactoryFromConfiguration(Configuration)	Создает новый экземпляр класса ConfigurationServiceClientCredentialFactory .
assertStoreItems(unknown, unknown[])
calculateChangeHash(StoreItem)	Служебная функция для вычисления хэша изменений для StoreItem.

Сведения о функции

useBotState(BotAdapter, BotState[])

Добавляет ПО промежуточного слоя в адаптер для регистрации одного или нескольких объектов BotState в контексте поворота. ПО промежуточного слоя регистрирует объекты состояния в контексте поворота в начале каждого шага.

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

Параметры

botAdapter

BotAdapter

Адаптер, в котором регистрируются объекты состояния.

botStates

BotState[]

Регистрируемые объекты состояния.

Возвращаемое значение

BotAdapter

Обновленный адаптер.

assertBotComponent(unknown, unknown[])

Предупреждение

Теперь этот API является нерекомендуемым.

Use BotComponent.z.parse() instead.

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

Параметры

val

unknown

_args

unknown[]

Возвращаемое значение

asserts

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

Регистрирует DialogView с помощью метода trackPageView в BotTelemetryClient , если botPageViewTelemetryClient был реализован. Кроме того, записывает данные в журнал с помощью TrackTrace.

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

Параметры

telemetryClient

BotTelemetryClient

TelemetryClient, реализующий BotTelemetryClient.

dialogName

string

Имя диалогового окна для записи или запуска.

properties

[key: string]: any

Именованные строковые значения, которые можно использовать для поиска и классификации событий.

metrics

[key: string]: number

Измерения, связанные с этим событием.

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

Создает новый экземпляр класса ConfigurationBotFrameworkAuthentication .

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

Параметры

configuration

Configuration

Экземпляр конфигурации .

credentialsFactory

ServiceClientCredentialsFactory

Экземпляр ServiceClientCredentialsFactory .

authConfiguration

AuthenticationConfiguration

Объект Configuration .

botFrameworkClientFetch

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

Пользовательская реализация Fetch, используемая в BotFrameworkClient.

connectorClientOptions

ConnectorClientOptions

Объект ConnectorClientOptions .

Возвращаемое значение

BotFrameworkAuthentication

Экземпляр ConfigurationBotFrameworkAuthentication .

Комментарии

Экземпляр Configuration , предоставленный конструктору, должен иметь требуемые значения проверки подлинности, доступные в корне, используя свойства ConfigurationBotFrameworkAuthenticationOptions в качестве ключей.

createServiceClientCredentialFactoryFromConfiguration(Configuration)

Создает новый экземпляр класса ConfigurationServiceClientCredentialFactory .

function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory

Параметры

configuration

Configuration

Экземпляр конфигурации .

Возвращаемое значение

ConfigurationServiceClientCredentialFactory

Экземпляр ConfigurationServiceClientCredentialFactory .

Комментарии

Экземпляр Configuration , предоставленный конструктору, должен иметь нужные значения проверки подлинности, доступные в корне, используя свойства ConfigurationServiceClientCredentialFactoryOptions в качестве ключей.

assertStoreItems(unknown, unknown[])

Предупреждение

Теперь этот API является нерекомендуемым.

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

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

Параметры

val

unknown

_args

unknown[]

Возвращаемое значение

asserts

calculateChangeHash(StoreItem)

Служебная функция для вычисления хэша изменений для StoreItem.

function calculateChangeHash(item: StoreItem): string

Параметры

item

StoreItem

Элемент для вычисления хэша изменений.

Возвращаемое значение

string

изменить хэш-строку

Комментарии

В этом примере вычисляется хэш изменений для объекта, который был прочитан в , а затем он записывается только в том случае, если он был изменен:

// 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 });
}