{ "$schema": "https://raw.githubusercontent.com/microsoft/botbuilder-dotnet/master/schemas/component.schema", "$id": "sdk.schema", "type": "object", "title": "Component kinds", "description": "These are all of the kinds that can be created by the loader.", "oneOf": [ { "title": "Microsoft.ActivityTemplate", "description": "", "$ref": "#/definitions/Microsoft.ActivityTemplate" }, { "title": "Microsoft.AdaptiveCardRecognizer", "description": "Recognizer for detecting the value response from an Adaptive Card.", "$ref": "#/definitions/Microsoft.AdaptiveCardRecognizer" }, { "title": "Microsoft.AdaptiveDialog", "description": "Flexible, data driven dialog that can adapt to the conversation.", "$ref": "#/definitions/Microsoft.AdaptiveDialog" }, { "title": "Microsoft.SkillDialog", "description": "Begin a remote skill dialog.", "$ref": "#/definitions/Microsoft.SkillDialog" }, { "title": "Microsoft.AgeEntityRecognizer", "description": "Recognizer which recognizes age.", "$ref": "#/definitions/Microsoft.AgeEntityRecognizer" }, { "title": "Microsoft.Ask", "description": "This is an action which sends an activity to the user when a response is expected", "$ref": "#/definitions/Microsoft.Ask" }, { "title": "Microsoft.AttachmentInput", "description": "Collect information - Ask for a file or image.", "$ref": "#/definitions/Microsoft.AttachmentInput" }, { "title": "Microsoft.BeginDialog", "description": "Begin another dialog.", "$ref": "#/definitions/Microsoft.BeginDialog" }, { "title": "Microsoft.BreakLoop", "description": "Stop executing this loop", "$ref": "#/definitions/Microsoft.BreakLoop" }, { "title": "Microsoft.CancelAllDialogs", "description": "Cancel all active dialogs. All dialogs in the dialog chain will need a trigger to capture the event configured in this action.", "$ref": "#/definitions/Microsoft.CancelAllDialogs" }, { "title": "Microsoft.ChoiceInput", "description": "Collect information - Pick from a list of choices", "$ref": "#/definitions/Microsoft.ChoiceInput" }, { "title": "Microsoft.ConditionalSelector", "description": "Use a rule selector based on a condition", "$ref": "#/definitions/Microsoft.ConditionalSelector" }, { "title": "Microsoft.ConfirmInput", "description": "Collect information - Ask for confirmation (yes or no).", "$ref": "#/definitions/Microsoft.ConfirmInput" }, { "title": "Microsoft.ConfirmationEntityRecognizer", "description": "Recognizer which recognizes confirmation choices (yes/no).", "$ref": "#/definitions/Microsoft.ConfirmationEntityRecognizer" }, { "title": "Microsoft.ContinueLoop", "description": "Stop executing this template and continue with the next iteration of the loop.", "$ref": "#/definitions/Microsoft.ContinueLoop" }, { "title": "Microsoft.CrossTrainedRecognizerSet", "description": "Recognizer for selecting between cross trained recognizers.", "$ref": "#/definitions/Microsoft.CrossTrainedRecognizerSet" }, { "title": "Microsoft.CurrencyEntityRecognizer", "description": "Recognizer which recognizes currency.", "$ref": "#/definitions/Microsoft.CurrencyEntityRecognizer" }, { "title": "Microsoft.DateTimeEntityRecognizer", "description": "Recognizer which recognizes dates and time fragments.", "$ref": "#/definitions/Microsoft.DateTimeEntityRecognizer" }, { "title": "Microsoft.DateTimeInput", "description": "Collect information - Ask for date and/ or time", "$ref": "#/definitions/Microsoft.DateTimeInput" }, { "title": "Microsoft.DebugBreak", "description": "If debugger is attached, stop the execution at this point in the conversation.", "$ref": "#/definitions/Microsoft.DebugBreak" }, { "title": "Microsoft.DeleteActivity", "description": "Delete an activity that was previously sent.", "$ref": "#/definitions/Microsoft.DeleteActivity" }, { "title": "Microsoft.DeleteProperties", "description": "Delete multiple properties and any value it holds.", "$ref": "#/definitions/Microsoft.DeleteProperties" }, { "title": "Microsoft.DeleteProperty", "description": "Delete a property and any value it holds.", "$ref": "#/definitions/Microsoft.DeleteProperty" }, { "title": "Microsoft.DimensionEntityRecognizer", "description": "Recognizer which recognizes dimension.", "$ref": "#/definitions/Microsoft.DimensionEntityRecognizer" }, { "title": "Microsoft.EditActions", "description": "Edit the current list of actions.", "$ref": "#/definitions/Microsoft.EditActions" }, { "title": "Microsoft.EditArray", "description": "Modify an array in memory", "$ref": "#/definitions/Microsoft.EditArray" }, { "title": "Microsoft.EmailEntityRecognizer", "description": "Recognizer which recognizes email.", "$ref": "#/definitions/Microsoft.EmailEntityRecognizer" }, { "title": "Microsoft.EmitEvent", "description": "Emit an event. Capture this event with a trigger.", "$ref": "#/definitions/Microsoft.EmitEvent" }, { "title": "Microsoft.EndDialog", "description": "End this dialog.", "$ref": "#/definitions/Microsoft.EndDialog" }, { "title": "Microsoft.EndTurn", "description": "End the current turn without ending the dialog.", "$ref": "#/definitions/Microsoft.EndTurn" }, { "title": "Microsoft.FirstSelector", "description": "Selector for first true rule", "$ref": "#/definitions/Microsoft.FirstSelector" }, { "title": "Microsoft.Foreach", "description": "Execute actions on each item in an a collection.", "$ref": "#/definitions/Microsoft.Foreach" }, { "title": "Microsoft.ForeachPage", "description": "Execute actions on each page (collection of items) in an array.", "$ref": "#/definitions/Microsoft.ForeachPage" }, { "title": "Microsoft.GetActivityMembers", "description": "Get the members who are participating in an activity. (BotFrameworkAdapter only)", "$ref": "#/definitions/Microsoft.GetActivityMembers" }, { "title": "Microsoft.GetConversationMembers", "description": "Get the members who are participating in an conversation. (BotFrameworkAdapter only)", "$ref": "#/definitions/Microsoft.GetConversationMembers" }, { "title": "Microsoft.GotoAction", "description": "Go to an an action by id.", "$ref": "#/definitions/Microsoft.GotoAction" }, { "title": "Microsoft.GuidEntityRecognizer", "description": "Recognizer which recognizes guids.", "$ref": "#/definitions/Microsoft.GuidEntityRecognizer" }, { "title": "Microsoft.HashtagEntityRecognizer", "description": "Recognizer which recognizes Hashtags.", "$ref": "#/definitions/Microsoft.HashtagEntityRecognizer" }, { "title": "Microsoft.HttpRequest", "description": "Make a HTTP request.", "$ref": "#/definitions/Microsoft.HttpRequest" }, { "title": "Microsoft.IfCondition", "description": "Two-way branch the conversation flow based on a condition.", "$ref": "#/definitions/Microsoft.IfCondition" }, { "title": "Microsoft.IpEntityRecognizer", "description": "Recognizer which recognizes internet IP patterns (like 192.1.1.1).", "$ref": "#/definitions/Microsoft.IpEntityRecognizer" }, { "title": "Microsoft.LanguagePolicy", "description": "This represents a policy map for locales lookups to use for language", "$ref": "#/definitions/Microsoft.LanguagePolicy" }, { "title": "Microsoft.LogAction", "description": "Log a message to the host application. Send a TraceActivity to Bot Framework Emulator (optional).", "$ref": "#/definitions/Microsoft.LogAction" }, { "title": "Microsoft.LuisRecognizer", "description": "LUIS recognizer.", "$ref": "#/definitions/Microsoft.LuisRecognizer" }, { "title": "Microsoft.MentionEntityRecognizer", "description": "Recognizer which recognizes @Mentions", "$ref": "#/definitions/Microsoft.MentionEntityRecognizer" }, { "title": "Microsoft.MostSpecificSelector", "description": "Select most specific true events with optional additional selector", "$ref": "#/definitions/Microsoft.MostSpecificSelector" }, { "title": "Microsoft.MultiLanguageRecognizer", "description": "Configure one recognizer per language and the specify the language fallback policy.", "$ref": "#/definitions/Microsoft.MultiLanguageRecognizer" }, { "title": "Microsoft.NumberEntityRecognizer", "description": "Recognizer which recognizes numbers.", "$ref": "#/definitions/Microsoft.NumberEntityRecognizer" }, { "title": "Microsoft.NumberInput", "description": "Collect information - Ask for a number.", "$ref": "#/definitions/Microsoft.NumberInput" }, { "title": "Microsoft.NumberRangeEntityRecognizer", "description": "Recognizer which recognizes ranges of numbers (Example:2 to 5).", "$ref": "#/definitions/Microsoft.NumberRangeEntityRecognizer" }, { "title": "Microsoft.OAuthInput", "description": "Collect login information.", "$ref": "#/definitions/Microsoft.OAuthInput" }, { "title": "Microsoft.OnActivity", "description": "Actions to perform on receipt of a generic activity.", "$ref": "#/definitions/Microsoft.OnActivity" }, { "title": "Microsoft.OnAssignEntity", "description": "Actions to take when an entity should be assigned to a property.", "$ref": "#/definitions/Microsoft.OnAssignEntity" }, { "title": "Microsoft.OnBeginDialog", "description": "Actions to perform when this dialog begins.", "$ref": "#/definitions/Microsoft.OnBeginDialog" }, { "title": "Microsoft.OnCancelDialog", "description": "Actions to perform on cancel dialog event.", "$ref": "#/definitions/Microsoft.OnCancelDialog" }, { "title": "Microsoft.OnChooseEntity", "description": "Actions to be performed when an entity value needs to be resolved.", "$ref": "#/definitions/Microsoft.OnChooseEntity" }, { "title": "Microsoft.OnChooseIntent", "description": "Actions to perform on when an intent is ambigious.", "$ref": "#/definitions/Microsoft.OnChooseIntent" }, { "title": "Microsoft.OnChooseProperty", "description": "Actions to take when there are multiple possible mappings of entities to properties.", "$ref": "#/definitions/Microsoft.OnChooseProperty" }, { "title": "Microsoft.OnClearProperty", "description": "Actions to take when a property needs to be cleared.", "$ref": "#/definitions/Microsoft.OnClearProperty" }, { "title": "Microsoft.OnCondition", "description": "Actions to perform when specified condition is true.", "$ref": "#/definitions/Microsoft.OnCondition" }, { "title": "Microsoft.OnConversationUpdateActivity", "description": "Actions to perform on receipt of an activity with type 'ConversationUpdate'.", "$ref": "#/definitions/Microsoft.OnConversationUpdateActivity" }, { "title": "Microsoft.OnCustomEvent", "description": "Actions to perform when a custom event is detected. Use 'Emit a custom event' action to raise a custom event.", "$ref": "#/definitions/Microsoft.OnCustomEvent" }, { "title": "Microsoft.OnDialogEvent", "description": "Actions to perform when a specific dialog event occurs.", "$ref": "#/definitions/Microsoft.OnDialogEvent" }, { "title": "Microsoft.OnEndOfActions", "description": "Actions to take when there are no more actions in the current dialog.", "$ref": "#/definitions/Microsoft.OnEndOfActions" }, { "title": "Microsoft.OnEndOfConversationActivity", "description": "Actions to perform on receipt of an activity with type 'EndOfConversation'.", "$ref": "#/definitions/Microsoft.OnEndOfConversationActivity" }, { "title": "Microsoft.OnError", "description": "Action to perform when an 'Error' dialog event occurs.", "$ref": "#/definitions/Microsoft.OnError" }, { "title": "Microsoft.OnEventActivity", "description": "Actions to perform on receipt of an activity with type 'Event'.", "$ref": "#/definitions/Microsoft.OnEventActivity" }, { "title": "Microsoft.OnHandoffActivity", "description": "Actions to perform on receipt of an activity with type 'HandOff'.", "$ref": "#/definitions/Microsoft.OnHandoffActivity" }, { "title": "Microsoft.OnIntent", "description": "Actions to perform when specified intent is recognized.", "$ref": "#/definitions/Microsoft.OnIntent" }, { "title": "Microsoft.OnInvokeActivity", "description": "Actions to perform on receipt of an activity with type 'Invoke'.", "$ref": "#/definitions/Microsoft.OnInvokeActivity" }, { "title": "Microsoft.OnMessageActivity", "description": "Actions to perform on receipt of an activity with type 'Message'. Overrides Intent trigger.", "$ref": "#/definitions/Microsoft.OnMessageActivity" }, { "title": "Microsoft.OnMessageDeleteActivity", "description": "Actions to perform on receipt of an activity with type 'MessageDelete'.", "$ref": "#/definitions/Microsoft.OnMessageDeleteActivity" }, { "title": "Microsoft.OnMessageReactionActivity", "description": "Actions to perform on receipt of an activity with type 'MessageReaction'.", "$ref": "#/definitions/Microsoft.OnMessageReactionActivity" }, { "title": "Microsoft.OnMessageUpdateActivity", "description": "Actions to perform on receipt of an activity with type 'MessageUpdate'.", "$ref": "#/definitions/Microsoft.OnMessageUpdateActivity" }, { "title": "Microsoft.OnQnAMatch", "description": "Actions to perform on when an match from QnAMaker is found.", "$ref": "#/definitions/Microsoft.OnQnAMatch" }, { "title": "Microsoft.OnRepromptDialog", "description": "Actions to perform when 'RepromptDialog' event occurs.", "$ref": "#/definitions/Microsoft.OnRepromptDialog" }, { "title": "Microsoft.OnTypingActivity", "description": "Actions to perform on receipt of an activity with type 'Typing'.", "$ref": "#/definitions/Microsoft.OnTypingActivity" }, { "title": "Microsoft.OnUnknownIntent", "description": "Action to perform when user input is unrecognized and if none of the 'on intent recognition' triggers match recognized intent.", "$ref": "#/definitions/Microsoft.OnUnknownIntent" }, { "title": "Microsoft.OrdinalEntityRecognizer", "description": "Recognizer which recognizes ordinals (example: first, second, 3rd).", "$ref": "#/definitions/Microsoft.OrdinalEntityRecognizer" }, { "title": "Microsoft.PercentageEntityRecognizer", "description": "Recognizer which recognizes percentages.", "$ref": "#/definitions/Microsoft.PercentageEntityRecognizer" }, { "title": "Microsoft.PhoneNumberEntityRecognizer", "description": "Recognizer which recognizes phone numbers.", "$ref": "#/definitions/Microsoft.PhoneNumberEntityRecognizer" }, { "title": "Microsoft.QnAMakerDialog", "description": "Dialog which uses QnAMAker knowledge base to answer questions.", "$ref": "#/definitions/Microsoft.QnAMakerDialog" }, { "title": "Microsoft.QnAMakerRecognizer", "description": "Recognizer for generating QnAMatch intents from a KB.", "$ref": "#/definitions/Microsoft.QnAMakerRecognizer" }, { "title": "Microsoft.RandomSelector", "description": "Select most specific true rule", "$ref": "#/definitions/Microsoft.RandomSelector" }, { "title": "Microsoft.RecognizerSet", "description": "Creates the union of the intents and entities of the recognizers in the set.", "$ref": "#/definitions/Microsoft.RecognizerSet" }, { "title": "Microsoft.RegExEntityRecognizer", "description": "Recognizer which recognizes patterns of input based on regex.", "$ref": "#/definitions/Microsoft.RegExEntityRecognizer" }, { "title": "Microsoft.RegexRecognizer", "description": "Use regular expressions to recognize intents and entities from user input.", "$ref": "#/definitions/Microsoft.RegexRecognizer" }, { "title": "Microsoft.RepeatDialog", "description": "Repeat current dialog.", "$ref": "#/definitions/Microsoft.RepeatDialog" }, { "title": "Microsoft.ReplaceDialog", "description": "Replace current dialog with another dialog.", "$ref": "#/definitions/Microsoft.ReplaceDialog" }, { "title": "Microsoft.SendActivity", "description": "Respond with an activity.", "$ref": "#/definitions/Microsoft.SendActivity" }, { "title": "Microsoft.SetProperties", "description": "Set one or more property values.", "$ref": "#/definitions/Microsoft.SetProperties" }, { "title": "Microsoft.SetProperty", "description": "Set property to a value.", "$ref": "#/definitions/Microsoft.SetProperty" }, { "title": "Microsoft.SignOutUser", "description": "Sign a user out that was logged in previously using OAuthInput.", "$ref": "#/definitions/Microsoft.SignOutUser" }, { "title": "Microsoft.StaticActivityTemplate", "description": "This allows you to define a static Activity object", "$ref": "#/definitions/Microsoft.StaticActivityTemplate" }, { "title": "Microsoft.SwitchCondition", "description": "Execute different actions based on the value of a property.", "$ref": "#/definitions/Microsoft.SwitchCondition" }, { "title": "Microsoft.TemperatureEntityRecognizer", "description": "Recognizer which recognizes temperatures.", "$ref": "#/definitions/Microsoft.TemperatureEntityRecognizer" }, { "title": "Microsoft.Test.AssertCondition", "description": "Assert condition is true.", "$ref": "#/definitions/Microsoft.Test.AssertCondition" }, { "title": "Microsoft.Test.AssertReply", "description": "Asserts that a reply text is valid.", "$ref": "#/definitions/Microsoft.Test.AssertReply" }, { "title": "Microsoft.Test.AssertReplyActivity", "description": "Asserts that a reply activity is valid.", "$ref": "#/definitions/Microsoft.Test.AssertReplyActivity" }, { "title": "Microsoft.Test.AssertReplyOneOf", "description": "Asserts that a reply text is one of multiple optional responses.", "$ref": "#/definitions/Microsoft.Test.AssertReplyOneOf" }, { "title": "Microsoft.Test.Script", "description": "Defines a sequence of test actions to perform to validate the behavior of dialogs.", "$ref": "#/definitions/Microsoft.Test.Script" }, { "title": "Microsoft.Test.UserActivity", "description": "Sends activity to the bot.", "$ref": "#/definitions/Microsoft.Test.UserActivity" }, { "title": "Microsoft.Test.UserConversationUpdate", "description": "Sends ConversationUpdate activity to the bot.", "$ref": "#/definitions/Microsoft.Test.UserConversationUpdate" }, { "title": "Microsoft.Test.UserDelay", "description": "Delays text script for time period.", "$ref": "#/definitions/Microsoft.Test.UserDelay" }, { "title": "Microsoft.Test.UserSays", "description": "Sends text to the bot from the user.", "$ref": "#/definitions/Microsoft.Test.UserSays" }, { "title": "Microsoft.Test.UserTyping", "description": "Sends typing activity to the bot.", "$ref": "#/definitions/Microsoft.Test.UserTyping" }, { "title": "Microsoft.TextInput", "description": "Collection information - Ask for a word or sentence.", "$ref": "#/definitions/Microsoft.TextInput" }, { "title": "Microsoft.TextTemplate", "description": "Lg tempalte to evaluate to create text", "$ref": "#/definitions/Microsoft.TextTemplate" }, { "title": "Microsoft.TraceActivity", "description": "Send a trace activity to the transcript logger and/ or Bot Framework Emulator.", "$ref": "#/definitions/Microsoft.TraceActivity" }, { "title": "Microsoft.TrueSelector", "description": "Selector for all true events", "$ref": "#/definitions/Microsoft.TrueSelector" }, { "title": "Microsoft.UpdateActivity", "description": "Respond with an activity.", "$ref": "#/definitions/Microsoft.UpdateActivity" }, { "title": "Microsoft.UrlEntityRecognizer", "description": "Recognizer which recognizes urls (example: http://bing.com)", "$ref": "#/definitions/Microsoft.UrlEntityRecognizer" } ], "definitions": { "Microsoft.ActivityTemplate": { "$role": "implements(Microsoft.IActivityTemplate)", "title": "Microsoft ActivityTemplate", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.ActivityTemplate" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "template": { "title": "Template", "Description": "Language Generator template to use to create the activity", "type": "string" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "template", "$kind" ] } ] }, "Microsoft.AdaptiveCardRecognizer": { "$role": "implements(Microsoft.Recognizer)", "title": "Cross-trained Recognizer Set", "description": "Recognizer for detecting the value response from an Adaptive Card.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.AdaptiveCardRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional unique id using with RecognizerSet." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.AdaptiveDialog": { "$role": "implements(Microsoft.IDialog)", "title": "Adaptive Dialog", "description": "Flexible, data driven dialog that can adapt to the conversation.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.AdaptiveDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional dialog ID." }, "autoEndDialog": { "type": "boolean", "title": "Auto end dialog", "description": "If set to true the dialog will automatically end when there are no further actions. If set to false, remember to manually end the dialog using EndDialog action.", "default": "true" }, "defaultResultProperty": { "type": "string", "title": "Default result property", "description": "Value that will be passed back to the parent dialog.", "default": "dialog.result" }, "recognizer": { "$kind": "Microsoft.Recognizer", "title": "Recognizer", "description": "Input recognizer that interprets user input into intent and entities.", "$ref": "#/definitions/Microsoft.Recognizer" }, "generator": { "$kind": "Microsoft.ILanguageGenerator", "title": "Language Generator", "description": "Language generator that generates bot responses.", "$ref": "#/definitions/Microsoft.ILanguageGenerator" }, "selector": { "$kind": "Microsoft.ITriggerSelector", "title": "Selector", "description": "Policy to determine which trigger is executed. Defaults to a 'best match' selector (optional).", "$ref": "#/definitions/Microsoft.ITriggerSelector" }, "triggers": { "type": "array", "description": "List of triggers defined for this dialog.", "title": "Triggers", "items": { "$kind": "Microsoft.ITriggerCondition", "$ref": "#/definitions/Microsoft.ITriggerCondition" } }, "schema": { "anyOf": [ { "title": "The schema to be filled in.", "type": "object", "additionalProperties": true }, { "type": "string", "title": "Reference to JSON schema", "description": "Reference to JSON schema .dialog file." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.SkillDialog": { "$role": "implements(Microsoft.IDialog)", "title": "Begin a skill dialog", "description": "Begin a remote skill dialog.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.SkillDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the skill dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "activityProcessed": { "$role": "expression", "title": "Activity Processed", "description": "When set to false, the dialog that is called can process the current activity.", "oneOf": [ { "type": "boolean", "default": true, "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "resultProperty": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to store any value returned by the dialog that is called.", "examples": [ "dialog.userName" ] }, "botId": { "$role": "expression", "type": "string", "title": "Skill host bot ID", "description": "The Microsoft App ID that will be calling the skill.", "default": "=settings.MicrosoftAppId" }, "skillHostEndpoint": { "$role": "expression", "type": "string", "title": "Skill host", "description": "The callback Url for the skill host.", "default": "=settings.skillHostEndpoint", "examples": [ "https://mybot.contoso.com/api/skills/" ] }, "skillAppId": { "$role": "expression", "type": "string", "title": "Skill App ID", "description": "The Microsoft App ID for the skill." }, "skillEndpoint": { "$role": "expression", "type": "string", "title": "Skill endpoint ", "description": "The /api/messages endpoint for the skill.", "examples": [ "https://myskill.contoso.com/api/messages/" ] }, "activity": { "$kind": "Microsoft.IActivityTemplate", "title": "Activity", "description": "The activity to send to the skill.", "$ref": "#/definitions/Microsoft.IActivityTemplate" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.AgeEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Age Entity Recognizer", "description": "Recognizer which recognizes age.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.AgeEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.Ask": { "$role": "implements(Microsoft.IDialog)", "title": "Send Activity to Ask a question", "description": "This is an action which sends an activity to the user when a response is expected", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Ask" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "activity": { "$kind": "Microsoft.IActivityTemplate", "title": "Activity", "description": "Activity to send.", "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "expectedProperties": { "$role": "expression", "title": "Expected Properties", "description": "Properties expected to be filled by entities from the user", "oneOf": [ { "type": "array", "items": { "type": "string", "title": "string" }, "title": "array" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to array." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.AttachmentInput": { "$role": "implements(Microsoft.IDialog)", "title": "Attachment input dialog", "description": "Collect information - Ask for a file or image.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.AttachmentInput" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ] }, "prompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Initial prompt", "description": "Message to send to collect information.", "examples": [ "What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "unrecognizedPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Unrecognized prompt", "description": "Message to send when the recognizer does not understand the user input.", "examples": [ "Sorry, I do not understand '{turn.activity.text'}. Let's try again. What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "invalidPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Invalid prompt", "description": "Message to send when the user input does not meet any validation expression.", "examples": [ "Sorry, '{this.value}' does not work. I need a number between 1-150. What is your age?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "defaultValueResponse": { "$kind": "Microsoft.IActivityTemplate", "title": "Default value response", "description": "Message to send when max turn count (if specified) has been exceeded and the default value is selected as the value.", "examples": [ "Sorry, I'm having trouble understanding you. I will just use {this.options.defaultValue} for now. You can say 'I'm 36 years old' to change it." ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "maxTurnCount": { "$role": "expression", "type": [ "integer", "string" ], "title": "Max turn count", "description": "Maximum number of re-prompt attempts to collect information.", "default": 3, "examples": [ 3 ] }, "validations": { "type": "array", "title": "Validation expressions", "description": "Expression to validate user input.", "examples": [ "int(this.value) > 1 && int(this.value) <= 150", "count(this.value) < 300" ], "items": { "$role": "expression", "type": "string" } }, "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to store collected information. Input will be skipped if property has value (unless 'Always prompt' is true).", "examples": [ "$birthday", "user.name", "conversation.issueTitle", "dialog.favColor" ] }, "defaultValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Default value", "description": "'Property' will be set to the value of this expression when max turn count is exceeded.", "examples": [ "@userName", "coalesce(@number, @partySize)" ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "'Property' will be set to the value of this expression unless it evaluates to null.", "examples": [ "@userName" ] }, "alwaysPrompt": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Always prompt", "description": "Collect information even if the specified 'property' is not empty.", "default": false, "examples": [ false ] }, "allowInterruptions": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Allow Interruptions", "description": "A boolean expression that determines whether the parent should be allowed to interrupt the input.", "default": "true", "examples": [ "true" ] }, "outputFormat": { "$role": "expression", "type": "string", "enum": [ "all", "first" ], "title": "Output format", "description": "Attachment output format.", "default": "first" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.BeginDialog": { "$role": "implements(Microsoft.IDialog)", "title": "Begin a dialog", "description": "Begin another dialog.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.BeginDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "dialog": { "$role": "expression", "title": "Dialog name", "description": "Name of the dialog to call.", "examples": [ "AddToDoDialog" ], "oneOf": [ { "$kind": "Microsoft.IDialog", "type": "object", "title": "object", "$ref": "#/definitions/Microsoft.IDialog" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to object." } ] }, "options": { "$role": "expression", "title": "Options", "description": "One or more options that are passed to the dialog that is called.", "oneOf": [ { "type": "object", "additionalProperties": { "type": "string", "title": "Options" }, "title": "object" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to object." } ] }, "activityProcessed": { "$role": "expression", "title": "Activity Processed", "description": "When set to false, the dialog that is called can process the current activity.", "oneOf": [ { "type": "boolean", "default": true, "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "resultProperty": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to store any value returned by the dialog that is called.", "examples": [ "dialog.userName" ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.BreakLoop": { "$role": "implements(Microsoft.IDialog)", "title": "Break Loop", "description": "Stop executing this loop", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.BreakLoop" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.CancelAllDialogs": { "$role": "implements(Microsoft.IDialog)", "title": "Cancel all dialogs", "description": "Cancel all active dialogs. All dialogs in the dialog chain will need a trigger to capture the event configured in this action.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.CancelAllDialogs" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "eventName": { "$role": "expression", "type": "string", "title": "Event name", "description": "Name of the event to emit." }, "eventValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Event value", "description": "Value to emit with the event (optional).", "additionalProperties": true } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.ChoiceInput": { "$role": "implements(Microsoft.IDialog)", "title": "Choice input dialog", "description": "Collect information - Pick from a list of choices", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.ChoiceInput" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ] }, "prompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Initial prompt", "description": "Message to send to collect information.", "examples": [ "What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "unrecognizedPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Unrecognized prompt", "description": "Message to send when the recognizer does not understand the user input.", "examples": [ "Sorry, I do not understand '{turn.activity.text'}. Let's try again. What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "invalidPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Invalid prompt", "description": "Message to send when the user input does not meet any validation expression.", "examples": [ "Sorry, '{this.value}' does not work. I need a number between 1-150. What is your age?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "defaultValueResponse": { "$kind": "Microsoft.IActivityTemplate", "title": "Default value response", "description": "Message to send when max turn count (if specified) has been exceeded and the default value is selected as the value.", "examples": [ "Sorry, I'm having trouble understanding you. I will just use {this.options.defaultValue} for now. You can say 'I'm 36 years old' to change it." ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "maxTurnCount": { "$role": "expression", "type": [ "integer", "string" ], "title": "Max turn count", "description": "Maximum number of re-prompt attempts to collect information.", "default": 3, "examples": [ 3 ] }, "validations": { "type": "array", "title": "Validation expressions", "description": "Expression to validate user input.", "examples": [ "int(this.value) > 1 && int(this.value) <= 150", "count(this.value) < 300" ], "items": { "$role": "expression", "type": "string" } }, "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to store collected information. Input will be skipped if property has value (unless 'Always prompt' is true).", "examples": [ "$birthday", "user.name", "conversation.issueTitle", "dialog.favColor" ] }, "defaultValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Default value", "description": "'Property' will be set to the value of this expression when max turn count is exceeded.", "examples": [ "@userName", "coalesce(@number, @partySize)" ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "'Property' will be set to the value of this expression unless it evaluates to null.", "examples": [ "@userName" ] }, "alwaysPrompt": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Always prompt", "description": "Collect information even if the specified 'property' is not empty.", "default": false, "examples": [ false ] }, "allowInterruptions": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Allow Interruptions", "description": "A boolean expression that determines whether the parent should be allowed to interrupt the input.", "default": "true", "examples": [ "true" ] }, "outputFormat": { "$role": "expression", "type": "string", "enum": [ "value", "index" ], "title": "Output format", "description": "Choice output format.", "default": "value" }, "choices": { "$role": "expression", "oneOf": [ { "type": "array", "items": [ { "type": "string", "title": "string" } ], "title": "array" }, { "type": "array", "items": [ { "title": "Choice", "type": "object", "properties": { "value": { "type": "string", "title": "Value", "description": "Value to return when this choice is selected." }, "action": { "type": "object", "title": "Action", "description": "Card action for the choice." }, "synonyms": { "type": "array", "title": "Synonyms", "description": "List of synonyms to recognize in addition to the value (optional).", "items": { "type": "string", "title": "string" } } } } ], "title": "array" }, { "type": "string", "title": "Expression" } ] }, "appendChoices": { "type": "boolean", "title": "Append choices", "description": "Compose an output activity containing a set of choices", "default": "true" }, "defaultLocale": { "type": "string", "title": "Default locale", "description": "Default locale.", "default": "en-us" }, "style": { "type": "string", "enum": [ "None", "Auto", "Inline", "List", "SuggestedAction", "HeroCard" ], "title": "List style", "description": "Style to render choices.", "default": "Auto" }, "choiceOptions": { "type": "object", "properties": { "inlineSeparator": { "type": "string", "title": "Inline separator", "description": "Character used to separate individual choices when there are more than 2 choices", "default": ", " }, "inlineOr": { "type": "string", "title": "Inline or", "description": "Separator inserted between the choices when there are only 2 choices", "default": " or " }, "inlineOrMore": { "type": "string", "title": "Inline or more", "description": "Separator inserted between the last 2 choices when their are more than 2 choices.", "default": ", or " }, "includeNumbers": { "type": "boolean", "title": "Include numbers", "description": "If true, 'inline' and 'list' list style will be prefixed with the index of the choice.", "default": true } } }, "recognizerOptions": { "type": "object", "properties": { "noValue": { "type": "boolean", "title": "No value", "description": "If true, the choices value field will NOT be search over", "default": false }, "noAction": { "type": "boolean", "title": "No action", "description": "If true, the the choices action.title field will NOT be searched over", "default": false } } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.ConditionalSelector": { "$role": "implements(Microsoft.ITriggerSelector)", "title": "Condtional Trigger Selector", "description": "Use a rule selector based on a condition", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.ConditionalSelector" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "ifTrue": { "$kind": "Microsoft.ITriggerSelector", "$ref": "#/definitions/Microsoft.ITriggerSelector" }, "ifFalse": { "$kind": "Microsoft.ITriggerSelector", "$ref": "#/definitions/Microsoft.ITriggerSelector" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "condition", "ifTrue", "ifFalse", "$kind" ] } ] }, "Microsoft.ConfirmInput": { "$role": "implements(Microsoft.IDialog)", "title": "Confirm input dialog", "description": "Collect information - Ask for confirmation (yes or no).", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.ConfirmInput" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ] }, "prompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Initial prompt", "description": "Message to send to collect information.", "examples": [ "What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "unrecognizedPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Unrecognized prompt", "description": "Message to send when the recognizer does not understand the user input.", "examples": [ "Sorry, I do not understand '{turn.activity.text'}. Let's try again. What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "invalidPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Invalid prompt", "description": "Message to send when the user input does not meet any validation expression.", "examples": [ "Sorry, '{this.value}' does not work. I need a number between 1-150. What is your age?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "defaultValueResponse": { "$kind": "Microsoft.IActivityTemplate", "title": "Default value response", "description": "Message to send when max turn count (if specified) has been exceeded and the default value is selected as the value.", "examples": [ "Sorry, I'm having trouble understanding you. I will just use {this.options.defaultValue} for now. You can say 'I'm 36 years old' to change it." ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "maxTurnCount": { "$role": "expression", "type": [ "integer", "string" ], "title": "Max turn count", "description": "Maximum number of re-prompt attempts to collect information.", "default": 3, "examples": [ 3 ] }, "validations": { "type": "array", "title": "Validation expressions", "description": "Expression to validate user input.", "examples": [ "int(this.value) > 1 && int(this.value) <= 150", "count(this.value) < 300" ], "items": { "$role": "expression", "type": "string" } }, "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to store collected information. Input will be skipped if property has value (unless 'Always prompt' is true).", "examples": [ "$birthday", "user.name", "conversation.issueTitle", "dialog.favColor" ] }, "defaultValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Default value", "description": "'Property' will be set to the value of this expression when max turn count is exceeded.", "examples": [ "@userName", "coalesce(@number, @partySize)" ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "'Property' will be set to the value of this expression unless it evaluates to null.", "examples": [ "@userName" ] }, "alwaysPrompt": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Always prompt", "description": "Collect information even if the specified 'property' is not empty.", "default": false, "examples": [ false ] }, "allowInterruptions": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Allow Interruptions", "description": "A boolean expression that determines whether the parent should be allowed to interrupt the input.", "default": "true", "examples": [ "true" ] }, "outputFormat": { "$role": "expression", "type": "string", "title": "Output format", "description": "Expression to format the confirm output.", "examples": [ "=concat('confirmation:', this.value)" ] }, "defaultLocale": { "$role": "expression", "type": "string", "title": "Default locale", "description": "Default locale.", "default": "en-us" }, "style": { "$role": "expression", "type": "string", "enum": [ "None", "Auto", "Inline", "List", "SuggestedAction", "HeroCard" ], "title": "List style", "description": "Style to render choices.", "default": "Auto" }, "choiceOptions": { "$role": "expression", "oneOf": [ { "type": "object", "properties": { "inlineSeparator": { "type": "string", "title": "Inline separator", "description": "Character used to separate individual choices when there are more than 2 choices", "default": ", " }, "inlineOr": { "type": "string", "title": "Inline or", "description": "Separator inserted between the choices when their are only 2 choices", "default": " or " }, "inlineOrMore": { "type": "string", "title": "Inline or more", "description": "Separator inserted between the last 2 choices when their are more than 2 choices.", "default": ", or " }, "includeNumbers": { "type": "boolean", "title": "Include numbers", "description": "If true, inline and list style choices will be prefixed with the index of the choice.", "default": true } }, "title": "object" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to object." } ] }, "confirmChoices": { "$role": "expression", "oneOf": [ { "type": "array", "items": [ { "type": "object", "properties": { "value": { "type": "string", "title": "Value", "description": "Value to return when this choice is selected." }, "action": { "type": "object", "title": "Action", "description": "Card action for the choice" }, "synonyms": { "type": "array", "title": "Synonyms", "description": "List of synonyms to recognize in addition to the value (optional)", "items": { "type": "string", "title": "string" } } }, "title": "object" } ], "title": "array" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to array." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.ConfirmationEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Confirmation Entity Recognizer", "description": "Recognizer which recognizes confirmation choices (yes/no).", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.ConfirmationEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.ContinueLoop": { "$role": "implements(Microsoft.IDialog)", "title": "Continune Loop", "description": "Stop executing this template and continue with the next iteration of the loop.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.ContinueLoop" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.CrossTrainedRecognizerSet": { "$role": "implements(Microsoft.Recognizer)", "title": "Cross-trained Recognizer Set", "description": "Recognizer for selecting between cross trained recognizers.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.CrossTrainedRecognizerSet" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional unique id using with RecognizerSet." }, "recognizers": { "type": "array", "title": "Recognizers", "description": "List of Recognizers defined for this set.", "items": { "$kind": "Microsoft.Recognizer", "$ref": "#/definitions/Microsoft.Recognizer" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "recognizers", "$kind" ] } ] }, "Microsoft.CurrencyEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Currency Entity Recognizer", "description": "Recognizer which recognizes currency.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.CurrencyEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.DateTimeEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "DateTime Entity Recognizer", "description": "Recognizer which recognizes dates and time fragments.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.DateTimeEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.DateTimeInput": { "$role": "implements(Microsoft.IDialog)", "title": "Date/time input dialog", "description": "Collect information - Ask for date and/ or time", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.DateTimeInput" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ] }, "prompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Initial prompt", "description": "Message to send to collect information.", "examples": [ "What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "unrecognizedPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Unrecognized prompt", "description": "Message to send when the recognizer does not understand the user input.", "examples": [ "Sorry, I do not understand '{turn.activity.text'}. Let's try again. What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "invalidPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Invalid prompt", "description": "Message to send when the user input does not meet any validation expression.", "examples": [ "Sorry, '{this.value}' does not work. I need a number between 1-150. What is your age?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "defaultValueResponse": { "$kind": "Microsoft.IActivityTemplate", "title": "Default value response", "description": "Message to send when max turn count (if specified) has been exceeded and the default value is selected as the value.", "examples": [ "Sorry, I'm having trouble understanding you. I will just use {this.options.defaultValue} for now. You can say 'I'm 36 years old' to change it." ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "maxTurnCount": { "$role": "expression", "type": [ "integer", "string" ], "title": "Max turn count", "description": "Maximum number of re-prompt attempts to collect information.", "default": 3, "examples": [ 3 ] }, "validations": { "type": "array", "title": "Validation expressions", "description": "Expression to validate user input.", "examples": [ "int(this.value) > 1 && int(this.value) <= 150", "count(this.value) < 300" ], "items": { "$role": "expression", "type": "string" } }, "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to store collected information. Input will be skipped if property has value (unless 'Always prompt' is true).", "examples": [ "$birthday", "user.name", "conversation.issueTitle", "dialog.favColor" ] }, "defaultValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Default value", "description": "'Property' will be set to the value of this expression when max turn count is exceeded.", "examples": [ "@userName", "coalesce(@number, @partySize)" ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "'Property' will be set to the value of this expression unless it evaluates to null.", "examples": [ "@userName" ] }, "alwaysPrompt": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Always prompt", "description": "Collect information even if the specified 'property' is not empty.", "default": false, "examples": [ false ] }, "allowInterruptions": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Allow Interruptions", "description": "A boolean expression that determines whether the parent should be allowed to interrupt the input.", "default": "true", "examples": [ "true" ] }, "outputFormat": { "$role": "expression", "type": "string", "title": "Output format", "description": "Expression to format the datetime output.", "examples": [ "this.value[0].Value" ] }, "defaultLocale": { "$role": "expression", "type": "string", "title": "Default locale", "description": "Default locale.", "default": "en-us" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.DebugBreak": { "$role": "implements(Microsoft.IDialog)", "title": "Debugger break", "description": "If debugger is attached, stop the execution at this point in the conversation.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.DebugBreak" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.DeleteActivity": { "$role": "implements(Microsoft.IDialog)", "title": "Delete Activity", "description": "Delete an activity that was previously sent.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.DeleteActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "activityId": { "$role": "expression", "type": "string", "title": "ActivityId", "description": "expression to an activityId to delete", "examples": [ "=$lastActivity" ] }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "property", "value", "$kind" ] } ] }, "Microsoft.DeleteProperties": { "$role": "implements(Microsoft.IDialog)", "title": "Delete Properties", "description": "Delete multiple properties and any value it holds.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.DeleteProperties" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "properties": { "type": "array", "title": "Properties", "description": "Properties to delete.", "items": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to delete." } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "properties", "$kind" ] } ] }, "Microsoft.DeleteProperty": { "$role": "implements(Microsoft.IDialog)", "title": "Delete Property", "description": "Delete a property and any value it holds.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.DeleteProperty" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to delete." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "property", "$kind" ] } ] }, "Microsoft.DimensionEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Dimension Entity Recognizer", "description": "Recognizer which recognizes dimension.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.DimensionEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.EditActions": { "$role": "implements(Microsoft.IDialog)", "title": "Edit actions.", "description": "Edit the current list of actions.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.EditActions" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "changeType": { "$role": "expression", "type": "string", "title": "Type of change", "description": "Type of change to apply to the current actions.", "enum": [ "insertActions", "insertActionsBeforeTags", "appendActions", "endSequence", "replaceSequence" ] }, "actions": { "type": "array", "title": "Actions", "description": "Actions to apply.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "changeType", "actions", "$kind" ] } ] }, "Microsoft.EditArray": { "$role": "implements(Microsoft.IDialog)", "title": "Edit array", "description": "Modify an array in memory", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.EditArray" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "changeType": { "$role": "expression", "type": "string", "title": "Type of change", "description": "Type of change to the array in memory.", "enum": [ "push", "pop", "take", "remove", "clear" ] }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "itemsProperty": { "$role": "expression", "type": "string", "title": "Items property", "description": "Property that holds the array to update." }, "resultProperty": { "$role": "expression", "type": "string", "title": "Result Property", "description": "Property to store the result of this action." }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "New value or expression.", "examples": [ "'milk'", "dialog.favColor", "dialog.favColor == 'red'" ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "changeType", "itemsProperty", "$kind" ] } ] }, "Microsoft.EmailEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Email Entity Recognizer", "description": "Recognizer which recognizes email.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.EmailEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.EmitEvent": { "$role": "implements(Microsoft.IDialog)", "title": "Emit a custom event", "description": "Emit an event. Capture this event with a trigger.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.EmitEvent" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "eventName": { "$role": "expression", "type": "string", "title": "Event name", "description": "Name of the event to emit.", "enum": [ "beginDialog", "resumeDialog", "repromptDialog", "cancelDialog", "endDialog", "activityReceived", "recognizedIntent", "unknownIntent", "actionsStarted", "actionsSaved", "actionsEnded", "actionsResumed" ] }, "eventValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Event value", "description": "Value to emit with the event (optional)." }, "bubbleEvent": { "$role": "expression", "title": "Bubble event", "description": "If true this event is passed on to parent dialogs.", "oneOf": [ { "type": "boolean", "default": false, "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "eventName", "$kind" ] } ] }, "Microsoft.EndDialog": { "$role": "implements(Microsoft.IDialog)", "title": "End dialog", "description": "End this dialog.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.EndDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "Result value returned to the parent dialog.", "examples": [ "=dialog.userName", "='tomato'" ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.EndTurn": { "$role": "implements(Microsoft.IDialog)", "title": "End turn", "description": "End the current turn without ending the dialog.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.EndTurn" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.EntityRecognizers": { "$role": "interface", "title": "Entity Recognizers", "description": "Union of components which derive from EntityRecognizer abstract class.", "type": "object", "oneOf": [ { "title": "Microsoft.AgeEntityRecognizer", "description": "Recognizer which recognizes age.", "$ref": "#/definitions/Microsoft.AgeEntityRecognizer" }, { "title": "Microsoft.ConfirmationEntityRecognizer", "description": "Recognizer which recognizes confirmation choices (yes/no).", "$ref": "#/definitions/Microsoft.ConfirmationEntityRecognizer" }, { "title": "Microsoft.CurrencyEntityRecognizer", "description": "Recognizer which recognizes currency.", "$ref": "#/definitions/Microsoft.CurrencyEntityRecognizer" }, { "title": "Microsoft.DateTimeEntityRecognizer", "description": "Recognizer which recognizes dates and time fragments.", "$ref": "#/definitions/Microsoft.DateTimeEntityRecognizer" }, { "title": "Microsoft.DimensionEntityRecognizer", "description": "Recognizer which recognizes dimension.", "$ref": "#/definitions/Microsoft.DimensionEntityRecognizer" }, { "title": "Microsoft.EmailEntityRecognizer", "description": "Recognizer which recognizes email.", "$ref": "#/definitions/Microsoft.EmailEntityRecognizer" }, { "title": "Microsoft.GuidEntityRecognizer", "description": "Recognizer which recognizes guids.", "$ref": "#/definitions/Microsoft.GuidEntityRecognizer" }, { "title": "Microsoft.HashtagEntityRecognizer", "description": "Recognizer which recognizes Hashtags.", "$ref": "#/definitions/Microsoft.HashtagEntityRecognizer" }, { "title": "Microsoft.IpEntityRecognizer", "description": "Recognizer which recognizes internet IP patterns (like 192.1.1.1).", "$ref": "#/definitions/Microsoft.IpEntityRecognizer" }, { "title": "Microsoft.MentionEntityRecognizer", "description": "Recognizer which recognizes @Mentions", "$ref": "#/definitions/Microsoft.MentionEntityRecognizer" }, { "title": "Microsoft.NumberEntityRecognizer", "description": "Recognizer which recognizes numbers.", "$ref": "#/definitions/Microsoft.NumberEntityRecognizer" }, { "title": "Microsoft.NumberRangeEntityRecognizer", "description": "Recognizer which recognizes ranges of numbers (Example:2 to 5).", "$ref": "#/definitions/Microsoft.NumberRangeEntityRecognizer" }, { "title": "Microsoft.OrdinalEntityRecognizer", "description": "Recognizer which recognizes ordinals (example: first, second, 3rd).", "$ref": "#/definitions/Microsoft.OrdinalEntityRecognizer" }, { "title": "Microsoft.PercentageEntityRecognizer", "description": "Recognizer which recognizes percentages.", "$ref": "#/definitions/Microsoft.PercentageEntityRecognizer" }, { "title": "Microsoft.PhoneNumberEntityRecognizer", "description": "Recognizer which recognizes phone numbers.", "$ref": "#/definitions/Microsoft.PhoneNumberEntityRecognizer" }, { "title": "Microsoft.RegExEntityRecognizer", "description": "Recognizer which recognizes patterns of input based on regex.", "$ref": "#/definitions/Microsoft.RegExEntityRecognizer" }, { "title": "Microsoft.TemperatureEntityRecognizer", "description": "Recognizer which recognizes temperatures.", "$ref": "#/definitions/Microsoft.TemperatureEntityRecognizer" }, { "title": "Microsoft.UrlEntityRecognizer", "description": "Recognizer which recognizes urls (example: http://bing.com)", "$ref": "#/definitions/Microsoft.UrlEntityRecognizer" }, { "type": "string", "title": "Reference to Microsoft.EntityRecognizers", "description": "Reference to Microsoft.EntityRecognizers .dialog file." } ] }, "Microsoft.FirstSelector": { "$role": "implements(Microsoft.ITriggerSelector)", "title": "First Trigger Selector", "description": "Selector for first true rule", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.FirstSelector" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.Foreach": { "$role": "implements(Microsoft.IDialog)", "title": "For each item", "description": "Execute actions on each item in an a collection.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Foreach" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "itemsProperty": { "$role": "expression", "type": "string", "title": "Items property", "description": "Property that holds the array.", "examples": [ "user.todoList" ] }, "actions": { "type": "array", "title": "Actions", "description": "Actions to execute for each item. Use '$foreach.value' to access the value of each item. Use '$foreach.index' to access the index of each item.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "itemsProperty", "actions", "$kind" ] } ] }, "Microsoft.ForeachPage": { "$role": "implements(Microsoft.IDialog)", "title": "For each page", "description": "Execute actions on each page (collection of items) in an array.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.ForeachPage" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "itemsProperty": { "$role": "expression", "type": "string", "title": "Items property", "description": "Property that holds the array.", "examples": [ "user.todoList" ] }, "actions": { "type": "array", "title": "Actions", "description": "Actions to execute for each page. Use '$foreach.page' to access each page.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "pageSize": { "$role": "expression", "title": "Page size", "description": "Number of items in each page.", "oneOf": [ { "type": "integer", "default": 10, "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "itemsProperty", "actions", "$kind" ] } ] }, "Microsoft.GetActivityMembers": { "$role": "implements(Microsoft.IDialog)", "title": "Get Activity Members", "description": "Get the members who are participating in an activity. (BotFrameworkAdapter only)", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.GetActivityMembers" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "activityId": { "$role": "expression", "type": "string", "title": "ActivityId", "description": "expression to an activityId to get the members. If none is defined then the current activity id will be used.", "examples": [ "$lastActivity" ] }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.GetConversationMembers": { "$role": "implements(Microsoft.IDialog)", "title": "Get Converation Members", "description": "Get the members who are participating in an conversation. (BotFrameworkAdapter only)", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.GetConversationMembers" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.GotoAction": { "$role": "implements(Microsoft.IDialog)", "title": "Go to Action", "description": "Go to an an action by id.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.GotoAction" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actionId": { "$role": "expression", "type": "string", "title": "Action Id", "description": "Action Id to execute next" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actionId", "$kind" ] } ] }, "Microsoft.GuidEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Guid Entity Recognizer", "description": "Recognizer which recognizes guids.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.GuidEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.HashtagEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Hashtag Entity Recognizer", "description": "Recognizer which recognizes Hashtags.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.HashtagEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.HttpRequest": { "$role": "implements(Microsoft.IDialog)", "type": "object", "title": "HTTP request", "description": "Make a HTTP request.", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.HttpRequest" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "method": { "type": "string", "title": "HTTP method", "description": "HTTP method to use.", "enum": [ "GET", "POST", "PATCH", "PUT", "DELETE" ], "examples": [ "GET", "POST" ] }, "url": { "$role": "expression", "type": "string", "title": "Url", "description": "URL to call (supports data binding).", "examples": [ "https://contoso.com" ] }, "body": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Body", "description": "Body to include in the HTTP call (supports data binding).", "additionalProperties": true }, "resultProperty": { "$role": "expression", "type": "string", "title": "Result property", "description": "Property to store the result of this action. The result includes 4 properties from the http response: statusCode, reasonPhrase, content and headers. If the content is json it will be a deserialized object.", "examples": [ "dialog.contosodata" ] }, "contentType": { "$role": "expression", "type": "string", "title": "Content type", "description": "Content media type for the body.", "examples": [ "application/json", "text/plain" ] }, "headers": { "type": "object", "title": "Headers", "description": "One or more headers to include in the request (supports data binding).", "additionalProperties": { "$role": "expression", "type": "string" } }, "responseType": { "$role": "expression", "type": "string", "title": "Response type", "description": "Defines the type of HTTP response. Automatically calls the 'Send a response' action if set to 'Activity' or 'Activities'.", "enum": [ "None", "Json", "Activity", "Activities" ], "default": "Json" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "url", "method", "$kind" ] } ] }, "Microsoft.IActivityTemplate": { "title": "Microsoft ActivityTemplates", "description": "Components which are IActivityTemplates", "$role": "interface", "oneOf": [ { "title": "Microsoft.ActivityTemplate", "description": "", "$ref": "#/definitions/Microsoft.ActivityTemplate" }, { "title": "Microsoft.StaticActivityTemplate", "description": "This allows you to define a static Activity object", "$ref": "#/definitions/Microsoft.StaticActivityTemplate" }, { "type": "string", "title": "string" } ] }, "Microsoft.IDialog": { "title": "Microsoft Dialogs", "description": "Union of components which implement the Dialog contract", "$role": "interface", "oneOf": [ { "title": "Microsoft.AdaptiveDialog", "description": "Flexible, data driven dialog that can adapt to the conversation.", "$ref": "#/definitions/Microsoft.AdaptiveDialog" }, { "title": "Microsoft.SkillDialog", "description": "Begin a remote skill dialog.", "$ref": "#/definitions/Microsoft.SkillDialog" }, { "title": "Microsoft.Ask", "description": "This is an action which sends an activity to the user when a response is expected", "$ref": "#/definitions/Microsoft.Ask" }, { "title": "Microsoft.AttachmentInput", "description": "Collect information - Ask for a file or image.", "$ref": "#/definitions/Microsoft.AttachmentInput" }, { "title": "Microsoft.BeginDialog", "description": "Begin another dialog.", "$ref": "#/definitions/Microsoft.BeginDialog" }, { "title": "Microsoft.BreakLoop", "description": "Stop executing this loop", "$ref": "#/definitions/Microsoft.BreakLoop" }, { "title": "Microsoft.CancelAllDialogs", "description": "Cancel all active dialogs. All dialogs in the dialog chain will need a trigger to capture the event configured in this action.", "$ref": "#/definitions/Microsoft.CancelAllDialogs" }, { "title": "Microsoft.ChoiceInput", "description": "Collect information - Pick from a list of choices", "$ref": "#/definitions/Microsoft.ChoiceInput" }, { "title": "Microsoft.ConfirmInput", "description": "Collect information - Ask for confirmation (yes or no).", "$ref": "#/definitions/Microsoft.ConfirmInput" }, { "title": "Microsoft.ContinueLoop", "description": "Stop executing this template and continue with the next iteration of the loop.", "$ref": "#/definitions/Microsoft.ContinueLoop" }, { "title": "Microsoft.DateTimeInput", "description": "Collect information - Ask for date and/ or time", "$ref": "#/definitions/Microsoft.DateTimeInput" }, { "title": "Microsoft.DebugBreak", "description": "If debugger is attached, stop the execution at this point in the conversation.", "$ref": "#/definitions/Microsoft.DebugBreak" }, { "title": "Microsoft.DeleteActivity", "description": "Delete an activity that was previously sent.", "$ref": "#/definitions/Microsoft.DeleteActivity" }, { "title": "Microsoft.DeleteProperties", "description": "Delete multiple properties and any value it holds.", "$ref": "#/definitions/Microsoft.DeleteProperties" }, { "title": "Microsoft.DeleteProperty", "description": "Delete a property and any value it holds.", "$ref": "#/definitions/Microsoft.DeleteProperty" }, { "title": "Microsoft.EditActions", "description": "Edit the current list of actions.", "$ref": "#/definitions/Microsoft.EditActions" }, { "title": "Microsoft.EditArray", "description": "Modify an array in memory", "$ref": "#/definitions/Microsoft.EditArray" }, { "title": "Microsoft.EmitEvent", "description": "Emit an event. Capture this event with a trigger.", "$ref": "#/definitions/Microsoft.EmitEvent" }, { "title": "Microsoft.EndDialog", "description": "End this dialog.", "$ref": "#/definitions/Microsoft.EndDialog" }, { "title": "Microsoft.EndTurn", "description": "End the current turn without ending the dialog.", "$ref": "#/definitions/Microsoft.EndTurn" }, { "title": "Microsoft.Foreach", "description": "Execute actions on each item in an a collection.", "$ref": "#/definitions/Microsoft.Foreach" }, { "title": "Microsoft.ForeachPage", "description": "Execute actions on each page (collection of items) in an array.", "$ref": "#/definitions/Microsoft.ForeachPage" }, { "title": "Microsoft.GetActivityMembers", "description": "Get the members who are participating in an activity. (BotFrameworkAdapter only)", "$ref": "#/definitions/Microsoft.GetActivityMembers" }, { "title": "Microsoft.GetConversationMembers", "description": "Get the members who are participating in an conversation. (BotFrameworkAdapter only)", "$ref": "#/definitions/Microsoft.GetConversationMembers" }, { "title": "Microsoft.GotoAction", "description": "Go to an an action by id.", "$ref": "#/definitions/Microsoft.GotoAction" }, { "title": "Microsoft.HttpRequest", "description": "Make a HTTP request.", "$ref": "#/definitions/Microsoft.HttpRequest" }, { "title": "Microsoft.IfCondition", "description": "Two-way branch the conversation flow based on a condition.", "$ref": "#/definitions/Microsoft.IfCondition" }, { "title": "Microsoft.LogAction", "description": "Log a message to the host application. Send a TraceActivity to Bot Framework Emulator (optional).", "$ref": "#/definitions/Microsoft.LogAction" }, { "title": "Microsoft.NumberInput", "description": "Collect information - Ask for a number.", "$ref": "#/definitions/Microsoft.NumberInput" }, { "title": "Microsoft.OAuthInput", "description": "Collect login information.", "$ref": "#/definitions/Microsoft.OAuthInput" }, { "title": "Microsoft.QnAMakerDialog", "description": "Dialog which uses QnAMAker knowledge base to answer questions.", "$ref": "#/definitions/Microsoft.QnAMakerDialog" }, { "title": "Microsoft.RepeatDialog", "description": "Repeat current dialog.", "$ref": "#/definitions/Microsoft.RepeatDialog" }, { "title": "Microsoft.ReplaceDialog", "description": "Replace current dialog with another dialog.", "$ref": "#/definitions/Microsoft.ReplaceDialog" }, { "title": "Microsoft.SendActivity", "description": "Respond with an activity.", "$ref": "#/definitions/Microsoft.SendActivity" }, { "title": "Microsoft.SetProperties", "description": "Set one or more property values.", "$ref": "#/definitions/Microsoft.SetProperties" }, { "title": "Microsoft.SetProperty", "description": "Set property to a value.", "$ref": "#/definitions/Microsoft.SetProperty" }, { "title": "Microsoft.SignOutUser", "description": "Sign a user out that was logged in previously using OAuthInput.", "$ref": "#/definitions/Microsoft.SignOutUser" }, { "title": "Microsoft.SwitchCondition", "description": "Execute different actions based on the value of a property.", "$ref": "#/definitions/Microsoft.SwitchCondition" }, { "title": "Microsoft.Test.AssertCondition", "description": "Assert condition is true.", "$ref": "#/definitions/Microsoft.Test.AssertCondition" }, { "title": "Microsoft.TextInput", "description": "Collection information - Ask for a word or sentence.", "$ref": "#/definitions/Microsoft.TextInput" }, { "title": "Microsoft.TraceActivity", "description": "Send a trace activity to the transcript logger and/ or Bot Framework Emulator.", "$ref": "#/definitions/Microsoft.TraceActivity" }, { "title": "Microsoft.UpdateActivity", "description": "Respond with an activity.", "$ref": "#/definitions/Microsoft.UpdateActivity" }, { "type": "string", "title": "string" } ] }, "Microsoft.ILanguageGenerator": { "title": "Microsoft ILanguageGenerator", "description": "Union of components which implement the ILanguageGenerator interface", "$role": "interface", "oneOf": [ { "type": "string", "title": "string" } ] }, "Microsoft.ITextTemplate": { "title": "Microsoft TextTemplate", "description": "Union of components which implement the TextTemplate", "$role": "interface", "oneOf": [ { "title": "Microsoft.TextTemplate", "description": "Lg tempalte to evaluate to create text", "$ref": "#/definitions/Microsoft.TextTemplate" }, { "type": "string", "title": "string" } ] }, "Microsoft.ITriggerCondition": { "$role": "interface", "title": "Microsoft Triggers", "description": "Union of components which implement the OnCondition", "oneOf": [ { "title": "Microsoft.OnActivity", "description": "Actions to perform on receipt of a generic activity.", "$ref": "#/definitions/Microsoft.OnActivity" }, { "title": "Microsoft.OnAssignEntity", "description": "Actions to take when an entity should be assigned to a property.", "$ref": "#/definitions/Microsoft.OnAssignEntity" }, { "title": "Microsoft.OnBeginDialog", "description": "Actions to perform when this dialog begins.", "$ref": "#/definitions/Microsoft.OnBeginDialog" }, { "title": "Microsoft.OnCancelDialog", "description": "Actions to perform on cancel dialog event.", "$ref": "#/definitions/Microsoft.OnCancelDialog" }, { "title": "Microsoft.OnChooseEntity", "description": "Actions to be performed when an entity value needs to be resolved.", "$ref": "#/definitions/Microsoft.OnChooseEntity" }, { "title": "Microsoft.OnChooseIntent", "description": "Actions to perform on when an intent is ambigious.", "$ref": "#/definitions/Microsoft.OnChooseIntent" }, { "title": "Microsoft.OnChooseProperty", "description": "Actions to take when there are multiple possible mappings of entities to properties.", "$ref": "#/definitions/Microsoft.OnChooseProperty" }, { "title": "Microsoft.OnClearProperty", "description": "Actions to take when a property needs to be cleared.", "$ref": "#/definitions/Microsoft.OnClearProperty" }, { "title": "Microsoft.OnCondition", "description": "Actions to perform when specified condition is true.", "$ref": "#/definitions/Microsoft.OnCondition" }, { "title": "Microsoft.OnConversationUpdateActivity", "description": "Actions to perform on receipt of an activity with type 'ConversationUpdate'.", "$ref": "#/definitions/Microsoft.OnConversationUpdateActivity" }, { "title": "Microsoft.OnCustomEvent", "description": "Actions to perform when a custom event is detected. Use 'Emit a custom event' action to raise a custom event.", "$ref": "#/definitions/Microsoft.OnCustomEvent" }, { "title": "Microsoft.OnDialogEvent", "description": "Actions to perform when a specific dialog event occurs.", "$ref": "#/definitions/Microsoft.OnDialogEvent" }, { "title": "Microsoft.OnEndOfActions", "description": "Actions to take when there are no more actions in the current dialog.", "$ref": "#/definitions/Microsoft.OnEndOfActions" }, { "title": "Microsoft.OnEndOfConversationActivity", "description": "Actions to perform on receipt of an activity with type 'EndOfConversation'.", "$ref": "#/definitions/Microsoft.OnEndOfConversationActivity" }, { "title": "Microsoft.OnError", "description": "Action to perform when an 'Error' dialog event occurs.", "$ref": "#/definitions/Microsoft.OnError" }, { "title": "Microsoft.OnEventActivity", "description": "Actions to perform on receipt of an activity with type 'Event'.", "$ref": "#/definitions/Microsoft.OnEventActivity" }, { "title": "Microsoft.OnHandoffActivity", "description": "Actions to perform on receipt of an activity with type 'HandOff'.", "$ref": "#/definitions/Microsoft.OnHandoffActivity" }, { "title": "Microsoft.OnIntent", "description": "Actions to perform when specified intent is recognized.", "$ref": "#/definitions/Microsoft.OnIntent" }, { "title": "Microsoft.OnInvokeActivity", "description": "Actions to perform on receipt of an activity with type 'Invoke'.", "$ref": "#/definitions/Microsoft.OnInvokeActivity" }, { "title": "Microsoft.OnMessageActivity", "description": "Actions to perform on receipt of an activity with type 'Message'. Overrides Intent trigger.", "$ref": "#/definitions/Microsoft.OnMessageActivity" }, { "title": "Microsoft.OnMessageDeleteActivity", "description": "Actions to perform on receipt of an activity with type 'MessageDelete'.", "$ref": "#/definitions/Microsoft.OnMessageDeleteActivity" }, { "title": "Microsoft.OnMessageReactionActivity", "description": "Actions to perform on receipt of an activity with type 'MessageReaction'.", "$ref": "#/definitions/Microsoft.OnMessageReactionActivity" }, { "title": "Microsoft.OnMessageUpdateActivity", "description": "Actions to perform on receipt of an activity with type 'MessageUpdate'.", "$ref": "#/definitions/Microsoft.OnMessageUpdateActivity" }, { "title": "Microsoft.OnQnAMatch", "description": "Actions to perform on when an match from QnAMaker is found.", "$ref": "#/definitions/Microsoft.OnQnAMatch" }, { "title": "Microsoft.OnRepromptDialog", "description": "Actions to perform when 'RepromptDialog' event occurs.", "$ref": "#/definitions/Microsoft.OnRepromptDialog" }, { "title": "Microsoft.OnTypingActivity", "description": "Actions to perform on receipt of an activity with type 'Typing'.", "$ref": "#/definitions/Microsoft.OnTypingActivity" }, { "title": "Microsoft.OnUnknownIntent", "description": "Action to perform when user input is unrecognized and if none of the 'on intent recognition' triggers match recognized intent.", "$ref": "#/definitions/Microsoft.OnUnknownIntent" }, { "type": "string", "title": "Reference to Microsoft.ITriggerCondition", "description": "Reference to Microsoft.ITriggerCondition .dialog file." } ] }, "Microsoft.ITriggerSelector": { "$role": "interface", "title": "Selectors", "description": "Union of components which are trigger selectors", "oneOf": [ { "title": "Microsoft.ConditionalSelector", "description": "Use a rule selector based on a condition", "$ref": "#/definitions/Microsoft.ConditionalSelector" }, { "title": "Microsoft.FirstSelector", "description": "Selector for first true rule", "$ref": "#/definitions/Microsoft.FirstSelector" }, { "title": "Microsoft.MostSpecificSelector", "description": "Select most specific true events with optional additional selector", "$ref": "#/definitions/Microsoft.MostSpecificSelector" }, { "title": "Microsoft.RandomSelector", "description": "Select most specific true rule", "$ref": "#/definitions/Microsoft.RandomSelector" }, { "title": "Microsoft.TrueSelector", "description": "Selector for all true events", "$ref": "#/definitions/Microsoft.TrueSelector" }, { "type": "string", "title": "Reference to Microsoft.ITriggerSelector", "description": "Reference to Microsoft.ITriggerSelector .dialog file." } ] }, "Microsoft.IfCondition": { "$role": "implements(Microsoft.IDialog)", "title": "If condition", "description": "Two-way branch the conversation flow based on a condition.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.IfCondition" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "condition": { "$role": "expression", "title": "Condition", "description": "Expression to evaluate.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "title": "Actions", "description": "Actions to execute if condition is true.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "elseActions": { "type": "array", "title": "Else", "description": "Actions to execute if condition is false.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "condition", "actions", "$kind" ] } ] }, "Microsoft.IpEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Ip Entity Recognizer", "description": "Recognizer which recognizes internet IP patterns (like 192.1.1.1).", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.IpEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.LanguagePolicy": { "title": "Language Policy", "description": "This represents a policy map for locales lookups to use for language", "type": "object", "additionalProperties": false, "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.LanguagePolicy" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.LogAction": { "$role": "implements(Microsoft.IDialog)", "title": "Log to console", "description": "Log a message to the host application. Send a TraceActivity to Bot Framework Emulator (optional).", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.LogAction" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "text": { "$role": "expression", "type": "string", "title": "Text", "description": "Information to log." }, "label": { "$role": "expression", "type": "string", "title": "Label", "description": "Label for the trace activity (used to identify it in a list of trace activities.)" }, "traceActivity": { "$role": "expression", "title": "Send Trace Activity", "description": "If true, automatically sends a TraceActivity (view in Bot Framework Emulator).", "oneOf": [ { "type": "boolean", "default": false, "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "text", "$kind" ] } ] }, "Microsoft.LuisRecognizer": { "$role": "implements(Microsoft.Recognizer)", "title": "LUIS Recognizer", "description": "LUIS recognizer.", "type": "object", "additionalProperties": false, "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.LuisRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional unique id using with RecognizerSet. Other recognizers should return 'DeferToRecognizer_{Id}' intent when cross training data for this recognizer." }, "applicationId": { "type": "string", "title": "LUIS Application ID", "description": "Application ID for your model from the LUIS service.", "$role": "expression" }, "endpoint": { "type": "string", "title": "LUIS Endpoint", "description": "Endpoint to use for LUIS service like https://westus.api.cognitive.microsoft.com.", "$role": "expression" }, "endpointKey": { "type": "string", "title": "LUIS prediction key", "description": "LUIS prediction key used to call endpoint.", "$role": "expression" }, "externalEntityRecognizer": { "title": "External Entity Recognizer", "description": "Entities recognized by this recognizer will be passed to LUIS as external entities.", "$kind": "Microsoft.Recognizer", "$ref": "#/definitions/Microsoft.Recognizer" }, "dynamicLists": { "$role": "expression", "title": "Dynamic lists", "description": "Runtime defined entity lists.", "oneOf": [ { "type": "array", "items": { "title": "Entity list", "description": "Lists of canonical values and synonyms for an entity.", "type": "object", "properties": { "entity": { "title": "Entity", "description": "Entity to extend with a dynamic list.", "type": "string" }, "list": { "title": "Dynamic list", "description": "List of canonical forms and synonyms.", "type": "array", "items": { "type": "object", "properties": { "canonicalForm": { "title": "Canonical form", "description": "Resolution if any synonym matches.", "type": "string" }, "synonyms": { "title": "Synonyms", "description": "List of synonyms for a canonical form.", "type": "array", "items": { "type": "string", "title": "string" } } }, "title": "object" } } } }, "title": "array" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to array." } ] }, "predictionOptions": { "type": "object", "properties": { "includeAllIntents": { "type": "boolean", "title": "Include all intents", "description": "True for all intents, false for only top intent." }, "includeInstanceData": { "type": "boolean", "title": "Include $instance", "description": "True to include $instance metadata in the LUIS response." }, "log": { "type": "boolean", "title": "Log utterances", "description": "True to log utterances on LUIS service." }, "preferExternalEntities": { "type": "boolean", "title": "Prefer External Entities", "description": "True to prefer external entities to those generated by LUIS models." }, "slot": { "type": "string", "title": "Slot", "description": "Slot to use for talking to LUIS service like production or staging." }, "version": { "type": "string", "title": "Version", "description": "LUIS application version to use." } } } }, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "applicationId", "endpoint", "endpointKey", "$kind" ] } ] }, "Microsoft.MentionEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Mentions Entity Recognizer", "description": "Recognizer which recognizes @Mentions", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.MentionEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.MostSpecificSelector": { "$role": "implements(Microsoft.ITriggerSelector)", "title": "Most Specific Trigger Selector", "description": "Select most specific true events with optional additional selector", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.MostSpecificSelector" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "selector": { "$kind": "Microsoft.ITriggerSelector", "$ref": "#/definitions/Microsoft.ITriggerSelector" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.MultiLanguageRecognizer": { "$role": "implements(Microsoft.Recognizer)", "title": "Multi-language recognizer", "description": "Configure one recognizer per language and the specify the language fallback policy.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.MultiLanguageRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional unique id using with RecognizerSet. Other recognizers should return 'DeferToRecognizer_{Id}' intent when cross training data for this recognizer." }, "languagePolicy": { "$kind": "Microsoft.LanguagePolicy", "type": "object", "title": "Language policy", "description": "Defines fall back languages to try per user input language.", "$ref": "#/definitions/Microsoft.LanguagePolicy" }, "recognizers": { "type": "object", "title": "Recognizers", "description": "Map of language -> Recognizer", "additionalProperties": { "$kind": "Microsoft.Recognizer", "$ref": "#/definitions/Microsoft.Recognizer" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "recognizers", "$kind" ] } ] }, "Microsoft.NumberEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Number Entity Recognizer", "description": "Recognizer which recognizes numbers.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.NumberEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.NumberInput": { "$role": "implements(Microsoft.IDialog)", "title": "Number input dialog", "description": "Collect information - Ask for a number.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.NumberInput" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ] }, "prompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Initial prompt", "description": "Message to send to collect information.", "examples": [ "What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "unrecognizedPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Unrecognized prompt", "description": "Message to send when the recognizer does not understand the user input.", "examples": [ "Sorry, I do not understand '{turn.activity.text'}. Let's try again. What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "invalidPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Invalid prompt", "description": "Message to send when the user input does not meet any validation expression.", "examples": [ "Sorry, '{this.value}' does not work. I need a number between 1-150. What is your age?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "defaultValueResponse": { "$kind": "Microsoft.IActivityTemplate", "title": "Default value response", "description": "Message to send when max turn count (if specified) has been exceeded and the default value is selected as the value.", "examples": [ "Sorry, I'm having trouble understanding you. I will just use {this.options.defaultValue} for now. You can say 'I'm 36 years old' to change it." ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "maxTurnCount": { "$role": "expression", "type": [ "integer", "string" ], "title": "Max turn count", "description": "Maximum number of re-prompt attempts to collect information.", "default": 3, "examples": [ 3 ] }, "validations": { "type": "array", "title": "Validation expressions", "description": "Expression to validate user input.", "examples": [ "int(this.value) > 1 && int(this.value) <= 150", "count(this.value) < 300" ], "items": { "$role": "expression", "type": "string" } }, "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to store collected information. Input will be skipped if property has value (unless 'Always prompt' is true).", "examples": [ "$birthday", "user.name", "conversation.issueTitle", "dialog.favColor" ] }, "defaultValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Default value", "description": "'Property' will be set to the value of this expression when max turn count is exceeded.", "examples": [ "@userName", "coalesce(@number, @partySize)" ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "'Property' will be set to the value of this expression unless it evaluates to null.", "examples": [ "@userName" ] }, "alwaysPrompt": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Always prompt", "description": "Collect information even if the specified 'property' is not empty.", "default": false, "examples": [ false ] }, "allowInterruptions": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Allow Interruptions", "description": "A boolean expression that determines whether the parent should be allowed to interrupt the input.", "default": "true", "examples": [ "true" ] }, "outputFormat": { "$role": "expression", "type": "string", "title": "Output format", "description": "Expression to format the number output.", "examples": [ "=this.value", "=int(this.text)" ] }, "defaultLocale": { "$role": "expression", "type": "string", "title": "Default locale", "description": "Default locale.", "default": "en-us" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.NumberRangeEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "NumberRange Entity Recognizer", "description": "Recognizer which recognizes ranges of numbers (Example:2 to 5).", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.NumberRangeEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.OAuthInput": { "$role": "implements(Microsoft.IDialog)", "title": "OAuthInput Dialog", "description": "Collect login information.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OAuthInput" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "connectionName": { "$role": "expression", "type": "string", "title": "Connection name", "description": "The connection name configured in Azure Web App Bot OAuth settings.", "examples": [ "msgraphOAuthConnection" ] }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "text": { "$role": "expression", "type": "string", "title": "Text", "description": "Text shown in the OAuth signin card.", "examples": [ "Please sign in. " ] }, "title": { "$role": "expression", "type": "string", "title": "Title", "description": "Title shown in the OAuth signin card.", "examples": [ "Login" ] }, "timeout": { "$role": "expression", "title": "Timeout", "description": "Time out setting for the OAuth signin card.", "oneOf": [ { "type": "integer", "default": "900000", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "property": { "$role": "expression", "type": "string", "title": "Token property", "description": "Property to store the OAuth token result.", "examples": [ "dialog.token" ] }, "invalidPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Invalid prompt", "description": "Message to send if user response is invalid.", "examples": [ "Sorry, the login info you provided is not valid." ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "defaultValueResponse": { "$kind": "Microsoft.IActivityTemplate", "title": "Default value response", "description": "Message to send when max turn count (if specified) has been exceeded and the default value is selected as the value.", "examples": [ "Login failed." ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "maxTurnCount": { "$role": "expression", "title": "Max turn count", "description": "Maximum number of re-prompt attempts to collect information.", "examples": [ 3 ], "oneOf": [ { "type": "integer", "default": 3, "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "defaultValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Default value", "description": "Expression to examine on each turn of the conversation as possible value to the property.", "examples": [ "@token" ] }, "allowInterruptions": { "$role": "expression", "title": "Allow Interruptions", "description": "A boolean expression that determines whether the parent should be allowed to interrupt the input.", "examples": [ "true" ], "oneOf": [ { "type": "boolean", "default": "true", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "connectionName", "$kind" ] } ] }, "Microsoft.OnActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On activity", "description": "Actions to perform on receipt of a generic activity.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "type": { "type": "string", "title": "Activity type", "description": "The Activity.Type to match" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "type", "$kind" ] } ] }, "Microsoft.OnAssignEntity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On entity assignment", "description": "Actions to take when an entity should be assigned to a property.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnAssignEntity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "property": { "type": "string", "title": "Property", "description": "Property that will be set after entity is selected." }, "entity": { "type": "string", "title": "Entity", "description": "Entity being put into property" }, "operation": { "type": "string", "title": "Operation to use for assigning entity" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnBeginDialog": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On begin dialog", "description": "Actions to perform when this dialog begins.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnBeginDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnCancelDialog": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On cancel dialog", "description": "Actions to perform on cancel dialog event.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnCancelDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnChooseEntity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On choose entity", "description": "Actions to be performed when an entity value needs to be resolved.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnChooseEntity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "property": { "type": "string", "title": "Property to be set", "description": "Property that will be set after entity is selected." }, "entity": { "type": "string", "title": "Ambiguous entity", "description": "Ambiguous entity" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnChooseIntent": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On ambigious intent", "description": "Actions to perform on when an intent is ambigious.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnChooseIntent" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "intents": { "type": "array", "title": "Intents", "description": "Intents that must be in the ChooseIntent result for this condition to trigger.", "items": { "type": "string" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnChooseProperty": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On choose property", "description": "Actions to take when there are multiple possible mappings of entities to properties.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnChooseProperty" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "entity": { "type": "string", "title": "Entity being assigned", "description": "Entity being assigned to property choice" }, "properties": { "type": "array", "title": "Possible properties", "description": "Properties to be chosen between", "items": { "type": "string", "title": "Property name" } }, "entities": { "type": "array", "title": "Possible properties", "description": "Entities being assigned", "items": { "type": "string", "title": "Entity name" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnClearProperty": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On clear property", "description": "Actions to take when a property needs to be cleared.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnClearProperty" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "property": { "type": "string", "title": "Property", "description": "Property that will be cleared" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnCondition": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On condition", "description": "Actions to perform when specified condition is true.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnCondition" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnConversationUpdateActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On ConversationUpdate activity", "description": "Actions to perform on receipt of an activity with type 'ConversationUpdate'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnConversationUpdateActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnCustomEvent": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On custom event", "description": "Actions to perform when a custom event is detected. Use 'Emit a custom event' action to raise a custom event.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnCustomEvent" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "event": { "type": "string", "title": "Custom event name", "description": "Name of the custom event." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "event", "$kind" ] } ] }, "Microsoft.OnDialogEvent": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On dialog event", "description": "Actions to perform when a specific dialog event occurs.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnDialogEvent" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "event": { "type": "string", "title": "Dialog event name", "description": "Name of dialog event." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "event", "$kind" ] } ] }, "Microsoft.OnEndOfActions": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On end of actions", "description": "Actions to take when there are no more actions in the current dialog.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnEndOfActions" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnEndOfConversationActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On EndOfConversation activity", "description": "Actions to perform on receipt of an activity with type 'EndOfConversation'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnEndOfConversationActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnError": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On Error", "description": "Action to perform when an 'Error' dialog event occurs.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnError" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnEventActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On Event activity", "description": "Actions to perform on receipt of an activity with type 'Event'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnEventActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnHandoffActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On Handoff activity", "description": "Actions to perform on receipt of an activity with type 'HandOff'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnHandoffActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnIntent": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On intent recognition", "description": "Actions to perform when specified intent is recognized.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnIntent" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" }, "intent": { "type": "string", "title": "Intent", "description": "Name of intent." }, "entities": { "type": "array", "title": "Entities", "description": "Required entities.", "items": { "type": "string" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnInvokeActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On Invoke activity", "description": "Actions to perform on receipt of an activity with type 'Invoke'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnInvokeActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnMessageActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On Message activity", "description": "Actions to perform on receipt of an activity with type 'Message'. Overrides Intent trigger.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnMessageActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnMessageDeleteActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On MessageDelete activity", "description": "Actions to perform on receipt of an activity with type 'MessageDelete'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnMessageDeleteActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnMessageReactionActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On MessageReaction activity", "description": "Actions to perform on receipt of an activity with type 'MessageReaction'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnMessageReactionActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnMessageUpdateActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On MessageUpdate activity", "description": "Actions to perform on receipt of an activity with type 'MessageUpdate'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnMessageUpdateActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnQnAMatch": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On QnAMaker Match", "description": "Actions to perform on when an match from QnAMaker is found.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnQnAMatch" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnRepromptDialog": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On RepromptDialog", "description": "Actions to perform when 'RepromptDialog' event occurs.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnRepromptDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnTypingActivity": { "$role": "implements(Microsoft.ITriggerCondition)", "title": "On Typing activity", "description": "Actions to perform on receipt of an activity with type 'Typing'.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnTypingActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OnUnknownIntent": { "title": "On unknown intent", "description": "Action to perform when user input is unrecognized and if none of the 'on intent recognition' triggers match recognized intent.", "type": "object", "$role": "implements(Microsoft.ITriggerCondition)", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OnUnknownIntent" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Condition (expression).", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "actions": { "type": "array", "description": "Sequence of actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } }, "priority": { "title": "priority", "description": "Priority expression of rule with 0 being the most important", "$role": "expression", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] }, "runOnce": { "type": "boolean", "title": "Run Once", "description": "True if rule should run once per unique conditions" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "actions", "$kind" ] } ] }, "Microsoft.OrdinalEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Ordinal Entity Recognizer", "description": "Recognizer which recognizes ordinals (example: first, second, 3rd).", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.OrdinalEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.PercentageEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Percentage Entity Recognizer", "description": "Recognizer which recognizes percentages.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.PercentageEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.PhoneNumberEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Phone Number Entity Recognizer", "description": "Recognizer which recognizes phone numbers.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.PhoneNumberEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.QnAMakerDialog": { "$role": "implements(Microsoft.IDialog)", "title": "QnAMaker Dialog", "description": "Dialog which uses QnAMAker knowledge base to answer questions.", "type": "object", "additionalProperties": false, "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.QnAMakerDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "knowledgeBaseId": { "$role": "expression", "type": "string", "title": "KnowledgeBase Id", "description": "KnowledgeBase Id of your QnA Maker KnowledgeBase.", "default": "=settings.qna.knowledgebaseid" }, "endpointKey": { "$role": "expression", "type": "string", "title": "Endpoint Key", "description": "Endpoint key for the QnA Maker KB.", "default": "=settings.qna.endpointkey" }, "hostname": { "$role": "expression", "type": "string", "title": "Hostname", "description": "Hostname for your QnA Maker service.", "default": "=settings.qna.hostname", "examples": [ "https://yourserver.azurewebsites.net/qnamaker" ] }, "noAnswer": { "$kind": "Microsoft.IActivityTemplate", "title": "Fallback answer", "description": "Default answer to return when none found in KB.", "default": "Sorry, I did not find an answer.", "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "threshold": { "$role": "expression", "title": "Threshold", "description": "Threshold score to filter results.", "oneOf": [ { "type": "number", "default": 0.3, "title": "number" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to number." } ] }, "activeLearningCardTitle": { "$role": "expression", "type": "string", "title": "Active learning card title", "description": "Title for active learning suggestions card.", "default": "Did you mean:" }, "cardNoMatchText": { "$role": "expression", "type": "string", "title": "Card no match text", "description": "Text for no match option.", "default": "None of the above." }, "cardNoMatchResponse ": { "$kind": "Microsoft.IActivityTemplate", "title": "Card no match response", "description": "Custom response when no match option was selected.", "default": "Thanks for the feedback.", "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "strictFilters": { "$role": "expression", "title": "Strict Filters", "description": "Metadata filters to use when calling the QnA Maker KB.", "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Name", "maximum": 100 }, "value": { "type": "string", "title": "Value", "maximum": 100 } }, "title": "object" }, "title": "array" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to array." } ] }, "top": { "$role": "expression", "title": "Top", "description": "The number of answers you want to retrieve.", "oneOf": [ { "type": "number", "default": 3, "title": "number" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to number." } ] }, "isTest": { "type": "boolean", "title": "IsTest", "description": "True, if pointing to Test environment, else false.", "default": false }, "rankerType": { "type": "string", "title": "RankerType", "description": "Type of Ranker.", "enum": [ "Default", "QuestionOnly", "AutoSuggestQuestion" ], "default": "Default" } }, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "knowledgeBaseId", "endpointKey", "hostname", "$kind" ] } ] }, "Microsoft.QnAMakerRecognizer": { "$role": "implements(Microsoft.Recognizer)", "title": "QnAMaker Recognizer", "description": "Recognizer for generating QnAMatch intents from a KB.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.QnAMakerRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional unique id using with RecognizerSet." }, "knowledgeBaseId": { "$role": "expression", "type": "string", "title": "KnowledgeBase Id", "description": "KnowledgeBase Id of your QnA Maker KnowledgeBase.", "default": "settings.qna.knowledgebaseid" }, "endpointKey": { "$role": "expression", "type": "string", "title": "Endpoint Key", "description": "Endpoint key for the QnA Maker KB.", "default": "settings.qna.endpointkey" }, "hostname": { "$role": "expression", "type": "string", "title": "Hostname", "description": "Hostname for your QnA Maker service.", "default": "settings.qna.hostname", "examples": [ "https://yourserver.azurewebsites.net/qnamaker" ] }, "threshold": { "$role": "expression", "title": "Threshold", "description": "Threshold score to filter results.", "oneOf": [ { "type": "number", "default": 0.3, "title": "number" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to number." } ] }, "strictFilters": { "$role": "expression", "title": "Strict Filters", "description": "Metadata filters to use when calling the QnA Maker KB.", "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Name", "maximum": 100 }, "value": { "type": "string", "title": "Value", "maximum": 100 } }, "title": "object" }, "title": "array" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to array." } ] }, "top": { "$role": "expression", "title": "Top", "description": "The number of answers you want to retrieve.", "oneOf": [ { "type": "number", "default": 3, "title": "number" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to number." } ] }, "isTest": { "$role": "expression", "title": "IsTest", "description": "True, if pointing to Test environment, else false.", "oneOf": [ { "type": "boolean", "default": false, "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "rankerType": { "$role": "expression", "type": "string", "title": "RankerType", "description": "Type of Ranker.", "default": "Default" }, "includeDialogNameInMetadata": { "$role": "expression", "title": "Include Dialog Name", "description": "When set to false, the dialog name will not be passed to QnAMaker. (default) is true", "oneOf": [ { "type": "boolean", "default": true, "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "metadata": { "$role": "expression", "title": "value to ", "description": "Metadata filters to use when calling the QnA Maker KB.", "oneOf": [ { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "title": "Name" }, "value": { "type": "string", "title": "Value" } }, "title": "object" }, "title": "array" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to array." } ] }, "context": { "$role": "expression", "title": "QnARequestContext", "oneOf": [ { "type": "object", "title": "object" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to object." } ] }, "qnaId": { "$role": "expression", "title": "QnAId", "description": "A number or expression which is the QnAId to paass to QnAMaker API.", "oneOf": [ { "type": "integer", "title": "integer" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to integer." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "knowledgeBaseId", "endpointKey", "hostname", "$kind" ] } ] }, "Microsoft.RandomSelector": { "$role": "implements(Microsoft.ITriggerSelector)", "title": "Random rule selector", "description": "Select most specific true rule", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.RandomSelector" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "seed": { "type": "integer" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.Recognizer": { "title": "Microsoft Recognizer", "description": "Union of components which implement the Recognizer abstract class", "$role": "interface", "oneOf": [ { "title": "Microsoft.AdaptiveCardRecognizer", "description": "Recognizer for detecting the value response from an Adaptive Card.", "$ref": "#/definitions/Microsoft.AdaptiveCardRecognizer" }, { "title": "Microsoft.CrossTrainedRecognizerSet", "description": "Recognizer for selecting between cross trained recognizers.", "$ref": "#/definitions/Microsoft.CrossTrainedRecognizerSet" }, { "title": "Microsoft.LuisRecognizer", "description": "LUIS recognizer.", "$ref": "#/definitions/Microsoft.LuisRecognizer" }, { "title": "Microsoft.MultiLanguageRecognizer", "description": "Configure one recognizer per language and the specify the language fallback policy.", "$ref": "#/definitions/Microsoft.MultiLanguageRecognizer" }, { "title": "Microsoft.QnAMakerRecognizer", "description": "Recognizer for generating QnAMatch intents from a KB.", "$ref": "#/definitions/Microsoft.QnAMakerRecognizer" }, { "title": "Microsoft.RecognizerSet", "description": "Creates the union of the intents and entities of the recognizers in the set.", "$ref": "#/definitions/Microsoft.RecognizerSet" }, { "title": "Microsoft.RegexRecognizer", "description": "Use regular expressions to recognize intents and entities from user input.", "$ref": "#/definitions/Microsoft.RegexRecognizer" }, { "type": "string", "title": "string" } ] }, "Microsoft.RecognizerSet": { "$role": "implements(Microsoft.Recognizer)", "title": "Recognizer Set", "description": "Creates the union of the intents and entities of the recognizers in the set.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.RecognizerSet" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional unique id using with RecognizerSet. Other recognizers should return 'DeferToRecognizer_{Id}' intent when cross training data for this recognizer." }, "recognizers": { "type": "array", "title": "Recognizers", "description": "List of Recognizers defined for this set.", "items": { "$kind": "Microsoft.Recognizer", "$ref": "#/definitions/Microsoft.Recognizer" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "recognizers", "$kind" ] } ] }, "Microsoft.RegExEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Regex Entity Recognizer", "description": "Recognizer which recognizes patterns of input based on regex.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.RegExEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "name": { "type": "string", "title": "Name", "description": "Name of the entity" }, "pattern": { "type": "string", "title": "Pattern", "description": "Pattern expressed as regular expression." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "name", "pattern", "$kind" ] } ] }, "Microsoft.RegexRecognizer": { "$role": "implements(Microsoft.Recognizer)", "title": "Regex recognizer", "description": "Use regular expressions to recognize intents and entities from user input.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.RegexRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional unique id using with RecognizerSet. Other recognizers should return 'DeferToRecognizer_{Id}' intent when cross training data for this recognizer." }, "intents": { "type": "array", "title": "RegEx patterns to intents", "description": "Collection of patterns to match for an intent.", "items": { "type": "object", "properties": { "intent": { "type": "string", "title": "Intent", "description": "The intent name." }, "pattern": { "type": "string", "title": "Pattern", "description": "The regular expression pattern." } } } }, "entities": { "type": "array", "title": "Entity recognizers", "description": "Collection of entity recognizers to use.", "items": { "$kind": "Microsoft.EntityRecognizers", "$ref": "#/definitions/Microsoft.EntityRecognizers" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "intents", "$kind" ] } ] }, "Microsoft.RepeatDialog": { "$role": "implements(Microsoft.IDialog)", "type": "object", "title": "Repeat dialog", "description": "Repeat current dialog.", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.RepeatDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "options": { "$role": "expression", "title": "Options", "description": "One or more options that are passed to the dialog that is called.", "oneOf": [ { "type": "object", "additionalProperties": { "type": "string", "title": "Options" }, "title": "object" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to object." } ] }, "activityProcessed": { "$role": "expression", "title": "Activity Processed", "description": "When set to false, the dialog that is called can process the current activity.", "oneOf": [ { "type": "boolean", "default": true, "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.ReplaceDialog": { "$role": "implements(Microsoft.IDialog)", "type": "object", "title": "Replace dialog", "description": "Replace current dialog with another dialog.", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.ReplaceDialog" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "dialog": { "$kind": "Microsoft.IDialog", "$role": "expression", "type": "string", "title": "Dialog name", "description": "Name of the dialog to call.", "examples": [ "AddToDoDialog" ], "$ref": "#/definitions/Microsoft.IDialog" }, "options": { "$role": "expression", "title": "Options", "description": "One or more options that are passed to the dialog that is called.", "oneOf": [ { "type": "object", "additionalProperties": { "type": "string", "title": "Options" }, "title": "object" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to object." } ] }, "activityProcessed": { "$role": "expression", "title": "Activity Processed", "description": "When set to false, the dialog that is called can process the current activity.", "oneOf": [ { "type": "boolean", "default": true, "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.SendActivity": { "$role": "implements(Microsoft.IDialog)", "title": "Send an activity", "description": "Respond with an activity.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.SendActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "activity": { "$kind": "Microsoft.IActivityTemplate", "title": "Activity", "description": "Activity to send.", "$ref": "#/definitions/Microsoft.IActivityTemplate" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.SetProperties": { "$role": "implements(Microsoft.IDialog)", "title": "Set property", "description": "Set one or more property values.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.SetProperties" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "assignments": { "type": "array", "title": "Assignments", "description": "Property value assignments to set.", "items": { "type": "object", "properties": { "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property (named location to store information).", "examples": [ "user.age" ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "New value or expression.", "examples": [ "='milk'", "=dialog.favColor", "=dialog.favColor == 'red'" ] } } } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "assignments", "$kind" ] } ] }, "Microsoft.SetProperty": { "$role": "implements(Microsoft.IDialog)", "title": "Set property", "description": "Set property to a value.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.SetProperty" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property (named location to store information).", "examples": [ "user.age" ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "New value or expression.", "examples": [ "='milk'", "=dialog.favColor", "=dialog.favColor == 'red'" ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "property", "value", "$kind" ] } ] }, "Microsoft.SignOutUser": { "$role": "implements(Microsoft.IDialog)", "title": "Sign Out User", "description": "Sign a user out that was logged in previously using OAuthInput.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.SignOutUser" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "userId": { "$role": "expression", "type": "string", "title": "ActivityId", "description": "expression to an activityId to get the members. If none is defined then the current activity id will be used.", "examples": [ "=$lastActivity" ] }, "connectionName": { "$role": "expression", "type": "string", "title": "Connection Name", "description": "Connection name that was used with OAuthInput to log a user in." }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.StaticActivityTemplate": { "$role": "implements(Microsoft.IActivityTemplate)", "title": "Microsoft Static Activity Template", "description": "This allows you to define a static Activity object", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.StaticActivityTemplate" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "activity": { "type": "object", "title": "Activity", "Description": "A static Activity to used" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "activity", "$kind" ] } ] }, "Microsoft.SwitchCondition": { "$role": "implements(Microsoft.IDialog)", "title": "Switch condition", "description": "Execute different actions based on the value of a property.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.SwitchCondition" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "condition": { "$role": "expression", "type": "string", "title": "Condition", "description": "Property to evaluate.", "examples": [ "user.favColor" ] }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "cases": { "type": "array", "title": "Cases", "desc": "Actions for each possible condition.", "items": { "type": "object", "required": [ "value", "case" ], "properties": { "value": { "type": [ "number", "integer", "boolean", "string" ], "title": "Value", "description": "Value.", "examples": [ "red", "true", "13" ] }, "actions": { "type": "array", "title": "Actions", "description": "Actions to execute.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } } } } }, "default": { "type": "array", "title": "Default", "description": "Actions to execute if none of the cases meet the condition.", "items": { "$kind": "Microsoft.IDialog", "$ref": "#/definitions/Microsoft.IDialog" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "condition", "$kind" ] } ] }, "Microsoft.TemperatureEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Temperature Entity Recognizer", "description": "Recognizer which recognizes temperatures.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.TemperatureEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.Test.AssertCondition": { "$role": "implements(Microsoft.IDialog)", "title": "Assert Condition", "description": "Assert condition is true.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.AssertCondition" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "condition": { "$role": "expression", "title": "Condition", "description": "Expression to evalute", "examples": [ "user.age > 10" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "description": { "type": "string", "title": "Description", "description": "Description of what the condition is testing" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.Test.AssertReply": { "$role": "implements(Microsoft.Test.ITestAction)", "title": "Assert Reply", "description": "Asserts that a reply text is valid.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.AssertReply" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "text": { "type": "string", "title": "Reply Text", "description": "Expected reply text" }, "exact": { "type": "boolean", "title": "Exact Match", "description": "If true then an exact match must happen, if false then the reply activity.text must contain the reply text. [Default:false]" }, "description": { "type": "string", "title": "Description", "description": "The description of what the assertion is testing" }, "timeout": { "type": "number", "title": "Timeout", "description": "The amount of time in milliseconds to wait for a reply (default is 3000)" }, "assertions": { "type": "array", "title": "Assertions to perform to validate Activity that is sent by the dialog", "description": "Sequence of expressions which must evaluate to true.", "items": { "$role": "expression", "title": "Assertion", "description": "Assertion as an expression, which must evaluate to true or it will fail the test script.", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "text", "$kind" ] } ] }, "Microsoft.Test.AssertReplyActivity": { "$role": "implements(Microsoft.Test.ITestAction)", "title": "Assert Reply Activity", "description": "Asserts that a reply activity is valid.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.AssertReplyActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "description": { "type": "string", "title": "Description", "description": "The description of what the assertion is testing" }, "timeout": { "type": "number", "title": "Timeout", "description": "The amount of time in milliseconds to wait for a reply (default is 3000)" }, "assertions": { "type": "array", "title": "Assertions to perform to validate Activity that is sent by the dialog", "description": "Sequence of expressions which must evaluate to true.", "items": { "$role": "expression", "title": "Assertion", "description": "Assertion as an expression, which must evaluate to true or it will fail the test script.", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "assertions", "$kind" ] } ] }, "Microsoft.Test.AssertReplyOneOf": { "$role": "implements(Microsoft.Test.ITestAction)", "title": "Assert Reply OneOf", "description": "Asserts that a reply text is one of multiple optional responses.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.AssertReplyOneOf" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "text": { "type": "array", "title": "Replies", "description": "Expected replies (one of which must match", "items": { "type": "string" } }, "exact": { "type": "boolean", "title": "Exact Match", "description": "If true then an exact match must happen, if false then the reply activity.text must contain the reply text. [Default:false]" }, "description": { "type": "string", "title": "Description", "description": "The description of what the assertion is testing" }, "timeout": { "type": "number", "title": "Timeout", "description": "The amount of time in milliseconds to wait for a reply (default is 3000)" }, "assertions": { "type": "array", "title": "Assertions to perform to validate Activity that is sent by the dialog", "description": "Sequence of expressions which must evaluate to true.", "items": { "$role": "expression", "title": "Assertion", "description": "Assertion as an expression, which must evaluate to true or it will fail the test script.", "examples": [ "user.vip == true" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "replies", "$kind" ] } ] }, "Microsoft.Test.ITestAction": { "title": "Microsoft Test ITestAction", "description": "Union of components which implement the Test.ITestAction interface", "$role": "interface", "oneOf": [ { "title": "Microsoft.Test.AssertReply", "description": "Asserts that a reply text is valid.", "$ref": "#/definitions/Microsoft.Test.AssertReply" }, { "title": "Microsoft.Test.AssertReplyActivity", "description": "Asserts that a reply activity is valid.", "$ref": "#/definitions/Microsoft.Test.AssertReplyActivity" }, { "title": "Microsoft.Test.AssertReplyOneOf", "description": "Asserts that a reply text is one of multiple optional responses.", "$ref": "#/definitions/Microsoft.Test.AssertReplyOneOf" }, { "title": "Microsoft.Test.UserActivity", "description": "Sends activity to the bot.", "$ref": "#/definitions/Microsoft.Test.UserActivity" }, { "title": "Microsoft.Test.UserConversationUpdate", "description": "Sends ConversationUpdate activity to the bot.", "$ref": "#/definitions/Microsoft.Test.UserConversationUpdate" }, { "title": "Microsoft.Test.UserDelay", "description": "Delays text script for time period.", "$ref": "#/definitions/Microsoft.Test.UserDelay" }, { "title": "Microsoft.Test.UserSays", "description": "Sends text to the bot from the user.", "$ref": "#/definitions/Microsoft.Test.UserSays" }, { "title": "Microsoft.Test.UserTyping", "description": "Sends typing activity to the bot.", "$ref": "#/definitions/Microsoft.Test.UserTyping" }, { "type": "string", "title": "Reference to Microsoft.Test.ITestAction", "description": "Reference to Microsoft.Test.ITestAction .dialog file." } ] }, "Microsoft.Test.Script": { "title": "Test Script", "description": "Defines a sequence of test actions to perform to validate the behavior of dialogs.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.Script" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "dialog": { "$kind": "Microsoft.IDialog", "title": "Dialog", "description": "The root dialog to execute the test script against.", "$ref": "#/definitions/Microsoft.IDialog" }, "description": { "type": "string", "title": "Description", "description": "Description of the test script" }, "script": { "type": "array", "description": "Sequence of test actions to execute.", "items": { "$kind": "Microsoft.Test.ITestAction", "$ref": "#/definitions/Microsoft.Test.ITestAction" } }, "locale": { "type": "string", "title": "Locale", "description": "Set the locale for the user utterances in the script.", "default": "en-us" }, "enableTrace": { "type": "boolean", "title": "Enable Trace Activity", "description": "Enable trace activities in the unit test (default is false)", "default": false } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "dialog", "testActions", "$kind" ] } ] }, "Microsoft.Test.UserActivity": { "$role": "implements(Microsoft.Test.ITestAction)", "title": "Send Activity", "description": "Sends activity to the bot.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.UserActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "activity": { "type": "object", "additionalProperties": true }, "user": { "type": "string", "title": "User Name", "description": "The activity.from.id and activity.from.name will be this if specified." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "activity", "$kind" ] } ] }, "Microsoft.Test.UserConversationUpdate": { "$role": "implements(Microsoft.Test.ITestAction)", "title": "Send ConversationUpdate", "description": "Sends ConversationUpdate activity to the bot.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.UserConversationUpdate" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "membersAdded": { "type": "array", "title": "Members Added", "description": "Names of the members to add", "items": { "type": "string" } }, "membersRemoved": { "type": "array", "title": "Members Removed", "description": "Names of the members to remove", "items": { "type": "string" } } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.Test.UserDelay": { "$role": "implements(Microsoft.Test.ITestAction)", "title": "Delay Execution", "description": "Delays text script for time period.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.UserDelay" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "timespan": { "type": "number", "title": "Timespan", "description": "The amount of time in milliseconds to delay the execution of the test script" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "timespan", "$kind" ] } ] }, "Microsoft.Test.UserSays": { "$role": "implements(Microsoft.Test.ITestAction)", "title": "User Text", "description": "Sends text to the bot from the user.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.UserSays" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "text": { "type": "string", "title": "Text", "description": "Text to send to the bot." }, "user": { "type": "string", "title": "User Name", "description": "The activity.from.id and activity.from.name will be this if specified." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "text", "$kind" ] } ] }, "Microsoft.Test.UserTyping": { "$role": "implements(Microsoft.Test.ITestAction)", "title": "Send Typing", "description": "Sends typing activity to the bot.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.Test.UserTyping" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "user": { "type": "string", "title": "User Name", "description": "The activity.from.id and activity.from.name will be this if specified." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.TextInput": { "$role": "implements(Microsoft.IDialog)", "type": "object", "title": "Text input dialog", "description": "Collection information - Ask for a word or sentence.", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.TextInput" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ] }, "prompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Initial prompt", "description": "Message to send to collect information.", "examples": [ "What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "unrecognizedPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Unrecognized prompt", "description": "Message to send when the recognizer does not understand the user input.", "examples": [ "Sorry, I do not understand '{turn.activity.text'}. Let's try again. What is your birth date?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "invalidPrompt": { "$kind": "Microsoft.IActivityTemplate", "title": "Invalid prompt", "description": "Message to send when the user input does not meet any validation expression.", "examples": [ "Sorry, '{this.value}' does not work. I need a number between 1-150. What is your age?" ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "defaultValueResponse": { "$kind": "Microsoft.IActivityTemplate", "title": "Default value response", "description": "Message to send when max turn count (if specified) has been exceeded and the default value is selected as the value.", "examples": [ "Sorry, I'm having trouble understanding you. I will just use {this.options.defaultValue} for now. You can say 'I'm 36 years old' to change it." ], "$ref": "#/definitions/Microsoft.IActivityTemplate" }, "maxTurnCount": { "$role": "expression", "type": [ "integer", "string" ], "title": "Max turn count", "description": "Maximum number of re-prompt attempts to collect information.", "default": 3, "examples": [ 3 ] }, "validations": { "type": "array", "title": "Validation expressions", "description": "Expression to validate user input.", "examples": [ "int(this.value) > 1 && int(this.value) <= 150", "count(this.value) < 300" ], "items": { "$role": "expression", "type": "string" } }, "property": { "$role": "expression", "type": "string", "title": "Property", "description": "Property to store collected information. Input will be skipped if property has value (unless 'Always prompt' is true).", "examples": [ "$birthday", "user.name", "conversation.issueTitle", "dialog.favColor" ] }, "defaultValue": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Default value", "description": "'Property' will be set to the value of this expression when max turn count is exceeded.", "examples": [ "@userName", "coalesce(@number, @partySize)" ] }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "'Property' will be set to the value of this expression unless it evaluates to null.", "examples": [ "@userName" ] }, "alwaysPrompt": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Always prompt", "description": "Collect information even if the specified 'property' is not empty.", "default": false, "examples": [ false ] }, "allowInterruptions": { "$role": "expression", "type": [ "boolean", "string" ], "title": "Allow Interruptions", "description": "A boolean expression that determines whether the parent should be allowed to interrupt the input.", "default": "true", "examples": [ "true" ] }, "outputFormat": { "$role": "expression", "type": "string", "title": "Output format", "description": "Expression to format the output.", "examples": [ "=toUpper(this.value)", "${toUpper(this.value)}" ] } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.TextTemplate": { "$role": "implements(Microsoft.ITextTemplate)", "title": "Microsoft TextTemplate", "description": "Lg tempalte to evaluate to create text", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.TextTemplate" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "template": { "title": "Template", "Description": "Language Generator template to evaluate to create the text", "type": "string" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "template", "$kind" ] } ] }, "Microsoft.TraceActivity": { "$role": "implements(Microsoft.IDialog)", "title": "Send a TraceActivity", "description": "Send a trace activity to the transcript logger and/ or Bot Framework Emulator.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.TraceActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "name": { "$role": "expression", "type": "string", "title": "Name", "description": "Name of the trace activity" }, "label": { "$role": "expression", "type": "string", "title": "Label", "description": "Label for the trace activity (used to identify it in a list of trace activities.)" }, "valueType": { "$role": "expression", "type": "string", "title": "Value type", "description": "Type of value" }, "value": { "$role": "expression", "type": [ "object", "array", "number", "integer", "boolean", "string" ], "title": "Value", "description": "Property that holds the value to send as trace activity." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.TrueSelector": { "$role": "implements(Microsoft.ITriggerSelector)", "title": "True Trigger Selector", "description": "Selector for all true events", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.TrueSelector" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.UpdateActivity": { "$role": "implements(Microsoft.IDialog)", "title": "Send an activity", "description": "Respond with an activity.", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.UpdateActivity" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." }, "id": { "type": "string", "title": "Id", "description": "Optional id for the dialog" }, "disabled": { "$role": "expression", "title": "Disabled", "description": "Optional condition which if true will disable this action.", "examples": [ "user.age > 3" ], "oneOf": [ { "type": "boolean", "title": "boolean" }, { "type": "string", "title": "Expression", "description": "Expression evaluating to boolean." } ] }, "activityId": { "$role": "expression", "type": "string", "title": "Activity Id", "dDescription": "An string expression with the activity id to update.", "examples": [ "=dialog.lastActivityId" ] }, "activity": { "$kind": "Microsoft.IActivityTemplate", "title": "Activity", "description": "Activity to send.", "$ref": "#/definitions/Microsoft.IActivityTemplate" } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] }, "Microsoft.UrlEntityRecognizer": { "$role": "implements(Microsoft.EntityRecognizers)", "title": "Url Entity Recognizer", "description": "Recognizer which recognizes urls (example: http://bing.com)", "type": "object", "properties": { "$kind": { "title": "$kind", "description": "Defines the valid properties for the component you are configuring (from a dialog .schema file)", "type": "string", "pattern": "^[a-zA-Z][a-zA-Z0-9.]*$", "const": "Microsoft.UrlEntityRecognizer" }, "$copy": { "title": "$copy", "description": "Copy the definition by id from a .dialog file.", "type": "string", "pattern": "^(([a-zA-Z][a-zA-Z0-9.]*)?(#[a-zA-Z][a-zA-Z0-9.]*)?)$" }, "$id": { "title": "$id", "description": "Inline id for reuse of an inline definition", "type": "string", "pattern": "^([a-zA-Z][a-zA-Z0-9.]*)$" }, "$designer": { "title": "$designer", "type": "object", "description": "Extra information for the Bot Framework Designer." } }, "additionalProperties": false, "patternProperties": { "^\\$": { "type": "string" } }, "anyOf": [ { "title": "Reference", "required": [ "$copy" ] }, { "title": "Type", "required": [ "$kind" ] } ] } } }