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

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

重要

親種別

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

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

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

バージョン

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

特別なアクセスルール

AIUsecaseDefinition オブジェクトは AI アクセラレータの管理者設定と使用事例に関連する製品の管理者設定が有効になっている場合に使用できます。Salesforce 組織に CRM Plus ライセンスと製品の CRM ライセンスがある必要があります。

項目

項目名	説明
aiUsecaseFieldMappings	項目の型 AIUsecaseFieldMapping[] 説明使用事例定義の項目の対応付け。各使用事例定義には複数の対応付けを含めることができます。
aiUsecaseModels	項目の型 AIUsecaseModel[] 説明使用事例定義のモデル。各使用事例定義には複数の使用事例モデルを含めることができます。
creatorType	項目の型 CreatorType (string 型の列挙) 説明必須。 AI アクセラレータが使用する使用事例定義を作成したユーザの種別。有効な値は、次のとおりです。 `INTERNAL_USER` `SALESFORCE_ADMIN` API バージョン 57.0 以降で利用できます。
masterLabel	項目の型 string 説明必須。使用事例定義のわかりやすい名前。使用事例定義の作成時に定義されます。
maximumInsightCount	項目の型 int 説明スコアリング応答によって返されるインサイトの最大数。
maximumRecommendationCount	項目の型 int 説明 Next Best Action 戦略によって返されるおすすめの最大数。
maximumSuggestionCount	項目の型 int 説明スコアリング応答によって返される提案の最大数。
primaryResponseObject	項目の型 string 説明指定された項目の対応付けに基づいてスコアリング応答が保存される主オブジェクト。
recommendationResponseObject	項目の型 string 説明使用事例定義に関連付けられたおすすめ応答オブジェクト。
recommendationSource	項目の型 RcmdSourceType (string 型の列挙) 説明おすすめを生成するツールまたはプラットフォーム。有効な値は、次のとおりです。 `Next_Best_Action_Flow` `None` API バージョン 57.0 以降で利用できます。
secondaryResponseObject	項目の型 string 説明指定された項目の対応付けに基づいてスコアリング応答が保存されるオブジェクト。
shouldSaveFeatures	項目の型 boolean 説明スコアリング要求用に抽出された特徴を保存するか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。
shouldSaveInsights	項目の型 boolean 説明スコアを生成するために使用される予測インサイトを保存するか (`true`) 否か (`false`) を示します。デフォルト値は、`false` です。
shouldSaveRecommendation	項目の型 boolean 説明おすすめを保存するか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。
shouldSaveRequestResponse	項目の型 boolean 説明要求の応答を保存するか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。
shouldSaveScore	項目の型 boolean 説明予測スコアを保存するか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。
shouldSaveSuggestions	項目の型 boolean 説明予測スコアを改��する提案を保存するか (`true`)、否か (`false`) を示します。デフォルト値は、`false` です。
suggestionImpactMinimumPct	項目の型 int 説明提案に基づいて既存の予測スコアを改善するために対象となる最小パーセント。スコアに対して指定したパーセントよりも大きい影響を持つ提案は予測スコアカードに表示されます。
usecaseName	項目の型 string 説明必須。使用事例定義の名前。

AIUsecaseFieldMapping

抽出された特徴、予測スコア、予測インサイト、使用事例の提案を応答オブジェクトに保存するための項目の対応付けに関する情報を表します。

項目名	説明
developerName	項目の型 string 説明使用事例定義の項目の対応付けの一意の名前。必須。API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更は登録者の組織で反映されます。表示ラベルは [レコードタイプ名] です。
mappedFieldName	項目の型 string 説明必須。スコアリング応答が保存される項目の名前。
mappedFieldType	項目の型 MappedFieldType (string 型の列挙) 説明必須。対応付けられた項目の種別。有効な値は、次のとおりです。 `FEATURE` `PREDICTION_SCORE` `INSIGHT` `SUGGESTION` `SECONDARY_RESPONSE_RECORD_ID` `RECOMMENDATION_RESPONSE_RECORD_ID` `RECOMMENDATION` デフォルト値は `FEATURE` です。
masterLabel	項目の型 string 説明必須。使用事例の項目の対応付けのわかりやすい名前。項目の対応付けの作成時に定義されます。
responseFieldName	項目の型 string 説明必須。スコアを保存する項目に対応付けられている応答オブジェクトの項目の名前。
responseObject	項目の型 string 説明必須。スコアを保存する項目に対応付けられている項目のオブジェクト。AIUsecaseDefinition オブジェクトで指定された PrimaryResponseObject または SecondaryResponseObject のいずれかです。
sequenceNumber	項目の型 int 説明項目の対応付けに保存されている情報の連番。

AIUsecaseModel

使用事例の予測を生成する機械学習モデルに関する情報を表します。

項目名	説明
aiFeatureExtractors	項目の型 AIFeatureExtractor[] 説明入力データを取得する AI 特徴抽出。
defaultFeatureExtractor	項目の型 AIFeatureExtractor 説明入力データを取得するデフォルトの AI 特徴抽出。
developerName	項目の型 string 説明使用事例モデルの一意の名前。必須。API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更は登録者の組織で反映されます。表示ラベルは [レコードタイプ名] です。
masterLabel	項目の型 string 説明必須。使用事例モデルのわかりやすい名前。使用事例モデルの作成時に定義されます。
predictionDefinition	項目の型 string 説明必須。使用事例モデルに関連する予測定義の一意の識別子。この識別子は外部 ID にすることもできます。Einstein Discovery を使用してモデルを作成する場合、`predictionDefinition` 項目にはレコードの API 参照名が保存されます。
predictionPlatform	項目の型 PredictionPlatform (string 型の列挙) 説明必須。機械学習モデルが作成され、リリースされるプラットフォーム。有効な値は、次のとおりです。 `Einstein_Discovery` `Default` — 内部使用のみ。デフォルト値は `Einstein_Discovery` です。API バージョン 57.0 以降で利用できます。

AIFeatureExtractor

予測の生成に使用される使用事例モデルの入力データを取得する特徴抽出に関する情報を表します。

項目名	説明
batchInputSourceIdentifier	項目の型 string 説明一括処理ジョブで計算された特徴の入力ソースの ID。この ID は予測の生成のためにモデルで使用できます。API バージョン 57.0 以降で利用できます。
className	項目の型 string 説明必須。特徴抽出用に作成された Apex クラスの ID。
developerName	項目の型 string 説明特徴抽出の一意の名前。必須。API のオブジェクトの一意の名前。この名前は、アンダースコアと英数字のみを使用でき、組織内で一意にする必要があります。最初は文字であること、空白は使用しない、最後にアンダースコアを使用しない、2 つ続けてアンダースコアを使用しないという制約があります。管理パッケージでこの項目を使用することにより、パッケージインストール時の名前の競合を回避します。この項目を使用して、開発者は管理パッケージのオブジェクト名を変更し、変更は登録者の組織で反映されます。表示ラベルは [レコードタイプ名] です。
extractorType	項目の型 ExtractorType (string 型の列挙) 説明必須。特徴抽出の種別。有効な値は、次のとおりです。 `APEX` `JAVA` `HYBRID` デフォルト値は `APEX` です。
featureInputType	項目の型 string 説明必須。予測の生成で使用される特徴入力種別。有効な値は、次のとおりです。 `Realtime_Input` `Sample_Input` `Batch_Input` `Batch_And_Realtime_Input` API バージョン 57.0 以降で利用できます。
inputContext	項目の型 string 説明特徴抽出のコンテキストとして機能する特徴を含む JSON ファイル。このデータには、アップロードされた CSV ファイルのデータを含めることもできます。API バージョン 57.0 以降で利用できます。
masterLabel	項目の型 string 説明必須。特徴抽出の分かりやすい名前。特徴抽出の作成時に定義されます。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<AIUsecaseDefinition xmlns="http://soap.sforce.com/2006/04/metadata">
3    <aiUsecaseFieldMappings>
4        <developerName>DevName1</developerName>
5        <mappedFieldName>Name</mappedFieldName>
6        <mappedFieldType>INSIGHT</mappedFieldType>
7        <masterLabel>DevName</masterLabel>
8        <responseFieldName>AnnualRevenue</responseFieldName>
9        <responseObject>Lead</responseObject>
10        <sequenceNumber>2</sequenceNumber>
11    </aiUsecaseFieldMappings>
12    <aiUsecaseFieldMappings>
13        <developerName>DevName2</developerName>
14        <mappedFieldName>Value</mappedFieldName>
15        <mappedFieldType>INSIGHT</mappedFieldType>
16        <masterLabel>DevName</masterLabel>
17        <responseFieldName>Id</responseFieldName>
18        <responseObject>Account</responseObject>
19        <sequenceNumber>2</sequenceNumber>
20    </aiUsecaseFieldMappings>
21    <aiUsecaseFieldMappings>
22        <developerName>DevName3</developerName>
23        <mappedFieldName>Score</mappedFieldName>
24        <mappedFieldType>PREDICTION_SCORE</mappedFieldType>
25        <masterLabel>DevName</masterLabel>
26        <responseFieldName>Company</responseFieldName>
27        <responseObject>Lead</responseObject>
28    </aiUsecaseFieldMappings>
29    <aiUsecaseFieldMappings>
30        <developerName>DevName4</developerName>
31        <mappedFieldName>RecordId</mappedFieldName>
32        <mappedFieldType>SECONDARY_RESPONSE_RECORD_ID</mappedFieldType>
33        <masterLabel>DevName</masterLabel>
34        <responseFieldName>Address</responseFieldName>
35        <responseObject>Lead</responseObject>
36    </aiUsecaseFieldMappings>
37    <aiUsecaseFieldMappings>
38        <developerName>DevName1</developerName>
39        <mappedFieldName>UsecaseModel1.inputScore</mappedFieldName>
40        <mappedFieldType>PREDICTION_SCORE_INPUT</mappedFieldType>
41        <masterLabel>DevName</masterLabel>
42        <responseFieldName>Score</responseFieldName>
43        <responseObject>LeadOutputDMO</responseObject>
44        <joinFieldName>LeadId</sequenceNumber>
45    </aiUsecaseFieldMappings>
46    <aiUsecaseModels>
47        <aiFeatureExtractors>
48            <className>01pxx0000004X2CAAU</className>
49            <extractorType>APEX</extractorType>
50            <developerName>DevName2</developerName>
51            <masterLabel>DevName</masterLabel>
52            <featureInputType>Realtime_Input</featureInputType>
53            <inputContext>"{columnNames=[column1, column2], rawData=[S, 315090]}"</inputContext>
54            <batchInputSourceIdentifier>DatasetName</batchInputSourceIdentifier>
55            <batchInputSourceType>CRMA</batchInputSourceType>
56        </aiFeatureExtractors>
57        <defaultFeatureExtractor>
58            <className>01pxx0000004X0aAAE</className>
59            <extractorType>APEX</extractorType>
60            <developerName>DevName1</developerName>
61            <masterLabel>DevName</masterLabel>
62            <featureInputType>Realtime_Input</featureInputType>
63            <inputContext>"{columnNames=[column1, column2], rawData=[S, 315090]}"</inputContext>
64            <batchInputSourceIdentifier>DatasetName</batchInputSourceIdentifier>
65        </defaultFeatureExtractor>
66        <developerName>DevName1</developerName>
67        <masterLabel>DevName</masterLabel>
68        <predictionDefinition>PredictionDefinitionD</predictionDefinition>
69        <predictionPlatform>Einstein_Discovery</predictionPlatform>
70        <arePredctGenInRealTime>true</arePredctGenInRealTime>
71    </aiUsecaseModels>
72    <aiUsecaseModels>
73        <developerName>DevName2</developerName>
74        <masterLabel>DevName</masterLabel>
75        <predictionDefinition>PredictionDefinitionBA</predictionDefinition>
76        <predictionPlatform>Einstein_Discovery</predictionPlatform>
77        <arePredctGenInRealTime>true</arePredctGenInRealTime>
78    </aiUsecaseModels>
79    <aiUsecaseModels>
80        <developerName>DevName3</developerName>
81        <masterLabel>DevName</masterLabel>
82        <predictionDefinition>PredictionDefinitionCA</predictionDefinition>
83        <predictionPlatform>Einstein_Discovery</predictionPlatform>
84        <arePredctGenInRealTime>true</arePredctGenInRealTime>
85    </aiUsecaseModels>
86    <masterLabel>DevName</masterLabel>
87    <maximumInsightCount>3</maximumInsightCount>
88    <maximumSuggestionCount>3</maximumSuggestionCount>
89    <maximumRecommendationCount>3</maximumRecommendationCount>
90    <primaryResponseObject>Lead</primaryResponseObject>
91    <secondaryResponseObject>Account</secondaryResponseObject>
92    <recommendationResponseObject>Contact</recommendationResponseObject>
93    <shouldSaveFeatures>true</shouldSaveFeatures>
94    <shouldSaveInsights>true</shouldSaveInsights>
95    <shouldSaveRecommendation>false</shouldSaveRecommendation>
96    <shouldSaveRequestResponse>false</shouldSaveRequestResponse>
97    <shouldSaveScore>true</shouldSaveScore>
98    <shouldSaveSuggestions>true</shouldSaveSuggestions>
99    <suggestionImpactMinimumPct>50</suggestionImpactMinimumPct>
100    <usecaseName>FTestSampleMLUsecase</usecaseName>
101    <recommendationSource>Next_Best_Action_Flow</recommendationSource>
102    <creatorType>INTERNAL_USER</creatorType>
103</AIUsecaseDefinition>

前の定義を参照する 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>*AIUsecaseDefinition*</name>
6    </types>
7    <version>59.0</version>
8</Package>

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

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