{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "BotBlock - Metadata API",
"description": "Represents the configuration details for a specific Einstein Bot block, including dialogs and variables.",
"file_information": ".botBlock",
"directory_location": "botBlocks",
"fields_columns": [
"type",
"description",
"required"
],
"fields": {
"botBlockVersions": {
"type": "BotBlockVersion[]",
"description": "The configuration details for specific Einstein Bot block versions, including dialogs and variables."
},
"description": {
"type": "string",
"description": "A description of the bot block."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "A user-friendly label for BotBlock, which is defined when the block is created."
},
"richContentEnabled": {
"type": "boolean",
"description": "Indicates whether the block is available for enhanced bots (true) or for only standard bots (false). The default is false."
}
},
"sub_types": {
"BotBlockVersion": {
"botDialogs": {
"type": "BotDialog[]",
"description": "The list of dialogs in this bot block."
},
"conversationGoals": {
"type": "ConversationDefinitionGoal[]",
"description": "The list of goals in this bot block. Available in API version 57.0 and later."
},
"conversationLanguages": {
"type": "string",
"required": true,
"description": "Specifies the language of the bot block."
},
"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. Available in API version 44.0 and later."
},
"description": {
"type": "string",
"description": "A description of the bot block."
},
"mlDomain": {
"type": "LocalMlDomain",
"required": true,
"description": "The Einstein Intent Set that groups intents, entities, and variables associated with a block."
},
"permissionSet": {
"type": "string",
"description": "The permission set associated with the bot block. Available in API version 59.0 and later."
},
"status": {
"type": "ConvDefBlockVersionStatus (enumeration of type string)",
"required": true,
"description": "Indicates whether a block is published or is a draft.Values are: Published"
}
}
},
"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```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a BotBlock component.",
"code": "\n\n \n \n Published\n \n Test_Dialog_1646070168572\n \n false\n \n \n Test_Dialog_1646070168926\n \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 \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 \n \n Redirect\n \n s3\n Navigation\n \n Welcome\n \n Welcome\n false\n \n en_US\n \n Text\n TestVariableABC\n \n \n \n Text\n TestVariableXYZ\n \n \n \n List\n Object\n MyCustomVariable\n \n \n Created for testing.\n \n \n \n End_Chat\n \n \n es\n Utterance1\n \n \n es\n Utterance2\n \n \n es\n Utterance3\n \n \n \n Main Menu Intent\n Main_Menu\n \n \n \n Welcome Intent\n Welcome\n \n \n blockDevName0001_vPub\n \n Published\n \n Collects the user's first name, last name, email address, phone number, and company name.\n User Info Collection Block\n true\n"
}
]
}