DialogContext Classe

Costruttore

DialogContext(dialog_set: DialogSet, turn_context: TurnContext, state: DialogState)

Parametri

Nome Descrizione
dialog_set
Necessario
turn_context
Necessario
state
Necessario

Metodi

begin_dialog

Inserisce un nuovo dialogo nello stack di dialoghi. :p aram dialog_id: ID della finestra di dialogo per avviare :p aram opzioni: (facoltativo) argomenti aggiuntivi da passare alla finestra di dialogo avviata.

cancel_all_dialogs

Elimina qualsiasi stack di dialoghi esistente annullando così tutti i dialoghi nello stack. :p aram cancel_parents: :p aram event_name: :p aram event_value: :return:

continue_dialog

Continua l'esecuzione del dialogo attivo, se presente, passando l'oggetto contesto al relativo metodo Dialog.continue_dialog(). È possibile controllare turn_context.reply dopo il completamento della chiamata per determinare se è stata eseguita una finestra di dialogo e se è stata inviata una risposta all'utente. :ritorno:

emit_event

Cerca una finestra di dialogo con un ID specificato. Genera un evento denominato per la finestra di dialogo corrente, o un utente che lo ha avviato, da gestire. nome :p aram: nome dell'evento da generare. valore :p aram: valore da inviare insieme all'evento. :p aram bubble: flag per controllare se l'evento deve essere visualizzato nel relativo elemento padre se non gestito localmente. Il valore predefinito è True. :p aram from_leaf: indica se l'evento viene generato da un nodo foglia. :p aram cancellationToken: token di annullamento. :return: True se l'evento è stato gestito.

end_active_dialog
end_dialog

Termina un dialogo estraendolo dallo stack e restituisce un risultato facoltativo all'elemento padre del dialogo. Il dialogo padre è il dialogo che ha avviato la finestra di dialogo terminata tramite una chiamata a "begin_dialog" o "prompt". Il dialogo padre avrà Dialog.resume_dialog() metodo richiamato con qualsiasi risultato restituito. Se il dialogo padre non ha implementato un metodo resume_dialog(), verrà terminato automaticamente e il risultato passato al relativo elemento padre. Se non sono presenti più dialoghi padre nello stack, l'elaborazione del turno terminerà. :p aram risultato: (facoltativo) da passare ai dialoghi padre. :ritorno:

find_dialog

Se non è possibile trovare la finestra di dialogo all'interno del DialogSet corrente, verrà eseguita la ricerca nel padre DialogContext, se presente. :p aram dialog_id: ID della finestra di dialogo da cercare. :ritorno:

find_dialog_sync

Se non è possibile trovare la finestra di dialogo all'interno del DialogSet corrente, verrà eseguita la ricerca nel padre DialogContext, se presente. :p aram dialog_id: ID della finestra di dialogo da cercare. :ritorno:

prompt

Funzione helper per semplificare la formattazione delle opzioni per chiamare una finestra di dialogo di richiesta. Questo helper accetta un argomento PromptOptions e quindi chiama. :p aram dialog_id: ID del prompt da avviare. :p aram opzioni: contiene un prompt, potenzialmente un RetryPrompt e se si usa ChoicePrompt, Scelte. :ritorno:

replace_dialog

Termina il dialogo attivo e avvia una nuova finestra di dialogo al suo posto. Ciò è particolarmente utile per la creazione di cicli o il reindirizzamento a un'altra finestra di dialogo. :p aram dialog_id: ID della finestra di dialogo da cercare. :p aram opzioni: (facoltativo) argomenti aggiuntivi da passare alla nuova finestra di dialogo. :ritorno:

reprompt_dialog

Chiama reprompt nella finestra di dialogo attualmente attiva, se presente. Usato con prompt con un comportamento di ripetizione. :ritorno:

begin_dialog

Inserisce un nuovo dialogo nello stack di dialoghi. :p aram dialog_id: ID della finestra di dialogo per avviare :p aram opzioni: (facoltativo) argomenti aggiuntivi da passare alla finestra di dialogo avviata.

async begin_dialog(dialog_id: str, options: object = None)

Parametri

Nome Descrizione
dialog_id
Necessario
options
Valore predefinito: None

cancel_all_dialogs

Elimina qualsiasi stack di dialoghi esistente annullando così tutti i dialoghi nello stack. :p aram cancel_parents: :p aram event_name: :p aram event_value: :return:

async cancel_all_dialogs(cancel_parents: bool = None, event_name: str = None, event_value: object = None)

Parametri

Nome Descrizione
cancel_parents
Valore predefinito: None
event_name
Valore predefinito: None
event_value
Valore predefinito: None

continue_dialog

Continua l'esecuzione del dialogo attivo, se presente, passando l'oggetto contesto al relativo metodo Dialog.continue_dialog(). È possibile controllare turn_context.reply dopo il completamento della chiamata per determinare se è stata eseguita una finestra di dialogo e se è stata inviata una risposta all'utente. :ritorno:

async continue_dialog()

emit_event

Cerca una finestra di dialogo con un ID specificato. Genera un evento denominato per la finestra di dialogo corrente, o un utente che lo ha avviato, da gestire. nome :p aram: nome dell'evento da generare. valore :p aram: valore da inviare insieme all'evento. :p aram bubble: flag per controllare se l'evento deve essere visualizzato nel relativo elemento padre se non gestito localmente. Il valore predefinito è True. :p aram from_leaf: indica se l'evento viene generato da un nodo foglia. :p aram cancellationToken: token di annullamento. :return: True se l'evento è stato gestito.

async emit_event(name: str, value: object = None, bubble: bool = True, from_leaf: bool = False) -> bool

Parametri

Nome Descrizione
name
Necessario
value
Valore predefinito: None
bubble
Valore predefinito: True
from_leaf
Valore predefinito: False

end_active_dialog

async end_active_dialog(reason: DialogReason)

Parametri

Nome Descrizione
reason
Necessario

end_dialog

Termina un dialogo estraendolo dallo stack e restituisce un risultato facoltativo all'elemento padre del dialogo. Il dialogo padre è il dialogo che ha avviato la finestra di dialogo terminata tramite una chiamata a "begin_dialog" o "prompt". Il dialogo padre avrà Dialog.resume_dialog() metodo richiamato con qualsiasi risultato restituito. Se il dialogo padre non ha implementato un metodo resume_dialog(), verrà terminato automaticamente e il risultato passato al relativo elemento padre. Se non sono presenti più dialoghi padre nello stack, l'elaborazione del turno terminerà. :p aram risultato: (facoltativo) da passare ai dialoghi padre. :ritorno:

async end_dialog(result: object = None)

Parametri

Nome Descrizione
result
Valore predefinito: None

find_dialog

Se non è possibile trovare la finestra di dialogo all'interno del DialogSet corrente, verrà eseguita la ricerca nel padre DialogContext, se presente. :p aram dialog_id: ID della finestra di dialogo da cercare. :ritorno:

async find_dialog(dialog_id: str) -> Dialog

Parametri

Nome Descrizione
dialog_id
Necessario

find_dialog_sync

Se non è possibile trovare la finestra di dialogo all'interno del DialogSet corrente, verrà eseguita la ricerca nel padre DialogContext, se presente. :p aram dialog_id: ID della finestra di dialogo da cercare. :ritorno:

find_dialog_sync(dialog_id: str) -> Dialog

Parametri

Nome Descrizione
dialog_id
Necessario

prompt

Funzione helper per semplificare la formattazione delle opzioni per chiamare una finestra di dialogo di richiesta. Questo helper accetta un argomento PromptOptions e quindi chiama. :p aram dialog_id: ID del prompt da avviare. :p aram opzioni: contiene un prompt, potenzialmente un RetryPrompt e se si usa ChoicePrompt, Scelte. :ritorno:

async prompt(dialog_id: str, options) -> DialogTurnResult

Parametri

Nome Descrizione
dialog_id
Necessario
options
Necessario

replace_dialog

Termina il dialogo attivo e avvia una nuova finestra di dialogo al suo posto. Ciò è particolarmente utile per la creazione di cicli o il reindirizzamento a un'altra finestra di dialogo. :p aram dialog_id: ID della finestra di dialogo da cercare. :p aram opzioni: (facoltativo) argomenti aggiuntivi da passare alla nuova finestra di dialogo. :ritorno:

async replace_dialog(dialog_id: str, options: object = None) -> DialogTurnResult

Parametri

Nome Descrizione
dialog_id
Necessario
options
Valore predefinito: None

reprompt_dialog

Chiama reprompt nella finestra di dialogo attualmente attiva, se presente. Usato con prompt con un comportamento di ripetizione. :ritorno:

async reprompt_dialog()

Attributi

active_dialog

Restituire il collegamento al contenitore nel database.

child

Restituire il collegamento al contenitore nel database.

context

Ottiene il contesto per il turno corrente della conversazione.

dialogs

Ottiene il set di dialoghi che è possibile chiamare da questo contesto.

stack

Ottiene lo stack di dialoghi corrente.