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

予測定義は、リリース済みの 1 つ以上のモデルに関連付けられた Einstein Discovery のコンテナオブジェクトです。予測定義に複数のモデルが含まれている場合、モデルごとに異なるデータ区分の予測が生成されます。予測定義には最大 10 個の有効なモデルを含めることができます。パッケージマネージャでは、この種別は [Discovery 予測] として表示されます。

宣言的なメタデータファイルのサフィックスおよびディレクトリの場所

DiscoveryGoal は、discovery フォルダに保存されます。DiscoveryGoal のファイルのサフィックスは .goal です。次に、サンプルの package.xml ファイルを示します。

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

バージョン

DiscoveryGoal は、API バージョン 51.0 以降で使用できます。

項目

項目名	項目の型	説明
active	boolean	予測定義が有効であるか (True)、否か (False) を示します。
deployedModels	DiscoveryDeployedModel[]	この予測定義に関連付けられている 1 つ以上のリリース済みモデル。
label	string	予測定義の名前。
modelCards	DiscoveryModelCard[]	この予測定義のモデルカード。
outcome	DiscoveryGoalOutcome	この予測定義の結果変数。
predictionType	DiscoveryPredictionType	予測の種別。Regression、Classification、Unknown があります。
pushbackField	string	予測用の自動ライトバック項目。subscribedEntity に指定された Salesforce オブジェクトのカスタム項目。プッシュバック項目は、目標メタデータから削除すると Salesforce オブジェクトからも削除されます。メモ
pushbackType	DiscoveryPushbackType	予測用のライトバック項目の型。
subscribedEntity	string	このモデルに関連付けられている Salesforce オブジェクト。
terminalStateFilters	DiscoveryFilter[]	指定する場合、観察が最終状態を達成した (実際の結果が達成された) 条件を定義する 1 つ以上の検索条件式。パフォーマンス監視のため、Einstein Discovery は、モデルの予測結果と実際の (観察された) 結果を比較してモデルの精度を判断します。

DiscoveryDeployedModel

Salesforce にリリースされたモデルを表します。

項目名	項目の型	説明
active	boolean	リリースされたモデルが有効か (True)、無効か (False) を示します。
aiModel	string	リリースされている DiscoveryAIModel の完全名。
classificationThreshold	double	しきい値。バイナリ分類モデルにのみ適用されます。回帰モデルの場合は null になります。
fieldMappings	DiscoveryFieldMap[]	項目 (Salesforce オブジェクトの場合) または列 (CRM Analytics データセットの場合) のいずれかとモデル変数の間の 1 つ以上の対応付け。
filters	DiscoveryFilter[]	指定した場合、1 つ以上のセグメンテーション検索条件により、リリースされたモデルを絞り込みます。予測を行うときは、検索条件が特定の入力行に一致した最初のモデルが使用されます。モデルがすべての入力行に一致することを示す検索条件はありません。
label	string	リリースされたモデルの表示ラベル。モデルマネージャに表示されます。
name	string	リリースされたモデルの名前。
prescribableFields	DiscoveryPrescribableField[]	改善に関連付けられているアクション可能な項目。

DiscoveryFieldMap

モデル変数と項目値の対応付けを表します。

項目名	項目の型	説明
mappedField	string	CRM Analytics データセットの Salesforce オブジェクトまたは列の項目。
modelField	string	モデル変数。
sobjectFieldJoinKey	string	Salesforce オブジェクトの結合キー。sourceType が AnalyticsDatasetField の場合は null です。
source	string	対応付けの対象が CRM Analytics データセットの場合は、データセットの名前です。それ以外の場合は、null。
sourceFieldJoinKey	string	対応付けの対象が CRM Analytics データセットの場合は、結合を実行するために使用されるそのデータセットのルックアップ列です。それ以外の場合は、null。
sourceType	DiscoveryFieldMapSourceType	項目の対応付け用のデータソース種別。

DiscoveryFieldMapSourceType

項目の対応付け用のデータソース種別を表します。SalesforceField または AnalyticsDatasetField があります。

項目名	項目の型	説明
SalesforceField	string	Salesforce オブジェクトの項目。
AnalyticsDatasetField	string	CRM Analytics データセットの��。

DiscoveryFilter

項目の検索条件を表します。

項目名	項目の型	説明
field	string	絞り込む項目の名前。
operator	DiscoveryFilterOperator	検索条件の計算のために使用される演算子。
type	DiscoveryFilterFieldType	検索条件の値の種別。
values	DiscoveryFilterValue[]	検索条件用に選択された 1 つ以上の値。

DiscoveryFilterOperator

検索条件の演算子を表します。

項目名	項目の型	説明
Equal	string	等号演算子 (=)。
NotEqual	string	非等号演算子 (<>)。
GreaterThan	string	より大演算子 (>)。
GreaterThanOrEqual	string	より大か等しい演算子 (>=)。
LessThan	string	より小演算子 (<)。
LessThanOrEqual	string	より小か等しい演算子 (<=)。
Between	string	二値間演算子。
NotBetween	string	非二値間演算子。
InSet	string	組内演算子。
NotIn	string	組外演算子。
Contains	string	内包演算子。
StartsWith	string	先頭演算子。
EndsWith	string	末尾演算子。
IsNull	string	空値演算子。
IsNotNull	string	非空値演算子。

DiscoveryFilterFieldType

検索条件項目のデータ型を表します。

項目名	項目の型	説明
Text	string	テキスト項目型。
Number	string	数値項目型。
Date	string	日付項目型。
DateTime	string	日時項目型。
Boolean	string	ブール項目型。

DiscoveryFilterValue

検索条件の値を表します。

項目名	項目の型	説明
type	DiscoveryFilterValueType	検索条件の値の種別。
value	DiscoveryFilterValue	値。

DiscoveryFilterValueType

検索条件値の種別を表します。

項目名	項目の型	説明
Constant	string	検索条件値は定数です。
PlaceHolder	string	検索条件値はプレースホルダです。

DiscoveryPrescribableField

カスタム改善テキストを表します。

項目名	項目の型	説明
customDefinitions	DiscoveryCustomPrescribableFieldDefinition[]	カスタム改善テキストの 1 つ以上の文字列。何も指定されていない場合は、デフォルトの改善テキストを使用します。
name	string	アクション可能なモデル項目の名前。

DiscoveryCustomPrescribableFieldDefinition

カスタム改善テキスト内の項目定義を表します。

項目名	項目の型	説明
filters	DiscoveryFilter[]	カスタム改善テキストに関連付けられている 1 つ以上の検索条件を表します。
template	string	指定した場合、カスタムテキストが計算されるユーザ提供のテンプレートを表します。指定しない場合、デフォルトのテキストが使用されます。

DiscoveryModelCard

Einstein Discovery 予測定義に関連付けられたモデルカードを表します。

項目名	項目の型	説明
contactEmail	string	このモデルカードの取引先責任者メール。
contactName	string	このモデルカードの取引先責任者名。
label	string	このモデルカードのタイトル。
sections	string	モデルカード内のセクション。

DiscoveryGoalOutcome

モデルの結果変数を表します。

項目名	項目の型	説明
field	string	結果変数の名前。
fieldLabel	string	結果変数の表示ラベル。
goal	DiscoveryOutcomeGoal	結果変数の目標。
mappedField	string	対応付けられた項目。

DiscoveryOutcomeGoal

結果の目標を表します。

項目名	項目の型	説明
Minimize	string	結果を最大化します。
Maximize	string	結果を最小化します。
None	string	将来の使用のために予約されています。

DiscoveryPredictionType

モデルの予測種別を表します。

項目名	項目の型	説明
Unknown	string	不明な予測種別。
Regression	string	回帰予測 (数値の使用事例)。
Classification	string	バイナリ分類予測。
MulticlassClassification	string	マルチクラス分類予測。

DiscoveryPushbackType

書き戻し項目の型を表します。AiRecordInsight に設定する必要があります。

項目名	項目の型	説明
AiRecordInsight	string	自動書き戻し種別。必須。
Direct	string	現在サポート��れていません。将来の使用のために予約されています。

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

次に、サンプルの DiscoveryGoal を示します。

1<?xml version="1.0" encoding="UTF-8"?>
2<DiscoveryGoal xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3   <active>true</active>
4   <deployedModels>
5      <active>true</active>
6      <aiModel>Maximize_Tenure</aiModel>
7      <fieldMappings>
8         <mappedField>Opportunity.Amount</mappedField>
9         <modelField>PTO</modelField>
10         <sourceType>SalesforceField</sourceType>
11      </fieldMappings>
12      <fieldMappings>
13         <mappedField>Opportunity.ExpectedRevenue</mappedField>
14         <modelField>Salary</modelField>
15         <sourceType>SalesforceField</sourceType>
16      </fieldMappings>
17      <fieldMappings>
18         <mappedField>Level</mappedField>
19         <modelField>Level</modelField>
20         <sobjectFieldJoinKey>Opportunity.Name</sobjectFieldJoinKey>
21         <source>employees</source>
22         <sourceFieldJoinKey>Name</sourceFieldJoinKey>
23         <sourceType>AnalyticsDatasetField</sourceType>
24      </fieldMappings>
25      <fieldMappings>
26         <mappedField>Opportunity.StageName</mappedField>
27         <modelField>Field</modelField>
28         <sourceType>SalesforceField</sourceType>
29      </fieldMappings>
30      <filters>
31         <field>Opportunity.StageName</field>
32         <operator>Equal</operator>
33         <values>
34            <type>Constant</type>
35            <value>Qualification</value>
36         </values>
37      </filters>
38      <label>employees</label>
39      <name>employees</name>
40      <prescribableFields>
41         <customDefinitions>
42           <filters>
43              <field>Salary</field>
44              <operator>LessThan</operator>
45              <type>Number</type>
46              <values>
47                 <type>PlaceHolder</type>
48                 <value>[value_low]</value>
49              </values>
50           </filters>
51           <template>Increase [field_name] by [diff]</template>
52         </customDefinitions>
53         <customDefinitions>
54            <filters>
55               <field>Salary</field>
56               <operator>GreaterThan</operator>
57               <type>Number</type>
58               <values>
59                   <type>PlaceHolder</type>
60                   <value>[value_low]</value>
61                </values>
62             </filters>
63             <template xsi:nil="true"/>
64          </customDefinitions>
65          <name>Salary</name>
66      </prescribableFields>
67      <prescribableFields>
68          <customDefinitions>
69             <filters>
70                <field>Level</field>
71                <operator>LessThan</operator>
72                <type>Number</type>
73                <values>
74                   <type>PlaceHolder</type>
75                   <value>[value_low]</value>
76                </values>
77            </filters>
78            <template xsi:nil="true"/>
79          </customDefinitions>
80          <customDefinitions>
81             <filters>
82                <field>Level</field>
83                <operator>GreaterThan</operator>
84                <type>Number</type>
85                <values>
86                   <type>PlaceHolder</type>
87                   <value>[value_low]</value>
88                 </values>
89              </filters>
90              <template xsi:nil="true"/>
91          </customDefinitions>
92          <name>Level</name>
93      </prescribableFields>
94      <prescribableFields>
95         <name>Field</name>
96      </prescribableFields>
97   </deployedModels>
98   <label>employees_Tenure</label>
99   <outcome>
100      <field>Tenure</field>
101      <fieldLabel>Tenure</fieldLabel>
102      <goal>Maximize</goal>
103      <mappedField>Opportunity.Amount</mappedField>
104   </outcome>
105   <predictionType>Regression</predictionType>
106   <pushbackField>My_Pushback_Field__c</pushbackField>
107   <subscribedEntity>Opportunity</subscribedEntity>
108   <terminalStateFilters>
109      <field>Opportunity.Amount</field>
110      <operator>GreaterThan</operator>
111      <values>
112         <type>Constant</type>
113         <value>5</value>
114      </values>
115   </terminalStateFilters>
116   <terminalStateFilters>
117      <field>Opportunity.Amount</field>
118      <operator>LessThan</operator>
119      <values>
120         <type>Constant</type>
121         <value>10</value>
122      </values>
123   </terminalStateFilters>
124</DiscoveryGoal>

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

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