botbuilder package
Classi
| ActionSet |
Implementare il supporto per le azioni denominate che possono essere associate a una finestra di dialogo per gestire espressioni globali dall'utente, ad esempio "help" o "cancel". Le azioni vengono inserite e disattivate dallo stack di dialoghi come parte dei dialoghi, in modo che questi listener possano entrare e uscire dall'ambito man mano che la conversazione avanza. È anche possibile associare il nome alle azioni ai pulsanti che consentono al bot di rispondere ai clic del pulsante sulle schede che potrebbero aver eseguito lo scorrimento dallo schermo. |
| AnimationCard |
Classe generatore di schede che semplifica la creazione di schede di animazione. |
| AudioCard |
Classe generatore di schede che semplifica la creazione di schede multimediali. |
| BotConnectorBot |
DEPRECATO usare UniversalBot e un ChatConnector di. |
| CardAction |
Classe Builder per semplificare l'aggiunta di azioni a una scheda. |
| CardImage |
Classe Builder per semplificare l'aggiunta di immagini a una scheda. |
| CardMedia |
Definizione di un'entità multimediale per una scheda |
| ChatConnector |
Connette un UniversalBot a più canali tramite Bot Framework. |
| CommandDialog |
deprecato usare invece un IntentDialog. |
| ConsoleConnector |
Connette un UniversalBot alla riga di comando tramite una finestra della console. |
| Dialog |
Classe di base per tutti i dialoghi. I dialoghi sono il componente principale del framework BotBuilder. I bot usano Dialoghi per gestire conversazioni arbitrariamente complesse con un utente. |
| DialogAction |
Le azioni del dialogo offrono collegamenti statici per implementare azioni comuni. Implementano anche il supporto per le azioni denominate che possono essere associate a una finestra di dialogo per gestire espressioni globali dall'utente, ad esempio "guida" o "annulla". Le azioni vengono inserite e disattivate dallo stack di dialoghi come parte dei dialoghi, in modo che questi listener possano entrare e uscire dall'ambito man mano che la conversazione avanza. È anche possibile associare il nome alle azioni ai pulsanti che consentono al bot di rispondere ai clic del pulsante sulle schede che potrebbero aver eseguito lo scorrimento dallo schermo. |
| EntityRecognizer |
Classe di utilità usata per analizzare & risolvere entità comuni come datetime ricevute da LUIS. |
| Fact |
Classe Builder per semplificare la creazione di un elenco di fatti per una scheda come una ricevuta. |
| HeroCard |
Classe generatore di schede che semplifica la compilazione di schede hero. Le schede hero contengono le stesse informazioni di una scheda di anteprima, solo con un layout più grande più pronunciato per le immagini delle schede. |
| IntentDialog |
Identifica una finalità degli utenti ed estrae facoltativamente le entità da un'espressione degli utenti. |
| IntentRecognizer |
Classe di base per tutti i riconoscitori principali. Consente l'esecuzione condizionale di un riconoscitore e dopo il filtro delle finalità riconosciute. La classe derivata deve eseguire l'override del metodo astratta onRecognize(). |
| IntentRecognizerSet |
Federate una chiamata recognize() in un set di riconoscitori finalità. |
| Keyboard |
Classe generatore di schede che semplifica la creazione di schede da tastiera. |
| Library |
Libreria di dialoghi correlati utilizzati a scopo di routing. Le librerie possono essere concatenate per consentire lo sviluppo di bot complessi. La classe UniversalBot è una libreria che costituisce la radice di questa catena. Le librerie di parti riutilizzabili possono essere sviluppate creando una nuova istanza della libreria e aggiungendo finestre di dialogo esattamente come si farebbe con un bot. La libreria deve avere un nome univoco che corrisponde al sito Web delle librerie o al nome del modulo NPM. I bot possono quindi riutilizzare la libreria semplicemente aggiungendo l'istanza della libreria di parti al bot usando UniversalBot.library(). Se la libreria stessa dipende da altre librerie, è necessario aggiungerle alla libreria come dipendenza usando Library.library(). È possibile gestire facilmente più versioni della libreria aggiungendo un numero di versione al nome della libreria. Per richiamare i dialoghi all'interno dei bot della libreria, sarà necessario chiamare session.beginDialog() con un ID di dialogo completo sotto forma di ':'. In genere, lo sviluppatore verrà nascosto esponendo una funzione dal modulo che avvia la finestra di dialogo per loro.
Quindi chiamare qualcosa come Vale la pena notare che i dialoghi vengono sempre richiamati all'interno del dialogo corrente, quindi una volta che all'interno di una finestra di dialogo dalla libreria non è necessario anteporre ogni beginDialog() chiamare con il nome delle librerie. È solo quando si passa da un contesto di libreria a un altro che è necessario includere il prefisso del nome della libreria. |
| LocalizedRegExpRecognizer |
Versione del RegExpRecognizer che usa il sistema di localizzazione dei framework per recuperare un'espressione regolare localizzata.
La chiave di ricerca nel file di index.json deve essere fornita e, dopo aver ricevuto un messaggio per una nuova impostazione locale, il riconoscitore recupererà l'espressione localizzata e verrà creato un nuovo |
| LuisDialog |
DEPRECATO usare invece un IntentDialog con un LuisRecognizer. |
| LuisRecognizer |
Plug-in riconoscimento finalità che rileva una finalità degli utenti usando Microsofts Language Understanding Intelligent Service (LUIS) Gli URL del servizio per più modelli LUIS (app) possono essere passati per supportare il riconoscimento in più lingue. |
| MediaCard |
Classe generatore di schede che semplifica la creazione di schede multimediali. |
| MemoryBotStorage |
Impostazione predefinita nell'implementazione dell'archiviazione in memoria per l'archiviazione dei dati sullo stato della sessione & utente. |
| Message |
Classe message builder che semplifica la creazione di messaggi complessi con allegati. |
| Middleware | |
| OAuthCard |
Classe generatore di schede che semplifica la creazione di schede oauth. |
| Prompt |
Classe di base per le richieste predefinite e può essere usata per compilare nuove richieste personalizzate. La classe Prompt fornisce la logica di base per richiedere o richiedere di nuovo un utente e fornisce un set di hook estendibili per personalizzare il riconoscimento delle richieste di risposta degli utenti e l'output inviato all'utente.
I prompt devono avere sempre almeno un suRecognize() gestore registrato e supportano l'aggiunta di un numero qualsiasi di corrispondenze () o matchesAny() gestori che possono essere usati per aggiungere comandi speciali avviati dall'utente al prompt. Ad esempio, i prompt predefiniti aggiungono un |
| PromptAttachment |
Richiesta di allegato personalizzabile. |
| PromptChoice |
Richiesta di scelta personalizzabile. |
| PromptConfirm |
Richiesta di conferma personalizzabile. |
| PromptNumber |
Richiesta di conferma personalizzabile. |
| PromptText |
Richiesta di testo personalizzabile. |
| PromptTime |
Richiesta di tempo personalizzabile. |
| ReceiptCard |
Classe generatore di schede che semplifica la compilazione delle schede di ricezione. |
| ReceiptItem |
Classe Builder per semplificare l'aggiunta di elementi a una scheda di ricezione. |
| RegExpRecognizer |
Plug-in riconoscimento finalità che rileva una finalità degli utenti usando un'espressione regolare. È possibile passare più espressioni per supportare il riconoscimento in più lingue. |
| RemoteSessionLogger |
Registra l'attività di sessione in un endpoint remoto usando eventi di debug. Il debugger remoto viene usato automaticamente quando l'emulatore si connette al bot. I canali non emulatori possono trasmettere l'attività all'emulatore salvando l'indirizzo della sessione dell'emulatore in |
| Session |
Gestisce la conversazione dei bot con un utente. |
| SessionLogger |
Logger di sessione predefinito usato per registrare l'attività della sessione nella console. |
| SigninCard |
Classe generatore di schede che semplifica la creazione di schede di accesso. |
| SimpleDialog |
Consente la creazione di dialoghi personalizzati basati su una semplice chiusura. Questo è utile per i casi in cui si vuole un flusso di conversazione dinamico o si ha una situazione che non è mappata molto bene all'uso di una cascata. Gli aspetti da tenere presenti:
|
| SimplePromptRecognizer |
DEPRECATO non più supportato a partire dalla versione 3.8. Usare invece prompt personalizzati. |
| SuggestedActions |
Classe Builder per aggiungere azioni suggerite a un messaggio |
| TextBot |
DEPRECATO usare UniversalBot e un ConsoleConnector. |
| ThumbnailCard |
Classe generatore di schede che semplifica la creazione di schede di anteprima. |
| UniversalBot |
Gestisce le conversazioni dei bot con gli utenti in più canali. |
| VideoCard |
Classe generatore di schede che semplifica la creazione di schede video. |
| WaterfallDialog |
Consente la creazione di dialoghi personalizzati basati su una cascata. |
Interfacce
| IActionRouteData |
Argomenti passati a un'azione attivata. |
| IAddress |
Indirizzare le informazioni di routing per un evento . Gli indirizzi sono bidirezionali, ovvero possono essere usati per gestire sia gli eventi in ingresso che in uscita. Sono anche connettori specifici che connettori sono liberi di aggiungere i propri campi all'indirizzo. Per inviare un messaggio proattivo a un bot utente deve salvare l'indirizzo da un messaggio ricevuto. A seconda degli indirizzi del canale possono cambiare, quindi i bot devono aggiornare periodicamente l'indirizzo archiviato per un determinato utente. |
| IAnimationCard |
Definizione dell'interfaccia per una scheda di animazione |
| IAttachment |
Molti canali di messaggistica offrono la possibilità di allegare oggetti più avanzati. Bot Builder consente di esprimere questi allegati in modo incrociato e connettori farà del proprio meglio per eseguire il rendering degli allegati usando i costrutti nativi dei canali. Se si desidera un maggiore controllo sul rendering dei canali di un messaggio, è possibile usare IEvent.sourceEvent per fornire allegati usando lo schema nativo dei canali. I tipi di allegati che possono essere inviati variano in base al canale, ma questi sono i tipi di base:
|
| IAudioCard |
Definizione dell'interfaccia per una scheda audio |
| IBeginDialogActionOptions |
Opzioni passate durante la definizione di un |
| IBotStateData |
Dati dello stato del bot esportati. |
| IBotStateDataResult |
Oggetto Result restituito da |
| IBotStorage |
Sistema di archiviazione sostituibile usato da UniversalBot. |
| IBotStorageContext |
Oggetto context passato alle chiamate IBotStorage. |
| IBotStorageData |
I valori dei dati sono persistenti in IBotStorage. |
| ICancelActionOptions |
Opzioni passate durante la definizione di un |
| ICardAction |
Azione che deve essere eseguita quando viene toccata una scheda, un pulsante o un'immagine. |
| ICardImage |
Immagine su una scheda. |
| ICardMediaUrl |
Informazioni sull'URL che descrivono i supporti per una scheda |
| IChatConnectorAddress |
ChatConnector indirizzo specifico. |
| IChatConnectorEndpoint |
Opzioni usate per impostare vari endpoint in un'istanza di ChatConnector. Questo non deve essere modificato e in genere non viene fornito dagli sviluppatori in IChatConnectorSettings. Le due proprietà in IChatConnectorSettings, "stateEndpoint" e "openIdMetadata" devono essere modificate. |
| IChatConnectorSettings |
Opzioni usate per inizializzare un'istanza di ChatConnector. |
| IChoice |
Scelta che può essere passata a Prompts.choice() o [PromptRecognizers.recognizeChoices()][/en-us/node/builder/chat-reference/classes/botbuilder_d.promptrecognizers#recognizechoices]. |
| IConnector |
Implementato dai plug-in del connettore per UniversalBot. |
| IContactRelationUpdate |
Un utente ha aggiornato l'elenco dei contatti. /** Un utente ha aggiornato l'elenco dei contatti. |
| IConversationMembers |
Elenco di membri all'interno di una conversazione. |
| IConversationUpdate |
Le proprietà di una conversazione sono state modificate. |
| IConversationsResult |
Oggetto Result restituito da |
| IDefaultLocalizerSettings |
Impostazioni usate per inizializzare un'implementazione di ILocalizer. |
| IDialogActionOptions |
Opzioni passate durante la definizione di un'azione di dialogo. |
| IDialogResult |
Risultati restituiti da una finestra di dialogo figlio al relativo padre tramite una chiamata a session.endDialog(). |
| IDialogState |
Voce nello stack di dialoghi delle sessioni. |
| IDialogVersionOptions |
Opzioni passate a Middleware.dialogVersion(). |
| IDialogWaterfallStep |
Firma per le funzioni passate come passaggi per DialogAction.waterfall().
Le cascate consentono di richiedere informazioni a un utente usando una sequenza di domande. Ogni passaggio della cascata può eseguire uno dei prompt predefiniti , avviare un nuovo dialogo chiamando session.beginDialog(), passare al passaggio successivo della cascata usando manualmente Quando un dialogo o un prompt predefinito viene chiamato da un passaggio a cascata, i risultati di tale finestra di dialogo o prompt verranno passati tramite il parametro È possibile passare manualmente al passaggio successivo della cascata usando la funzione È possibile terminare una cascata all'inizio cadendo in ogni passaggio della cascata usando chiamate a nota: le cascate hanno un ultimo passaggio nascosto che terminerà automaticamente il dialogo corrente se si chiama un prompt o un dialogo dall'ultimo passaggio. Ciò è utile in cui si dispone di uno stack completo di dialoghi e si desidera una chiamata a session.endDialog() dall'ultimo elemento figlio nello stack per terminare l'intero stack. La chiusura dell'ultimo elemento figlio attiverà tutti i suoi genitori per passare a questo passaggio nascosto che scadrà la chiusura fino allo stack. Si tratta in genere di un comportamento desiderato, ma se si vuole evitare o arrestarlo in un punto centrale, è necessario aggiungere un passaggio alla fine della cascata che non esegue alcuna operazione o chiama qualcosa come session.send() che non farà avanzare la cascata in avanti. |
| IDisambiguateChoices |
Instradare le opzioni da passare a Prompts.disambiguate().
La chiave per la mappa deve essere l'etichetta localizzata da visualizzare all'utente e il valore deve essere la route da selezionare quando scelto dall'utente. È possibile passare |
| IDisambiguateRouteHandler |
Logica di disambiguazione della route personalizzata passata a UniversalBot.onDisambiguateRoute(). |
| IEntity |
Entità riconosciuta. |
| IEvent |
Evento ricevuto o inviato a un'origine. |
| IEventMiddleware |
Firma della funzione per un middleware che associa gli eventi "receive" o "send". |
| IFact | |
| IFindActionRouteContext |
Contesto passato a |
| IFindMatchResult |
Risultato restituito da una chiamata a EntityRecognizer.findBestMatch() o EntityRecognizer.findAllMatches(). |
| IFindRoutesHandler |
Logica di ricerca di route personalizzata passata a Library.onFindRoutes(). |
| IFirstRunOptions |
Opzioni passate a Middleware.firstRun(). |
| IIdentity |
Rappresenta un utente, un bot o una conversazione. |
| IIntent |
Finalità riconosciuta. |
| IIntentDialogOptions |
Opzioni usate per configurare un IntentDialog. |
| IIntentRecognizer |
Interfaccia implementata dai plug-in di riconoscimento finalità, ad esempio la classe luisRecognizer. |
| IIntentRecognizerResult |
Risultati restituiti da un riconoscitore finalità. |
| IIntentRecognizerSetOptions |
Opzioni usate per configurare un IntentRecognizerSet. |
| IIsAttachment |
Implementata dalle classi che possono essere convertite in un allegato. |
| IIsCardAction |
Implementata dalle classi che possono essere convertite in un'azione scheda. |
| IIsCardImage |
Implementata dalle classi che possono essere convertite in un'immagine scheda. |
| IIsCardMedia |
Entità che possono essere convertite in supporti per le schede |
| IIsFact |
Implementata dalle classi che possono essere convertite in un fatto. |
| IIsMessage |
Implementata dalle classi che possono essere convertite in un IMessage, ad esempio la classe generatore Message. |
| IIsReceiptItem |
Implementata dalle classi che possono essere convertite in un elemento di ricevuta. |
| IIsSuggestedActions |
Implementata dalle classi che possono essere convertite in azioni suggerite |
| ILocalizer |
Plug-in per la localizzazione dei messaggi inviati all'utente da un bot. |
| ILuisModelMap |
Mapping per/locale dell'URL del servizio LUIS da usare per luisRecognizer. |
| IMediaCard |
Definizione dell'interfaccia di un MediaCard generico, che nella sua forma concreta può essere una scheda Audio, Animazione o Video |
| IMediaEventValue |
Parametro supplementare per gli eventi multimediali. |
| IMessage |
Messaggio di chat inviato tra un utente e un bot. I messaggi dal bot all'utente sono disponibili in due versioni:
Nel caso reattivo, è necessario copiare il campo indirizzo di dal messaggio in arrivo al messaggio in uscita (se si usa la classe generatore messaggio e inizializzarla con la sessione di che verrà eseguita automaticamente) e quindi impostare il testo o gli allegati . Per i messaggi proattivi è necessario salvare l'indirizzo dal messaggio in arrivo in un archivio esterno. Successivamente è possibile passarlo a UniversalBot.beginDialog() o copiarlo in un messaggio in uscita passato a UniversalBot.send(). La composizione di un messaggio all'utente tramite l'oggetto indirizzo in ingresso invierà per impostazione predefinita una risposta all'utente nel contesto della conversazione corrente. Alcuni canali consentono l'avvio di nuove conversazioni con l'utente. Per avviare una nuova conversazione proattiva con l'utente, è sufficiente eliminare il campo conversazione dall'oggetto indirizzo prima di comporre il messaggio in uscita. |
| IMessageOptions |
Proprietà facoltative del messaggio che possono essere inviate a elementi come prompt o session.say(). |
| IMessageReaction |
Oggetto reazione al messaggio. |
| IMessageUpdate |
Le proprietà di un messaggio sono state modificate. |
| IMiddlewareMap |
Mappa di hook middleware che possono essere registrati in una chiamata a UniversalBot.use(). |
| IOAuthCard |
Interfaccia che rappresenta OAuthCard. Scheda che rappresenta una richiesta per eseguire l'accesso tramite OAuth |
| IPagedMembersResult |
Oggetto Result restituito da |
| IPromptArgs |
DEPRECATO il nuovo sistema di prompt usa solo IPromptOptions. |
| IPromptAttachmentFeatures |
Funzionalità facoltative per classe promptAttachment. |
| IPromptAttachmentOptions |
Opzioni passate a Prompts.attachment() o in una chiamata |
| IPromptAttachmentResult |
Risultato del prompt degli allegati fortemente tipizzato. |
| IPromptChoiceFeatures |
Funzionalità facoltative per Classe PromptChoice. |
| IPromptChoiceOptions |
Opzioni passate a Prompts.choice() o in una chiamata |
| IPromptChoiceResult |
Risultato prompt di scelta fortemente tipizzato. |
| IPromptConfirmResult |
Risultato conferma conferma fortemente tipizzato. |
| IPromptContext |
Informazioni contestuali rilevate per un prompt . È possibile accedere a queste informazioni all'interno di una richiesta tramite session.dialogData. |
| IPromptFeatures |
Funzionalità facoltative che devono essere abilitate/disabilitate durante la creazione di un prompt di personalizzato |
| IPromptNumberOptions |
Opzioni passate a Prompts.number() o in una chiamata |
| IPromptNumberResult |
Risultato del prompt dei numeri fortemente tipizzato. |
| IPromptOptions | |
| IPromptRecognizeChoicesOptions |
Opzioni passate a PromptRecognizers.recognizeChoices(). |
| IPromptRecognizeNumbersOptions |
Opzioni passate a PromptRecognizers.recognizeNumbers(). |
| IPromptRecognizeTimesOptions |
Opzioni passate a PromptRecognizers.recognizeTimes(). |
| IPromptRecognizeValuesOptions |
Opzioni passate a PromptRecognizers.recognizeValues(). |
| IPromptRecognizer |
DEPRECATO non più supportato a partire dalla versione 3.8. Usare invece prompt personalizzati. |
| IPromptRecognizerArgs |
DEPRECATO non più supportato a partire dalla versione 3.8. Usare invece prompt personalizzati. |
| IPromptRecognizerResult |
Risultato restituito da un IPromptRecognizer. |
| IPromptResult |
Risultato del dialogo restituito da una richiesta di sistema. |
| IPromptTextFeatures |
Funzionalità facoltative per classe PromptText. |
| IPromptTextOptions |
Opzioni passate a Prompts.text() o in una chiamata |
| IPromptTextResult |
Risultato della richiesta di testo fortemente tipizzato. |
| IPromptTimeResult |
Risultato richiesta ora fortemente tipizzato. |
| IPromptsOptions |
DEPRECATO non più supportato a partire dalla versione 3.8. Usare invece prompt personalizzati. |
| IReceiptCard |
Visualizza una ricevuta avanzata a un utente per un elemento che ha acquistato o sta pianificando l'acquisto. |
| IReceiptItem | |
| IRecognizeContext |
Contesto del messaggio ricevuto passato a vari metodi di riconoscimento. |
| IRecognizeDialogContext |
Contesto passato a |
| IRecognizeResult |
Risultati da una chiamata a una funzione recognize(). L'implementazione è gratuita per aggiungere eventuali proprietà aggiuntive al risultato. |
| IRegExpMap |
Mapping per/locale di espressioni regolari da usare per regExpRecognizer. |
| IRouteResult |
Route candidata restituita da Library.findRoutes(). |
| ISelectRouteHandler |
Logica di ricerca di route personalizzata passata a Library.onSelectRoute(). |
| ISemanticAction |
Rappresenta un riferimento a un'azione programmatica. |
| ISessionMiddleware |
Firma della funzione per un middleware che associa l'evento "botbuilder". |
| ISessionOptions |
Opzioni passate al costruttore di una sessione. |
| ISessionState |
Stato sessione persistente usato per tenere traccia di uno stack di dialoghi di conversazioni. |
| ISigninCard |
Visualizza una scheda di accesso e un pulsante per l'utente. Alcuni canali possono scegliere di eseguirne il rendering come richiesta di testo e collegamento per fare clic. |
| ISourceEventMap |
Mapping per origine dei dati dell'evento personalizzati da inviare. |
| IStartConversationAddress |
Proprietà aggiuntive che possono essere passate con l'indirizzo a UniversalBot.beginDialog(). |
| ISuggestedActions |
Azioni suggerite da inviare all'utente e visualizzate come risposte rapide. Le azioni suggerite verranno visualizzate solo nei canali che supportano le azioni suggerite. |
| ITextHighlight |
Interfaccia che rappresenta TextHighlight. Fa riferimento a una sottostringa del contenuto all'interno di un altro campo. |
| IThumbnailCard |
Visualizza una scheda all'utente usando un layout di anteprima più piccolo o più grande (gli allegati contentType determinano quale). Tutti i campi delle schede sono facoltativi, quindi questa scheda può essere usata per specificare elementi come una tastiera in determinati canali. Alcuni canali possono scegliere di eseguire il rendering di una versione di fedeltà inferiore della scheda o di usare una rappresentazione alternativa. |
| ITokenResponse |
Interfaccia che rappresenta TokenResponse. Risposta che include un token utente |
| ITranscript |
Interfaccia che rappresenta le attività storiche. |
| ITriggerActionOptions |
Opzioni passate durante la definizione di un |
| IUniversalBotSettings |
Opzioni utilizzate per inizializzare un'istanza universalBot. |
| IVideoCard |
Definizione dell'interfaccia per una scheda video |
| IWatchableHandler |
Funzione per il recupero del valore di una variabile osservata. Passato a Session.watchable(). |
Alias tipo
| AttachmentType |
Alcuni metodi possono accettare un |
| MatchType |
Regole supportate per la corrispondenza di un'espressione degli utenti.
|
| MessageType |
Prompt basati su messaggi che possono essere inviati a un utente.
|
| TextOrMessageType |
Intervallo flessibile di possibili richieste che possono essere inviate a un utente.
|
| TextType |
Richieste basate su testo che possono essere inviate a un utente.
|
| ValueListType |
Elenco di valori di testo. I valori possono essere espressi come stringa delimitata da pipe, ad esempio "value1|value2|value3" o matrice semplice di valori. |
Enumerazioni
| ListStyle |
Tipo di elenco di cui eseguire il rendering per prompt PromptType.choice. |
| PromptType |
Tipo di richiesta richiamato. |
| RecognizeMode |
Controlla un IntentDialogs l'elaborazione delle espressioni di testo degli utenti. |
| RecognizeOrder |
Ordine in cui deve essere valutato un intentDialogs riconoscitori. |
| ResumeReason |
Codici motivo per cui è stato ripreso un dialogo. |