botbuilder-calling package

Classe Del generatore di azioni progettata per semplificare la compilazione di azioni di risposta .

Connettere un UniversalCallBot al servizio di chiamata Skype.

Gestisce la conversazione dei bot con un utente.

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.

Le azioni di dialogo offrono collegamenti all'implementazione di azioni comuni.

Classe Del generatore di azioni progettata per semplificare la compilazione azioni di blocco.

Libreria di dialoghi correlati utilizzati a scopo di routing. Le librerie possono essere concatenate per consentire lo sviluppo di bot complessi. La classe UniversalCallBot è 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 aggiungendo semplicemente l'istanza della libreria di parti al bot usando UniversalCallBot.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 si nasconderà da devloper esponendo una funzione dal relativo modulo che avvia la finestra di dialogo per loro. Quindi chiamare qualcosa come myLib.someDialog(session, { arg: '' }); finirebbe per chiamare session.beginDialog('myLib:someDialog', args); sotto le quinte.

Vale la pena notare che i dialoghi vengono sempre richiamati all'interno del dialogo corrente, quindi una volta che l'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.

Impostazione predefinita nell'implementazione dell'archiviazione in memoria per l'archiviazione dei dati sullo stato della sessione & utente.

Classe Del generatore di azioni progettata per semplificare la compilazione azioni playPrompt.

Classe prompt builder che semplifica la compilazione di richieste di azione playPrompt.

Richieste predefinite predefinite che possono essere chiamate da qualsiasi finestra di dialogo.

Classe Del generatore di azioni progettata per semplificare la compilazione riconoscere le azioni.

Classe Del generatore di azioni progettata per semplificare la compilazione di azioni record.

Classe Del generatore di azioni progettata per semplificare la compilazione rifiutare le azioni.

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:

• La chiusura dei dialoghi può essere chiamata in due contesti diversi per cui è potenzialmente necessario eseguire il test. Verrà chiamato come previsto quando l'utente invia un messaggio, ma se si chiama un'altra richiesta o finestra di dialogo dalla chiusura, viene chiamata una seconda volta con i risultati dal prompt/finestra di dialogo. In genere è possibile verificare questo secondo caso controllando l'esistenza di una proprietà args.resumed. È importante evitare di entrare in un ciclo infinito che può essere facile da fare.
• A differenza di una cascata, il dialogo non terminerà automaticamente. Rimarrà la finestra di dialogo attiva finché non si chiama session.endDialog().

Gestisce le conversazioni dei bot con gli utenti in più canali.

Classe di base per tutte le azioni.

Classe di base per tutti i risultati dell'azione.

Indirizzare le informazioni di routing per un messaggio di . Gli indirizzi sono bidirezionali, ovvero possono essere usati per gestire sia i messaggi in ingresso che in uscita. Sono anche connettori specifici che connettori sono liberi di aggiungere i propri campi.

L'azione di risposta consente a un bot di accettare una chiamata Skype. L'azione di risposta deve essere una prima azione in risposta alla notifica di conversazione.

Risultato dell'azione Risposta.

Sistema di archiviazione replacabile usato da UniversalCallBot.

Oggetto context passato alle chiamate IBotStorage.

I valori dei dati sono persistenti in IBotStorage.

Implementato dai plug-in del connettore per UniversalCallBot.

Indirizzo specifico del connettore chat.

Opzioni usate per inizializzare un'istanza di ChatConnector.

Firma della funzione per un middleware che associa l'evento "botbuilder".

Opzioni passate al costruttore di una sessione.

Restituito quando viene selezionato un riconoscimento di scelta.

Specifica le opzioni per la raccolta di cifre. Ad esempio, "Immettere il codice postale a 5 cifre seguito dal segno di cancelletto".

Restituito quando la raccolta di cifre è selezionata.

Opzioni passate a un prompt 'confirm'.

IConversation è un corpo JSON di una prima richiesta per la nuova chiamata vocale Skype effettuata da Skype Bot Platform per la chiamata a un bot. Il corpo JSON di IConversation viene pubblicato sull'endpoint HTTPs iniziale registrato da uno sviluppatore di bot nel portale di Bot Framework. La richiesta IConversation contiene informazioni sul chiamante e sulla destinazione della chiamata e alcune informazioni aggiuntive sullo stato iniziale di una chiamata.

IConversationResult è un corpo JSON di qualsiasi richiesta successiva dopo la notifica IConversation iniziale inviata a un bot da Skype Bot Platform for Calling. IConversationResult viene inviato a un collegamento di callback fornito dalla risposta del flusso di lavoro precedente. IConversationResult rappresenta il risultato di un'ultima azione riuscita della risposta del flusso di lavoro precedente.

Risultati restituiti da una finestra di dialogo figlio al relativo padre tramite una chiamata a session.endDialog().

Voce nello stack di dialoghi delle sessioni.

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 skip()o terminare la cascata.

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 results al passaggio successivo della cascata. Gli utenti possono pronunciare elementi come "nevermind" per annullare le richieste predefinite in modo da evitare questa situazione controllando almeno risultati.risposta prima di procedere. Un'esplorazione più dettagliata del motivo per cui la cascata continua può essere determinata esaminando il codice restituito per i risultati .ripreso.

È possibile passare manualmente al passaggio successivo della cascata usando la funzione skip() passata. La chiamata a skip({ response: "some text" }) con un IDialogResult consente di simulare in modo più accurato i risultati di un prompt predefinito e di semplificare la logica a cascata complessiva.

È possibile terminare una cascata all'inizio cadendo in ogni passaggio della cascata usando chiamate a skip() o semplicemente non avviando un'altra richiesta o un altro dialogo.

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.

Opzioni passate a un prompt 'digits'.

Firma della funzione per un gestore eventi di errore.

Evento ricevuto o inviato a un'origine.

Firma della funzione per un middleware che associa gli eventi "receive" o "send".

risultato restituito da una chiamata a EntityRecognizer.findBestMatch() o EntityRecognizer.findAllMatches().

Hang up consente al bot di terminare la chiamata in corso. Hang up è l'ultima azione nel flusso di lavoro. Si noti che il diverso tra Hangup e Reject. Rifiuta azione consente al bot di terminare la chiamata anziché rispondere alla chiamata mentre Hangup termina la chiamata in corso.

Restituisce il risultato del blocco.

Rappresenta un utente, un bot o una conversazione.

Implementata dalle classi che possono essere convertite in azioni.

Implementata dalle classi che possono essere convertite in un evento.

Implementata dalle classi che possono essere convertite in richieste.

Plug-in per la localizzazione dei messaggi inviati all'utente da un bot.

Mappa di hook middleware che possono essere registrati in una chiamata a UniversalCallBot.use().

PlayPrompt consente di riprodurre testo-To-Speech audio o un file multimediale.

Il risultato della richiesta di riproduzione restituisce il risultato della riproduzione di un prompt.

Richiesta eseguita come parte dell'azione PlayPrompt.

Risultato del prompt delle azioni fortemente tipizzato.

Risultato prompt di scelta fortemente tipizzato.

Risultato conferma conferma fortemente tipizzato.

Risultato prompt cifre fortemente tipizzato.

Opzioni passate ai prompt predefiniti.

Risultato richiesta record fortemente tipizzato.

Risultato del dialogo restituito da una richiesta di sistema.

Opzioni di configurazione globali per la finestra di dialogo Prompt.

Specifica le opzioni di riconoscimento vocale & DTMF per un riconoscimento basato su scelta. Ad esempio, "Say 'Sales' or press 1 for the sales department".

L'azione Di riconoscimento consente di acquisire l'output del riconoscimento vocale o raccogliere cifre dal dial pad dell'utente Skype.

Il risultato del riconoscimento è il risultato di un'azione di riconoscimento. Contiene cifre riconosciute o riconoscimento vocale.

Opzioni passate alle richieste basate sul riconoscimento.

L'azione registra è un'azione interattiva in cui viene registrato l'audio dell'utente Skype.

Il risultato del record restituisce il risultato dell'azione audio del record. RecordOutcome può essere restituito come contenuto multipart in cui la prima parte di multipart contiene il risultato dell'azione mentre la seconda parte contiene un flusso binario che rappresenta l'audio registrato. Il flusso audo sarà disponibile tramite la proprietà IConversationResult.recordedAudio.

Opzioni passate a un prompt 'record'.

Registrazione restituita dal prompt dei record predefinito.

Rifiuta consente di rifiutare di rispondere alla chiamata. L'azione Rifiuta può essere usata come prima azione del primo flusso di lavoro invece di Answer.

Risultato dell'azione Rifiuta. Il rifiuto può essere usato invece dell'azione Answer se il bot decide che il bot non vuole rispondere alla chiamata.

Stato sessione persistente usato per tenere traccia di uno stack di dialoghi di conversazioni.

Opzioni utilizzate per inizializzare un'istanza universalCallBot.

IWorkflow è un corpo JSON inviato dal bot in risposta alla richiesta IConversation o IConversationResult da Skype Bot Platform for Calling. IWorkflow contiene un elenco di una o più azioni che i bot indicano a Skype Bot Platform per la chiamata in esecuzione per suo conto, nonché all'indirizzo HTTP di callback se il bot vuole ricevere una notifica sul risultato dell'ultima azione eseguita.

Tipo di richiesta richiamato.

Codici motivo per cui è stato ripreso un dialogo.