botbuilder package
Classes
| ActionSet |
Implemente o suporte para ações nomeadas que podem ser associadas a uma caixa de diálogo para lidar com enunciados globais do usuário, como "ajuda" ou "cancelar". As ações são enviadas para dentro e para fora da pilha de diálogos como parte das caixas de diálogo para que esses ouvintes possam entrar e sair do escopo à medida que a conversa progride. Você também pode associar ações nomeadas a botões que permitem que o bot responda a cliques de botão em cartões que talvez tenham rolado para fora da tela. |
| AnimationCard |
Classe de construtor de cartões que simplifica a criação de cartões de animação. |
| AudioCard |
Classe de construtor de cartões que simplifica a criação de cartões de mídia. |
| BotConnectorBot |
PRETERIDO use UniversalBot e um ChatConnector . |
| CardAction |
Classe builder para simplificar a adição de ações a um cartão. |
| CardImage |
Classe builder para simplificar a adição de imagens a um cartão. |
| CardMedia |
Definição de uma entidade de mídia para um cartão |
| ChatConnector |
Conecta um UniversalBot a vários canais por meio do Bot Framework. |
| CommandDialog |
PRETERIDO use um IntentDialog . |
| ConsoleConnector |
Conecta um UniversalBot à linha de comando por meio de uma janela do console. |
| Dialog |
Classe base para todos os diálogos. As caixas de diálogo são o componente principal da estrutura BotBuilder. Os bots usam caixas de diálogo para gerenciar conversas arbitrariamente complexas com um usuário. |
| DialogAction |
As ações de caixa de diálogo oferecem atalhos estáticos para implementar ações comuns. Eles também implementam suporte para ações nomeadas que podem ser associadas a uma caixa de diálogo para lidar com enunciados globais do usuário, como "ajuda" ou "cancelar". As ações são enviadas para dentro e para fora da pilha de diálogos como parte das caixas de diálogo para que esses ouvintes possam entrar e sair do escopo à medida que a conversa progride. Você também pode associar ações nomeadas a botões que permitem que o bot responda a cliques de botão em cartões que talvez tenham rolado para fora da tela. |
| EntityRecognizer |
Classe de utilitário usada para analisar & resolve entidades comuns, como datetimes recebidos do LUIS. |
| Fact |
Classe builder para simplificar a criação de uma lista de fatos para um cartão como um recibo. |
| HeroCard |
Classe de construtor de cartões que simplifica a criação de cartões hero. Os cartões hero contêm as mesmas informações que uma miniatura cartão, apenas com um layout mais pronunciado para as imagens de cartões. |
| IntentDialog |
Identifica uma intenção de usuários e, opcionalmente, extrai entidades de um enunciado de usuários. |
| IntentRecognizer |
Classe base para todos os reconhecedores principais. Permite a execução condicional de um reconhecedor e a filtragem pós-filtragem de intenções reconhecidas. A classe derivada deve substituir o método abstrato onRecognize(). |
| IntentRecognizerSet |
Federa uma chamada recognize() em um conjunto de reconhecedores de intenção. |
| Keyboard |
Classe de construtor de cartão que simplifica a criação de cartões de teclado. |
| Library |
Uma biblioteca de caixas de diálogo relacionadas usadas para fins de roteamento. As bibliotecas podem ser encadeadas para habilitar o desenvolvimento de bots complexos. A classe UniversalBot é uma Biblioteca que forma a raiz dessa cadeia. Bibliotecas de partes reutilizáveis podem ser desenvolvidas criando uma nova instância de Biblioteca e adicionando diálogos da mesma forma que você faria a um bot. Sua biblioteca deve ter um nome exclusivo que corresponda ao seu site de bibliotecas ou ao nome do módulo NPM. Os bots podem reutilizar sua biblioteca simplesmente adicionando sua instância da Biblioteca de Partes ao bot usando UniversalBot.library(). Se a própria biblioteca depender de outras bibliotecas, você deverá adicioná-las à biblioteca como uma dependência usando Library.library(). Você pode gerenciar facilmente várias versões da biblioteca adicionando um número de versão ao nome da biblioteca. Para invocar caixas de diálogo em seus bots de biblioteca, será necessário chamar session.beginDialog() com uma ID de caixa de diálogo totalmente qualificada na forma de ':'. Normalmente, você ocultará isso do desenvolvedor expondo uma função do módulo que inicia a caixa de diálogo para eles.
Então chamar algo como Vale a pena observar que as caixas de diálogo são sempre invocadas na caixa de diálogo atual para que, uma vez dentro de uma caixa de diálogo de sua biblioteca, você não precise prefixar cada beginDialog() chame seu com o nome das bibliotecas. É apenas ao cruzar de um contexto de biblioteca para outro que você precisa incluir o prefixo de nome da biblioteca. |
| LocalizedRegExpRecognizer |
Versão do RegExpRecognizer que usa o sistema de localização de estruturas para recuperar uma expressão regular localizada.
A chave de pesquisa no arquivo index.json deve ser fornecida e, ao receber uma mensagem para uma nova localidade, o reconhecedor recuperará a expressão localizada e um novo diferenciador de maiúsculas |
| LuisDialog |
PRETERIDO use um IntentDialog com um LuisRecognizer . |
| LuisRecognizer |
Plug-in de reconhecimento de intenções que detecta uma intenção de usuários usando o MICROSOFTs Reconhecimento vocal LUIS (Serviço Inteligente) As URLs de serviço para vários modelos luis (aplicativos) podem ser passadas para dar suporte ao reconhecimento em vários idiomas. |
| MediaCard |
Classe de construtor de cartões que simplifica a criação de cartões de mídia. |
| MemoryBotStorage |
Padrão na implementação de armazenamento de memória para armazenar dados de estado de sessão & usuário. |
| Message |
Classe do construtor de mensagens que simplifica a criação de mensagens complexas com anexos. |
| Middleware | |
| OAuthCard |
Classe de construtor de cartões que simplifica a criação de cartões oauth. |
| Prompt |
Classe base para prompts internos e pode ser usada para criar novos prompts personalizados. A classe Prompt fornece a lógica básica para solicitar/solicitar novamente um usuário e fornece um conjunto de ganchos extensíveis para personalizar o reconhecimento de prompts de resposta dos usuários, bem como a saída enviada ao usuário.
Os prompts sempre devem ter pelo menos um manipulador onRecognize() registrado e dão suporte à adição de qualquer número de manipuladores matches() ou matchesAny() que podem ser usados para adicionar comandos especiais iniciados pelo usuário ao prompt. Por exemplo, os prompts internos adicionam um |
| PromptAttachment |
Prompt de anexo personalizável. |
| PromptChoice |
Prompt de escolha personalizável. |
| PromptConfirm |
Prompt de confirmação personalizável. |
| PromptNumber |
Prompt de confirmação personalizável. |
| PromptText |
Prompt de texto personalizável. |
| PromptTime |
Prompt de tempo personalizável. |
| ReceiptCard |
Classe de construtor de cartões que simplifica a criação de cartões de recibo. |
| ReceiptItem |
Classe builder para simplificar a adição de itens a uma cartão de recibo. |
| RegExpRecognizer |
Plug-in de reconhecimento de intenção que detecta uma intenção de usuários usando uma expressão regular. Várias expressões podem ser passadas para dar suporte ao reconhecimento em vários idiomas. |
| RemoteSessionLogger |
Registra a atividade de sessão em um ponto de extremidade remoto usando eventos de depuração. O depurador remoto é usado automaticamente quando o emulador se conecta ao bot. Canais não emuladores podem transmitir suas atividades para o emulador salvando o endereço da sessão do emulador em |
| Session |
Gerencia a conversa de bots com um usuário. |
| SessionLogger |
Agente de sessão padrão usado para registrar a atividade de sessão no console. |
| SigninCard |
Classe de construtor de cartões que simplifica a criação de cartões de entrada. |
| SimpleDialog |
Permite a criação de caixas de diálogo personalizadas baseadas em um fechamento simples. Isso é útil para casos em que você deseja um fluxo de conversa dinâmica ou tem uma situação que simplesmente não é muito bem mapeada para usar uma cascata. As coisas a se ter em mente:
|
| SimplePromptRecognizer |
PRETERIDO não tem mais suporte a partir da v3.8. Em vez disso, use prompts personalizados. |
| SuggestedActions |
Classe builder para adicionar ações sugeridas a uma mensagem |
| TextBot |
PRETERIDO use UniversalBot e um ConsoleConnector . |
| ThumbnailCard |
Classe de construtor de cartões que simplifica a criação de cartões em miniatura. |
| UniversalBot |
Gerencia suas conversas de bots com usuários em vários canais. |
| VideoCard |
Classe de construtor de cartões que simplifica a criação de placas de vídeo. |
| WaterfallDialog |
Permite a criação de caixas de diálogo personalizadas baseadas em uma cascata. |
Interfaces
| IActionRouteData |
Argumentos passados para uma ação disparada. |
| IAddress |
Endereçar informações de roteamento para um evento. Os endereços são bidirecionais, o que significa que eles podem ser usados para abordar eventos de entrada e saída. Eles também são específicos do conector, o que significa que os conectores são livres para adicionar seus próprios campos ao endereço. Para enviar uma mensagem proativa a um usuário, os bots devem salvar o endereço de uma mensagem recebida. Dependendo dos endereços de canal, os bots devem atualizar periodicamente o endereço armazenado para um determinado usuário. |
| IAnimationCard |
Definição de interface para um cartão de animação |
| IAttachment |
Muitos canais de mensagens fornecem a capacidade de anexar objetos mais avançados. O Bot Builder permite que você expresse esses anexos de maneira transversal e os conectores farão o possível para renderizar os anexos usando os constructos nativos de canais. Se você quiser mais controle sobre a renderização de canais de uma mensagem, poderá usar IEvent.sourceEvent para fornecer anexos usando o esquema nativo de canais. Os tipos de anexos que podem ser enviados variam de acordo com o canal, mas estes são os tipos básicos:
|
| IAudioCard |
Definição de interface para uma cartão de áudio |
| IBeginDialogActionOptions |
Opções passadas ao definir um |
| IBotStateData |
Dados de estado do bot exportados. |
| IBotStateDataResult |
Objeto de resultado retornado de |
| IBotStorage |
Sistema de armazenamento substituível usado pelo UniversalBot. |
| IBotStorageContext |
Objeto de contexto passado para chamadas IBotStorage. |
| IBotStorageData |
Valores de dados persistidos para IBotStorage. |
| ICancelActionOptions |
Opções passadas ao definir um |
| ICardAction |
A ação que deve ser executada quando um cartão, botão ou imagem é tocado. |
| ICardImage |
Uma imagem em um cartão. |
| ICardMediaUrl |
Informações de URL que descrevem a mídia para um cartão |
| IChatConnectorAddress |
Endereço específico do ChatConnector. |
| IChatConnectorEndpoint |
Opções usadas para definir vários pontos de extremidade em uma instância do ChatConnector. Isso não deve ser alterado e normalmente não é fornecido por desenvolvedores no IChatConnectorSettings. Em vez disso, as duas propriedades em IChatConnectorSettings, "stateEndpoint" e "openIdMetadata" devem ser alteradas lá. |
| IChatConnectorSettings |
Opções usadas para inicializar uma instância do ChatConnector. |
| IChoice |
Uma opção que pode ser passada para Prompts.choice() ou [PromptRecognizers.recognizeChoices()][/en-us/node/builder/chat-reference/classes/botbuilder_d.promptrecognizers#recognizechoices]. |
| IConnector |
Implementado por plug-ins de conector para o UniversalBot. |
| IContactRelationUpdate |
Um usuário atualizou sua lista de contatos. /** Um usuário atualizou sua lista de contatos. |
| IConversationMembers |
Lista de membros dentro de uma conversa. |
| IConversationUpdate |
As Propriedades de uma conversa foram alteradas. |
| IConversationsResult |
Objeto de resultado retornado de |
| IDefaultLocalizerSettings |
Configurações usadas para inicializar uma implementação de ILocalizer. |
| IDialogActionOptions |
Opções passadas ao definir uma ação de caixa de diálogo. |
| IDialogResult |
Resultados retornados por uma caixa de diálogo filho para seu pai por meio de uma chamada para session.endDialog(). |
| IDialogState |
Uma entrada na pilha de diálogo de sessões. |
| IDialogVersionOptions |
Opções passadas para Middleware.dialogVersion(). |
| IDialogWaterfallStep |
Assinatura para funções passadas como etapas para DialogAction.waterfall().
As cascatas permitem que você solicite informações a um usuário usando uma sequência de perguntas. Cada etapa da cascata pode executar um dos prompts internos, iniciar uma nova caixa de diálogo chamando session.beginDialog(), avançar para a próxima etapa da cascata manualmente usando Quando uma caixa de diálogo ou um prompt interno é chamado de uma etapa de cascata, os resultados dessa caixa de diálogo ou prompt serão passados por meio do Você pode avançar manualmente para a próxima etapa da cascata usando a Você pode encerrar uma cascata mais cedo caindo em cada etapa da cascata usando chamadas para Nota: As cascatas têm uma última etapa oculta que encerrará automaticamente a caixa de diálogo atual se você chamar um prompt ou caixa de diálogo da última etapa. Isso é útil quando você tem uma pilha profunda de diálogos e deseja uma chamada para session.endDialog() do último filho na pilha para encerrar toda a pilha. O fechamento do último filho vai disparar todos os seus pais para passar para esta etapa oculta que vai em cascata o fechamento todo o caminho até a pilha. Normalmente, esse é um comportamento desejado, mas se você quiser evitá-lo ou interrompê-lo em algum lugar no meio, será necessário adicionar uma etapa ao final da cascata que não faz nada ou chama algo como session.send() que não vai avançar a cascata para frente. |
| IDisambiguateChoices |
Escolhas de rota a serem passadas para Prompts.disambiguate().
A chave do mapa deve ser o rótulo localizado a ser exibido para o usuário e o valor deve ser a rota a ser selecionada quando escolhido pelo usuário. Você pode passar |
| IDisambiguateRouteHandler |
Lógica de desambiguação de rota personalizada passada para UniversalBot.onDisambiguateRoute(). |
| IEntity |
Uma entidade reconhecida. |
| IEvent |
Um evento recebido ou enviado para uma origem. |
| IEventMiddleware |
Assinatura de função para uma parte do middleware que conecta os eventos 'receive' ou 'send'. |
| IFact |
Um fato exibido em um cartão como um recibo. |
| IFindActionRouteContext |
Contexto passado para |
| IFindMatchResult |
Resultado retornado de uma chamada para EntityRecognizer.findBestMatch() ou EntityRecognizer.findAllMatches(). |
| IFindRoutesHandler |
Lógica de pesquisa de rota personalizada passada para Library.onFindRoutes(). |
| IFirstRunOptions |
Opções passadas para Middleware.firstRun(). |
| IIdentity |
Representa um usuário, bot ou conversa. |
| IIntent |
Uma intenção reconhecida. |
| IIntentDialogOptions |
Opções usadas para configurar um IntentDialog. |
| IIntentRecognizer |
Interface implementada por plug-ins do reconhecedor de intenção, como a classe LuisRecognizer . |
| IIntentRecognizerResult |
Resultados retornados por um reconhecedor de intenção. |
| IIntentRecognizerSetOptions |
Opções usadas para configurar um IntentRecognizerSet. |
| IIsAttachment |
Implementado por classes que podem ser convertidas em um anexo. |
| IIsCardAction |
Implementado por classes que podem ser convertidas em uma ação cartão. |
| IIsCardImage |
Implementado por classes que podem ser convertidas em uma imagem cartão. |
| IIsCardMedia |
Entidades que podem ser convertidas em Mídia para cartões |
| IIsFact |
Implementado por classes que podem ser convertidas em um fato. |
| IIsMessage |
Implementado por classes que podem ser convertidas em um IMessage, como a classe construtor de mensagens. |
| IIsReceiptItem |
Implementado por classes que podem ser convertidas em um item de recibo. |
| IIsSuggestedActions |
Implementado por classes que podem ser convertidas em ações sugeridas |
| ILocalizer |
Plug-in para localizar mensagens enviadas ao usuário por um bot. |
| ILuisModelMap |
Um mapeamento por/local das URLs de serviço do LUIS a serem usadas para um LuisRecognizer. |
| IMediaCard |
Definição de interface de um MediaCard genérico, que em sua forma concreta pode ser uma cartão de Áudio, Animação ou Vídeo |
| IMediaEventValue |
Parâmetro suplementar para eventos de mídia. |
| IMessage |
Uma mensagem de chat enviada entre um Usuário e um Bot. As mensagens do bot para o usuário vêm em duas variantes:
No caso reativo, você deve copiar o campo de endereço da mensagem de entrada para a mensagem de saída (se você usar a classe construtor de mensagens e inicializá-la com a sessão , isso acontecerá automaticamente) e, em seguida, definir o texto ou anexos. Para mensagens proativas, você precisará salvar o endereço da mensagem de entrada em um armazenamento externo em algum lugar. Posteriormente, você pode passar isso para UniversalBot.beginDialog() ou copiá-lo para uma mensagem de saída passada para UniversalBot.send(). Redigir uma mensagem para o usuário usando o objeto de endereço de entrada enviará, por padrão, uma resposta ao usuário no contexto da conversa atual. Alguns canais permitem o início de novas conversas com o usuário. Para iniciar uma nova conversa proativa com o usuário, basta excluir o campo de conversa do objeto de endereço antes de redigir a mensagem de saída. |
| IMessageOptions |
Propriedades de mensagem opcionais que podem ser enviadas para itens como prompts ou session.say(). |
| IMessageReaction |
Objeto de reação de mensagem. |
| IMessageUpdate |
As Propriedades de uma mensagem foram alteradas. |
| IMiddlewareMap |
Mapa de ganchos de middleware que podem ser registrados em uma chamada para UniversalBot.use(). |
| IOAuthCard |
Uma interface que representa o OAuthCard. Um cartão que representa uma solicitação para formatar uma entrada por meio do OAuth |
| IPagedMembersResult |
Objeto de resultado retornado de |
| IPromptArgs |
PRETERIDO O novo sistema de prompt usa apenas IPromptOptions. |
| IPromptAttachmentFeatures |
Recursos opcionais para a classe PromptAttachment . |
| IPromptAttachmentOptions |
Opções passadas para Prompts.attachment() ou em uma |
| IPromptAttachmentResult |
Resultado do prompt de anexo fortemente tipado. |
| IPromptChoiceFeatures |
Recursos opcionais para a classe PromptChoice . |
| IPromptChoiceOptions |
Opções passadas para Prompts.choice() ou em uma |
| IPromptChoiceResult |
Resultado do Prompt de Escolha fortemente tipado. |
| IPromptConfirmResult |
Confirmação de Resultado do Prompt fortemente tipado. |
| IPromptContext |
Informações contextuais rastreadas para um Prompt. Essas informações podem ser acessadas em um prompt por meio de session.dialogData. |
| IPromptFeatures |
Recursos opcionais que devem ser habilitados/desabilitados ao criar um prompt personalizado |
| IPromptNumberOptions |
Opções passadas para Prompts.number() ou em uma |
| IPromptNumberResult |
Resultado do prompt de número fortemente tipado. |
| IPromptOptions |
Opções passadas para os prompts internos. |
| IPromptRecognizeChoicesOptions |
Opções passadas para PromptRecognizers.recognizeChoices(). |
| IPromptRecognizeNumbersOptions |
Opções passadas para PromptRecognizers.recognizeNumbers(). |
| IPromptRecognizeTimesOptions |
Opções passadas para PromptRecognizers.recognizeTimes(). |
| IPromptRecognizeValuesOptions |
Opções passadas para PromptRecognizers.recognizeValues(). |
| IPromptRecognizer |
PRETERIDO não tem mais suporte a partir da v3.8. Em vez disso, use prompts personalizados. |
| IPromptRecognizerArgs |
PRETERIDO não tem mais suporte a partir da v3.8. Em vez disso, use prompts personalizados. |
| IPromptRecognizerResult |
Resultado retornado de um IPromptRecognizer. |
| IPromptResult |
Resultado da caixa de diálogo retornado por um prompt do sistema. |
| IPromptTextFeatures |
Recursos opcionais para a classe PromptText . |
| IPromptTextOptions |
Opções passadas para Prompts.text() ou em uma |
| IPromptTextResult |
Resultado do prompt de texto fortemente tipado. |
| IPromptTimeResult |
Resultado do Prompt de Tempo fortemente tipado. |
| IPromptsOptions |
PRETERIDO não tem mais suporte a partir da v3.8. Em vez disso, use prompts personalizados. |
| IReceiptCard |
Exibe um recibo avançado para um usuário para algo que ele comprou ou está planejando comprar. |
| IReceiptItem |
Um item individual dentro de um recibo. |
| IRecognizeContext |
Contexto da mensagem recebida passada para vários métodos de reconhecimento. |
| IRecognizeDialogContext |
Contexto passado para |
| IRecognizeResult |
Resulta de uma chamada para uma função recognize(). A implementação é gratuita para adicionar quaisquer propriedades adicionais ao resultado. |
| IRegExpMap |
Um mapeamento por/local de expressões regulares a serem usadas para um RegExpRecognizer. |
| IRouteResult |
Rota candidata retornada por Library.findRoutes(). |
| ISelectRouteHandler |
Lógica de pesquisa de rota personalizada passada para Library.onSelectRoute(). |
| ISemanticAction |
Representa uma referência a uma ação programática. |
| ISessionMiddleware |
Assinatura de função para uma parte do middleware que conecta o evento 'botbuilder'. |
| ISessionOptions |
Opções passadas para o construtor de uma sessão. |
| ISessionState |
Estado de sessão persistente usado para acompanhar uma pilha de diálogo de conversas. |
| ISigninCard |
Exibe uma cartão de entrada e um botão para o usuário. Alguns canais podem optar por renderizar isso como um prompt de texto e vincular para clicar. |
| ISourceEventMap |
Um mapeamento por/origem dos dados de evento personalizados a serem enviados. |
| IStartConversationAddress |
Propriedades adicionais que podem ser passadas com o endereço para UniversalBot.beginDialog(). |
| ISuggestedActions |
Ações sugeridas para enviar ao usuário e exibidas como respostas rápidas. Ações sugeridas serão exibidas somente nos canais que dão suporte a ações sugeridas. |
| ITextHighlight |
Uma interface que representa TextHighlight. Refere-se a uma substring de conteúdo dentro de outro campo. |
| IThumbnailCard |
Exibe um cartão para o usuário usando um layout de miniatura menor ou um layout hero maior (o contentType de anexos determina qual). Todos os campos de cartões são opcionais, portanto, esse cartão pode ser usado para especificar itens como um teclado em determinados canais. Alguns canais podem optar por renderizar uma versão de menor fidelidade do cartão ou usar uma representação alternativa. |
| ITokenResponse |
Uma interface que representa TokenResponse. Uma resposta que inclui um token de usuário |
| ITranscript |
Uma interface que representa atividades históricas. |
| ITriggerActionOptions |
Opções passadas ao definir um |
| IUniversalBotSettings |
Opções usadas para inicializar uma instância do UniversalBot. |
| IVideoCard |
Definição de interface para uma cartão de vídeo |
| IWatchableHandler |
Função para recuperar o valor de uma variável observada. Passado para Session.watchable(). |
Aliases de tipo
| AttachmentType |
Alguns métodos podem usar um |
| MatchType |
Regras com suporte para correspondência de um enunciado de usuários.
|
| MessageType |
Prompts baseados em mensagem que podem ser enviados a um usuário.
|
| TextOrMessageType |
Intervalo flexível de possíveis prompts que podem ser enviados a um usuário.
|
| TextType |
Prompts baseados em texto que podem ser enviados a um usuário.
|
| ValueListType |
Lista de valores de texto. Os valores podem ser expressos como uma cadeia de caracteres delimitada por pipe, como "value1|value2|value3" ou uma matriz simples de valores. |
Enumerações
| ListStyle |
Tipo de lista a ser renderizada para prompt PromptType.choice. |
| PromptType |
Tipo de prompt invocado. |
| RecognizeMode |
Controla um processamento IntentDialogs dos enunciados de texto dos usuários. |
| RecognizeOrder |
Ordem na qual os reconhecedores intentDialogs devem ser avaliados. |
| ResumeReason |
Códigos de motivo para o motivo pelo qual uma caixa de diálogo foi retomada. |