botbuilder-core package
Classes
ActivityFactory |
O ActivityFactory para gerar texto e, em seguida, usa semântica de markdown simples como chatdown para criar Atividade. |
ActivityHandler |
Manipulador de atividades emissoras de eventos para bots. Estende ActivityHandlerBase. |
ActivityHandlerBase |
Define o comportamento principal para manipuladores de atividades emissoras de eventos para bots. |
AutoSaveStateMiddleware |
Middleware que salvará automaticamente as alterações de estado no final da curva. |
BotAdapter |
Define o comportamento principal de um adaptador de bot que pode conectar um bot a um ponto de extremidade de serviço. |
BotComponent |
Definição de um BotComponent que permite o registro de serviços, ações personalizadas, escopos de memória e adaptadores. Para disponibilizar seus componentes para o sistema, você deriva de BotComponent e registra serviços para adicionar funcionalidade. Esses componentes são consumidos em locais apropriados pelos sistemas que precisam deles. Ao usar o Composer, configureServices é chamado automaticamente nos componentes pelo runtime do bot, desde que os componentes sejam registrados na configuração. |
BotState |
Classe base para os escopos de persistência de estado das estruturas. |
BotStatePropertyAccessor |
Uma |
BotStateSet |
Uma coleção de |
NullTelemetryClient |
Um cliente de telemetria de bot nulo que implementa BotTelemetryClient. |
BrowserLocalStorage |
Provedor de armazenamento que usa o armazenamento local do navegador. |
BrowserSessionStorage |
Provedor de armazenamento que usa o armazenamento de sessão do navegador. |
CardFactory |
Fornece métodos para formatar os vários tipos de cartão que um bot pode retornar. |
CloudAdapterBase |
Um adaptador que implementa o Protocolo Bot Framework e pode ser hospedado em diferentes ambientes de nuvem públicos e privados. |
ComponentRegistration |
ComponentRegistration é uma classe de assinatura para descobrir ativos de componentes. |
ConfigurationBotFrameworkAuthentication |
Cria uma instância botFrameworkAuthentication de um objeto com os valores de autenticação ou uma instância de Configuração . |
ConfigurationServiceClientCredentialFactory |
ServiceClientCredentialsFactory que usa um ConfigurationServiceClientCredentialFactoryOptions ou uma instância de Configuração para criar ServiceClientCredentials com um AppId e uma senha de aplicativo. |
ConversationState |
Lê e grava o estado da conversa para o bot no armazenamento. |
InvokeException |
Uma exceção personalizada para invocar erros de resposta. |
MemoryStorage |
Provedor de armazenamento baseado em memória para um bot. |
MemoryTranscriptStore |
O repositório de transcrição de memória armazena transcrições em memória volátil em um Mapa. |
MessageFactory |
Um conjunto de funções de utilitário para ajudar na formatação dos vários tipos de mensagem que um bot pode retornar. |
MiddlewareSet |
Um conjunto de |
PrivateConversationState |
Lê e grava o estado PrivateConversation do bot no armazenamento. |
QueueStorage |
Uma classe base para enfileirar uma atividade para processamento posterior. |
RegisterClassMiddleware |
Middleware para adicionar um objeto ou registrar um serviço com o contexto de turno atual. |
ShowTypingMiddleware |
Middleware que enviará um indicador de digitação automaticamente para cada mensagem. |
SkillConversationIdFactory |
Um SkillConversationIdFactory que armazena e recupera instâncias ConversationReference . |
SkillConversationIdFactoryBase |
Define os métodos de uma fábrica que é usada para criar IDs de conversa exclusivas para conversas de habilidades. |
SkypeMentionNormalizeMiddleware |
Middleware para mencionar entidades do Skype, pois elas não estão em conformidade com os valores esperados. Os bots que interagem com o Skype devem usar esse middleware se as menções forem usadas. |
StringUtils |
Classe auxiliar que contém métodos de utilitário de cadeia de caracteres. |
TelemetryConstants |
Define nomes de propriedades comuns para uso com um objeto BotTelemetryClient . |
TelemetryLoggerMiddleware |
Middleware para registrar mensagens de entrada, saída, atualização ou exclusão de atividade. Usa a interface botTelemetryClient. |
TestAdapter |
Adaptador de teste usado para testes de unidade. Esse adaptador pode ser usado para simular o envio de mensagens do usuário para o bot. |
TestFlow |
A classe de suporte para |
ConsoleTranscriptLogger |
ConsoleTranscriptLogger , grava atividades na saída do console. |
TranscriptLoggerMiddleware |
Registra atividades de entrada e saída em um TranscriptStore. |
TurnContext |
Fornece contexto para uma vez de um bot. |
TurnContextStateCollection |
Os valores persistiram durante o tempo de vida da curva como parte do TurnContext. |
UserState |
Lê e grava o estado do usuário do bot no armazenamento. |
Interfaces
CachedBotState |
Informações de estado armazenadas em cache do objeto de contexto por uma |
StatePropertyAccessor |
Define métodos para acessar uma propriedade de estado criada em um objeto BotState . |
BotPageViewTelemetryClient | |
BotTelemetryClient | |
TelemetryDependency | |
TelemetryEvent | |
TelemetryException | |
TelemetryPageView | |
TelemetryTrace | |
CoreAppCredentials |
CoreAppCredentials |
CoreWebResource |
Interface interna que representa o "WebResource" de @azure/ms-rest-js |
ExtendedUserTokenProvider |
Interface para APIs de Logon Único do OAuth de Token de Usuário e Troca de Tokens para BotAdapters |
IntentScore |
Pontuação mais qualquer informação extra sobre uma intenção. |
Middleware |
Interface implementada pelo middleware baseado em objeto. |
PropertyManager |
Interface implementada por classes capazes de fatorar acessadores de propriedade. |
RecognizerResult |
Valor retornado de um reconhecedor. |
BotFrameworkSkill |
Registro para um ponto de extremidade de habilidade baseado em BotFrameworkHttpProtocol. |
SkillConversationIdFactoryOptions | |
SkillConversationReference | |
Storage |
Interface para um provedor de armazenamento que armazena e recupera objetos JSON antigos simples. |
StoreItem |
Objeto armazenado no Armazenamento com uma eTag opcional. |
StoreItems |
Mapa de objetos nomeados |
PagedResult |
Página de resultados. |
TranscriptInfo |
Metadados para uma transcrição armazenada. |
TranscriptLogger |
O agente de transcrição armazena atividades para conversas para recall. |
TranscriptStore |
O agente de transcrição armazena atividades para conversas para recall. |
IUserTokenProvider |
Interface para APIs OAuth de Token de Usuário para BotAdapters |
TokenPollingSettings |
Fornece detalhes para sondagem de token. |
Aliases de tipo
BotHandler |
Descreve um manipulador de eventos de atividade de bot, para uso com um objeto ActivityHandler . |
ConfigurationBotFrameworkAuthenticationOptions |
Contém configurações usadas para configurar uma instância ConfigurationBotFrameworkAuthentication . |
ConfigurationServiceClientCredentialFactoryOptions |
Contém as configurações usadas para configurar uma instância de ConfigurationServiceClientCredentialFactory . |
MiddlewareHandler |
Assinatura implementada pelo middleware baseado em função.
|
StorageKeyFactory |
Retorno de chamada para calcular uma chave de armazenamento.
|
TestActivityInspector |
Assinatura para uma função que pode ser usada para inspecionar atividades individuais retornadas por um bot que está sendo testado usando o
|
DeleteActivityHandler |
Um manipulador que pode participar de eventos de atividade de exclusão para o turno atual. |
SendActivitiesHandler |
Um manipulador que pode participar de eventos de atividade de envio para a curva atual. |
UpdateActivityHandler |
Um manipulador que pode participar de eventos de atividade de atualização para a virada atual. |
Enumerações
Severity |
Define o nível de gravidade do evento. |
Funções
Detalhes da função
useBotState(BotAdapter, BotState[])
Adiciona middleware ao adaptador para registrar um ou mais objetos BotState no contexto de turno. O middleware registra os objetos de estado no contexto de turno no início de cada turno.
function useBotState(botAdapter: BotAdapter, botStates: BotState[]): BotAdapter
Parâmetros
- botAdapter
- BotAdapter
O adaptador no qual registrar os objetos de estado.
- botStates
-
BotState[]
Os objetos de estado a serem registrados.
Retornos
O adaptador atualizado.
assertBotComponent(unknown, unknown[])
Aviso
Essa API foi preterida.
Use BotComponent.z.parse()
instead.
function assertBotComponent(val: unknown, _args: unknown[]): asserts
Parâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)
Registra um DialogView usando o método trackPageView no BotTelemetryClient se BotPageViewTelemetryClient tiver sido implementado. Como alternativa, registra as informações por meio do 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
Nome da caixa de diálogo para a qual registrar a entrada/iniciar.
- properties
-
[key: string]: any
Valores de cadeia de caracteres nomeados que você pode usar para pesquisar e classificar eventos.
- metrics
-
[key: string]: number
Medidas associadas a esse evento.
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)
Cria uma nova instância da classe ConfigurationBotFrameworkAuthentication .
function createBotFrameworkAuthenticationFromConfiguration(configuration: Configuration, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions): BotFrameworkAuthentication
Parâmetros
- configuration
-
Configuration
Uma instância de Configuração .
- credentialsFactory
-
ServiceClientCredentialsFactory
Uma instância de ServiceClientCredentialsFactory .
- authConfiguration
-
AuthenticationConfiguration
Um objeto Configuration .
- botFrameworkClientFetch
-
(input: RequestInfo, init?: RequestInit) => Promise<Response>
Uma implementação de Fetch personalizada a ser usada no BotFrameworkClient.
- connectorClientOptions
-
ConnectorClientOptions
Um objeto ConnectorClientOptions .
Retornos
BotFrameworkAuthentication
Uma instância ConfigurationBotFrameworkAuthentication .
Comentários
A instância de configuração fornecida ao construtor deve ter os valores de autenticação desejados disponíveis na raiz, usando as propriedades de ConfigurationBotFrameworkAuthenticationOptions como suas chaves.
createServiceClientCredentialFactoryFromConfiguration(Configuration)
Cria uma nova instância da classe ConfigurationServiceClientCredentialFactory .
function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory
Parâmetros
- configuration
-
Configuration
Uma instância de Configuração .
Retornos
Uma instância configurationServiceClientCredentialFactory .
Comentários
A instância de Configuração fornecida ao construtor deve ter os valores de autenticação desejados disponíveis na raiz, usando as propriedades de ConfigurationServiceClientCredentialFactoryOptions como suas chaves.
assertStoreItems(unknown, unknown[])
Aviso
Essa API foi preterida.
Use zod.record(zod.unknown())
instead.
function assertStoreItems(val: unknown, _args: unknown[]): asserts
Parâmetros
- val
-
unknown
- _args
-
unknown[]
Retornos
asserts
calculateChangeHash(StoreItem)
Função utility para calcular um hash de alteração para um StoreItem
.
function calculateChangeHash(item: StoreItem): string
Parâmetros
- item
- StoreItem
Item para o qual calcular o hash de alteração.
Retornos
string
alterar cadeia de caracteres de hash
Comentários
Este exemplo calcula um hash de alteração para um objeto que foi lido e, em seguida, só o grava novamente se tiver sido 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 });
}