Edit

dialogs Package

Packages

choices
memory
prompts
skills

Modules

about
component_dialog
dialog
dialog_container
dialog_context
dialog_event
dialog_events
dialog_extensions
dialog_instance
dialog_manager
dialog_manager_result
dialog_reason
dialog_set
dialog_state
dialog_turn_result
dialog_turn_status
dialogs_component_registration
object_path
persisted_state
persisted_state_keys
waterfall_dialog
waterfall_step
waterfall_step_context

Classes

ComponentDialog

A Dialog that is composed of other dialogs

Initializes a new instance of the ComponentDialog

ConfirmPrompt
DateTimePrompt
DateTimeResolution
Dialog
DialogContainer
DialogContext
DialogEvent
DialogExtensions
DialogInstance

Tracking information for a dialog on the stack.

Gets or sets the ID of the dialog and gets or sets the instance's persisted state.

DialogManager

Class which runs the dialog system.

Initializes a instance of the <see cref="DialogManager"/> class. :param root_dialog: Root dialog to use. :param dialog_state_property: alternate name for the dialog_state property. (Default is "DialogState").

DialogManagerResult
DialogSet
DialogState

Contains state information for the dialog stack.

Initializes a new instance of the DialogState class.

DialogTurnResult

Result returned to the caller of one of the various stack manipulation methods.

DialogsComponentRegistration
NumberPrompt
OAuthPrompt

Creates a new instance of the OAuthPrompt class.

OAuthPromptSettings

Settings used to configure an OAuthPrompt instance. Parameters: connection_name (str): Name of the OAuth connection being used. title (str): The title of the cards signin button. text (str): (Optional) additional text included on the signin card. timeout (int): (Optional) number of milliseconds the prompt will wait for the user to authenticate.

     *OAuthPrompt* defaults value to *900,000* ms (15 minutes).

  oauth_app_credentials (AppCredentials): (Optional) AppCredentials to use for OAuth.  If None,
  the Bots credentials are used.
  end_on_invalid_message (bool): (Optional) value indicating whether the OAuthPrompt should end upon
  receiving an invalid message.  Generally the OAuthPrompt will ignore incoming messages from the
  user during the auth flow, if they are not related to the auth flow.  This flag enables ending the
  OAuthPrompt rather than ignoring the user's message.  Typically, this flag will be set to 'true',
  but is 'false' by default for backwards compatibility.
ObjectPath

Helper methods for working with json objects.

PersistedState
PersistedStateKeys
Prompt

Defines the core behavior of prompt dialogs. Extends the Dialog base class.

Creates a new Prompt instance.

ComponentDialog :type dialog_id: str :param validator: Optionally provide additional validation and re-prompting logic :type validator: Object

PromptOptions

Contains settings to pass to a Prompt object when the prompt is started.

Sets the initial prompt to send to the user as an Activity.

PromptRecognizerResult

Creates result returned by a prompts recognizer function.

PromptValidatorContext

Creates contextual information passed to a custom PromptValidator. :param turn_context: The context for the current turn of conversation with the user. :param recognized: Result returned from the prompts recognizer function. :param state: A dictionary of values persisted for each conversational turn while the prompt is active. :param options: Original set of options passed to the prompt by the calling dialog.

TextPrompt

Creates a new Prompt instance.

ComponentDialog :type dialog_id: str :param validator: Optionally provide additional validation and re-prompting logic :type validator: Object

WaterfallDialog
WaterfallStepContext

Enums

DialogEvents
DialogReason

Indicates in which a dialog-related method is being called.

DialogTurnStatus

Indicates in which a dialog-related method is being called.