mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 19:50:42 +08:00
86 lines
40 KiB
JSON
86 lines
40 KiB
JSON
|
{
|
||
|
|
"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<xsd:complexType name=\"BotBlock\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"botBlockVersions\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BotBlockVersion\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"icon\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n <xsd:element name=\"richContentEnabled\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"BotBlockVersion\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"botDialogs\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:BotDialog\"/>\n <xsd:element name=\"conversationGoals\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ConversationDefinitionGoal\"/>\n <xsd:element name=\"conversationLanguages\" type=\"xsd:string\"/>\n <xsd:element name=\"conversationVariables\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ConversationVariable\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"mlDomain\" type=\"tns:LocalMlDomain\"/>\n <xsd:element name=\"permissionSet\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"status\" type=\"tns:ConvDefBlockVersionStatus\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\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=\"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\
|
||
|
|
"declarative_metadata_sample_definition": [
|
||
|
|
{
|
||
|
|
"description": "The following is an example of a BotBlock component.",
|
||
|
|
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<BotBlock xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <access xsi:nil=\"true\"/>\n <botBlockVersions>\n <fullName>Published</fullName>\n <botDialogs>\n <developerName>Test_Dialog_1646070168572</developerName>\n <label>Test_Dialog_1646070168572</label>\n <showInFooterMenu>false</showInFooterMenu>\n </botDialogs>\n <botDialogs>\n <developerName>Test_Dialog_1646070168926</developerName>\n <label>Test_Dialog_1646070168926</label>\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</developerName>\n <label>No Agent</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
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|