BotVersion | メタデータ API 開発者ガイド

ファイルのサフィックスおよびディレクトリの場所

BotVersion コンポーネントのサフィックスは .bot で、bot フォルダに保存されます。BotVersion はボットの最上位の子で、そのサフィックスとファイルディレクトリを共有します。

バージョン

BotVersion コンポーネントは、API バージョン 43.0 以降で使用できます。

特別なアクセスルール

BotVersion を使用できるのは、組織でチャットと Einstein Bots が有効になっている場合のみです。

項目

項目名	項目の型	説明
botDialogGroups	BotDialogGroup[]	このボットバージョンのダイアロググループのリスト。
botDialogs	BotDialog[]	このボットバージョンのダイアログのリスト。
conversationSystemDialogs	ConversationSystemDialog[]	ダイアログに割り当てられているシステム機能。API バージョン 48.0 以降で利用できます。
conversationVariables	ConversationVariable[]	顧客から収集した特定のデータを保存するコンテナ。ダイアログアクション内の変数を入力と出力の両方で使用できます。API バージョン 44.0 以降で利用できます。
entryDialog	string	必須。ボットで顧客に表示する最初のダイアログへの参照。例: `Welcome` (ようこそ)。
mainMenuDialog	string	必須。メインメニューダイアログとして識別するダイアログへの参照。例: `Main Menu` (メインメニュー)。
nlpProviders	ConversationDefinitionNlpProvider[]	特定の言語に使用する言語プロバイダを定義します。API バージョン 49.0 以降で利用できます。
responseDelayMilliseconds	int	入力をシミュレーションするための、各ボット応答後のデフォルトまたはカスタムの遅延 (省略可能)。

BotDialogGroup

このボットバージョンのダイアロググループのリスト。

項目名	項目の型	説明
description	string	ボットダイアロググループの説明。
developerName	string	必須。一意の名前を使用して、同じボットバージョンに関連付けられた他のダイアロググループとの競合を回避します。この名前には、アンダースコアと英数字のみを使用できます。最初が文字である、空白を使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
label	string	必須。Salesforce ユーザインターフェース全体でダイアロググループを識別する表示ラベル。

BotDialog

このボットバージョンのダイアログのリスト。

項目名	項目の型	説明
botDialogGroup	string	このボットダイアログを含むボットダイアロググループ。
botSteps	BotStep[]	ダイアログの一部として実行するステップのリスト。
description	string	ボットダイアログの説明。
developerName	string	必須。一意の名前を使用して、同じボットバージョンに関連付けられた他のダイアログとの競合を回避します。この名前には、アンダースコアと英数字のみを使用できます。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
label	string	必須。Salesforce ユーザインターフェース全体でダイアログを識別する表示ラベル。
mlIntent	string	必須。ダイアログに関連付けられたインテントの名前。
mlIntentTrainingEnabled	boolean	ダイアログインテント用のインテントモデルをトレーニングするために Einstein が有効化されているか (`true`)、完全一致オプションのために無効化されているか (`false`) を示します。デフォルト値は `false` です。API バージョン 46.0 以降で使用できます。
showInFooterMenu	boolean	ボットオプションメニューでこのダイアログを表示するか、否かを示します。デフォルト値は、`false` です。

BotStep

ダイアログの一部として実行するステップ。

項目名	項目の型	説明
booleanFilter	string	この項目は、将来の使用のために予約されています。
botInvocation	BotInvocation	`Invocation` 種別の BotStep で使用するボット呼び出し。
botMessages	BotMessage[]	`Message` 種別の BotStep で使用するボットメッセージのリスト。
botNavigation	BotNavigation	`Navigation` 種別の BotStep で使用するボットナビゲーション。
botStepConditions	BotStepCondition[]	`Group` 種別の BotStep に関連付けられた BotStep 条件のリスト。
botSteps	BotStep[]	`Group` 種別のボットステップに関連付けられた BotStep のリスト。
botVariableOperation	BotVariableOperation[]	`VariableOperation` 種別の BotStep で使用するボット変数操作。
conversationRecordLookup	ConversationRecordLookup []	会話レコードへのルックアップアクション。API バージョン 46.0 以降で利用できます。
conversationSystemMessage	ConversationSystemMessage[]	ボットステップのアクション (エージェントへの転送やチャットの終了など) を表すシステムメッセージ。API バージョン 46.0 以降で利用できます。
type	BotStepType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Navigation` `Invocation` `VariableOperation` `Message` `Wait` `Group` `RecordLookup` (API バージョン 48.0 以降で使用可能)。

BotInvocation

Invocation 種別の BotStep で使用するボット呼び出し。

項目名	項目の型	説明
invocationActionName	string	ボット呼び出しで使用する呼び出し可能なアクションの名前。
invocationActionType	ConversationInvocableTargetType	使用可能なダイアログアクション種別は次のとおりです。 `apex` `flow` `standardInvocableAction`
invocationMappings	BotInvocationMapping[]	ボット呼び出しの対応付けのリスト。

BotInvocationMapping

ボット呼び出しの対応付けのリスト。

項目名	項目の型	説明
parameterName	string	必須。親のボット呼び出し対象の入力/出力パラメータの名前。
type	BotInvocationMappingType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Input` `Output`
value	string	指定したパラメータに割り当てられるリテラル値。
variableName	string	呼び出しの対応付けの一部として使用するボット変数の名前。
variableType	ConversationVariableType (string 型の列挙)	この項目は、この呼び出しの対応付けに使用される変数のデータ型に関係します。有効な値は、次のとおりです。 `ConversationVariable` `ContextVariable`

BotMessage

Message 種別の BotStep で使用するボットメッセージ。

項目名	項目の型	説明
message	string	必須。ボットから顧客への送信メッセージの一部として表示するメッセージ。

BotNavigation

Navigation 種別の BotStep で使用するボットナビゲーション。

項目名	項目の型	説明
botNavigationLinks	BotNavigationLink[]	`Call` または `Redirect` 種別のボットナビゲーションに関連付けられたボットナビゲーションリンクのリスト。
type	BotNavigationType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Call` `Redirect` `TransferToAgent`

BotNavigationLink

Call または Redirect 種別のボットナビゲーションに関連付けられたボットナビゲーションリンクのリスト。

項目名	項目の型	説明
label	string	`Redirect` 種別のボットナビゲーションで複数のボットナビゲーションリンクが使用可能な場合に表示する表示ラベル。表示ラベルが指定されていない場合、対象のダイアログの表示ラベルが使用されます。
targetBotDialog	string	必須。このボットナビゲーションリンクの一部としてコールする対象のダイアログの名前。

BotStepCondition

Group 種別の BotStep に関連付けられた BotStep 条件のリスト。

項目名	項目の型	説明
leftOperandName	string	必須。条件操作の左側で使用する変数の名前。
leftOperandType	ConversationVariableType (string 型の列挙)	必須。条件操作の左側で使用する変数の型。有効な値は、次のとおりです。 `ConversationVariable` `ContextVariable`
operatorType	BotStepConditionOperatorType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Equals` `NotEquals` `IsSet` `IsNotSet` `GreaterThan` (API バージョン 47.0 以降で使用可能)。 `LessThan` (API バージョン 47.0 以降で使用可能)。 `GreaterThanOrEqualTo` (API バージョン 47.0 以降で使用可能)。 `LessThanOrEqualTo` (API バージョン 47.0 以降で使用可能)。
rightOperandValue	string	条件操作の右側で使用する値。`IsSet` および `IsNotSet` 演算子を使用する場合、この値は無視されます。

BotVariableOperation

VariableOperation 種別の BotStep で使用するボット変数操作。

項目名	項目の型	説明
botInvocation	BotInvocation	`Collect` 種別であり quickReplyType が `Dynamic` のボット変数操作で、動的選択肢を提供するために使用するボット呼び出し。
botMessages	BotMessage[]	`Collect` 種別のボット変数操作で入力要求メッセージとして使用するボットメッセージのリスト。
botQuickReplyOptions	BotQuickReplyOption[]	`Collect` 種別であり quickReplyType が `Static` のボット変数操作で使用する静的選択肢オプションのリスト。
botVariableOperands	BotVariableOperand[]	`Set` または `Unset` 種別のボット変数に関連付けられたボット変数オペランドのリスト。
invalidInputBotNavigation	BotNavigation	`Collect` 種別のボット変数操作で使用するボットナビゲーション。このナビゲーションは、関連付けられたボット呼び出しがオプションを返さない場合に実行されます。
optionalCollect	boolean	`true` の場合、ボットは修正試行を 1 回尋ね、次のダイアログステップに移動します。デフォルト値は `false` です。API バージョン 48.0 以降で利用できます。
quickReplyOptionTemplate	string	`Object` 種別の動的選択肢オプションの表示ラベルを解決するために使用する数式テンプレート。
quickReplyType	BotQuickReplyType (string 型の列挙)	有効な値は、次のとおりです。 `Static` `Dynamic`
quickReplyWidgetType	BotWidgetType (string 型の列挙)	有効な値は、次のとおりです。 `Menu` `Buttons`
retryMessages	BotMessage[]	会話の修正で、修正試行に割り当てられているメッセージ。API バージョン 48.0 以降で利用できます。
sourceVariableName	string	変数操作で使用する取得元 VariableName の名前。(API バージョン 47.0 以降で使用可能)。
sourceVariableType	ConversationVariableType (string 型の列挙)	この名前は、変数操作で使用する VariableName のデータ型を定義します。(API バージョン 47.0 以降で使用可能)。有効な値は、次のとおりです。 `ConversationVariable` `ContextVariable`
type	BotVariableOperationType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Set` `Unset` `Collect`

BotQuickReplyOption

Collect 種別であり quickReplyType が Static のボット変数操作で使用する静的選択肢オプションのリスト。

項目名	項目の型	説明
literalValue	string	必須。メニューまたはボタンの選択肢として顧客に表示する値。

BotVariableOperand

Set または Unset 種別のボット変数に関連付けられたボット変数オペランドのリスト。

項目名	項目の型	説明
disableAutoFill	boolean	`Collect` 種別のボット変数操作でのボット変数の自動入力動作を無効にします。
sourceName	string	変数操作で使用する取得元 CustomField または MlSlotClass の名前。
sourceType	ConversationVariableOperandSourceType (string 型の列挙)	有効な値は、次のとおりです。 `StandardConversationVariable` `ConversationVariable` `ContextVariable` API 45.0 以降で使用できます。 `MlSlotClass` `StandardMlSlotClass` `Value`
sourceValue	string	この変数操作のコピー元として使用するリテラル値。
targetName	string	必須。変数操作で使用するコピー先変数の名前。
targetType	ConversationVariableType (string 型の列挙)	必須。変数操作で使用するコピー先の型。有効な値は、次のとおりです。 `ConversationVariable` `ContextVariable`

ConversationDefinitionNlpProvider

ボットバージョンに割り当てられる言語で使用される自然言語サービスを定義します。API バージョン 49.0 以降で利用できます。

項目名	項目の型	説明
language	Language	必須。ボットバージョンに割り当てられる言語。
nlpProviderName	string	nlpProviderType が EinsteinAI でない場合、この項目は空白に��ります。Apex の場合、この項目にはサービスの Apex クラス名が格納されます。
nlpProviderType	ConversationDefinitionNlpProviderType (string 型の列挙)	必須。デフォルト値は `EinsteinAi` です。有効な値は、次のとおりです。 `EinsteinAi` `Apex`

ConversationRecordLookup

リンク済みの会話に関連する情報。現在は、Lightning Knowledge でのみ機能します。API バージョン 46.0 以降で利用できます。

項目名	項目の型	説明
lookupFields	ConversationRecordLookupField []	この検索に使用される項目の定義。
maxLookupResults	int	必須。返すレコードの最大数 (1 ～ 3)。
SObjectType	string	必須。ボット変数に保存されている ID の SObjectType を指定します。
sourceVariableName	string	必須。この検索操作の入力。
sourceVariableType	ConversationVariableType (string 型の列挙)	必須。変数操作で使用するコピー先の型。有効な値は、次のとおりです。 `ConversationVariable` `ContextVariable`
targetVariableName	string	必須。この検索の結果を保持する変数。

ConversationRecordLookupField

会話レコードの検索で使用される項目。API バージョン 46.0 以降で利用できます。

項目名	項目の型	説明
fieldName	string	必須。会話検索関数で使用する項目名を定義します。

ConversationSystemDialog

ダイアログに割り当てられているシステム機能。API バージョン 48.0 以降で利用できます。

項目名	項目の型	説明
dialog	string	このシステムイベントが起動されたときにトリガされるダイアログ名。
type	ConversationSystemDialogType (string 型の列挙)	システムイベントの種別。必須。有効な値は、次のとおりです。 `TransferFailed`

ConversationSystemMessage

ボットステップのアクション (エージェントへの転送やチャットの終了など) を表すシステムメッセージ。API バージョン 46.0 以降で利用できます。

項目名	項目の型	説明
systemMessageMappings	ConversationSystemMessageMapping	送信されるシステムメッセージの種別を定義します。
type	ConversationSystemMessageType (string 型の列挙)	必須。この項目は、システムメッセージに使用できる値を定義します。有効な値は、次のとおりです。 `Transfer` `EndChat`

ConversationSystemMessageMapping

システムメッセージについて提供される追加情報を示す対応付けのリスト。API バージョン 46.0 以降で利用できます。

項目名	項目の型	説明
mappingType	ConversationMappingType (string 型の列挙)	必須。レコードで使用される対応付けの種別を定義します。有効な値は、`Input` および `Output` です。
parameterType	ConversationSystemMessageParamType (string 型の列挙)	必須。値を対応付けるパラメータの種別を定義します。有効な値は `Transfer` です。
variableName	string	必須。システムメッセージに渡される値が含まれる変数の名前。

ConversationVariable

顧客から収集した特定のデータを保存するコンテナ。ダイアログアクション内の変数を入力と出力の両方で使用できます。API バージョン 44.0 以降で利用できます。

項目名	項目の型	説明
collectionType	ConversationVariableCollectionType (string 型の列挙)	この項目は、変数をリスト変数として指定するかどうかを定義します。有効な値は `List` です。
dataType	ConversationVariableDataType (string 型の列挙)	必須。有効な値は、次のとおりです。 `Boolean` `Currency` `Date` `DateTime` `Id` (API バージョン 45.0 以降で使用可能)。 `Object` `Number` `Text`
developerName	string	必須。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
label	string	必須。Salesforce ユーザインターフェース全体で変数を識別する表示ラベル。
SObjectType	string	ボット変数に保存されている ID の SObjectType を指定します。有効な値は、次のとおりです。 `BotDefinition` `Queue`

宣言的なメタデータの定義のサンプル

次に、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                </botMessages>
42                <type>Message</type>
43            </botSteps>
44            <botSteps>
45                <botStepConditions>
46                    <leftOperandName>Verified_User</leftOperandName>
47                    <leftOperandType>ConversationVariable</leftOperandType>
48                    <operatorType>Equals</operatorType>
49                    <rightOperandValue>false</rightOperandValue>
50                </botStepConditions>
51                <botSteps>
52                    <botNavigation>
53                        <botNavigationLinks>
54                            <targetBotDialog>Customer_Verification</targetBotDialog>
55                        </botNavigationLinks>
56                        <type>Call</type>
57                    </botNavigation>
58                    <type>Navigation</type>
59                </botSteps>
60                <type>Group</type>
61            </botSteps>
62            <botSteps>
63                <botStepConditions>
64                    <leftOperandName>Location</leftOperandName>
65                    <leftOperandType>ConversationVariable</leftOperandType>
66                    <operatorType>IsNotSet</operatorType>
67                </botStepConditions>
68                <botSteps>
69                    <botNavigation>
70                        <botNavigationLinks>
71                            <targetBotDialog>Select_Location</targetBotDialog>
72                        </botNavigationLinks>
73                        <type>Call</type>
74                    </botNavigation>
75                    <type>Navigation</type>
76                </botSteps>
77                <type>Group</type>
78            </botSteps>
79            <botSteps>
80                <botVariableOperation>
81                    <botInvocation>
82                        <invocationActionName>CreateOrderService</invocationActionName>
83                        <invocationActionType>apex</invocationActionType>
84                        <invocationMappings>
85                            <parameterName>customer</parameterName>
86                            <type>Input</type>
87                            <variableName>Contact</variableName>
88                            <variableType>ConversationVariable</variableType>
89                        </invocationMappings>
90                        <invocationMappings>
91                            <parameterName>location</parameterName>
92                            <type>Input</type>
93                            <variableName>Location</variableName>
94                            <variableType>ConversationVariable</variableType>
95                        </invocationMappings>
96                        <invocationMappings>
97                            <parameterName>output</parameterName>
98                            <type>Output</type>
99                            <variableName>Pizza_Order</variableName>
100                            <variableType>ConversationVariable</variableType>
101                        </invocationMappings>
102                    </botInvocation>
103                    <type>Set</type>
104                </botVariableOperation>
105                <type>VariableOperation</type>
106            </botSteps>
107            <botSteps>
108                <botMessages>
109                    <message>Perfect, let&apos;s work on your order from our {!Location.Name} location</message>
110                </botMessages>
111                <type>Message</type>
112            </botSteps>
113            <botSteps>
114                <botNavigation>
115                    <botNavigationLinks>
116                        <targetBotDialog>Add_Items_to_Order</targetBotDialog>
117                    </botNavigationLinks>
118                    <type>Redirect</type>
119                </botNavigation>
120                <type>Navigation</type>
121            </botSteps>
122            <developerName>New_Order</developerName>
123            <label>New Order</label>
124            <mlIntent>New_Order</mlIntent>
125            <showInFooterMenu>false</showInFooterMenu>
126        </botDialogs>
127        <conversationVariables>
128            <dataType>Object</dataType>
129            <developerName>Contact</developerName>
130            <label>Contact</label>
131        </conversationVariables>
132        <conversationVariables>
133            <dataType>Text</dataType>
134            <developerName>Delivery_Address</developerName>
135            <label>Delivery Address</label>
136        </conversationVariables>
137        <conversationVariables>
138            <dataType>Object</dataType>
139            <developerName>Pizza_Order</developerName>
140            <label>Pizza Order</label>
141        </conversationVariables>
142        <entryDialog>Welcome</entryDialog>
143        <mainMenuDialog>Main_Menu</mainMenuDialog>
144    </botVersions>
145    <label>Astro&apos;s Pizza</label>
146</Bot>

前の定義を参照する package.xml の例を次に示します。

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>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) はサポートされません。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。