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

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

重要

親種別

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

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

BotTemplate コンポーネントのサフィックスは .botTemplate で、botTemplates フォルダに保存されます。

バージョン

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

特別なアクセスルール

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

項目

項目名	説明
botDialogGroups	項目の型 BotDialogGroup[] 説明このボットテンプレートのダイアロググループのリスト。
botDialogs	項目の型 BotDialog[] 説明このボットテンプレートのダイアログのリスト。
conversationLanguages	項目の型 string 説明必須。ボットテンプレートの言語を指定します。
contextVariables	項目の型 ConversationContextVariable[] 説明チャネルに関係なくボットで顧客情報を収集できるようにするコンテキスト変数を表します。
conversationSystemDialogs	項目の型 ConversationSystemDialog[] 説明ダイアログに割り当てられているシステム機能。
conversationVariables	項目の型 ConversationVariable[] 説明顧客から収集した特定のデータを保存するコンテナ。ダイアログアクション内の変数を入力と出力の両方で使用できます。
description	項目の型 string 説明ボットテンプレートの説明。
entryDialog	項目の型 string 説明ボットで顧客に表示する最初のダイアログへの参照。例: `Welcome` (ようこそ)。
icon	項目の型 string 説明テンプレートの識別に使用するアイコン。
mainMenuDialog	項目の型 string 説明メインメニューダイアログとして識別するダイアログへの参照。例: `Main Menu` (メインメニュー)。
masterLabel	項目の型 string 説明必須。 BotTemplate のわかりやすい表示ラベルで、BotTemplate の作成時に定義されます。
mlDomain	項目の型 LocalMlDomain 説明必須。テンプレートに関連付けられたインテント、エンティティ、変数をグループ化する Einstein Intent セットを表します。
richContentEnabled	項目の型 boolean 説明テンプレートを拡張ボットで使用できるか (`true`)、または標準ボットで使用できるか (`false`) を示します。デフォルトは、`false` です。

BotDialogGroup

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

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

BotDialog

このボットテンプレートのダイアログのリスト。

項目名	説明
botDialogGroup	項目の型 string 説明このボットダイアログを含むボットダイアロググループ。
botSteps	項目の型 BotStep[] 説明ダイアログの一部として実行するステップのリスト。
description	項目の型 string 説明ボットダイアログの説明。
developerName	項目の型 string 説明必須。一意の名前を使用して、同じボットバージョンに関連付けられた他のダイアログとの競合を回避します。この名前には、アンダースコアと英数字のみを使用できます。最初は文字であること、スペースは使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。「DeveloperName を表示」または「設定・定義を参照する」権限を持っているユーザのみがこの項目の表示、グループ化、並び替え、絞り込みを行えます。メモ
label	項目の型 string 説明必須。 Salesforce ユーザインターフェース全体でダイアログを識別する表示ラベル。
mlIntent	項目の型 string 説明ダイアログに関連付けられたインテントの名前。
mlIntentTrainingEnabled	項目の型 boolean 説明ダイアログインテント用のインテントモデルをトレーニングするために Einstein が有効化されているか (`true`)、完全一致オプションのために無効化されているか (`false`) を示します。デフォルト値は `false` です。
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 説明会話レコードへのルックアップアクション。
conversationSystemMessage	項目の型 ConversationSystemMessage 説明 BotStep のアクション (エージェントへの転送やチャットの終了など) を表すシステムメッセージ。
messageDefinition	項目の型 ConversationDefinitionRichMessage 説明メッセージングコンポーネントを参照する BotStep で使用する設定の詳細のリスト。
stepIdentifier	項目の型 string 説明ダイアログ内のステップを識別する一意のキー。翻訳済み表示ラベルをステップ内の表示ラベルにリンクするために使用します。この項目はすべてのステップレコードで推奨され、ステップの翻訳済み表示ラベルでは必須です。 UI を介してステップを作成する場合、stepIdentifier は自動的に生成されます。API を介してステップを作成する場合、stepIdentifier を指定する必要があります。stepIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。
type	項目の型 BotStepType (string 型の列挙) 説明必須。値は次のとおりです。 `Group` `Invocation` `Message` `Navigation` `RecordLookup` `RichMessage` `SystemMessage` `VariableOperation` `Wait`

BotInvocation

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

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

BotInvocationMapping

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

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

BotMessage

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

項目名	説明
message	項目の型 string 説明必須。ボットから顧客への送信メッセージの一部として表示するメッセージ。
messageIdentifier	項目の型 string 説明ダイアログ内のメッセージを識別する一意のキー。翻訳済み表示ラベルをメッセージ内の表示ラベルにリンクするために使用します。この項目はすべてのメッセージレコードで推奨され、メッセージの翻訳済み表示ラベルでは必須です。 UI を介してメッセージを作成する場合、messageIdentifier は自動的に生成されます。API を介してメッセージを作成する場合、messageIdentifier を指定する必要があります。messageIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。

項目名

説明

message

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

messageIdentifier

項目の型: string
説明: ダイアログ内のメッセージを識別する一意のキー。翻訳済み表示ラベルをメッセージ内の表示ラベルにリンクするために使用します。この項目はすべてのメッセージレコードで推奨され、メッセージの翻訳済み表示ラベルでは必須です。
UI を介してメッセージを作成する場合、messageIdentifier は自動的に生成されます。API を介してメッセージを作成する場合、messageIdentifier を指定する必要があります。messageIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。

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 型の列挙) 説明必須。条件操作の左側で使用する変数の型。値は次のとおりです。 `ContextVariable` `ConversationVariable`
operatorType	項目の型 BotStepConditionOperatorType (string 型の列挙) 説明必須。値は次のとおりです。 `Equals` `GreaterThan` `GreaterThanOrEqualTo` `IsNotSet` `IsSet` `LessThan` `LessThanOrEqualTo` `NotEquals`
rightOperandValue	項目の型 string 説明条件操作の右側で使用する値。`IsSet` および `IsNotSet` 演算子を使用する場合、この値は無視されます。

BotVariableOperation

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

項目名	説明
askCollectIfSet	項目の型 boolean 説明 `true` の場合、変数にすでに値が含まれているかどうかにかかわらず、ボットは `Collect` 種別のボット変数操作を実行します。変数の値が存在する場合、ボットはユーザに関連情報の入力を求め、既存の値をユーザが入力した値で上書きします。`false` の場合、ボットは既存の値が含まれる変数をスキップし、既存の値を維持します。デフォルトは、`false` です。
autoSelectIfSingleChoice	項目の型 boolean 説明 `true` の場合、種別が `Collect` で quickReplyType 値が `Dynamic` のボット変数操作で 1 つのボタン選択のみが使用可能なときは、ボットは会話フロー内で回答を自動的に選択します。`false` の場合、ボットは 1 つのボタン選択を表示してユーザの応答を待機します。デフォルトは、`false` です。
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` です。
quickReplyOptionTemplate	項目の型 string 説明 `Object` 種別の動的選択肢オプションの表示ラベルを解決するために使用する数式テンプレート。
quickReplyType	項目の型 BotQuickReplyType (string 型の列挙) 説明値は次のとおりです。 `Dynamic` `Static`
quickReplyWidgetType	項目の型 BotWidgetType (string 型の列挙) 説明値は次のとおりです。 `Buttons` `Menu`
retryMessages	項目の型 BotMessage[] 説明会話の修正で、修正試行に割り当てられているメッセージ。
sourceVariableName	項目の型 string 説明変数操作で使用する取得元 VariableName の名前。
sourceVariableType	項目の型 ConversationVariableType (string 型の列挙) 説明この名前は、変数操作で使用する VariableName のデータ型を定義します。値は次のとおりです。 `ContextVariable` `ConversationVariable`
type	項目の型 BotVariableOperationType (string 型の列挙) 説明必須。値は次のとおりです。 `Collect` `Set` `SetConversationLanguage` `Unset`
variableOperationIdentifier	項目の型 string 説明ダイアログ内の変数操作を識別する一意のキー。翻訳済み表示ラベルを変数操作内の表示ラベルにリンクするために使用します。この項目はすべての変数操作レコードで推奨され、変数操作の翻訳済み表示ラベルでは必須です。 UI を介して変数操作を作成する場合、variableOperationIdentifier は自動的に生成されます。API を介して変数操作を作成する場合、variableOperationIdentifier を指定する必要があります。variableOperationIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。

BotQuickReplyOption

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

項目名	説明
literalValue	項目の型 string 説明必須。メニューまたはボタンの選択肢として顧客に表示する値。
quickReplyOptionIdentifier	項目の型 string 説明ダイアログ内のクイック返信オプションを識別する一意のキー。翻訳済み表示ラベルをクイック返信オプション内の表示ラベルにリンクするために使用します。この項目はすべてのクイック返信オプションレコードで推奨され、クイック返信オプションの翻訳済み表示ラベルでは必須です。 UI を介してクイック返信オプションを作成する場合、quickReplyOptionIdentifier は自動的に生成されます。API を介してメッセージを作成する場合、quickReplyOptionIdentifier を指定する必要があります。quickReplyOptionIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。

項目名

説明

literalValue

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

quickReplyOptionIdentifier

項目の型: string
説明: ダイアログ内のクイック返信オプションを識別する一意のキー。翻訳済み表示ラベルをクイック返信オプション内の表示ラベルにリンクするために使用します。この項目はすべてのクイック返信オプションレコードで推奨され、クイック返信オプションの翻訳済み表示ラベルでは必須です。
UI を介してクイック返信オプションを作成する場合、quickReplyOptionIdentifier は自動的に生成されます。API を介してメッセージを作成する場合、quickReplyOptionIdentifier を指定する必要があります。quickReplyOptionIdentifier には、文字、数字、ダッシュ、アンダースコアを 255 文字まで含めることができます。

BotVariableOperand

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

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

ConversationRecordLookup

リンク済みの会話に関連する情報。現在は、Lightning Knowledge でのみ機能します。

項目名	説明
SObjectType	項目の型 string 説明必須。ボット変数に保存されている ID の SObjectType を指定します。
conditions	項目の型 ConversationRecordLookupCondition[] 説明この検索に関連付けられた条件。
filterLogic	項目の型 string 説明条件を接続する論理演算子。値は次のとおりです。 `And` `Or`
lookupFields	項目の型 ConversationRecordLookupField[] 説明この検索に使用される項目の定義。
maxLookupResults	項目の型 int 説明必須。返すレコードの最大数 (1 ～ 3)。
sortFieldName	項目の型 string 説明検索結果の並び替えに使用される項目の名前。
sortOrder	項目の型 SortOrder (string 型の列挙) 説明検索結果の表示順序。値は次のとおりです。 `Asc` `Desc`
sourceVariableName	項目の型 string 説明この検索操作の入力。
sourceVariableType	項目の型 ConversationVariableType (string 型の列挙) 説明変数操作で使用するコピー先の型。値は次のとおりです。 `ContextVariable` `ConversationVariable`
targetVariableName	項目の型 string 説明必須。この検索の結果を保持する変数。

ConversationRecordLookupCondition

ConversationRecordLookup に関連付けられた条件のリスト。

項目名	説明
leftOperand	項目の型 string 説明必須。条件操作が実行される項目。
operatorType	項目の型 string 説明必須。 leftOperand に適用される演算子。値は次のとおりです。 `Equals` `NotEquals` `IsSet` `IsNotSet` `GreaterThan` `LessThan` `GreaterThanOrEqualTo` `LessThanOrEqualTo`
rightOperandName	項目の型 string 説明比較する変数の名前。
rightOperandType	項目の型 ConversationVariableType (string 型の列挙) 説明比較する変数の型。値は次のとおりです。 `ContextVariable` `ConversationVariable`
rightOperandValue	項目の型 string 説明比較するカスタム値。`IsSet` および `IsNotSet` 演算子を使用する場合、この値は無視されます。
sortOrder	項目の型 int 説明必須。条件の適用順序。

ConversationRecordLookupField

会話レコードの検索で使用される項目。

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

ConversationSystemMessage

ボットステップのアクション (エージェントへの転送やチャットの終了など) を表すシステムメッセージ。

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

ConversationSystemMessageMapping

システムメッセージについて提供される追加情報を示す対応付けのリスト。

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

ConversationDefinitionRichMessage

拡張リンクなどのメッセージングコンポーネントを参照するための設定の詳細を表します。

項目名	説明
messageDefinitionMappings	項目の型 BotInvocationMapping[] 説明メッセージングコンポーネントを参照する対応付けのリスト。入力パラメータとその値を含みます。必要に応じて、出力を保存するための会話変数を指定できます。入力パラメータ値は、静的値か、会話変数またはコンテキスト変数への参照のいずれかにできます。
messageDefinitionName	項目の型 string 説明必須。ボットによって参照されるメッセージングコンポーネントの API 参照名。

項目名

説明

messageDefinitionMappings

項目の型: BotInvocationMapping[]
説明: メッセージングコンポーネントを参照する対応付けのリスト。入力パラメータとその値を含みます。必要に応じて、出力を保存するための会話変数を指定できます。
入力パラメータ値は、静的値か、会話変数またはコンテキスト変数への参照のいずれかにできます。

messageDefinitionName

項目の型: string
説明: 必須。
ボットによって参照されるメッセージングコンポーネントの API 参照名。

ConversationContextVariable

現在のボットのローカルのコンテキスト変数。

項目名	説明
SObjectType	項目の型 string 説明有効な値は、次のとおりです。 `BotDefinition` `Queue`
contextVariableMappings	項目の型 ConversationContextVariableMapping[] 説明コンテキスト変数、チャネル種別、および sObject 項目間の対応付けを表します。
dataType	項目の型 ConversationDataType (string 型の列挙) 説明必須。コンテキスト変数のデータ型を表します。値は次のとおりです。 `Boolean` `Currency` `Date` `DateTime` `Id` `Number` `Object` `Text`
developerName	項目の型 string 説明必須。コンテキスト変数の名前を表します。アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、スペースは使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。
label	項目の型 string 説明必須。 Salesforce ユーザインターフェース全体でコンテキスト変数を識別する表示ラベル。

ConversationContextVariableMapping

コンテキスト変数、チャネル種別、および sObject 項目間の対応付けを表します。

項目名	説明
SObjectType	項目の型 string 説明必須。対応付けの一部として定義する項目プロパティの sObject 型。値は次のとおりです。 `LiveChatTranscript` `MessagingEndUser` `MessagingSession`
fieldName	項目の型 string 説明必須。対応付けの一部として使用する sObject 項目の API 参照名。
messageType	項目の型 MessageType (string 型の列挙) 説明必須。チャネル (SMS メッセージまたはチャットのいずれか) を表します。値は次のとおりです。 `Alexa` `AppleBusinessChat` `EmbeddedMessaging` `Facebook` `GoogleHome` `Line` `Omega` `Phone` `Text` `Voice` `WeChat` `WebChat` `WhatsApp`

ConversationSystemDialog

ダイアログに割り当てられているシステム機能。

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

ConversationVariable

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

項目名	説明
SObjectType	項目の型 string 説明ボット変数に保存されている ID の SObjectType を指定します。値は次のとおりです。 `BotDefinition` `Queue`
collectionType	項目の型 ConversationVariableCollectionType (string 型の列挙) 説明この項目は、変数をリスト変数として指定するかどうかを定義します。値は次のとおりです。 `List`
dataType	項目の型 ConversationDataType (string 型の列挙) 説明必須。値は次のとおりです。 `Boolean` `Currency` `Date` `DateTime` `Id` `Number` `Object` `Text`
developerName	項目の型 string 説明必須。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、スペースは使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。「DeveloperName を表示」または「設定・定義を参照する」権限を持っているユーザのみがこの項目の表示、グループ化、並び替え、絞り込みを行えます。メモ
label	項目の型 string 説明必須。 Salesforce ユーザインターフェース全体で変数を識別する表示ラベル。

LocalMlDomain

現在のボットテンプレートのローカルの Einstein Intent セット。

項目名	説明
label	項目の型 string 説明必須。 Salesforce ユーザインターフェース全体で、現在のボットバージョンのローカルの Einstein Intent セットを表す表示ラベル。
mlIntents	項目の型 MlIntent[] 説明このローカルインテントセットに関連付けられたインテントのリスト。
mlSlotClasses	項目の型 MlSlotClass[] 説明このローカルインテントセットに関連付けられたエンティティのリスト。
name	項目の型 string 説明必須。一意の名前を使用して、他のローカル Einstein Intent セットとの競合を回避します。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、スペースは使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。

MlIntent

Einstein Intent セットの Intent。

項目名	説明
description	項目の型 string 説明 Einstein Intent セットの説明。
developerName	項目の型 string 説明必須。一意の名前を使用して、同じボットバージョンに関連付けられた他の Einstein Intent セットとの競合を回避します。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、スペースは使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。「DeveloperName を表示」または「設定・定義を参照する」権限を持っているユーザのみがこの項目の表示、グループ化、並び替え、絞り込みを行えます。メモ
label	項目の型 string 説明必須。 Einstein Intent セットの名前。
mlIntentUtterances	項目の型 MlIntentUtterance[] 説明このインテントへの顧客の入力のリスト。
relatedMlIntents	項目の型 MlRelatedIntent[] 説明このインテントへの顧客の入力を展開するために使用する Einstein Intent セットのインテントのリスト。ローカルの Einstein Intent セットのインテントにのみ、関連するインテントがあります。

MlIntentUtterance

このインテントへの顧客の入力。

項目名	説明
language	項目の型 Language (string 型の列挙) 説明 MlIntentUtterance の言語。
utterance	項目の型 string 説明必須。親インテントをトリガし、ボットにこのインテントに関連付けられたダイアログを実行するよう要求する、顧客の入力または自然言語によるクエリ。

MlRelatedIntent

このインテントへの顧客の入力を展開するために使用する Einstein Intent セットのインテント。ローカルの Einstein Intent セットのインテントにのみ、関連するインテントがあります。

項目名	説明
relatedMlIntent	項目の型 string 説明必須。現在の親インテントの顧客の入力を展開するために使用するインテントの名前。

MlSlotClass

この Einstein Intent セットのエンティティ。

項目名	説明
dataType	項目の型 MlSlotClassDataType (string 型の列挙) 説明必須。 MISlotClass で使用可能なデータ型のリスト。値は次のとおりです。 `Boolean` `Currency` `Date` `DateTime` `Number` `Text`
description	項目の型 string 説明 Einstein Bot エンティティの説明。
developerName	項目の型 string 説明必須。一意の名前を使用して、Einstein Intent セット内の他のエンティティとの競合を回避します。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、スペースは使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。「DeveloperName を表示」または「設定・定義を参照する」権限を持っているユーザのみがこの項目の表示、グループ化、並び替え、絞り込みを行えます。メモ
extractionRegex	項目の型 string 説明種別が `Pattern` に設定されている場合にエンティティを抽出するために使用する正規表現。
extractionType	項目の型 MlSlotClassExtractionType (string 型の列挙) 説明値は次のとおりです。 `Pattern` `Value`
label	項目の型 string 説明必須。 Salesforce ユーザインターフェース全体でエンティティを識別する表示ラベル。
mlSlotClassValues	項目の型 MlSlotClassValue[] 説明 `Value` 種別のエンティティに関連付けられたエンティティ値のリスト。

MlSlotClassValue

Value 種別のエンティティに関連付けられたエンティティ値。

項目名	説明
synonymGroup	項目の型 SynonymGroup[] 説明現在のエンティティ値の用語またはシノニムのリストを表します。
value	項目の型 string 説明必須。 `Value` 種別のエンティティを抽出するために使用する 1 つの値。

SynonymGroup

同義の単語または語句のグループを表します。

項目名	説明
languages	項目の型 Language[] (string 型の列挙) 説明値リストを適用する言語を指定します。値リスト項目が 1 つの言語に固有である場合は、その言語のみを指定します。値リスト項目を複数の言語に適用する場合は、1 つの値リストに複数の言語を指定します。
terms	項目の型 string[] 説明値リストの他の用語と同義の単語または語句です。

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

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

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

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

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

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

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