botbuilder-dialogs-adaptive package
Classes
ActionContext |
Extends the DialogContext with additional methods for manipulating the executing sequence of actions for an AdaptiveDialog. |
ActionScope |
|
BaseInvokeDialog |
Action which calls another Dialog. |
BeginDialog |
Action which begins executing another Dialog, when it is done, it will return to the caller. |
BeginSkill |
Begin a Skill. |
BreakLoop |
Break out of a loop. |
CancelAllDialogs |
Command to cancel all of the current Dialogs by emitting an event that must be caught to prevent cancellation from propagating. |
CancelAllDialogsBase |
Base class for CancelAllDialogs api. |
CancelDialog |
Command to cancel all of the current Dialogs by emitting an event that must be caught to prevent cancellation from propagating. |
Case |
Cases of action scope. |
CodeAction |
Class representing a Dialog code action. |
ContinueConversation |
Action which continues a conversation using a Conversation reference. |
ContinueConversationLater |
Action which schedules the current conversation to be continued at a later time. |
ContinueLoop |
Continue the loop. |
DeleteActivity |
Ends and deletes an activity. |
DeleteProperties |
Deletes a collection of properties from memory. |
DeleteProperty |
Deletes a property from memory. |
DynamicBeginDialog |
Internal |
EditActions |
Class which allows you to edit the current actions. |
EditArray |
Lets you modify an array in memory. |
EmitEvent |
Action which emits an event declaratively. |
EndDialog |
Command to end the current Dialog, returning the |
EndTurn |
This command ends the current turn without ending the Dialog. |
ForEach |
Executes a set of actions once for each item in an in-memory list or collection. |
ForEachPage |
Executes a set of actions once for each page of results in an in-memory list or collection. |
GetActivityMembers |
Calls |
GetConversationMembers |
Calls |
GetConversationReference |
Gets the current conversation reference and saves it to a memory property suitable to use in ContinueConversation action. |
GotoAction |
Goto an action by Id. |
HttpRequest |
Action for performing an |
Result |
Result data of HTTP operation. |
IfCondition |
Conditional branch. |
LogAction |
Write entry into application trace logs. |
RepeatDialog |
Action which repeats the active Dialog (restarting it). |
ReplaceDialog |
Action which calls another Dialog, when it is done it will go to the caller's parent dialog. |
SendActivity |
Send an activity back to the user. |
SendHandoffActivity |
Sends a handoff activity. Note that this is a single turn/step dialog (i.e. it calls this.endDialog). |
SetProperties |
Sets properties with the result of evaluating a value expression. |
SetProperty |
Sets a property with the result of evaluating a value expression. |
SignOutUser |
Singns out the user and finishes the dialog. |
SwitchCondition |
Conditional branch with multiple cases. |
TelemetryTrackEventAction |
Track a custom event. |
ThrowException |
Action which throws an exception declaratively. |
TraceActivity |
Send an trace activity back to the transcript. |
UpdateActivity |
Update an activity with replacement. |
AdaptiveBotComponent |
BotComponent for adaptive components. |
AdaptiveDialog |
The Adaptive Dialog models conversation using events and events to adapt dynamically to changing conversation flow. |
AdaptiveEvents |
Adaptive event identifier definition list. |
OnActivity |
Actions triggered when an Activity of a given type is received. |
OnAssignEntity |
Triggered to assign an entity to a property. |
OnBeginDialog |
Actions triggered when a dialog is started via BeginDialog(). |
OnCancelDialog |
Actions triggered when an dialog was canceled. |
OnChooseEntity |
Triggered to choose between different possible entity resolutions. |
OnChooseIntent |
Actions triggered when an Intent of "ChooseIntent" has been emitted by a Recognizer. |
OnChooseProperty |
Triggered to choose which property an entity goes to. |
OnCommandActivity |
Actions triggered when a Command activity is received. |
OnCommandResultActivity |
Actions triggered when a CommandResult activity is received. |
OnCondition |
Actions triggered when condition is true. |
OnContinueConversation |
Actions triggered when an EventActivity is received. |
OnConversationUpdateActivity |
Actions triggered when ConversationUpdateActivity is received. |
OnDialogEvent |
Actions triggered when a dialog event is emitted. |
OnEndOfActions |
Triggered when all actions and ambiguity events have been processed. |
OnEndOfConversationActivity |
Actions triggered when EndOfConversationActivity is received. |
OnError |
Actions triggered when an error event has been emitted. |
OnEventActivity |
Actions triggered when an EventActivity is received. |
OnHandoffActivity |
Actions triggered when a HandoffActivity is received. |
OnInstallationUpdateActivity |
Actions triggered when a InstallationUpdateActivity is received. |
OnIntent |
Actions triggered when an Activity has been received and the recognized intents and entities match specified list of intent and entity filters. |
OnInvokeActivity |
Actions triggered when an InvokeActivity is received. |
OnMessageActivity |
Actions triggered when an MessageActivity is received. |
OnMessageDeleteActivity |
Actions triggered when a MessageDeleteActivity is received. |
OnMessageReactionActivity |
Actions triggered when a MessageReactionActivity is received. |
OnMessageUpdateActivity |
Actions triggered when a MessageUpdateActivity is received. |
OnQnAMatch |
Actions triggered when a MessageUpdateActivity is received. |
OnRepromptDialog |
Actions triggered when an RepromptDialog event is emitted. |
OnTypingActivity |
Actions triggered when a TypingActivity is received. |
OnUnknownIntent |
Actions triggered when a UnknownIntent event has been emitted by the recognizer. |
ActivityTemplateConverter |
Activity template converter that implements Converter. |
DialogExpressionConverter |
Dialog expression converter that implements Converter. |
DialogListConverter |
Converter which allows json to be expression to object or static object. |
DialogSetConverter |
DialogSet converter that implements Converter. |
LanguageGeneratorConverter |
Language generator converter that implements Converter. |
MultiLanguageRecognizerConverter |
Language generator converter that implements Converter. |
RecognizerConverter |
Recognizer converter that implements Converter. |
RecognizerListConverter |
Recognizer list converter that implements Converter. |
TextTemplateConverter |
Text template converter that implements Converter. |
DynamicBeginDialogDeserializer |
Internal serializer for |
EntityAssignment |
Static methods for working with |
EntityAssignmentComparer |
Compare two entity assignments to determine their relative priority. |
EntityAssignments |
Tracks entity related events to surface. |
EntityInfo |
Extended information about an entity including $instance data. Extended information about an entity including $instance data. |
DialogExpression |
Represents a property which is either a Dialog or a string expression for a dialogId. |
HasPendingActionsFunction |
Defines hasPendingActions() expression function. The expression will return true if the current adaptive dialog has any pending actions. |
IsDialogActiveFunction |
Defines isDialogActive(id) expression function. This expression will return true if any of the dialog ids is on the dialog execution stack. Example isDialogActive('dialog1') Example isDialogActive('dialog1', 'dialog2', 'dialog3') |
LanguageGeneratorManager |
Class which manages cache of all LG resources from a ResourceExplorer. |
MultiLanguageGenerator |
LanguageGenerator which uses implements a map of locale->LanguageGenerator for the locale and has a policy which controls fallback (try en-us -> en -> default). |
MultiLanguageGeneratorBase |
Base class which applies language policy to tryGetGenerator. |
ResourceMultiLanguageGenerator |
Uses resourceExplorer to mount root lg and all language variants as a multi language generator. |
TemplateEngineLanguageGenerator |
LanguageGenerator implementation which uses LGFile. |
Ask |
Ask for an open-ended response.
This sends an activity and then terminates the turn with |
AttachmentInput |
Input dialog which prompts the user to send a file. |
ChoiceInput |
ChoiceInput - Declarative input to gather choices from user. |
ChoiceOptionsSet |
Sets the ChoiceFactoryOptions. |
ChoiceSet |
Defines ChoiceSet collection. |
ConfirmInput |
Declarative input control that will gather yes/no confirmation input from a set of choices. |
DateTimeInput |
Input dialog to collect a datetime from the user. |
InputDialog |
Defines input dialogs. |
NumberInput |
Input dialog for asking for numbers. |
OAuthInput |
OAuthInput prompts user to login. |
TextInput |
Declarative text input to gather text data from users. |
LanguageGenerationBotComponent |
ComponentRegistration class for language generation resources. |
LanguageGeneratorExtensions |
Extension methods for language generator. |
LanguagePolicy |
Language policy with fallback for each language as most specific to default en-us -> en -> default. |
LanguagePolicyConverter |
Language policy converter that implements |
LanguageResourceLoader |
Load all LG resource and split them into different language groups. |
PropertySchema |
Represents a property found in a JSON schema. |
AdaptiveRecognizer |
Base class for adaptive recognizers. |
CrossTrainedRecognizerSet |
Recognizer for selecting between cross trained recognizers. |
AgeEntityRecognizer |
Recognizes age input. |
ChannelMentionEntityRecognizer |
Recognizer which maps channel activity.entities of type mention into RecognizerResult format. |
ConfirmationEntityRecognizer |
Recognizes yes/no confirmation style input. |
CurrencyEntityRecognizer |
Recognizes currency input. |
DateTimeEntityRecognizer |
Recognizes DateTime input. |
DimensionEntityRecognizer |
Recognizes dimension input. |
EmailEntityRecognizer |
Recognizes email input. |
EntityRecognizer |
Entity recognizers base class. |
EntityRecognizerSet |
EntityRecognizerSet - Implements a workflow against a pool of EntityRecognizer instances, iterating until nobody has anything new to add. |
GuidEntityRecognizer |
Recognizes GUID input. |
HashtagEntityRecognizer |
Recognizes hashtag input. |
IpEntityRecognizer |
Recognizes IP input. |
MentionEntityRecognizer |
Recognizes mention input. |
NumberEntityRecognizer |
Recognizes number input. |
OrdinalEntityRecognizer |
Recognizes ordinal input. |
PercentageEntityRecognizer |
Recognizes percentage input. |
PhoneNumberEntityRecognizer |
Recognizes phone number input. |
RegexEntityRecognizer |
Matches input against a regular expression. |
TemperatureEntityRecognizer |
Recognizes temperature input. |
TextEntity |
Text entity base class. |
TextEntityRecognizer |
TextEntityRecognizer - base class for Text.Recogizers from the text recognizer library. |
UrlEntityRecognizer |
Recognizes URL input. |
IntentPattern |
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. |
MultiLanguageRecognizer |
Defines map of languages -> recognizer. |
RecognizerSet |
A recognizer class whose result is the union of results from multiple recognizers into one RecognizerResult. |
RegexRecognizer |
Recognizer implementation which uses regex expressions to identify intents. |
ValueRecognizer |
ValueRecognizer - Recognizer for mapping message activity. Value payload into intent/entities. |
ResourceExtensions |
Extension methods for resource explorer. |
SchemaHelper |
Helper class for dialog schema. |
ConditionalSelector |
Select between two rule selectors based on a condition. |
FirstSelector |
Select the first true rule implementation of TriggerSelector |
MostSpecificSelector |
Select the most specific true rule implementation of TriggerSelector. |
RandomSelector |
Select a random true rule implementation of TriggerSelector. |
TrueSelector |
Select all rules which evaluate to true. |
SkillExtensions |
Extension methods for skills. |
TelemetryLoggerConstants |
Defines names of common adaptive dialog events for use with a BotTelemetryClient object. |
ActivityTemplate |
Defines an activity template where the template expression is local aka "inline" and processed through registered language generator. |
StaticActivityTemplate |
Defines a static activity as a template. |
TextTemplate |
Defines a text template where the template expression is local aka "inline" and processed through registered language generator. |
TriggerSelector |
Select the trigger to execute in a given state. |
Interfaces
Type Aliases
Enums
ActionChangeType |
Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT License. |
ActionScopeCommands | |
ArrayChangeType | |
HttpMethod | |
ResponsesTypes | |
AttachmentOutputFormat | |
ChoiceOutputFormat | |
InputState |
Functions
evaluate |
Evaluate ValueExpression according the value type. |
replace |
Replaces the binding paths in a JSON value with the evaluated results recursively. |
use |
Extension methods for telemetry. Configures the telemetry client to use. |
Function Details
evaluateExpression(DialogStateManager, ValueExpression)
Evaluate ValueExpression according the value type.
function evaluateExpression(state: DialogStateManager, valExpr: ValueExpression): any
Parameters
- state
-
DialogStateManager
Input ValueExpression
- valExpr
-
ValueExpression
A scope for looking up variables.
Returns
any
Deep data binding result.
replaceJsonRecursively(DialogStateManager, object)
Replaces the binding paths in a JSON value with the evaluated results recursively.
function replaceJsonRecursively(state: DialogStateManager, unit: object): any
Parameters
- state
-
DialogStateManager
A scope for looking up variables.
- unit
-
object
An object.
Returns
any
Deep data binding result.
useTelemetry(DialogManager, BotTelemetryClient)
Extension methods for telemetry. Configures the telemetry client to use.
function useTelemetry(dialogManager: DialogManager, telemetryClient: BotTelemetryClient): DialogManager
Parameters
- dialogManager
-
DialogManager
DialogManager to configure.
- telemetryClient
-
BotTelemetryClient
BotTelemetryClient instance to use.
Returns
DialogManager
DialogManager.