botbuilder-core package
Classi
ActivityFactory |
ActivityFactory per generare testo e quindi usa una semplice semantica markdown, ad esempio chatdown per creare l'attività. |
ActivityHandler |
Gestore attività di creazione di eventi per i bot. Estende ActivityHandlerBase. |
ActivityHandlerBase |
Definisce il comportamento principale per i gestori di attività di creazione di eventi per i bot. |
AutoSaveStateMiddleware |
Middleware che salverà automaticamente le modifiche di stato alla fine del turno. |
BotAdapter |
Definisce il comportamento principale di un adattatore bot in grado di connettere un bot a un endpoint di servizio. |
BotComponent |
Definizione di botComponent che consente la registrazione di servizi, azioni personalizzate, ambiti di memoria e adattatori. Per rendere i componenti disponibili per il sistema derivato da BotComponent e registrare i servizi per aggiungere funzionalità. Questi componenti vengono quindi utilizzati in posizioni appropriate dai sistemi che ne hanno bisogno. Quando si usa Composer, configureServices viene chiamato automaticamente nei componenti dal runtime del bot, purché i componenti vengano registrati nella configurazione. |
BotState |
Classe di base per gli ambiti di persistenza dello stato dei framework. |
BotStatePropertyAccessor |
|
BotStateSet |
Raccolta di plug-in |
NullTelemetryClient |
Client di telemetria del bot Null che implementa BotTelemetryClient. |
BrowserLocalStorage |
Provider di archiviazione che usa l'archiviazione locale del browser. |
BrowserSessionStorage |
Provider di archiviazione che usa l'archiviazione delle sessioni del browser. |
CardFactory |
Fornisce metodi per la formattazione dei vari tipi di scheda che un bot può restituire. |
CloudAdapterBase |
Adattatore che implementa il protocollo Bot Framework e può essere ospitato in ambienti cloud diversi sia pubblici che privati. |
ComponentRegistration |
ComponentRegistration è una classe di firma per l'individuazione degli asset dai componenti. |
ConfigurationBotFrameworkAuthentication |
Crea un'istanza di BotFrameworkAuthentication da un oggetto con i valori di autenticazione o un'istanza di Configuration. |
ConfigurationServiceClientCredentialFactory |
ServiceClientCredentialsFactory che usa un ConfigurationServiceClientCredentialFactoryOptions o un'istanza di Configuration per compilare ServiceClientCredentials con un AppId e una password dell'app. |
ConversationState |
Legge e scrive lo stato della conversazione per il bot nell'archiviazione. |
InvokeException |
Eccezione personalizzata per richiamare gli errori di risposta. |
MemoryStorage |
Provider di archiviazione basato sulla memoria per un bot. |
MemoryTranscriptStore |
L'archivio trascrizioni di memoria archivia le trascrizioni in memoria volatile in una mappa. |
MessageFactory |
Un set di funzioni di utilità per facilitare la formattazione dei vari tipi di messaggio che un bot può restituire. |
MiddlewareSet |
Set di plug-in di |
PrivateConversationState |
Legge e scrive lo stato PrivateConversation per il bot nell'archiviazione. |
QueueStorage |
Classe base per accodare un'attività per un'elaborazione successiva. |
RegisterClassMiddleware |
Middleware per l'aggiunta di un oggetto a o la registrazione di un servizio con il contesto di turno corrente. |
ShowTypingMiddleware |
Middleware che invierà automaticamente un indicatore di digitazione per ogni messaggio. |
SkillConversationIdFactory |
SkillConversationIdFactory che archivia e recupera istanze di ConversationReference. |
SkillConversationIdFactoryBase |
Definisce i metodi di una factory usata per creare ID di conversazione univoci per le conversazioni di competenza. |
SkypeMentionNormalizeMiddleware |
Middleware per patch menzionare Entità da Skype perché non sono conformi ai valori previsti. I bot che interagiscono con Skype devono usare questo middleware se vengono usate menzioni. |
StringUtils |
Classe helper contenente metodi di utilità stringa. |
TelemetryConstants |
Definisce i nomi delle proprietà comuni da usare con un oggetto BotTelemetryClient. |
TelemetryLoggerMiddleware |
Middleware per la registrazione dei messaggi attività in ingresso, in uscita, aggiornati o eliminati. Usa l'interfaccia botTelemetryClient. |
TestAdapter |
Adattatore di test usato per gli unit test. Questo adapter può essere usato per simulare l'invio di messaggi dall'utente al bot. |
TestFlow |
Classe di supporto per |
ConsoleTranscriptLogger |
ConsoleTranscriptLogger , scrive le attività nell'output della console. |
TranscriptLoggerMiddleware |
Registra le attività in ingresso e in uscita in un archivio trascrizioni. |
TurnContext |
Fornisce il contesto per un turno di un bot. |
TurnContextStateCollection |
Valori mantenuti per la durata del turno come parte del TurnContext. |
UserState |
Legge e scrive lo stato utente per il bot nell'archiviazione. |
Interfacce
CachedBotState |
Informazioni sullo stato memorizzate nella cache dell'oggetto contesto da un'istanza di |
StatePropertyAccessor |
Definisce i metodi per accedere a una proprietà di stato creata in un oggetto BotState. |
BotPageViewTelemetryClient | |
BotTelemetryClient | |
TelemetryDependency | |
TelemetryEvent | |
TelemetryException | |
TelemetryPageView | |
TelemetryTrace | |
CoreAppCredentials |
CoreAppCredentials |
CoreWebResource |
Interfaccia interna che rappresenta "WebResource" da @azure/ms-rest-js |
ExtendedUserTokenProvider |
Interfaccia per le API OAuth per l'accesso Single Sign-On e l'scambio di token per BotAdapter |
IntentScore |
Punteggio più eventuali informazioni aggiuntive su una finalità. |
Middleware |
Interfaccia implementata dal middleware basato su oggetti. |
PropertyManager |
Interfaccia implementata dalle classi in grado di factoring delle funzioni di accesso alle proprietà. |
RecognizerResult |
Valore restituito da un riconoscitore. |
BotFrameworkSkill |
Registrazione per un endpoint di competenza basato su BotFrameworkHttpProtocol. |
SkillConversationIdFactoryOptions | |
SkillConversationReference | |
Storage |
Interfaccia per un provider di archiviazione che archivia e recupera gli oggetti JSON precedenti semplici. |
StoreItem |
Oggetto archiviato in Archiviazione con un eTag facoltativo. |
StoreItems |
Mappa di oggetti |
PagedResult |
Pagina dei risultati. |
TranscriptInfo |
Metadati per una trascrizione archiviata. |
TranscriptLogger |
Transcript logger archivia le attività per le conversazioni per il richiamo. |
TranscriptStore |
Transcript logger archivia le attività per le conversazioni per il richiamo. |
IUserTokenProvider |
Interfaccia per le API OAuth dei token utente per BotAdapter |
TokenPollingSettings |
Fornisce informazioni dettagliate sul polling dei token. |
Alias tipo
BotHandler |
Descrive un gestore eventi dell'attività del bot, da usare con un oggetto ActivityHandler |
ConfigurationBotFrameworkAuthenticationOptions |
Contiene le impostazioni usate per configurare un'istanza di ConfigurationBotFrameworkAuthentication. |
ConfigurationServiceClientCredentialFactoryOptions |
Contiene le impostazioni usate per configurare un'istanza di ConfigurationServiceClientCredentialFactory. |
MiddlewareHandler |
Firma implementata dal middleware basato su funzione.
|
StorageKeyFactory |
Callback per calcolare una chiave di archiviazione.
|
TestActivityInspector |
Firma per una funzione che può essere usata per controllare le singole attività restituite da un bot sottoposto a test usando il
|
DeleteActivityHandler |
Gestore che può partecipare agli eventi di eliminazione dell'attività per il turno corrente. |
SendActivitiesHandler |
Gestore che può partecipare a eventi di attività di invio per il turno corrente. |
UpdateActivityHandler |
Gestore che può partecipare agli eventi dell'attività di aggiornamento per il turno corrente. |
Enumerazioni
Severity |
Definisce il livello di gravità per l'evento. |
Funzioni
use |
Aggiunge middleware all'adapter per registrare uno o più oggetti BotState nel contesto di turno. Il middleware registra gli oggetti di stato nel contesto di turno all'inizio di ogni turno. |
assert |
|
telemetry |
Registra un controllo DialogView usando il metodo trackPageView |
create |
Crea una nuova istanza della classe configurationBotFrameworkAuthentication |
create |
Crea una nuova istanza della classe ConfigurationServiceClientCredentialFactory. |
assert |
|
calculate |
Funzione di utilità per calcolare un hash delle modifiche per un |
Dettagli funzione
useBotState(BotAdapter, BotState[])
Aggiunge middleware all'adapter per registrare uno o più oggetti BotState nel contesto di turno. Il middleware registra gli oggetti di stato nel contesto di turno all'inizio di ogni turno.
function useBotState(botAdapter: BotAdapter, botStates: BotState[]): BotAdapter
Parametri
- botAdapter
- BotAdapter
Adattatore in cui registrare gli oggetti di stato.
- botStates
-
BotState[]
Oggetti di stato da registrare.
Restituisce
Adattatore aggiornato.
assertBotComponent(unknown, unknown[])
Avviso
Questa API è ora deprecata.
Use BotComponent.z.parse()
instead.
function assertBotComponent(val: unknown, _args: unknown[]): asserts
Parametri
- val
-
unknown
- _args
-
unknown[]
Restituisce
asserts
telemetryTrackDialogView(BotTelemetryClient, string, [key: string]: any, [key: string]: number)
Registra un controllo DialogView usando il metodo trackPageView
function telemetryTrackDialogView(telemetryClient: BotTelemetryClient, dialogName: string, properties?: [key: string]: any, metrics?: [key: string]: number)
Parametri
- telemetryClient
- BotTelemetryClient
TelemetryClient che implementa BotTelemetryClient.
- dialogName
-
string
Nome della finestra di dialogo per cui registrare la voce/inizio.
- properties
-
[key: string]: any
Valori stringa denominati che è possibile usare per cercare e classificare gli eventi.
- metrics
-
[key: string]: number
Misurazioni associate a questo evento.
createBotFrameworkAuthenticationFromConfiguration(Configuration, ServiceClientCredentialsFactory, AuthenticationConfiguration, (input: RequestInfo, init?: RequestInit) => Promise<Response>, ConnectorClientOptions)
Crea una nuova istanza della classe configurationBotFrameworkAuthentication
function createBotFrameworkAuthenticationFromConfiguration(configuration: Configuration, credentialsFactory?: ServiceClientCredentialsFactory, authConfiguration?: AuthenticationConfiguration, botFrameworkClientFetch?: (input: RequestInfo, init?: RequestInit) => Promise<Response>, connectorClientOptions?: ConnectorClientOptions): BotFrameworkAuthentication
Parametri
- configuration
-
Configuration
Istanza di configuration di
- credentialsFactory
-
ServiceClientCredentialsFactory
Istanza di ServiceClientCredentialsFactory.
- authConfiguration
-
AuthenticationConfiguration
Oggetto Configuration di
- botFrameworkClientFetch
-
(input: RequestInfo, init?: RequestInit) => Promise<Response>
Implementazione di recupero personalizzata da usare nel BotFrameworkClient.
- connectorClientOptions
-
ConnectorClientOptions
Oggetto ConnectorClientOptions di
Restituisce
BotFrameworkAuthentication
Istanza di ConfigurationBotFrameworkAuthentication.
Commenti
L'istanza di Configuration fornita al costruttore deve avere i valori di autenticazione desiderati disponibili nella radice, usando le proprietà di ConfigurationBotFrameworkAuthenticationOptions come chiavi.
createServiceClientCredentialFactoryFromConfiguration(Configuration)
Crea una nuova istanza della classe ConfigurationServiceClientCredentialFactory.
function createServiceClientCredentialFactoryFromConfiguration(configuration: Configuration): ConfigurationServiceClientCredentialFactory
Parametri
- configuration
-
Configuration
Istanza di configuration di
Restituisce
Istanza di ConfigurationServiceClientCredentialFactory.
Commenti
L'istanza di Configuration fornita al costruttore deve avere i valori di autenticazione desiderati disponibili nella radice, usando le proprietà di ConfigurationServiceClientCredentialFactoryOptions come chiavi.
assertStoreItems(unknown, unknown[])
Avviso
Questa API è ora deprecata.
Use zod.record(zod.unknown())
instead.
function assertStoreItems(val: unknown, _args: unknown[]): asserts
Parametri
- val
-
unknown
- _args
-
unknown[]
Restituisce
asserts
calculateChangeHash(StoreItem)
Funzione di utilità per calcolare un hash delle modifiche per un StoreItem
.
function calculateChangeHash(item: StoreItem): string
Parametri
- item
- StoreItem
Elemento per cui calcolare l'hash delle modifiche.
Restituisce
string
modificare la stringa hash
Commenti
Questo esempio calcola un hash delle modifiche per un oggetto che è stato letto e quindi lo scrive solo se è stato modificato:
// 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 });
}