botbuilder-core package

Classes

ActivityFactory	ActivityFactory pour générer du texte, puis utilise des sémantiques markdown simples telles que chatdown pour créer l’activité.
ActivityHandler	Gestionnaire d’activités émettrice d’événements pour les bots. Étend ActivityHandlerBase.
ActivityHandlerBase	Définit le comportement principal pour les gestionnaires d’activités émettrices d’événements pour les bots.
AutoSaveStateMiddleware	Middleware qui enregistre automatiquement les modifications d’état à la fin du tour.
BotAdapter	Définit le comportement principal d’un adaptateur de bot qui peut connecter un bot à un point de terminaison de service.
BotComponent	Définition d’un BotComponent qui autorise l’inscription de services, d’actions personnalisées, d’étendues de mémoire et d’adaptateurs. Pour rendre vos composants disponibles pour le système que vous dérivez de BotComponent et inscrire des services pour ajouter des fonctionnalités. Ces composants sont ensuite consommés à des endroits appropriés par les systèmes qui en ont besoin. Lors de l’utilisation de Composer, configureServices est appelé automatiquement sur les composants par le runtime du bot, tant que les composants sont inscrits dans la configuration.
BotState	Classe de base pour les étendues de persistance d’état des frameworks.
BotStatePropertyAccessor	Implémentation BotState spécifique de l’interface StatePropertyAccessor.
BotStateSet	Collection de plug-ins BotState qui doivent être chargés ou enregistrés en parallèle sous forme d’unité unique. Consultez AutoSaveStateMiddleware pour une implémentation de cette classe.
NullTelemetryClient	Un client de télémétrie de bot null qui implémente BotTelemetryClient.
BrowserLocalStorage	Fournisseur de stockage qui utilise le stockage local du navigateur.
BrowserSessionStorage	Fournisseur de stockage qui utilise le stockage de session du navigateur.
CardFactory	Fournit des méthodes pour mettre en forme les différents types de cartes qu’un bot peut retourner.
CloudAdapterBase	Adaptateur qui implémente le protocole Bot Framework et peut être hébergé dans différents environnements cloud à la fois publics et privés.
ComponentRegistration	ComponentRegistration est une classe de signature permettant de découvrir des ressources à partir de composants.
ConfigurationBotFrameworkAuthentication	Crée une instance BotFrameworkAuthentication à partir d’un objet avec les valeurs d’authentification ou une instance Configuration.
ConfigurationServiceClientCredentialFactory	ServiceClientCredentialsFactory qui utilise un ConfigurationServiceClientCredentialFactoryOptions ou une instance Configuration pour générer ServiceClientCredentials avec un AppId et un mot de passe d’application.
ConversationState	Lit et écrit l’état de conversation de votre bot dans le stockage.
InvokeException	Exception personnalisée pour les erreurs de réponse d’appel.
MemoryStorage	Fournisseur de stockage basé sur la mémoire pour un bot.
MemoryTranscriptStore	Le magasin de transcriptions de mémoire stocke les transcriptions en mémoire volatile dans une carte.
MessageFactory	Un ensemble de fonctions utilitaires pour faciliter la mise en forme des différents types de messages qu’un bot peut retourner.
MiddlewareSet	Ensemble de plug-ins Middleware.
PrivateConversationState	Lit et écrit l’état PrivateConversation de votre bot dans le stockage.
QueueStorage	Classe de base pour mettre en file d’attente une activité pour un traitement ultérieur.
RegisterClassMiddleware	Intergiciel pour l’ajout d’un objet à un service ou l’inscription d’un service avec le contexte de tour actuel.
ShowTypingMiddleware	Middleware qui envoie automatiquement un indicateur de saisie pour chaque message.
SkillConversationIdFactory	SkillConversationIdFactory qui stocke et récupère ConversationReference instances.
SkillConversationIdFactoryBase	Définit les méthodes d’une fabrique utilisée pour créer des ID de conversation uniques pour les conversations de compétences.
SkypeMentionNormalizeMiddleware	Middleware pour mettre à jour les entités de Skype, car elles ne sont pas conformes aux valeurs attendues. Les bots qui interagissent avec Skype doivent utiliser ce middleware si des mentions sont utilisées.
StringUtils	Classe d’assistance contenant des méthodes utilitaires de chaîne.
TelemetryConstants	Définit les noms des propriétés courantes à utiliser avec un objet BotTelemetryClient.
TelemetryLoggerMiddleware	Middleware pour la journalisation des messages d’activité entrants, sortants, mis à jour ou supprimés. Utilise l’interface botTelemetryClient.
TestAdapter	Adaptateur de test utilisé pour les tests unitaires. Cet adaptateur peut être utilisé pour simuler l’envoi de messages de l’utilisateur au bot.
TestFlow	Classe de support pour TestAdapter qui permet la construction simple d’une séquence de tests.
ConsoleTranscriptLogger	ConsoleTranscriptLogger , écrit des activités dans la sortie de la console.
TranscriptLoggerMiddleware	Journalise les activités entrantes et sortantes dans un TranscriptStore.
TurnContext	Fournit un contexte pour un tour d’un bot.
TurnContextStateCollection	Les valeurs conservées pendant la durée de vie du tour dans le cadre du TurnContext.
UserState	Lit et écrit l’état utilisateur de votre bot dans le stockage.

Interfaces

CachedBotState	Informations d’état mises en cache sur l’objet de contexte par une instance de BotState.
StatePropertyAccessor	Définit les méthodes permettant d’accéder à une propriété d’état créée dans un objet BotState.
BotPageViewTelemetryClient
BotTelemetryClient
TelemetryDependency
TelemetryEvent
TelemetryException
TelemetryPageView
TelemetryTrace
CoreAppCredentials	CoreAppCredentials
CoreWebResource	Interface interne représentant le « WebResource » de @azure/ms-rest-js
ExtendedUserTokenProvider	Interface pour l’authentification unique OAuth de jeton utilisateur et LES API Exchange de jetons pour BotAdapters
IntentScore	Noter plus toutes les informations supplémentaires relatives à une intention.
Middleware	Interface implémentée par l’intergiciel basé sur l’objet.
PropertyManager	Interface implémentée par les classes capables de factoriser les accesseurs de propriété.
RecognizerResult	Valeur retournée par un module de reconnaissance.
BotFrameworkSkill	Inscription d’un point de terminaison de compétence basé sur BotFrameworkHttpProtocol.
SkillConversationIdFactoryOptions
SkillConversationReference
Storage	Interface pour un fournisseur de stockage qui stocke et récupère les anciens objets JSON bruts.
StoreItem	Objet stocké dans le stockage avec un eTag facultatif.
StoreItems	Mappage d’objets nommés StoreItem.
PagedResult	Page des résultats.
TranscriptInfo	Métadonnées d’une transcription stockée.
TranscriptLogger	L’enregistreur d’événements de transcription stocke les activités des conversations pour le rappel.
TranscriptStore	L’enregistreur d’événements de transcription stocke les activités des conversations pour le rappel.
IUserTokenProvider	Interface pour les API OAuth de jeton utilisateur pour BotAdapters
TokenPollingSettings	Fournit des détails pour l’interrogation des jetons.

Alias de type

BotHandler	Décrit un gestionnaire d’événements d’activité de bot, à utiliser avec un objet ActivityHandler.
ConfigurationBotFrameworkAuthenticationOptions	Contient les paramètres utilisés pour configurer une instance ConfigurationBotFrameworkAuthentication.
ConfigurationServiceClientCredentialFactoryOptions	Contient les paramètres utilisés pour configurer une instance ConfigurationServiceClientCredentialFactory.
MiddlewareHandler	Signature implémentée par l’intergiciel basé sur les fonctions. type MiddlewareHandler = (context: TurnContext, next: () => Promise<void>) => Promise<void>;
StorageKeyFactory	Rappel pour calculer une clé de stockage. type StorageKeyFactory = (context: TurnContext) => Promise<string>;
TestActivityInspector	Signature d’une fonction qui peut être utilisée pour inspecter les activités individuelles retournées par un bot en cours de test à l’aide du TestAdapter. type TestActivityInspector = (activity: Partial<Activity>, description: string) => void;
DeleteActivityHandler	Gestionnaire qui peut participer aux événements d’activité de suppression pour le tour actuel.
SendActivitiesHandler	Gestionnaire qui peut participer aux événements d’activité d’envoi pour le tour actuel.
UpdateActivityHandler	Gestionnaire qui peut participer aux événements d’activité de mise à jour pour le tour actuel.

Énumérations

Severity

Définit le niveau de gravité de l’événement.

Functions

useBotState(BotAdapter, BotState[])	Ajoute un intergiciel à l’adaptateur pour inscrire un ou plusieurs objets BotState dans le contexte de tour. L’intergiciel enregistre les objets d’état sur le contexte de tour au début de chaque tour.
assertBotComponent(unknown, unknown[])
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)	Journalise un DialogView à l’aide de la méthode trackPageView sur le BotTelemetryClient si BotPageViewTelemetryClient a été implémenté. Vous pouvez également journalisation des informations via TrackTrace.
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)	Crée une instance de la classe ConfigurationBotFrameworkAuthentication.
createServiceClientCredentialFactoryFromConfiguration(Configuration)	Crée une instance de la classe ConfigurationServiceClientCredentialFactory.
assertStoreItems(unknown, unknown[])
calculateChangeHash(StoreItem)	Fonction utilitaire pour calculer un hachage de modification pour un StoreItem.

Informations relatives à la fonction

useBotState(BotAdapter, BotState[])

Ajoute un intergiciel à l’adaptateur pour inscrire un ou plusieurs objets BotState dans le contexte de tour. L’intergiciel enregistre les objets d’état sur le contexte de tour au début de chaque tour.

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

Paramètres

botAdapter

BotAdapter

Adaptateur sur lequel inscrire les objets d’état.

botStates

BotState[]

Objets d’état à inscrire.

Retours

BotAdapter

Adaptateur mis à jour.

assertBotComponent(unknown, unknown[])

Avertissement

Cette API est à présent déconseillée.

Use BotComponent.z.parse() instead.

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

Paramètres

val

unknown

_args

unknown[]

Retours

asserts

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

Journalise un DialogView à l’aide de la méthode trackPageView sur le BotTelemetryClient si BotPageViewTelemetryClient a été implémenté. Vous pouvez également journalisation des informations via TrackTrace.

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

Paramètres

telemetryClient

BotTelemetryClient

TelemetryClient qui implémente BotTelemetryClient.

dialogName

string

Nom de la boîte de dialogue pour laquelle enregistrer l’entrée/ démarrer.

properties

[key: string]: any

Valeurs de chaîne nommées que vous pouvez utiliser pour rechercher et classifier des événements.

metrics

[key: string]: number

Mesures associées à cet événement.

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

Crée une instance de la classe ConfigurationBotFrameworkAuthentication.

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

Paramètres

configuration

Configuration

Instance Configuration.

credentialsFactory

ServiceClientCredentialsFactory

Instance ServiceClientCredentialsFactory.

authConfiguration

AuthenticationConfiguration

Objet Configuration.

botFrameworkClientFetch

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

Implémentation fetch personnalisée à utiliser dans le BotFrameworkClient.

connectorClientOptions

ConnectorClientOptions

Objet ConnectorClientOptions.

Retours

BotFrameworkAuthentication

Instance de ConfigurationBotFrameworkAuthentication.

Remarques

L’instance Configuration fournie au constructeur doit avoir les valeurs d’authentification souhaitées disponibles à la racine, à l’aide des propriétés de ConfigurationBotFrameworkAuthenticationOptions en tant que clés.

createServiceClientCredentialFactoryFromConfiguration(Configuration)

Crée une instance de la classe ConfigurationServiceClientCredentialFactory.

function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory

Paramètres

configuration

Configuration

Instance Configuration.

Retours

ConfigurationServiceClientCredentialFactory

Instance ConfigurationServiceClientCredentialFactory.

Remarques

L’instance Configuration fournie au constructeur doit avoir les valeurs d’authentification souhaitées disponibles à la racine, à l’aide des propriétés de ConfigurationServiceClientCredentialFactoryOptions en tant que clés.

assertStoreItems(unknown, unknown[])

Avertissement

Cette API est à présent déconseillée.

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

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

Paramètres

val

unknown

_args

unknown[]

Retours

asserts

calculateChangeHash(StoreItem)

Fonction utilitaire pour calculer un hachage de modification pour un StoreItem.

function calculateChangeHash(item: StoreItem): string

Paramètres

item

StoreItem

Élément pour lequel calculer le hachage de modification.

Retours

string

modifier la chaîne de hachage

Remarques

Cet exemple calcule un hachage de modification pour un objet qui a été lu, puis l’écrit uniquement s’il a été modifié :

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