botbuilder package
Clases
| ActionSet |
Implemente la compatibilidad con acciones con nombre que se pueden enlazar a un cuadro de diálogo para controlar las expresiones globales del usuario, como "ayuda" o "cancelar". Las acciones se insertan en la pila de diálogos como parte de los diálogos para que estos agentes de escucha puedan entrar y salir del ámbito a medida que avanza la conversación. También puede enlazar con nombre a acciones a botones que permiten que el bot responda a clics de botón en tarjetas que tal vez se hayan desplazado fuera de la pantalla. |
| AnimationCard |
Clase generador de tarjetas que simplifica la creación de tarjetas de animación. |
| AudioCard |
Clase generador de tarjetas que simplifica la creación de tarjetas Multimedia. |
| BotConnectorBot |
|
| CardAction |
Clase Builder para simplificar la adición de acciones a una tarjeta. |
| CardImage |
Clase Builder para simplificar la adición de imágenes a una tarjeta. |
| CardMedia |
Definición de una entidad multimedia para una tarjeta |
| ChatConnector |
Conecta un UniversalBot a varios canales a través de Bot Framework. |
| CommandDialog |
|
| ConsoleConnector |
Conecta un UniversalBot a la línea de comandos a través de una ventana de consola. |
| Dialog |
Clase base para todos los diálogos. Los diálogos son el componente principal del marco BotBuilder. Los bots usan diálogos para administrar conversaciones arbitrariamente complejas con un usuario. |
| DialogAction |
Las acciones de diálogo ofrecen accesos directos estáticos para implementar acciones comunes. También implementan compatibilidad con acciones con nombre que se pueden enlazar a un cuadro de diálogo para controlar las expresiones globales del usuario, como "ayuda" o "cancelar". Las acciones se insertan en la pila de diálogos como parte de los diálogos para que estos agentes de escucha puedan entrar y salir del ámbito a medida que avanza la conversación. También puede enlazar con nombre a acciones a botones que permiten que el bot responda a clics de botón en tarjetas que tal vez se hayan desplazado fuera de la pantalla. |
| EntityRecognizer |
Clase de utilidad que se usa para analizar & resolver entidades comunes como datetimes recibidas de LUIS. |
| Fact |
Clase builder para simplificar la creación de una lista de hechos para una tarjeta como un recibo. |
| HeroCard |
Clase generador de tarjetas que simplifica la creación de tarjetas prominentes. Las tarjetas prominentes contienen la misma información que una tarjeta en miniatura, solo con un diseño más pronunciado para las imágenes de tarjetas. |
| IntentDialog |
Identifica una intención de los usuarios y, opcionalmente, extrae entidades de una expresión de usuarios. |
| IntentRecognizer |
Clase base para todos los reconocedores principales. Permite la ejecución condicional de un reconocedor y el filtrado posterior de intenciones reconocidas. La clase derivada debe invalidar el método abstracto onRecognize(). |
| IntentRecognizerSet |
Federa una llamada recognize() en un conjunto de reconocedores de intención. |
| Keyboard |
Clase generador de tarjetas que simplifica la creación de tarjetas de teclado. |
| Library |
Biblioteca de diálogos relacionados que se usan con fines de enrutamiento. Las bibliotecas se pueden encadenar juntas para permitir el desarrollo de bots complejos. La clase universalBot es una biblioteca que forma la raíz de esta cadena. Las bibliotecas de elementos reutilizables se pueden desarrollar mediante la creación de una nueva instancia de biblioteca y la adición de diálogos como lo haría con un bot. La biblioteca debe tener un nombre único que se corresponda con el sitio web de las bibliotecas o el nombre del módulo NPM. Después, los bots pueden reutilizar la biblioteca simplemente agregando la instancia de biblioteca de elementos a su bot mediante UniversalBot.library(). Si la propia biblioteca depende de otras bibliotecas, debe agregarlas a la biblioteca como dependencia mediante Library.library(). Puede administrar fácilmente varias versiones de la biblioteca agregando un número de versión al nombre de la biblioteca. Para invocar diálogos dentro de los bots de biblioteca, deberá llamar a session.beginDialog() con un identificador de diálogo completo en forma de ":". Normalmente, lo ocultará del desarrollador exponiendo una función de su módulo que inicia el cuadro de diálogo para ellos.
Por lo tanto, llamar a algo como Cabe destacar que los diálogos siempre se invocan dentro del diálogo actual, por lo que una vez que se encuentra dentro de un diálogo de la biblioteca, no es necesario prefijar todas las llamadas beginDialog() con el nombre de las bibliotecas. Solo es cuando se cruza de un contexto de biblioteca a otro que debe incluir el prefijo de nombre de biblioteca. |
| LocalizedRegExpRecognizer |
Versión del RegExpRecognizer que usa el sistema de localización de marcos para recuperar una expresión regular localizada.
Se debe proporcionar la clave de búsqueda en el archivo index.json y al recibir un mensaje para una nueva configuración regional, el reconocedor recuperará la expresión localizada y se creará un nuevo |
| LuisDialog |
|
| LuisRecognizer |
Complemento de reconocedor de intenciones que detecta la intención de los usuarios mediante Microsofts Language Understanding Intelligent Service (LUIS) Las direcciones URL del servicio para varios modelos de LUIS (aplicaciones) se pueden pasar para admitir el reconocimiento en varios idiomas. |
| MediaCard |
Clase generador de tarjetas que simplifica la creación de tarjetas Multimedia. |
| MemoryBotStorage |
Valor predeterminado en la implementación de almacenamiento en memoria para almacenar los datos de estado de sesión del usuario &. |
| Message |
Clase generador de mensajes que simplifica la creación de mensajes complejos con datos adjuntos. |
| Middleware | |
| OAuthCard |
Clase generador de tarjetas que simplifica la creación de tarjetas de oauth. |
| Prompt |
Clase base para mensajes integrados y se puede usar para crear nuevas solicitudes personalizadas. La clase Prompt proporciona la lógica básica para solicitar o volver a preguntar a un usuario y proporciona un conjunto de enlaces extensibles para personalizar el reconocimiento de las solicitudes de respuesta de los usuarios, así como la salida enviada al usuario.
Las solicitudes siempre deben tener al menos un controlador onRecognize() y admiten agregar cualquier número de matches() o matchesAny() controladores que se pueden usar para agregar comandos especiales iniciados por el usuario al símbolo del sistema. Por ejemplo, los mensajes integrados agregan un |
| PromptAttachment |
Solicitud de datos adjuntos personalizable. |
| PromptChoice |
Petición de elección personalizable. |
| PromptConfirm |
Mensaje de confirmación personalizable. |
| PromptNumber |
Mensaje de confirmación personalizable. |
| PromptText |
Mensaje de texto personalizable. |
| PromptTime |
Petición de tiempo personalizable. |
| ReceiptCard |
Clase generador de tarjetas que simplifica la creación de tarjetas de recibo. |
| ReceiptItem |
Clase Builder para simplificar la adición de elementos a una tarjeta de recibo. |
| RegExpRecognizer |
Complemento de reconocedor de intenciones que detecta la intención de los usuarios mediante una expresión regular. Se pueden pasar varias expresiones para admitir el reconocimiento en varios lenguajes. |
| RemoteSessionLogger |
Registra la actividad de sesión en un punto de conexión remoto mediante eventos de depuración. El depurador remoto se usa automáticamente cuando el emulador se conecta al bot. Los canales que no son emuladores pueden transmitir su actividad al emulador guardando la dirección de la sesión del emulador en |
| Session |
Administra la conversación de bots con un usuario. |
| SessionLogger |
Registrador de sesión predeterminado usado para registrar la actividad de sesión en la consola. |
| SigninCard |
Clase generador de tarjetas que simplifica la creación de tarjetas de inicio de sesión. |
| SimpleDialog |
Permite la creación de diálogos personalizados basados en un cierre simple. Esto es útil para los casos en los que desea un flujo de conversación dinámico o tiene una situación que simplemente no se asigna muy bien al uso de una cascada. Las cosas que se deben tener en cuenta:
|
| SimplePromptRecognizer |
en desuso ya no se admiten a partir de la versión 3.8. En su lugar, use avisos personalizados. |
| SuggestedActions |
Clase builder para agregar acciones sugeridas a un mensaje |
| TextBot |
|
| ThumbnailCard |
Clase generador de tarjetas que simplifica la creación de tarjetas en miniatura. |
| UniversalBot |
Administra las conversaciones de los bots con los usuarios en varios canales. |
| VideoCard |
Clase generador de tarjetas que simplifica la creación de tarjetas de vídeo. |
| WaterfallDialog |
Permite la creación de diálogos personalizados basados en una cascada. |
Interfaces
| IActionRouteData |
Argumentos pasados a una acción desencadenada. |
| IAddress |
Dirección de la información de enrutamiento de un evento de . Las direcciones son bidireccionales, lo que significa que se pueden usar para abordar eventos entrantes y salientes. También son específicos del conector, lo que significa que conectores son libres de agregar sus propios campos a la dirección. Para enviar un mensaje proactivo a los bots de usuario, debe guardar la dirección de un mensaje de recibido. Dependiendo de las direcciones del canal puede cambiar, por lo que los bots deben actualizar periódicamente la dirección almacenada para un usuario determinado. |
| IAnimationCard |
Definición de interfaz para una tarjeta de animación |
| IAttachment |
Muchos canales de mensajería proporcionan la capacidad de adjuntar objetos más enriquecidos. Bot Builder le permite expresar estos datos adjuntos de forma cruzada y conectores hará lo mejor para representar los datos adjuntos mediante las construcciones nativas de canales. Si desea tener más control sobre la representación de canales de un mensaje, puede usar IEvent.sourceEvent para proporcionar datos adjuntos mediante el esquema nativo de canales. Los tipos de datos adjuntos que se pueden enviar varían según el canal, pero estos son los tipos básicos:
|
| IAudioCard |
Definición de interfaz para una tarjeta de audio |
| IBeginDialogActionOptions |
Opciones pasadas al definir un |
| IBotStateData |
Datos de estado de bot exportados. |
| IBotStateDataResult |
Objeto result devuelto de |
| IBotStorage |
Sistema de almacenamiento reemplazable usado por UniversalBot. |
| IBotStorageContext |
Objeto de contexto pasado a llamadas IBotStorage. |
| IBotStorageData |
Los valores de datos se conservan en IBotStorage. |
| ICancelActionOptions |
Opciones pasadas al definir un |
| ICardAction |
Acción que se debe realizar cuando se pulsa una tarjeta, un botón o una imagen. |
| ICardImage |
Imagen en una tarjeta. |
| ICardMediaUrl |
Información de dirección URL que describe los medios de una tarjeta |
| IChatConnectorAddress | |
| IChatConnectorEndpoint |
Opciones usadas para establecer varios puntos de conexión en una instancia de ChatConnector. Esto no debe cambiarse y normalmente no lo proporcionan los desarrolladores en IChatConnectorSettings. En su lugar, las dos propiedades de IChatConnectorSettings, "stateEndpoint" y "openIdMetadata" deben cambiarse allí. |
| IChatConnectorSettings |
Opciones usadas para inicializar una instancia de ChatConnector. |
| IChoice |
Opción que se puede pasar a Prompts.choice() o [PromptRecognizers.recognizeChoices()][/en-us/node/builder/chat-reference/classes/botbuilder_d.promptrecognizers#recognizechoices]. |
| IConnector |
Implementado por complementos de conector para UniversalBot. |
| IContactRelationUpdate |
Un usuario ha actualizado su lista de contactos. /** Un usuario ha actualizado su lista de contactos. |
| IConversationMembers |
Lista de miembros dentro de una conversación. |
| IConversationUpdate |
Las propiedades de una conversación han cambiado. |
| IConversationsResult |
Objeto result devuelto de |
| IDefaultLocalizerSettings |
Configuración usada para inicializar una implementación de ILocalizer. |
| IDialogActionOptions |
Opciones pasadas al definir una acción de diálogo. |
| IDialogResult |
Resultados devueltos por un cuadro de diálogo secundario a su elemento primario a través de una llamada a session.endDialog(). |
| IDialogState |
Entrada en la pila de diálogos de sesiones. |
| IDialogVersionOptions |
Opciones pasadas a Middleware.dialogVersion(). |
| IDialogWaterfallStep |
Firma para funciones pasadas como pasos para DialogAction.waterfall().
Las cascadas le permiten solicitar a un usuario información mediante una secuencia de preguntas. Cada paso de la cascada puede ejecutar una de las integradas, iniciar un nuevo cuadro de diálogo llamando a session.beginDialog(), avanzar al siguiente paso de la cascada manualmente mediante Cuando se llama a un cuadro de diálogo o un símbolo del sistema integrado desde un paso en cascada, los resultados de ese diálogo o mensaje se pasarán a través del parámetro Puede avanzar manualmente al siguiente paso de la cascada mediante la función Puede finalizar una cascada temprano pasando por cada paso de la cascada mediante llamadas a nota: Cascadas tienen un último paso oculto que finalizará automáticamente el cuadro de diálogo actual si llama a un mensaje o diálogo desde el último paso. Esto es útil en el que tiene una pila profunda de diálogos y desea que una llamada a session.endDialog() del último elemento secundario de la pila para finalizar toda la pila. El cierre del último elemento secundario desencadenará que todos sus elementos primarios se muevan a este paso oculto, lo que pondrá en cascada el cierre hasta arriba de la pila. Suele ser un comportamiento deseado, pero si quiere evitarlo o detenerlo en algún lugar del centro, deberá agregar un paso al final de la cascada que no haga nada o llame a algo como session.send() que no va a avanzar hacia delante de la cascada. |
| IDisambiguateChoices |
Opciones de ruta para pasar a Prompts.disambiguate().
La clave del mapa debe ser la etiqueta localizada que se va a mostrar al usuario y el valor debe ser la ruta que se debe seleccionar cuando lo elija el usuario. Puede pasar |
| IDisambiguateRouteHandler |
Lógica de desambiguación de ruta personalizada pasada a UniversalBot.onDisambiguateRoute(). |
| IEntity |
Una entidad reconocida. |
| IEvent |
Evento recibido de o que se envía a un origen. |
| IEventMiddleware |
Firma de función para un fragmento de middleware que enlaza los eventos "receive" o "send". |
| IFact | |
| IFindActionRouteContext |
Contexto pasado a |
| IFindMatchResult |
Resultado devuelto de una llamada a EntityRecognizer.findBestMatch() o EntityRecognizer.findAllMatches(). |
| IFindRoutesHandler |
Lógica de búsqueda de rutas personalizada pasada a Library.onFindRoutes(). |
| IFirstRunOptions |
Opciones pasadas a Middleware.firstRun(). |
| IIdentity |
Representa un usuario, un bot o una conversación. |
| IIntent |
Una intención reconocida. |
| IIntentDialogOptions |
Opciones usadas para configurar un IntentDialog. |
| IIntentRecognizer |
Interfaz implementada por complementos de reconocedor de intenciones como la clase |
| IIntentRecognizerResult |
Resultados devueltos por un reconocedor de intenciones. |
| IIntentRecognizerSetOptions |
Opciones usadas para configurar un IntentRecognizerSet. |
| IIsAttachment |
Implementado por clases que se pueden convertir en datos adjuntos. |
| IIsCardAction |
Implementado por clases que se pueden convertir en una acción de tarjeta. |
| IIsCardImage |
Implementado por clases que se pueden convertir en una imagen de tarjeta. |
| IIsCardMedia |
Entidades que se pueden convertir a Media para tarjetas |
| IIsFact |
Implementado por clases que se pueden convertir en un hecho. |
| IIsMessage |
Implementado por clases que se pueden convertir en un IMessage, como la clase de generador message |
| IIsReceiptItem |
Implementado por clases que se pueden convertir en un elemento de recibo. |
| IIsSuggestedActions |
Implementado por clases que se pueden convertir en acciones sugeridas |
| ILocalizer |
Complemento para localizar los mensajes enviados al usuario por un bot. |
| ILuisModelMap |
Asignación por local de la dirección URL del servicio luis que se va a usar para luisRecognizer. |
| IMediaCard |
Definición de interfaz de un MediaCard genérico, que en su forma concreta puede ser una tarjeta de audio, animación o vídeo |
| IMediaEventValue |
Parámetro complementario para eventos multimedia. |
| IMessage |
Mensaje de chat enviado entre un usuario y un bot. Los mensajes del bot al usuario vienen en dos tipos:
En el caso reactivo, debe copiar el campo de dirección La redacción de un mensaje al usuario mediante el objeto de dirección entrante enviará de forma predeterminada una respuesta al usuario en el contexto de la conversación actual. Algunos canales permiten el inicio de nuevas conversaciones con el usuario. Para iniciar una nueva conversación proactiva con el usuario, simplemente elimine el campo de conversación del objeto de dirección antes de redactar el mensaje saliente. |
| IMessageOptions |
Propiedades de mensaje opcionales que se pueden enviar a elementos como mensajes o session.say(). |
| IMessageReaction |
Objeto de reacción de mensaje. |
| IMessageUpdate |
Las propiedades de un mensaje han cambiado. |
| IMiddlewareMap |
Mapa de enlaces de middleware que se pueden registrar en una llamada a UniversalBot.use(). |
| IOAuthCard |
Interfaz que representa OAuthCard. Tarjeta que representa una solicitud para dar forma a un inicio de sesión a través de OAuth |
| IPagedMembersResult |
Objeto result devuelto de |
| IPromptArgs |
EN DESUSO el nuevo sistema de mensajes solo usa IPromptOptions. |
| IPromptAttachmentFeatures |
Características opcionales para clase PromptAttachment. |
| IPromptAttachmentOptions |
Opciones pasadas a |
| IPromptAttachmentResult |
Resultado del aviso de datos adjuntos fuertemente tipado. |
| IPromptChoiceFeatures |
Características opcionales para clase PromptChoice. |
| IPromptChoiceOptions |
Opciones pasadas a |
| IPromptChoiceResult |
Resultado del símbolo del sistema de elección fuertemente tipado. |
| IPromptConfirmResult |
Confirmar resultado del símbolo del sistema fuertemente tipado. |
| IPromptContext |
Información contextual de la que se realiza un seguimiento de un prompt. Se puede acceder a esta información dentro de un símbolo del sistema a través de session.dialogData. |
| IPromptFeatures |
Características opcionales que se deben habilitar o deshabilitar al crear un prompt personalizado |
| IPromptNumberOptions |
Opciones pasadas a Prompts.number() o en una llamada de |
| IPromptNumberResult |
Resultado del símbolo del número fuertemente tipado. |
| IPromptOptions |
Las opciones que se pasan al mensajes integrados. |
| IPromptRecognizeChoicesOptions |
Opciones pasadas a PromptRecognizers.recognizeChoices(). |
| IPromptRecognizeNumbersOptions |
Opciones pasadas a PromptRecognizers.recognizeNumbers(). |
| IPromptRecognizeTimesOptions |
Opciones pasadas a PromptRecognizers.recognizeTimes(). |
| IPromptRecognizeValuesOptions |
Opciones pasadas a PromptRecognizers.recognizeValues(). |
| IPromptRecognizer |
en desuso ya no se admiten a partir de la versión 3.8. En su lugar, use avisos personalizados. |
| IPromptRecognizerArgs |
en desuso ya no se admiten a partir de la versión 3.8. En su lugar, use avisos personalizados. |
| IPromptRecognizerResult |
Resultado devuelto de un IPromptRecognizer. |
| IPromptResult |
Resultado del cuadro de diálogo devuelto por un símbolo del sistema. |
| IPromptTextFeatures |
Características opcionales para clase PromptText. |
| IPromptTextOptions |
Opciones pasadas a |
| IPromptTextResult |
Resultado del mensaje de texto fuertemente tipado. |
| IPromptTimeResult |
Resultado del aviso de tiempo fuertemente tipado. |
| IPromptsOptions |
en desuso ya no se admiten a partir de la versión 3.8. En su lugar, use avisos personalizados. |
| IReceiptCard |
Muestra un recibo enriquecido a un usuario para algo que haya comprado o esté planeando comprar. |
| IReceiptItem | |
| IRecognizeContext |
Contexto del mensaje recibido pasado a varios métodos de reconocimiento. |
| IRecognizeDialogContext |
Contexto pasado a |
| IRecognizeResult |
Resultados de una llamada a una función recognize(). La implementación es gratuita para agregar propiedades adicionales al resultado. |
| IRegExpMap |
Asignación por local de expresiones regulares que se van a usar para regExpRecognizer. |
| IRouteResult |
Ruta candidata devuelta por Library.findRoutes(). |
| ISelectRouteHandler |
Lógica de búsqueda de rutas personalizada pasada a Library.onSelectRoute(). |
| ISemanticAction |
Representa una referencia a una acción mediante programación. |
| ISessionMiddleware |
Firma de función para un fragmento de middleware que enlaza el evento "botbuilder". |
| ISessionOptions |
Opciones pasadas al constructor de una sesión. |
| ISessionState |
Estado de sesión persistente usado para realizar un seguimiento de una pila de diálogos de conversaciones. |
| ISigninCard |
Muestra una tarjeta de inicio de sesión y un botón para el usuario. Algunos canales pueden optar por representarlo como un mensaje de texto y vincular para hacer clic. |
| ISourceEventMap |
Asignación por origen de datos de eventos personalizados que se van a enviar. |
| IStartConversationAddress |
Propiedades adicionales que se pueden pasar con la dirección a UniversalBot.beginDialog(). |
| ISuggestedActions |
Acciones sugeridas para enviar al usuario y mostrarlas como respuestas rápidas. Las acciones sugeridas solo se mostrarán en los canales que admiten acciones sugeridas. |
| ITextHighlight |
Interfaz que representa TextHighlight. Hace referencia a una subcadena de contenido dentro de otro campo. |
| IThumbnailCard |
Muestra una tarjeta al usuario mediante un diseño de miniatura más pequeño o un diseño de imagen principal mayor (los datos adjuntos contentType determina cuáles). Todos los campos de tarjetas son opcionales, por lo que esta tarjeta se puede usar para especificar cosas como un teclado en determinados canales. Algunos canales pueden optar por representar una versión de fidelidad inferior de la tarjeta o usar una representación alternativa. |
| ITokenResponse |
Interfaz que representa TokenResponse. Respuesta que incluye un token de usuario |
| ITranscript |
Interfaz que representa actividades históricas. |
| ITriggerActionOptions |
Opciones pasadas al definir un |
| IUniversalBotSettings |
Opciones usadas para inicializar una instancia de UniversalBot. |
| IVideoCard |
Definición de interfaz para una tarjeta de vídeo |
| IWatchableHandler |
Función para recuperar el valor de una variable vista. Se pasa a Session.watchable(). |
Alias de tipos
| AttachmentType |
Algunos métodos pueden tomar una |
| MatchType |
Reglas admitidas para buscar coincidencias con una expresión de usuarios.
|
| MessageType |
Mensajes basados en mensajes que se pueden enviar a un usuario.
|
| TextOrMessageType |
Intervalo flexible de posibles mensajes que se pueden enviar a un usuario.
|
| TextType |
Mensajes basados en texto que se pueden enviar a un usuario.
|
| ValueListType |
Lista de valores de texto. Los valores se pueden expresar como una cadena delimitada de canalización como "value1|value2|value3" o una matriz simple de valores. |
Enumeraciones
| ListStyle |
Tipo de lista que se va a representar para promptType.choice prompt. |
| PromptType |
Tipo de símbolo del sistema invocado. |
| RecognizeMode |
Controla un IntentDialogs procesamiento de las expresiones de texto de los usuarios. |
| RecognizeOrder |
Orden en el que se deben evaluar un IntentDialogs reconocedores. |
| ResumeReason |
Códigos de motivo para por qué se reanudó un cuadro de diálogo. |