botbuilder-core package
Clases
ActivityFactory |
ActivityFactory para generar texto y, a continuación, usa una semántica de Markdown sencilla como chatdown para crear actividad. |
ActivityHandler |
Controlador de actividad de emisión de eventos para bots. Extiende ActivityHandlerBase. |
ActivityHandlerBase |
Define el comportamiento principal de los controladores de actividad emisores de eventos para los bots. |
AutoSaveStateMiddleware |
Middleware que guardará automáticamente los cambios de estado al final del turno. |
BotAdapter |
Define el comportamiento principal de un adaptador de bot que puede conectar un bot a un punto de conexión de servicio. |
BotComponent |
Definición de un BotComponent que permite el registro de servicios, acciones personalizadas, ámbitos de memoria y adaptadores. Para que los componentes estén disponibles para el sistema que deriva de BotComponent y registre los servicios para agregar funcionalidad. Estos componentes se consumen en lugares adecuados por los sistemas que los necesitan. Al usar Composer, el entorno de ejecución del bot llama automáticamente a configureServices en los componentes, siempre y cuando los componentes se registren en la configuración. |
BotState |
Clase base para los ámbitos de conservación de estado de los marcos. |
BotStatePropertyAccessor |
Implementación |
BotStateSet |
Colección de |
NullTelemetryClient |
Un cliente de telemetría de bot nulo que implementa BotTelemetryClient. |
BrowserLocalStorage |
Proveedor de almacenamiento que usa el almacenamiento local del explorador. |
BrowserSessionStorage |
Proveedor de almacenamiento que usa el almacenamiento de sesión del explorador. |
CardFactory |
Proporciona métodos para dar formato a los distintos tipos de tarjeta que un bot puede devolver. |
CloudAdapterBase |
Un adaptador que implementa el Protocolo bot Framework y se puede hospedar en diferentes entornos de nube tanto públicos como privados. |
ComponentRegistration |
ComponentRegistration es una clase de firma para detectar recursos de componentes. |
ConfigurationBotFrameworkAuthentication |
Crea una instancia de BotFrameworkAuthentication a partir de un objeto con los valores de autenticación o una instancia de Configuration . |
ConfigurationServiceClientCredentialFactory |
ServiceClientCredentialsFactory que usa configurationServiceClientCredentialFactoryOptions o una instancia de Configuration para compilar ServiceClientCredentials con un AppId y una contraseña de aplicación. |
ConversationState |
Lee y escribe el estado de conversación del bot en el almacenamiento. |
InvokeException |
Excepción personalizada para los errores de respuesta de invocación. |
MemoryStorage |
Proveedor de almacenamiento basado en memoria para un bot. |
MemoryTranscriptStore |
El almacén de transcripciones de memoria almacena transcripciones en memoria volátil en un mapa. |
MessageFactory |
Un conjunto de funciones de utilidad para ayudar con el formato de los distintos tipos de mensajes que puede devolver un bot. |
MiddlewareSet |
Un conjunto de |
PrivateConversationState |
Lee y escribe el estado privateConversation del bot en el almacenamiento. |
QueueStorage |
Clase base para poner en cola una actividad para su procesamiento posterior. |
RegisterClassMiddleware |
Middleware para agregar un objeto a un servicio o registrarlo con el contexto de turno actual. |
ShowTypingMiddleware |
Middleware que enviará automáticamente un indicador de escritura para cada mensaje. |
SkillConversationIdFactory |
SkillConversationIdFactory que almacena y recupera instancias de ConversationReference . |
SkillConversationIdFactoryBase |
Define los métodos de un generador que se usa para crear identificadores de conversación únicos para conversaciones de aptitudes. |
SkypeMentionNormalizeMiddleware |
Middleware para aplicar revisiones a las entidades de Skype, ya que no se ajustan a los valores esperados. Los bots que interactúan con Skype deben usar este middleware si se usan menciones. |
StringUtils |
Clase auxiliar que contiene métodos de utilidad de cadena. |
TelemetryConstants |
Define los nombres de propiedades comunes para su uso con un objeto BotTelemetryClient . |
TelemetryLoggerMiddleware |
Middleware para registrar mensajes de actividad entrantes, salientes, actualizados o eliminados. Usa la interfaz botTelemetryClient. |
TestAdapter |
Adaptador de prueba usado para pruebas unitarias. Este adaptador se puede usar para simular el envío de mensajes desde el usuario al bot. |
TestFlow |
Clase de soporte para |
ConsoleTranscriptLogger |
ConsoleTranscriptLogger , escribe actividades en la salida de la consola. |
TranscriptLoggerMiddleware |
Registra las actividades entrantes y salientes en un TranscriptStore. |
TurnContext |
Proporciona contexto para un turno de un bot. |
TurnContextStateCollection |
Los valores se conservan durante la vigencia del turno como parte de TurnContext. |
UserState |
Lee y escribe el estado de usuario del bot en el almacenamiento. |
Interfaces
CachedBotState |
Información de estado almacenada en caché del objeto de contexto por una |
StatePropertyAccessor |
Define métodos para acceder a una propiedad de estado creada en un objeto BotState . |
BotPageViewTelemetryClient | |
BotTelemetryClient | |
TelemetryDependency | |
TelemetryEvent | |
TelemetryException | |
TelemetryPageView | |
TelemetryTrace | |
CoreAppCredentials |
CoreAppCredentials |
CoreWebResource |
Interfaz interna que representa el "WebResource" de @azure/ms-rest-js |
ExtendedUserTokenProvider |
Interfaz para el inicio de sesión único de OAuth del token de usuario y las API de Intercambio de tokens para BotAdapters |
IntentScore |
Puntuar más información adicional sobre una intención. |
Middleware |
Interfaz implementada por middleware basado en objetos. |
PropertyManager |
Interfaz implementada por clases capaces de factorizar descriptores de acceso de propiedad. |
RecognizerResult |
Valor devuelto de un reconocedor. |
BotFrameworkSkill |
Registro de un punto de conexión de aptitud basado en BotFrameworkHttpProtocol. |
SkillConversationIdFactoryOptions | |
SkillConversationReference | |
Storage |
Interfaz para un proveedor de almacenamiento que almacena y recupera objetos JSON antiguos sin formato. |
StoreItem |
Objeto que se almacena en Storage con una eTag opcional. |
StoreItems |
Asignación de objetos con nombre |
PagedResult |
Página de resultados. |
TranscriptInfo |
Metadatos de una transcripción almacenada. |
TranscriptLogger |
El registrador de transcripciones almacena las actividades de las conversaciones para la recuperación. |
TranscriptStore |
El registrador de transcripciones almacena las actividades de las conversaciones para la recuperación. |
IUserTokenProvider |
Interfaz para las API de OAuth de token de usuario para BotAdapters |
TokenPollingSettings |
Proporciona detalles para el sondeo de tokens. |
Alias de tipos
BotHandler |
Describe un controlador de eventos de actividad del bot, para su uso con un objeto ActivityHandler . |
ConfigurationBotFrameworkAuthenticationOptions |
Contiene las opciones usadas para configurar una instancia de ConfigurationBotFrameworkAuthentication . |
ConfigurationServiceClientCredentialFactoryOptions |
Contiene las opciones usadas para configurar una instancia de ConfigurationServiceClientCredentialFactory . |
MiddlewareHandler |
Firma implementada por middleware basado en funciones.
|
StorageKeyFactory |
Devolución de llamada para calcular una clave de almacenamiento.
|
TestActivityInspector |
Firma de una función que se puede usar para inspeccionar las actividades individuales devueltas por un bot que se está probando mediante
|
DeleteActivityHandler |
Controlador que puede participar en eventos de actividad de eliminación para el turno actual. |
SendActivitiesHandler |
Controlador que puede participar en eventos de actividad de envío para el turno actual. |
UpdateActivityHandler |
Controlador que puede participar en eventos de actividad de actualización para el turno actual. |
Enumeraciones
Severity |
Define el nivel de gravedad del evento. |
Funciones
Detalles de la función
useBotState(BotAdapter, BotState[])
Agrega middleware al adaptador para registrar uno o varios objetos BotState en el contexto de turno. El middleware registra los objetos de estado en el contexto de turno al principio de cada turno.
function useBotState(botAdapter: BotAdapter, botStates: BotState[]): BotAdapter
Parámetros
- botAdapter
- BotAdapter
Adaptador en el que se van a registrar los objetos de estado.
- botStates
-
BotState[]
Objetos de estado que se van a registrar.
Devoluciones
Adaptador actualizado.
assertBotComponent(unknown, unknown[])
Advertencia
Esta API ya está en desuso.
Use BotComponent.z.parse()
instead.
function assertBotComponent(val: unknown, _args: unknown[]): asserts
Parámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)
Registra un control DialogView mediante el método trackPageView en BotTelemetryClient si se ha implementado BotPageViewTelemetryClient . Como alternativa, registra la información a través de TrackTrace.
function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, dialogName: string, properties?: [key: string]: any, metrics?: [key: string]: number)
Parámetros
- telemetryClient
- BotTelemetryClient
TelemetryClient que implementa BotTelemetryClient.
- dialogName
-
string
Nombre del cuadro de diálogo para el que se va a registrar la entrada o inicio.
- properties
-
[key: string]: any
Valores de cadena con nombre que puede usar para buscar y clasificar eventos.
- metrics
-
[key: string]: number
Medidas asociadas a este evento.
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)
Crea una nueva instancia de la clase ConfigurationBotFrameworkAuthentication .
function createBotFrameworkAuthenticationFromConfiguration(configuration: Configuration, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions): BotFrameworkAuthentication
Parámetros
- configuration
-
Configuration
Instancia de configuración .
- credentialsFactory
-
ServiceClientCredentialsFactory
Una instancia de ServiceClientCredentialsFactory .
- authConfiguration
-
AuthenticationConfiguration
Objeto Configuration .
- botFrameworkClientFetch
-
(input: RequestInfo, init?: RequestInit) => Promise<Response>
Una implementación personalizada de Fetch que se usará en BotFrameworkClient.
- connectorClientOptions
-
ConnectorClientOptions
Objeto ConnectorClientOptions .
Devoluciones
BotFrameworkAuthentication
Una instancia de ConfigurationBotFrameworkAuthentication .
Comentarios
La instancia de configuración proporcionada al constructor debe tener los valores de autenticación deseados disponibles en la raíz, utilizando las propiedades de ConfigurationBotFrameworkAuthenticationOptions como sus claves.
createServiceClientCredentialFactoryFromConfiguration(Configuration)
Crea una nueva instancia de la clase ConfigurationServiceClientCredentialFactory .
function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory
Parámetros
- configuration
-
Configuration
Instancia de configuración .
Devoluciones
Una instancia de ConfigurationServiceClientCredentialFactory .
Comentarios
La instancia de configuración proporcionada al constructor debe tener los valores de autenticación deseados disponibles en la raíz, utilizando las propiedades de ConfigurationServiceClientCredentialFactoryOptions como sus claves.
assertStoreItems(unknown, unknown[])
Advertencia
Esta API ya está en desuso.
Use zod.record(zod.unknown())
instead.
function assertStoreItems(val: unknown, _args: unknown[]): asserts
Parámetros
- val
-
unknown
- _args
-
unknown[]
Devoluciones
asserts
calculateChangeHash(StoreItem)
Función de utilidad para calcular un hash de cambio para .StoreItem
function calculateChangeHash(item: StoreItem): string
Parámetros
- item
- StoreItem
Elemento para el que se va a calcular el hash de cambio.
Devoluciones
string
change hash string
Comentarios
En este ejemplo se calcula un hash de cambio para un objeto que se ha leído y, a continuación, solo se vuelve a escribir si se ha modificado:
// 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 });
}