Newer Version Available
BotVersion
Parent Type
File Suffix and Directory Location
BotVersion components have the suffix .bot and are stored in the bot folder. BotVersion is a top-level child of Bot and shares its suffix and file directory.
Version
BotVersion components are available in API version 43.0 and later.
Special Access Rules
BotVersion is available only if Chat and Einstein Bots are enabled in your org.
Fields
| Field Name | Description |
|---|---|
| botDialogGroups |
|
| botDialogs |
|
| conversationGoals |
|
| conversationSystemDialogs |
|
| conversationVariables |
|
| entryDialog |
|
| intentDisambiguationEnabled |
|
| intentV3Enabled |
|
| knowledgeFallbackEnabled |
|
| mainMenuDialog |
|
| nlpProviders |
|
| responseDelayMilliseconds |
|
BotDialogGroup
The list of dialog groups in this bot version.
| Field Name | Description |
|---|---|
| description |
|
| developerName |
|
| label |
|
BotDialog
The list of dialogs in this bot version.
| Field Name | Description |
|---|---|
| botDialogGroup |
|
| botSteps |
|
| description |
|
| developerName |
|
| isPlaceholderDialog |
|
| label |
|
| mlIntent |
|
| mlIntentTrainingEnabled |
|
| showInFooterMenu |
|
BotStep
A step that is executed as part of the dialog.
| Field Name | Description |
|---|---|
| booleanFilter |
|
| botInvocation |
|
| botMessages |
|
| botNavigation |
|
| botStepConditions |
|
| botSteps |
|
| botVariableOperation |
|
| conditionLogicType |
|
| conversationRecordLookup |
|
| conversationStepGoalMappings |
|
| conversationSystemMessage |
|
| messageDefinition |
|
| stepIdentifier |
|
| type |
|
BotInvocation
Bot Invocation used by a BotStep of type Invocation.
| Field Name | Description |
|---|---|
| invocationActionName |
|
| invocationActionType |
|
| invocationMappings |
|
BotInvocationMapping
List of Bot Invocation Mappings for a Bot Invocation.
| Field Name | Description |
|---|---|
| parameterName |
|
| recordName |
|
| type |
|
| value |
|
| variableName |
|
| variableType |
|
BotMessage
A bot message used by a BotStep of type Message.
| Field Name | Description |
|---|---|
| message |
|
| messageIdentifier |
|
BotStepCondition
List of BotStep conditions associated with a BotStep of type Group.
| Field Name | Description |
|---|---|
| leftOperandName |
|
| leftOperandType |
|
| operatorType |
|
| rightOperandValue |
|
BotVariableOperation
Bot variable operation used by a BotStep of type VariableOperation.
| Field Name | Description |
|---|---|
| askCollectIfSet |
|
| autoSelectIfSingleChoice |
|
| botInvocation |
|
| botMessages |
|
| botQuickReplyOptions |
|
| botVariableOperands |
|
| invalidInputBotNavigation |
|
| messageDefinition |
|
| optionalCollect |
|
| quickReplyOptionTemplate |
|
| quickReplyType |
|
| quickReplyWidgetType |
|
| retryMessages |
|
| sourceVariableName |
|
| sourceVariableType |
|
| successMessages |
|
| type |
|
| variableOperationIdentifier |
|
BotQuickReplyOption
List of static choice options used by a bot variable operation of type Collect and quickReplyType of Static.
| Field Name | Description |
|---|---|
| literalValue |
|
| quickReplyOptionIdentifier |
|
BotVariableOperand
List of bot variable operands associated with a bot variable of type Set or Unset.
| Field Name | Description |
|---|---|
| disableAutoFill |
|
| sourceName |
|
| sourceType |
|
| sourceValue |
|
| targetName |
|
| targetType |
|
ConversationRecordLookup
Information related to the linked conversation. Currently only works on Lightning Knowledge. Available in API version 46.0 and later.
| Field Name | Description |
|---|---|
| SObjectType |
|
| conditions |
|
| filterLogic |
|
| lookupFields |
|
| maxLookupResults |
|
| sortFieldName |
|
| sortOrder |
|
| sourceVariableName |
|
| sourceVariableType |
|
| targetVariableName |
|
ConversationRecordLookupCondition
List of conditions associated with a ConversationRecordLookup. Available in API version 51.0 and later.
| Field Name | Description |
|---|---|
| leftOperand |
|
| operatorType |
|
| rightOperandName |
|
| rightOperandType |
|
| rightOperandValue |
|
| sortOrder |
|
ConversationRecordLookupField
The fields used in a conversation record lookup. Available in API version 46.0 and later.
| Field Name | Description |
|---|---|
| fieldName |
|
ConversationDefinitionStepGoalMapping
Represents the association between a goal and a BotStep. A goal can be associated with only one BotStep and one dialog at a time. Available in API version 57.0 and later.
| Field Name | Description |
|---|---|
| goalName |
|
ConversationSystemMessage
System messages that represent an action for a Bot Step, such as transferring to an agent or ending a chat. Available in API version 46.0 and later.
| Field Name | Description |
|---|---|
| systemMessageMappings |
|
| type |
|
ConversationSystemMessageMapping
List of mappings that indicate additional information provided for the system message. Available in API version 46.0 and later.
| Field Name | Description |
|---|---|
| mappingType |
|
| parameterType |
|
| variableName |
|
ConversationDefinitionRichMessage
Represents the configuration details for referencing a messaging component, such as an enhanced link. Available in API version 54.0 and later.
| Field Name | Description |
|---|---|
| messageDefinitionMappings |
|
| messageDefinitionName |
|
ConversationDefinitionGoal
A goal included in the bot version. Available in API version 57.0 and later.
| Field Name | Description |
|---|---|
| developerName |
|
| label |
|
ConversationSystemDialog
A system function assigned to a dialog. Available in API version 48.0 and later.
| Field Name | Description |
|---|---|
| dialog |
|
| type |
|
ConversationVariable
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.
| Field Name | Description |
|---|---|
| collectionType |
|
| dataType |
|
| developerName |
|
| label |
|
| SObjectType |
|
ConversationDefinitionNlpProvider
Defines the natural language service that is used for the language assigned to a bot version. Available in API version 49.0 and later.
| Field Name | Description |
|---|---|
| language |
|
| nlpProviderName |
|
| nlpProviderType |
|
Declarative Metadata Sample Definition
The following is an example of a BotVersion.
1<?xml version="1.0" encoding="UTF-8"?>
2<Bot xmlns="http://soap.sforce.com/2006/04/metadata">
3 <botMlDomain>
4 <label>Astros Pizza</label>
5 <mlIntents>
6 <developerName>New_Order</developerName>
7 <label>New Order</label>
8 <mlIntentUtterances>
9 <utterance>Today is pie day so I want pie</utterance>
10 </mlIntentUtterances>
11 </mlIntents>
12 <mlSlotClasses>
13 <developerName>Size</developerName>
14 <extractionType>Value</extractionType>
15 <label>Size</label>
16 <mlSlotClassValues>
17 <synonymGroup>
18 <languages>en_US</languages>
19 <terms>Big</terms>
20 <terms>Extra Large</terms>
21 <terms>X-Large</terms>
22 <terms>Grande</terms>
23 <terms>Huge</terms>
24 </synonymGroup>
25 <value>Large</value>
26 </mlSlotClassValues>
27 </mlSlotClasses>
28 <name>Astros_Pizza_ld1</name>
29 </botMlDomain>
30 <botVersions>
31 <fullName>v1</fullName>
32 <botDialogGroups>
33 <developerName>Order_Management</developerName>
34 <label>Order Management</label>
35 </botDialogGroups>
36 <botDialogs>
37 <botDialogGroup>Order_Management</botDialogGroup>
38 <botSteps>
39 <botMessages>
40 <message>πππPizza Time! πππ</message>
41 <messageIdentifier>Greeting_Message</messageIdentifier>
42 </botMessages>
43 <stepIdentifier>Greeting</stepIdentifier>
44 <type>Message</type>
45 </botSteps>
46 <botSteps>
47 <botStepConditions>
48 <leftOperandName>Verified_User</leftOperandName>
49 <leftOperandType>ConversationVariable</leftOperandType>
50 <operatorType>Equals</operatorType>
51 <rightOperandValue>false</rightOperandValue>
52 </botStepConditions>
53 <botSteps>
54 <botNavigation>
55 <botNavigationLinks>
56 <targetBotDialog>Customer_Verification</targetBotDialog>
57 </botNavigationLinks>
58 <type>Call</type>
59 </botNavigation>
60 <stepIdentifier>Call_Customer_Verification</stepIdentifier>
61 <type>Navigation</type>
62 </botSteps>
63 <stepIdentifier>Verify_User</stepIdentifier>
64 <type>Group</type>
65 </botSteps>
66 <botSteps>
67 <botStepConditions>
68 <leftOperandName>Location</leftOperandName>
69 <leftOperandType>ConversationVariable</leftOperandType>
70 <operatorType>IsNotSet</operatorType>
71 </botStepConditions>
72 <botSteps>
73 <botNavigation>
74 <botNavigationLinks>
75 <targetBotDialog>Select_Location</targetBotDialog>
76 </botNavigationLinks>
77 <type>Call</type>
78 </botNavigation>
79 <stepIdentifier>Call_Select_Location</stepIdentifier>
80 <type>Navigation</type>
81 </botSteps>
82 <stepIdentifier>Set_Location</stepIdentifier>
83 <type>Group</type>
84 </botSteps>
85 <botSteps>
86 <botVariableOperation>
87 <botInvocation>
88 <invocationActionName>CreateOrderService</invocationActionName>
89 <invocationActionType>apex</invocationActionType>
90 <invocationMappings>
91 <parameterName>customer</parameterName>
92 <type>Input</type>
93 <variableName>Contact</variableName>
94 <variableType>ConversationVariable</variableType>
95 </invocationMappings>
96 <invocationMappings>
97 <parameterName>location</parameterName>
98 <type>Input</type>
99 <variableName>Location</variableName>
100 <variableType>ConversationVariable</variableType>
101 </invocationMappings>
102 <invocationMappings>
103 <parameterName>output</parameterName>
104 <type>Output</type>
105 <variableName>Pizza_Order</variableName>
106 <variableType>ConversationVariable</variableType>
107 </invocationMappings>
108 </botInvocation>
109 <type>Set</type>
110 <variableOperationIdentifier>Set_Order</variableOperationIdentifier>
111 </botVariableOperation>
112 <stepIdentifier>Create_Order</stepIdentifier>
113 <type>VariableOperation</type>
114 </botSteps>
115 <botSteps>
116 <botMessages>
117 <message>Perfect, let's work on your order from our {!Location.Name} location</message>
118 <messageIdentifier>Start_Order_Message</messageIdentifier>
119 </botMessages>
120 <stepIdentifier>Start_Order</stepIdentifier>
121 <type>Message</type>
122 </botSteps>
123 <botSteps>
124 <messageDefinition>
125 <messageDefinitionName>Astros_Pizza_Menu</messageDefinitionName>
126 </messageDefinition>
127 <stepIdentifier>36e5a7cb-50c4-4279-aa06-1217eba1bf62</stepIdentifier>
128 <type>RichMessage</type>
129 </botSteps>
130 <botSteps>
131 <botNavigation>
132 <botNavigationLinks>
133 <targetBotDialog>Add_Items_to_Order</targetBotDialog>
134 </botNavigationLinks>
135 <type>Redirect</type>
136 </botNavigation>
137 <stepIdentifier>Proceed_To_Add_Items</stepIdentifier>
138 <type>Navigation</type>
139 </botSteps>
140 <developerName>New_Order</developerName>
141 <label>New Order</label>
142 <mlIntent>New_Order</mlIntent>
143 <showInFooterMenu>false</showInFooterMenu>
144 </botDialogs>
145 <conversationVariables>
146 <dataType>Object</dataType>
147 <developerName>Contact</developerName>
148 <label>Contact</label>
149 </conversationVariables>
150 <conversationVariables>
151 <dataType>Text</dataType>
152 <developerName>Delivery_Address</developerName>
153 <label>Delivery Address</label>
154 </conversationVariables>
155 <conversationVariables>
156 <dataType>Object</dataType>
157 <developerName>Pizza_Order</developerName>
158 <label>Pizza Order</label>
159 </conversationVariables>
160 <entryDialog>Welcome</entryDialog>
161 <mainMenuDialog>Main_Menu</mainMenuDialog>
162 </botVersions>
163 <label>Astro's Pizza</label>
164</Bot>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>Astros Pizza_Bot.v1</members>
5 <name>BotVersion</name>
6 </types>
7 <version>45.0</version>
8</Package>Wildcard Support in the Manifest File
This metadata type doesnβt support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.