mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-31 04:01:24 +08:00
96 lines
44 KiB
JSON
96 lines
44 KiB
JSON
|
{
|
||
|
|
"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<xsd:complexType name=\"BotDialog\">\n <xsd:sequence>\n <xsd:element name=\"botDialogGroup\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"botSteps\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BotStep\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"developerName\" type=\"xsd:string\"/>\n <xsd:element name=\"isPlaceholderDialog\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"label\" type=\"xsd:string\"/>\n <xsd:element name=\"mlIntent\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"mlIntentTrainingEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"showInFooterMenu\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"BotDialogGroup\">\n <xsd:sequence>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"developerName\" type=\"xsd:string\"/>\n <xsd:element name=\"label\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"BotInvocation\">\n <xsd:sequence>\n <xsd:element name=\"invocationActionName\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"invocationActionType\" minOccurs=\"0\" type=\"tns:ConversationInvocableTargetType\"/>\n <xsd:element name=\"invocationMappings\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BotInvocationMapping\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"BotInvocationMapping\">\n <xsd:sequence>\n <xsd:element name=\"parameterName\" type=\"xsd:string\"/>\n <xsd:element name=\"recordName\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"type\" type=\"tns:BotInvocationMappingType\"/>\n <xsd:element name=\"value\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"variableName\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"variableType\" minOccurs=\"0\" type=\"tns:ConversationVariableType\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"BotInvocationMappingType\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"Input\"/>\n <xsd:enumeration value=\"Output\"/>\n <xsd:enumeration value=\"Error\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"BotMessage\">\n <xsd:sequence>\n <xsd:element name=\"message\" type=\"xsd:string\"/>\n <xsd:element name=\"messageIdentifier\" minOccurs=\"0\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"BotNavigation\">\n <xsd:sequence>\n <xsd:element name=\"botNavigationLinks\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BotNavigationLink\"/>\n <xsd:element name=\"type\" type=\"tns:BotNavigationType\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"BotNavigationLink\">\n <xsd:sequence>\n <xsd:element name=\"label\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"targetBotDialog\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"targetVariable\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"targetVariableType\" minOccurs=\"0\" type=\"tns:ConversationVariableType\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"BotNavigationType\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"Call\"/>\n <xsd:enumeration value=\"Redirect\"/>\n <xsd:enumeration value=\"TransferToAgent\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"BotQuickReplyOption\">\n <xsd:sequence>\n <xsd:element name=\"literalValue\" type=\"xsd:string\"/>\n <xsd:element name=\"quickReplyOptionIdentifier\" minOccurs=\"0\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"BotQuickReplyType\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"Static\"/>\n <xsd:enumeration value=\"Dynamic\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"BotStep\">\n <xsd:sequence>
|
||
|
|
"declarative_metadata_sample_definition": [
|
||
|
|
{
|
||
|
|
"description": "The following is an example of a BotTemplate component.",
|
||
|
|
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<BotTemplate xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <botDialogGroups>\n <developerName>dialog_group1</developerName>\n <label>dialog group1</label>\n </botDialogGroups>\n <botDialogs>\n <developerName>Test_Dialog_1</developerName>\n <label>Test_Dialog_1</label>\n <showInFooterMenu>false</showInFooterMenu>\n </botDialogs>\n <botDialogs>\n <developerName>Test_Dialog_2</developerName>\n <label>Test_Dialog_2</label>\n <showInFooterMenu>false</showInFooterMenu>\n </botDialogs>\n <botDialogs>\n <botSteps>\n <botMessages>\n <message>Hi! I'm your helpful bot.</message>\n <messageIdentifier>m1</messageIdentifier>\n </botMessages>\n <stepIdentifier>s1</stepIdentifier>\n <type>Message</type>\n </botSteps>\n <botSteps>\n <conversationRecordLookup>\n <SObjectType>Account</SObjectType>\n <conditions>\n <leftOperand>Account.Phone</leftOperand>\n <operatorType>Equal</operatorType>\n <rightOperandValue>Value</rightOperandValue>\n <sortOrder>0</sortOrder>\n </conditions>\n <lookupFields>\n <fieldName>Account.Phone</fieldName>\n </lookupFields>\n <lookupFields>\n <fieldName>Account.OwnerId</fieldName>\n </lookupFields>\n <maxLookupResults>1</maxLookupResults>\n <sourceVariableName>_LastCustomerInput</sourceVariableName>\n <sourceVariableType>ConversationVariable</sourceVariableType>\n <targetVariableName>MyCustomVariable</targetVariableName>\n </conversationRecordLookup>\n <stepIdentifier>s2</stepIdentifier>\n <type>RecordLookup</type>\n </botSteps>\n <botSteps>\n <botNavigation>\n <botNavigationLinks>\n <targetBotDialog>Main_Menu</targetBotDialog>\n </botNavigationLinks>\n <type>Redirect</type>\n </botNavigation>\n <stepIdentifier>s3</stepIdentifier>\n <type>Navigation</type>\n </botSteps>\n <developerName>Welcome</developerName>\n <label>Welcome</label>\n <mlIntent>Welcome</mlIntent>\n <showInFooterMenu>false</showInFooterMenu>\n </botDialogs>\n <botDialogs>\n <botSteps>\n <stepIdentifier>s4</stepIdentifier>\n <type>Wait</type>\n </botSteps>\n <developerName>Main_Menu</developerName>\n <label>Main Menu</label>\n <mlIntent>Main_Menu</mlIntent>\n <showInFooterMenu>false</showInFooterMenu>\n </botDialogs>\n <botDialogs>\n <botSteps>\n <botMessages>\n <message>Goodbye! Click the "End Chat" button to end this chat</message>\n <messageIdentifier>m2</messageIdentifier>\n </botMessages>\n <stepIdentifier>s6</stepIdentifier>\n <type>Message</type>\n </botSteps>\n <botSteps>\n <stepIdentifier>s7</stepIdentifier>\n <type>Wait</type>\n </botSteps>\n <developerName>End_Chat</developerName>\n <label>End Chat</label>\n <mlIntent>End_Chat</mlIntent>\n <showInFooterMenu>false</showInFooterMenu>\n </botDialogs>\n <botDialogs>\n <botSteps>\n <botMessages>\n <message>Unfortunately, there are no agents available at the moment</message>\n <messageIdentifier>m3</messageIdentifier>\n </botMessages>\n <stepIdentifier>s8</stepIdentifier>\n <type>Message</type>\n </botSteps>\n <botSteps>\n <stepIdentifier>s9</stepIdentifier>\n <type>Wait</type>\n </botSteps>\n <developerName>No_Agent_Available</devel
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|