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

親種別

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

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

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

バージョン

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

特別なアクセスルール

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

項目

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

BotDialogGroup

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

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

BotDialog

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

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

BotInvocation

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

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

BotInvocationMapping

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

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

BotMessage

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

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

項目名

説明

message

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

messageIdentifier

項目の型: string
説明: ダイアログ内のメッセージを識別する一意のキー。翻訳済み表示ラベルをメッセージ内の表示ラベルにリンクするために使用します。この項目はすべてのメッセージレコードで推奨され、メッセージの翻訳済み表示ラベルでは必須です。API バージョン 53.0 以降で利用できます。
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 説明このボットナビゲーションリンクの一部としてコールする対象のダイアログの名前。
targetVariable	項目の型 string 説明 [ダイアログにリダイレクト] ルールアクションにおいて、このボットナビゲーションリンクの一部としてコールする対象オブジェクト変数の ID。API バージョン 57.0 以降で利用できます。
targetVariableType	項目の型 ConversationVariableType (string 型の列挙) 説明 [ダイアログにリダイレクト] ルールアクションにおいて、targetVariable で参照される変数のデータ型。API バージョン 57.0 以降で利用できます。値は次のとおりです。 `ContextVariable` `ConversationVariable`

BotStepCondition

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

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

BotVariableOperation

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

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

BotQuickReplyOption

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

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

項目名

説明

literalValue

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

quickReplyOptionIdentifier

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

BotVariableOperand

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

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

ConversationRecordLookup

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

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

ConversationRecordLookupCondition

ConversationRecordLookup に関連付けられた条件のリスト。API バージョン 51.0 以降で利用できます。

項目名	説明
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

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

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

ConversationDefinitionStepGoalMapping

目標と BotStep との間の関連を表します。目標は一度に 1 つの BotStep およびダイアログにのみ関連付けることができます。API バージョン 57.0 以降で利用できます。

項目名	説明
goalName	項目の型 string 説明目標の API 参照名。

ConversationSystemMessage

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

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

ConversationSystemMessageMapping

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

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

ConversationDefinitionRichMessage

拡張リンクなどのメッセージングコンポーネントを参照するための設定の詳細を表します。API バージョン 54.0 以降で利用できます。

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

項目名

説明

messageDefinitionMappings

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

messageDefinitionName

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

ConversationDefinitionGoal

ボットバージョンに含まれる目標。API バージョン 57.0 以降で使用できます。

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

項目名

説明

developerName

項目の型: string
説明: 必須。
同じボットバージョンに関連付けられた他の目標との競合を回避する一意の名前。この名前には、アンダースコアと英数字のみを使用できます。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。

label

項目の型: string
説明: 必須。
Salesforce ユーザーインターフェース全体で目標を識別する表示ラベル。この表示ラベルには、アンダースコアと英数字のみを使用できます。最初は文字であること、スペースは使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。

ConversationSystemDialog

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

項目名	説明
dialog	項目の型 string 説明このシステムイベントが起動されたときにトリガーされるダイアログ名。
type	項目の型 ConversationSystemDialogType (string 型の列挙) 説明システムイベントの種別。必須。有効な値は、次のとおりです。 `Disambiguation` (将来の使用のために予約) `DisambiguationFailed` (将来の使用のために予約) `ErrorHandling` `KnowledgeFallback` (API バージョン 51.0 で使用可能)。 `TransferFailed`

ConversationVariable

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

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

ConversationDefinitionNlpProvider

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

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

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

次に、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&apos;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&apos;s Pizza</label>
164</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 ファイルを使用したメタデータのリリースと取得」を参照してください。