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	Клиент телеметрии null, реализующий BotTelemetryClient.
BrowserLocalStorage	Поставщик хранилища, использующий локальное хранилище браузера.
BrowserSessionStorage	Поставщик хранилища, использующий хранилище сеансов браузера.
CardFactory	Предоставляет методы форматирования различных типов карт, которые бот может возвращать.
CloudAdapterBase	Адаптер, который реализует протокол Bot Framework и может размещаться в разных облачных средах как в общедоступных, так и частных.
ComponentRegistration	ComponentRegistration — это класс подписи для обнаружения ресурсов из компонентов.
ConfigurationBotFrameworkAuthentication	Создает экземпляр BotFrameworkAuthentication из объекта со значениями проверки подлинности или экземпляром configuration.
ConfigurationServiceClientCredentialFactory	ServiceClientCredentialsFactory, использующий ConfigurationServiceClientCredentialFactoryOptions или экземпляр конфигурации для создания ServiceClientCredentials с помощью идентификатора приложения и пароля приложения.
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	Регистрирует входящие и исходящие действия в DataStore.
TurnContext	Предоставляет контекст для поворота бота.
TurnContextStateCollection	Значения, сохраненные в течение времени существования поворота в составе TurnContext.
UserState	Считывает и записывает состояние пользователя для бота в хранилище.

Интерфейсы

CachedBotState	Сведения о состоянии кэшируются с объекта контекста BotState экземпляром.
StatePropertyAccessor	Определяет методы для доступа к свойству состояния, созданному в объекте BotState.
BotPageViewTelemetryClient
BotTelemetryClient
TelemetryDependency
TelemetryEvent
TelemetryException
TelemetryPageView
TelemetryTrace
CoreAppCredentials	CoreAppCredentials
CoreWebResource	Внутренний интерфейс, представляющий "WebResource" из @azure/ms-rest-js
ExtendedUserTokenProvider	Интерфейс для API Единого входа oAuth маркера пользователя и токена Exchange для 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>

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

connectorClientOptions

ConnectorClientOptions

Объект connectorClientOptions .

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

BotFrameworkAuthentication

Экземпляр ConfigurationBotFrameworkAuthentication.

Комментарии

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

createServiceClientCredentialFactoryFromConfiguration(Configuration)

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

function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory

Параметры

configuration

Configuration

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

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

ConfigurationServiceClientCredentialFactory

Экземпляр ConfigurationServiceClientCredentialFactory.

Комментарии

Экземпляр конфигурации конфигурации, предоставленный конструктору, должен иметь требуемые значения проверки подлинности, доступные в корне, используя свойства 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 });
}