Compartir a través de


botbuilder-calling package

Clases

AnswerAction

Clase del generador de acciones diseñada para simplificar la creación de acciones de respuesta .

CallConnector

Conecte un UniversalCallBot al servicio de llamadas de Skype.

CallSession

Administra la conversación de bots con un usuario.

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 a la implementación de acciones comunes.

HangupAction

Clase del generador de acciones diseñada para simplificar la creación de acciones de bloqueo .

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 UniversalCallBot 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. Los bots pueden reutilizar la biblioteca simplemente agregando la instancia de biblioteca de elementos a su bot mediante UniversalCallBot.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 devloper exponiendo una función de su módulo que inicia el cuadro de diálogo para ellos. Por lo tanto, llamar a algo como myLib.someDialog(session, { arg: '' }); terminaría llamando a session.beginDialog('myLib:someDialog', args); en segundo plano.

Vale la pena tener en cuenta 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.

MemoryBotStorage

Valor predeterminado en la implementación de almacenamiento en memoria para almacenar los datos de estado de sesión del usuario &.

PlayPromptAction

Clase de generador de acciones diseñada para simplificar la creación de acciones playPrompt.

Prompt

Clase del generador de mensajes que simplifica la creación de mensajes para la acción playPrompt.

Prompts

Se han integrado mensajes integrados a los que se puede llamar desde cualquier cuadro de diálogo.

RecognizeAction

Clase del generador de acciones diseñada para simplificar la creación de reconocer acciones.

RecordAction

Clase del generador de acciones diseñada para simplificar la creación de acciones de registro .

RejectAction

Clase del generador de acciones diseñada para simplificar la creación de rechazar acciones.

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:

  • El cierre de los diálogos se puede llamar en dos contextos diferentes para los que es posible que necesite probar. Se llamará según lo esperado cuando el usuario envíe un mensaje al cuadro de diálogo, pero si llama a otro mensaje o diálogo desde el cierre, se llamará una segunda vez con los resultados del mensaje o cuadro de diálogo. Normalmente, puede probar para este segundo caso comprobando si existe una propiedad args.resumed. Es importante evitar entrar en un bucle infinito que puede ser fácil de hacer.
  • A diferencia de una cascada, el diálogo no finalizará automáticamente. Seguirá siendo el cuadro de diálogo activo hasta que llame a session.endDialog().
UniversalCallBot

Administra las conversaciones de los bots con los usuarios en varios canales.

Interfaces

IAction

Clase base para todas las acciones.

IActionOutcome

Clase base para todos los resultados de la acción.

IAddress

Información de enrutamiento de direcciones para un mensaje de . Las direcciones son bidireccionales, lo que significa que se pueden usar para abordar los mensajes entrantes y salientes. También son específicos del conector, lo que significa que conectores pueden agregar sus propios campos.

IAnswerAction

La acción de respuesta permite que un bot acepte una llamada de Skype. La acción de respuesta debe ser una primera acción en respuesta a la notificación de conversación.

IAnswerOutcome

Resultado de la acción Respuesta.

IBotStorage

Sistema de almacenamiento relacable usado por UniversalCallBot.

IBotStorageContext

Objeto de contexto pasado a llamadas IBotStorage.

IBotStorageData

Los valores de datos se conservan en IBotStorage.

ICallConnector

Implementado por complementos de conector para UniversalCallBot.

ICallConnectorAddress

Dirección específica del conector de chat.

ICallConnectorSettings

Opciones usadas para inicializar una instancia de ChatConnector.

ICallSessionMiddleware

Firma de función para un fragmento de middleware que enlaza el evento "botbuilder".

ICallSessionOptions

Opciones pasadas al constructor de una sesión.

IChoiceOutcome

Se devuelve cuando se selecciona un reconocimiento de opciones.

ICollectDigits

Especifica las opciones de la colección de dígitos. Por ejemplo, "Escriba el código postal de 5 dígitos seguido del signo de libra".

ICollectDigitsOutcome

Se devuelve cuando se selecciona la colección de dígitos.

IConfirmPromptOptions

Opciones pasadas a un símbolo del sistema de confirmación.

IConversation

IConversation es un cuerpo JSON de una primera solicitud de nueva llamada de voz de Skype realizada por la Plataforma de bots de Skype para llamar a un bot. El cuerpo JSON de IConversation se publica en el punto de conexión HTTPs inicial registrado por un desarrollador de bots en el Portal de Bot Framework. La solicitud IConversation contiene información sobre el autor de la llamada y el destino de la llamada y información adicional sobre el estado inicial de una llamada.

IConversationResult

IConversationResult es un cuerpo JSON de cualquier solicitud posterior después de la notificación inicial de IConversation que se envía a un bot desde skype Bot Platform for Calling. IConversationResult se publica en un vínculo de devolución de llamada proporcionado por la respuesta anterior del flujo de trabajo. IConversationResult representa el resultado de una última acción correcta de la respuesta de flujo de trabajo anterior.

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.

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 skip()o finalizar la cascada.

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 results al siguiente paso de la cascada. Los usuarios pueden decir cosas como "nevermind" para cancelar las indicaciones integradas, por lo que debe protegerse de eso al menos comprobando si hay results.response antes de continuar. Se puede determinar una extensión más detallada de por qué se continúa la cascada examinando el código de devuelto para results.reanudado.

Puede avanzar manualmente al siguiente paso de la cascada mediante la función skip() pasada. Llamar a skip({ response: "some text" }) con un de IDialogResult le permite imitar con mayor precisión los resultados de un mensaje integrado y puede simplificar la lógica general de cascada.

Puede finalizar una cascada temprano pasando por cada paso de la cascada mediante llamadas a skip() o simplemente no iniciando otro mensaje o cuadro de diálogo.

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. Este 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.

IDigitsPromptOptions

Opciones pasadas a un símbolo del sistema de "dígitos".

IErrorEvent

Firma de función para un controlador de eventos de error.

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".

IFindMatchResult

result devuelto de una llamada a EntityRecognizer.findBestMatch() o EntityRecognizer.findAllMatches().

IHangupAction

Bloquear permite que el bot finalice la llamada en curso. Colgar es la última acción del flujo de trabajo. Tenga en cuenta que es diferente entre Hangup y Reject. La acción rechazar permite al bot finalizar la llamada en lugar de responder a la llamada mientras hangup finaliza la llamada en curso.

IHangupOutcome

Devuelve el resultado del bloqueo.

IIdentity

Representa un usuario, un bot o una conversación.

IIsAction

Implementado por clases que se pueden convertir en acciones.

IIsEvent

Implementado por clases que se pueden convertir en un evento.

IIsPrompt

Implementado por clases que se pueden convertir en mensajes.

ILocalizer

Complemento para localizar los mensajes enviados al usuario por un bot.

IMiddlewareMap

Mapa de enlaces de middleware que se pueden registrar en una llamada a UniversalCallBot.use().

IPlayPromptAction

PlayPrompt permite reproducir textoTo-Speech audio o un archivo multimedia.

IPlayPromptOutcome

El resultado de la solicitud de reproducción devuelve el resultado de reproducir un mensaje.

IPrompt

Aviso jugado como parte de la acción PlayPrompt.

IPromptActionResult

Resultado del símbolo del sistema de acción fuertemente tipado.

IPromptChoiceResult

Resultado del símbolo del sistema de elección fuertemente tipado.

IPromptConfirmResult

Confirmar resultado del símbolo del sistema fuertemente tipado.

IPromptDigitsResult

Resultado del aviso de dígitos fuertemente tipados.

IPromptOptions

Opciones pasadas a avisos integrados.

IPromptRecordResult

Resultado del aviso de registro fuertemente tipado.

IPromptResult

Resultado del cuadro de diálogo devuelto por un símbolo del sistema.

IPromptsSettings

Opciones de configuración global para el cuadro de diálogo Avisos.

IRecognitionChoice

Especifica las opciones de voz & DTMF para un reconocimiento basado en opciones. Por ejemplo, "Diga "Ventas" o presione 1 para el departamento de ventas".

IRecognizeAction

La acción Reconocer permite capturar la salida del reconocimiento de voz o recopilar dígitos del panel de marcado de usuario de Skype.

IRecognizeOutcome

El resultado de reconocer es el resultado de la acción de reconocimiento. Contiene dígitos reconocidos o voz reconocida.

IRecognizerPromptOptions

Opciones pasadas a avisos basados en reconocedores.

IRecordAction

La acción grabar es una acción interactiva en la que se graba audio de usuario de Skype.

IRecordOutcome

El resultado del registro devuelve el resultado de la acción de audio de grabación. RecordOutcome podría devolverse como contenido de varias partes, donde la primera parte de varias partes contiene el resultado de la acción, mientras que la segunda parte contiene una secuencia binaria que representa el audio grabado. La secuencia audo estará disponible a través de la propiedad IConversationResult.recordedAudio.

IRecordPromptOptions

Opciones pasadas a un símbolo del sistema "record".

IRecording

Grabación devuelta desde el símbolo del sistema de grabación integrado.

IRejectAction

Reject permite rechazar para responder a la llamada. La acción rechazar podría usarse como primera acción del primer flujo de trabajo en lugar de Responder.

IRejectOutcome

Resultado de la acción Rechazar. El rechazo se puede usar en lugar de responder a la acción si el bot decide que el bot no quiere responder a la llamada.

ISessionState

Estado de sesión persistente usado para realizar un seguimiento de una pila de diálogos de conversaciones.

IUniversalCallBotSettings

Opciones usadas para inicializar una instancia de UniversalCallBot.

IWorkflow

IWorkflow es un cuerpo JSON enviado por el bot en respuesta a la solicitud IConversation o IConversationResult de skype bot platform for Calling. IWorkflow contiene una lista de una o varias acciones que los bots indican a la Plataforma de bots de Skype para llamar a en su nombre, así como la dirección HTTPs de devolución de llamada si el bot quiere recibir una notificación sobre el resultado del último resultado de la acción ejecutada.

Enumeraciones

PromptType

Tipo de símbolo del sistema invocado.

ResumeReason

Códigos de motivo para por qué se reanudó un cuadro de diálogo.