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

可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。

重要

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

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

BotBlock コンポーネントは .botBlock のサフィックスを持ち、botBlocks フォルダーに保存されます。

バージョン

BotBlock コンポーネントは、API バージョン 58.0 以降で利用できます。

特別なアクセスルール

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

項目

項目名	説明
botBlockVersions	項目の型 BotBlockVersion[] 説明ダイアログや変数など、特定の Einstein ボットブロックバージョンの設定の詳細。
description	項目の型 string 説明ボットブロックの説明。
masterLabel	項目の型 string 説明必須。 BotBlock のわかりやすい表示ラベル。ブロックの作成時に定義します。
richContentEnabled	項目の型 boolean 説明ブロックを拡張ボットで使用できるか (`true`)、または標準ボットでのみ使用できるか (`false`) を示します。デフォルトは、`false` です。

BotBlockVersion

ダイアログや変数など、Einstein ボットブロックバージョンの設定の詳細を表します。

項目名	説明
botDialogs	項目の型 BotDialog[] 説明このボットブロックのダイアログのリスト。
conversationGoals	項目の型 ConversationDefinitionGoal[] 説明このボットブロックの目標のリスト。API バージョン 57.0 以降で利用できます。
conversationLanguages	項目の型 string 説明必須。ボットブロックの言語を指定します。
conversationVariables	項目の型 ConversationVariable[] 説明顧客から収集した特定のデータを保存するコンテナ。ダイアログアクション内の変数を入力と出力の両方で使用できます。API バージョン 44.0 以降で利用できます。
description	項目の型 string 説明ボットブロックの説明。
mlDomain	項目の型 LocalMlDomain 説明必須。ブロックに関連付けられたインテント、エンティティ、変数をグループ化する Einstein Intent セット。
permissionSet	項目の型 string 説明ボットブロックに関連付けられた権限セット。API バージョン 59.0 以降で利用できます。
status	項目の型 ConvDefBlockVersionStatus (string 型の列挙) 説明必須。ブロックが公開済みか、ドラフトかを示します。値は次のとおりです。 `Published`

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

BotBlock コンポーネントの例を次に示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<BotBlock xmlns="http://soap.sforce.com/2006/04/metadata">
3    <access xsi:nil="true"/>
4    <botBlockVersions>
5        <fullName>Published</fullName>
6        <botDialogs>
7            <developerName>Test_Dialog_1646070168572</developerName>
8            <label>Test_Dialog_1646070168572</label>
9            <showInFooterMenu>false</showInFooterMenu>
10        </botDialogs>
11        <botDialogs>
12            <developerName>Test_Dialog_1646070168926</developerName>
13            <label>Test_Dialog_1646070168926</label>
14            <showInFooterMenu>false</showInFooterMenu>
15        </botDialogs>
16        <botDialogs>
17            <botSteps>
18                <stepIdentifier>s4</stepIdentifier>
19                <type>Wait</type>
20            </botSteps>
21            <developerName>Main_Menu</developerName>
22            <label>Main Menu</label>
23            <mlIntent>Main_Menu</mlIntent>
24            <showInFooterMenu>false</showInFooterMenu>
25        </botDialogs>
26        <botDialogs>
27            <botSteps>
28                <botMessages>
29                    <message>Goodbye! Click the &quot;End Chat&quot; button to end this chat</message>
30                    <messageIdentifier>m2</messageIdentifier>
31                </botMessages>
32                <stepIdentifier>s6</stepIdentifier>
33                <type>Message</type>
34            </botSteps>
35            <botSteps>
36                <stepIdentifier>s7</stepIdentifier>
37                <type>Wait</type>
38            </botSteps>
39            <developerName>End_Chat</developerName>
40            <label>End Chat</label>
41            <mlIntent>End_Chat</mlIntent>
42            <showInFooterMenu>false</showInFooterMenu>
43        </botDialogs>
44        <botDialogs>
45            <botSteps>
46                <botMessages>
47                    <message>Unfortunately, there are no agents available at the moment</message>
48                    <messageIdentifier>m3</messageIdentifier>
49                </botMessages>
50                <stepIdentifier>s8</stepIdentifier>
51                <type>Message</type>
52            </botSteps>
53            <botSteps>
54                <stepIdentifier>s9</stepIdentifier>
55                <type>Wait</type>
56            </botSteps>
57            <developerName>No_Agent_Available</developerName>
58            <label>No Agent</label>
59            <showInFooterMenu>false</showInFooterMenu>
60        </botDialogs>
61        <botDialogs>
62            <botSteps>
63                <botMessages>
64                    <message>Hi! I&apos;m your helpful bot.</message>
65                    <messageIdentifier>m1</messageIdentifier>
66                </botMessages>
67                <stepIdentifier>s1</stepIdentifier>
68                <type>Message</type>
69            </botSteps>
70            <botSteps>
71                <conversationRecordLookup>
72                    <SObjectType>Account</SObjectType>
73                    <conditions>
74                        <leftOperand>Account.Phone</leftOperand>
75                        <operatorType>Equal</operatorType>
76                        <rightOperandValue>Value</rightOperandValue>
77                        <sortOrder>0</sortOrder>
78                    </conditions>
79                    <lookupFields>
80                        <fieldName>Account.Phone</fieldName>
81                    </lookupFields>
82                    <lookupFields>
83                        <fieldName>Account.OwnerId</fieldName>
84                    </lookupFields>
85                    <maxLookupResults>1</maxLookupResults>
86                    <sourceVariableName>_LastCustomerInput</sourceVariableName>
87                    <sourceVariableType>ConversationVariable</sourceVariableType>
88                    <targetVariableName>MyCustomVariable</targetVariableName>
89                </conversationRecordLookup>
90                <stepIdentifier>s2</stepIdentifier>
91                <type>RecordLookup</type>
92            </botSteps>
93            <botSteps>
94                <botNavigation>
95                    <botNavigationLinks>
96                        <targetBotDialog>Main_Menu</targetBotDialog>
97                        <targetVariable xsi:nil="true"/>
98                        <targetVariableType xsi:nil="true"/>
99                    </botNavigationLinks>
100                    <type>Redirect</type>
101                </botNavigation>
102                <stepIdentifier>s3</stepIdentifier>
103                <type>Navigation</type>
104            </botSteps>
105            <developerName>Welcome</developerName>
106            <label>Welcome</label>
107            <mlIntent>Welcome</mlIntent>
108            <showInFooterMenu>false</showInFooterMenu>
109        </botDialogs>
110        <conversationLanguages>en_US</conversationLanguages>
111        <conversationVariables>
112            <dataType>Text</dataType>
113            <developerName>TestVariableABC</developerName>
114            <label>TestVariableABC</label>
115        </conversationVariables>
116        <conversationVariables>
117            <dataType>Text</dataType>
118            <developerName>TestVariableXYZ</developerName>
119            <label>TestVariableXYZ</label>
120        </conversationVariables>
121        <conversationVariables>
122            <collectionType>List</collectionType>
123            <dataType>Object</dataType>
124            <developerName>MyCustomVariable</developerName>
125            <label>MyCustomVariable</label>
126        </conversationVariables>
127        <description>Created for testing.</description>
128        <mlDomain>
129            <label>vPub</label>
130            <mlIntents>
131                <developerName>End_Chat</developerName>
132                <label>End Chat</label>
133                <mlIntentUtterances>
134                    <language>es</language>
135                    <utterance>Utterance1</utterance>
136                </mlIntentUtterances>
137                <mlIntentUtterances>
138                    <language>es</language>
139                    <utterance>Utterance2</utterance>
140                </mlIntentUtterances>
141                <mlIntentUtterances>
142                    <language>es</language>
143                    <utterance>Utterance3</utterance>
144                </mlIntentUtterances>
145            </mlIntents>
146            <mlIntents>
147                <description>Main Menu Intent</description>
148                <developerName>Main_Menu</developerName>
149                <label>Main Menu</label>
150            </mlIntents>
151            <mlIntents>
152                <description>Welcome Intent</description>
153                <developerName>Welcome</developerName>
154                <label>Welcome</label>
155            </mlIntents>
156            <name>blockDevName0001_vPub</name>
157        </mlDomain>
158        <status>Published</status>
159    </botBlockVersions>
160    <description>Collects the user&apos;s first name, last name, email address, phone number, and company name.</description>
161    <masterLabel>User Info Collection Block</masterLabel>
162    <richContentEnabled>true</richContentEnabled>
163</BotBlock>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>AgentTransfer</members>
5        <name>BotBlock</name>
6    </types>
7    <version>58.0</version>
8</Package>

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

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