DialogContext Klasa

Konstruktor

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

Parametry

Nazwa Opis
dialog_set
Wymagane
turn_context
Wymagane
state
Wymagane

Metody

begin_dialog

Wypycha nowe okno dialogowe do stosu okien dialogowych. :p aram dialog_id: identyfikator okna dialogowego, aby uruchomić opcje :p aram: (opcjonalne) dodatkowe argumenty, które mają być przekazywane do uruchomionego okna dialogowego.

cancel_all_dialogs

Usuwa istniejący stos okien dialogowych, co powoduje anulowanie wszystkich okien dialogowych w stosie. :p aram cancel_parents: :p aram event_name: :p aram event_value: :return:

continue_dialog

Kontynuuje wykonywanie aktywnego okna dialogowego, jeśli istnieje, przekazując obiekt kontekstu do metody Dialog.continue_dialog(). Możesz sprawdzić turn_context.responded po zakończeniu połączenia, aby określić, czy okno dialogowe zostało uruchomione, a odpowiedź została wysłana do użytkownika. :Zwraca:

emit_event

Wyszukuje okno dialogowe z danym identyfikatorem. Emituje nazwane zdarzenie dla bieżącego okna dialogowego lub kogoś, kto go uruchomił, do obsługi. nazwa :p aram: nazwa zdarzenia do wywołania. wartość :p aram: wartość, która ma być wysyłana wraz ze zdarzeniem. bąbelek :p aram: flaga do kontrolowania, czy zdarzenie powinno być bąbelkowe do elementu nadrzędnego, jeśli nie jest obsługiwane lokalnie. Wartość domyślna to True. :p aram from_leaf: czy zdarzenie jest emitowane z węzła liścia. :p aram cancellationToken: token anulowania. :return: Prawda, jeśli zdarzenie zostało obsłużone.

end_active_dialog
end_dialog

Kończy okno dialogowe, wyskakując go ze stosu i zwraca opcjonalny wynik do elementu nadrzędnego okna dialogowego. Okno dialogowe nadrzędne to okno dialogowe, w ramach którego okno dialogowe zostało zakończone za pośrednictwem wywołania "begin_dialog" lub "monitu". Okno dialogowe nadrzędne będzie miało wywołaną metodę Dialog.resume_dialog() z dowolnym zwróconym wynikiem. Jeśli okno dialogowe nadrzędne nie zaimplementowało metody resume_dialog(), zostanie ono również automatycznie zakończone i wynik przekazany do jego elementu nadrzędnego. Jeśli nie ma więcej okien dialogowych nadrzędnych w stosie, przetwarzanie kolei zakończy się. :p aram wynik: (Opcjonalnie) wynik przekazywania do okien dialogowych nadrzędnych. :Zwraca:

find_dialog

Jeśli nie można odnaleźć okna dialogowego w bieżącym zestawie dialogowym, nadrzędne okno dialogoweContext zostanie przeszukane, jeśli istnieje. :p aram dialog_id: identyfikator okna dialogowego do wyszukania. :Zwraca:

find_dialog_sync

Jeśli nie można odnaleźć okna dialogowego w bieżącym zestawie dialogowym, nadrzędne okno dialogoweContext zostanie przeszukane, jeśli istnieje. :p aram dialog_id: identyfikator okna dialogowego do wyszukania. :Zwraca:

prompt

Funkcja pomocnika upraszczająca formatowanie opcji wywoływania okna dialogowego monitu. Ten pomocnik użyje argumentu PromptOptions , a następnie wywoła. :p aram dialog_id: identyfikator monitu do uruchomienia. opcje :p aram: zawiera monit, potencjalnie retryPrompt i w przypadku korzystania z opcji ChoicePrompt, Choices. :Zwraca:

replace_dialog

Kończy aktywne okno dialogowe i uruchamia nowe okno dialogowe w jego miejscu. Jest to szczególnie przydatne w przypadku tworzenia pętli lub przekierowywania do innego okna dialogowego. :p aram dialog_id: identyfikator okna dialogowego do wyszukania. opcje :p aram: (opcjonalne) dodatkowe argumenty, które mają być przekazywane do nowego okna dialogowego. :Zwraca:

reprompt_dialog

Wywołuje reprompt w aktualnie aktywnym oknie dialogowym, jeśli istnieje. Używany z monitami, które mają zachowanie repromptowania. :Zwraca:

begin_dialog

Wypycha nowe okno dialogowe do stosu okien dialogowych. :p aram dialog_id: identyfikator okna dialogowego, aby uruchomić opcje :p aram: (opcjonalne) dodatkowe argumenty, które mają być przekazywane do uruchomionego okna dialogowego.

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

Parametry

Nazwa Opis
dialog_id
Wymagane
options
Domyślna wartość: None

cancel_all_dialogs

Usuwa istniejący stos okien dialogowych, co powoduje anulowanie wszystkich okien dialogowych w stosie. :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)

Parametry

Nazwa Opis
cancel_parents
Domyślna wartość: None
event_name
Domyślna wartość: None
event_value
Domyślna wartość: None

continue_dialog

Kontynuuje wykonywanie aktywnego okna dialogowego, jeśli istnieje, przekazując obiekt kontekstu do metody Dialog.continue_dialog(). Możesz sprawdzić turn_context.responded po zakończeniu połączenia, aby określić, czy okno dialogowe zostało uruchomione, a odpowiedź została wysłana do użytkownika. :Zwraca:

async continue_dialog()

emit_event

Wyszukuje okno dialogowe z danym identyfikatorem. Emituje nazwane zdarzenie dla bieżącego okna dialogowego lub kogoś, kto go uruchomił, do obsługi. nazwa :p aram: nazwa zdarzenia do wywołania. wartość :p aram: wartość, która ma być wysyłana wraz ze zdarzeniem. bąbelek :p aram: flaga do kontrolowania, czy zdarzenie powinno być bąbelkowe do elementu nadrzędnego, jeśli nie jest obsługiwane lokalnie. Wartość domyślna to True. :p aram from_leaf: czy zdarzenie jest emitowane z węzła liścia. :p aram cancellationToken: token anulowania. :return: Prawda, jeśli zdarzenie zostało obsłużone.

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

Parametry

Nazwa Opis
name
Wymagane
value
Domyślna wartość: None
bubble
Domyślna wartość: True
from_leaf
Domyślna wartość: False

end_active_dialog

async end_active_dialog(reason: DialogReason)

Parametry

Nazwa Opis
reason
Wymagane

end_dialog

Kończy okno dialogowe, wyskakując go ze stosu i zwraca opcjonalny wynik do elementu nadrzędnego okna dialogowego. Okno dialogowe nadrzędne to okno dialogowe, w ramach którego okno dialogowe zostało zakończone za pośrednictwem wywołania "begin_dialog" lub "monitu". Okno dialogowe nadrzędne będzie miało wywołaną metodę Dialog.resume_dialog() z dowolnym zwróconym wynikiem. Jeśli okno dialogowe nadrzędne nie zaimplementowało metody resume_dialog(), zostanie ono również automatycznie zakończone i wynik przekazany do jego elementu nadrzędnego. Jeśli nie ma więcej okien dialogowych nadrzędnych w stosie, przetwarzanie kolei zakończy się. :p aram wynik: (Opcjonalnie) wynik przekazywania do okien dialogowych nadrzędnych. :Zwraca:

async end_dialog(result: object = None)

Parametry

Nazwa Opis
result
Domyślna wartość: None

find_dialog

Jeśli nie można odnaleźć okna dialogowego w bieżącym zestawie dialogowym, nadrzędne okno dialogoweContext zostanie przeszukane, jeśli istnieje. :p aram dialog_id: identyfikator okna dialogowego do wyszukania. :Zwraca:

async find_dialog(dialog_id: str) -> Dialog

Parametry

Nazwa Opis
dialog_id
Wymagane

find_dialog_sync

Jeśli nie można odnaleźć okna dialogowego w bieżącym zestawie dialogowym, nadrzędne okno dialogoweContext zostanie przeszukane, jeśli istnieje. :p aram dialog_id: identyfikator okna dialogowego do wyszukania. :Zwraca:

find_dialog_sync(dialog_id: str) -> Dialog

Parametry

Nazwa Opis
dialog_id
Wymagane

prompt

Funkcja pomocnika upraszczająca formatowanie opcji wywoływania okna dialogowego monitu. Ten pomocnik użyje argumentu PromptOptions , a następnie wywoła. :p aram dialog_id: identyfikator monitu do uruchomienia. opcje :p aram: zawiera monit, potencjalnie retryPrompt i w przypadku korzystania z opcji ChoicePrompt, Choices. :Zwraca:

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

Parametry

Nazwa Opis
dialog_id
Wymagane
options
Wymagane

replace_dialog

Kończy aktywne okno dialogowe i uruchamia nowe okno dialogowe w jego miejscu. Jest to szczególnie przydatne w przypadku tworzenia pętli lub przekierowywania do innego okna dialogowego. :p aram dialog_id: identyfikator okna dialogowego do wyszukania. opcje :p aram: (opcjonalne) dodatkowe argumenty, które mają być przekazywane do nowego okna dialogowego. :Zwraca:

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

Parametry

Nazwa Opis
dialog_id
Wymagane
options
Domyślna wartość: None

reprompt_dialog

Wywołuje reprompt w aktualnie aktywnym oknie dialogowym, jeśli istnieje. Używany z monitami, które mają zachowanie repromptowania. :Zwraca:

async reprompt_dialog()

Atrybuty

active_dialog

Zwróć link kontenera w bazie danych.

child

Zwróć link kontenera w bazie danych.

context

Pobiera kontekst bieżącej konwersacji.

dialogs

Pobiera zestaw okien dialogowych, które można wywołać z tego kontekstu.

stack

Pobiera bieżący stos okna dialogowego.