{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "BotTemplate - Metadata API",
"description": "Represents the configuration details for a specific Einstein Bot template, including dialogs and variables.",
"file_information": ".botTemplate",
"directory_location": "botTemplates",
"fields_columns": [
"type",
"description",
"required"
],
"fields": {
"botDialogGroups": {
"type": "BotDialogGroup[]",
"description": "The list of dialog groups in this bot template."
},
"botDialogs": {
"type": "BotDialog[]",
"description": "The list of dialogs in this bot template."
},
"conversationLanguages": {
"type": "string",
"required": true,
"description": "Specifies the language of the bot template."
},
"contextVariables": {
"type": "ConversationContextVariable[]",
"description": "Represents the context variables that enable your bot to gather customer information regardless of channel."
},
"conversationGoals": {
"type": "ConversationDefinitionGoal[]",
"description": "The list of goals in this bot template. Available in API version 57.0 and later."
},
"conversationSystemDialogs": {
"type": "ConversationSystemDialog[]",
"description": "A system function assigned to a dialog."
},
"conversationVariables": {
"type": "ConversationVariable[]",
"description": "A container that stores a specific piece of data collected from the customer. You can use variables within dialog actions as both inputs and outputs."
},
"description": {
"type": "string",
"description": "A description of the bot template."
},
"entryDialog": {
"type": "string",
"description": "A reference to the first dialog that the bot presents to your customer. For example, Welcome."
},
"icon": {
"type": "string",
"description": "The icon used to identify the template."
},
"mainMenuDialog": {
"type": "string",
"description": "A reference to the dialog identified as the main menu dialog. For example, Main Menu."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "A user-friendly label for BotTemplate, which is defined when the BotTemplate is created."
},
"mlDomain": {
"type": "LocalMlDomain",
"required": true,
"description": "Represents the Einstein Intent Set that groups intents, entities, and variables associated with a template."
},
"permissionSet": {
"type": "string",
"description": "The permission set associated with the bot template. Available in API version 59.0 and later."
},
"richContentEnabled": {
"type": "boolean",
"description": "Indicates whether the template is available for enhanced bots (true) or for standard bots (false). The default is false."
},
"type": {
"type": "BotType (enumeration of type string)",
"description": "This field represents the configuration type of the bot. The default value is Bot. Valid values are: Bot—Default Einstein Bot configuration. ExternalCopilot— An external-facing agent. For example, an Agentforce Service agent. InternalCopilot— An internal-facing agent. For example, an Agentforce Employee agent."
}
},
"wsdl_segment": "```xml\n\n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n\n\n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n \n\n\n \n \n \n \n\n\n \n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a BotTemplate component.",
"code": "\n\n \n dialog_group1\n \n \n \n Test_Dialog_1\n \n false\n \n \n Test_Dialog_2\n \n false\n \n \n \n \n Hi! I'm your helpful bot.\n m1\n \n s1\n Message\n \n \n \n Account\n \n Account.Phone\n Equal\n Value\n 0\n \n \n Account.Phone\n \n \n Account.OwnerId\n \n 1\n _LastCustomerInput\n ConversationVariable\n MyCustomVariable\n \n s2\n RecordLookup\n \n \n \n \n Main_Menu\n \n Redirect\n \n s3\n Navigation\n \n Welcome\n \n Welcome\n false\n \n \n \n s4\n Wait\n \n Main_Menu\n \n Main_Menu\n false\n \n \n \n \n Goodbye! Click the "End Chat" button to end this chat\n m2\n \n s6\n Message\n \n \n s7\n Wait\n \n End_Chat\n \n End_Chat\n false\n \n \n \n \n Unfortunately, there are no agents available at the moment\n m3\n \n s8\n Message\n \n \n s9\n Wait\n \n No_Agent_Available\n \n false\n \n \n \n LiveChatTranscript\n LiveChatTranscript.ChatKey\n WebChat\n \n Text\n ChatKey\n \n \n en_US\n \n \n TransferFailed\n \n \n \n ErrorHandling\n \n \n Text\n TestVariableXYZ\n \n \n \n List\n Object\n MyCustomVariable\n \n \n Description of BotTemplate\n Test_Dialog_1\n AA8qwqXXXXX\n Test_Dialog_2\n Astro Bot\n \n \n \n End_Chat\n \n \n Utterance1\n es\n \n \n Utterance2\n es\n \n \n Utterance3\n es\n \n \n \n Main_Menu\n \n Main Menu Intent\n \n \n Welcome\n \n Welcome Intent\n \n Astro_Bot_ld1\n \n true\n"
}
]
}