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

モデルとは、Einstein Discovery が過去の結果に関する包括的かつ統計的な理解に基づいて生成する高度なカスタムアルゴリズムのことです。Einstein Discovery ではモデルを使用して、将来の結果を予測します。モデルは、1 つ以上の予測変数の値を入力として受け入れて、予測結果を出力として生成します。要求に応じて、上位の要素と改善も生成されます。パッケージマネージャーでは、この種別は [Discovery モデル] として表示されます。

サードパーティのモデリングツールを使用してモデルを作成し、Analytics Studio のモデルマネージャーを使用してそのモデルを Salesforce にインポートすることもできます。

通常、DiscoveryAIModel オブジェクトの書き込み操作はサポートされません。

メモ

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

DiscoveryAIModel は、discovery フォルダーに保存されます。DiscoveryAIModel には、次の 2 つのファイルがあります。

サフィックスが .model であるファイルには、モデルの実際のデータが含まれます。
ModelName.model-meta.xml という名前のファイルには、モデルのメタデータが含まれます。

次に、サンプルの package.xml ファイルを示します。

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

バージョン

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

項目

項目名	項目の型	説明
algorithmType	DiscoveryAlgorithmType	このストーリーに関連付けられたモデルを作成するために Einstein Discovery が使用したアルゴリズム。
classificationThreshold	double	しきい値。バイナリ分類モデルにのみ適用されます。回帰モデルの場合は null になります。
description	string	モデルの説明。
label	string	モデルの表示ラベル。モデルをパッケージ化した場合、この表示ラベルは、パッケージマネージャーに表示されます。
modelFields	DiscoveryModelField[]	1 つ以上のモデル項目 (変数)。
modelRuntimeType	DiscoveryModelRuntimeType	モデルの実行時の種別。
predictedField	string	予測された項目の名前。
predictionType	DiscoveryPredictionType	予測の種別。次のいずれかの文字列になります。 Regression Classification Unknown
sourceType	DiscoveryModelSourceType	ソース種別。
status	DiscoveryAIModelStatus	モデルの状況 (有効または無効)。
trainingMetrics	string	トレーニングされたモデルに関する総計値を表す JSON オブジェクト。
transformations	DiscoveryModelTransform	1 つ以上のモデル変換。

DiscoveryAlgorithmType

モデルを作成するために Einstein Discovery が使用したアルゴリズムを表します。

項目名	項目の型	説明
Best	string	トーナメントモデル。パフォーマンス向上を目的とした決定ツリーの最適化のような、最適化および検索の問題に対して高品質のソリューションを生成するために使用される遺伝的アルゴリズム。
Glm	string	一般化された線形モデル。回帰ベースのアルゴリズムです。
Gbm	string	勾配ブーストマシン。ディシジョンツリーベースのアンサンブル機械学習アルゴリズムです。
Xgboost	string	XGBoost。ディシジョンツリーベースのアンサンブル機械学習アルゴリズムです。
Drf	string	ランダムフォレスト。複数のディシジョンツリー、ランダマイゼーション、および他の最適化技法を使用する教師あり学習アルゴリズムです。

DiscoveryModelField

モデルの項目 (変数) を表します。

項目名	項目の型	説明
isDisparateImpact	boolean	この項目が異種影響であるか (`true`)、否か (`false`) を示します。
isSensitive	boolean	項目が機密であるか (`true`)、否か (`false`) を示します。
label	string	UI に表示される項目の表示ラベル。
name	string	項目名。
type	DiscoveryModelFieldType	データ型。列挙されます。
values	string[]	項目値のリスト。

DiscoveryModelTransform

モデルの変換を表します。

項目名	項目の型	説明
config	string	変換の設定。
sourceFieldNames	string[]	取得元項目名のリスト。
targetFieldNames	string[]	取得先項目名のリスト。
type	DiscoveryAIModelTransformationType	変換の種別。

DiscoveryAIModelTransformationType

予測を実行する前に適用する変換の種別を表します。

項目名	項目の型	説明
TypographicClustering	string	タイポグラフィッククラスター化変換。
SentimentAnalysis	string	センチメント分析変換。
FreeTextClustering	string	自由テキストのクラスター化変換。
NumericalImputation	string	数値代入変換。
CatagoricalImputation	string	カテゴリ代入変換。
TimeSeriesForecast	string	時系列予測変換。
ExtractMonthOfYear	string	月変換を抽出します。
ExtractDayOfWeek	string	曜日変換を抽出します。
ZipCodeAnalysis	string	郵便番号分析変換。

DiscoveryModelFieldType

モデル項目のデータ型を表します。

項目名	項目の型	説明
Text	string	テキストデータ型。
Number	string	数値データ型。
Date	string	日付データ型。

DiscoveryModelRuntimeType

モデルの実行種別を表します。

項目名	項目の型	説明
Discovery	string	モデルの実行種別は Einstein Discovery です。
H2O	string	モデルの実行種別は H20 です。
T	string	モデルの実行種別は Tensorflow v2.4.4 です。
Tf27	string	モデルの実行種別は Tensorflow v2.7.0 です。
SC102	string	モデルの実行種別は Scikit Learn v1.0.2 です。

DiscoveryModelSourceType

モデルの作成に使用されたソースツールを表します。Discovery または外部ツール (モデルを Salesforce にアップロード) があります。

項目名	項目の型	説明
Discovery	string	Einstein Discovery がモデルを作成しました。
UserUpload	string	外部ツールがモデルを作成しました。作成されたモデルは、Salesforce にアップロードされました。このソース種別は、メタデータ API ではサポートされません。メモ

DiscoveryAIModelStatus

モデルの状況を表します (有効または無効)。

項目名	項目の型	説明
Disabled	string	モデルは無効 (非アクティブ) です。
Uploading	string	モデルがアップロードしています。
UploadFailed	string	モデルがアップロードに失敗しました。
UploadCompleted	string	モデルのアップロードが完了しました。
Validating	string	モデルが検証しています。
ValidationFailed	string	モデルが検証に失敗しました。
ValidationCompleted	string	モデルの検証が完了しました。
Enabled	string	モデルは有効 (アクティブ) です。

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

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

1<?xml version="1.0" encoding="UTF-8"?>
2<DiscoveryAIModel xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3   <content xsi:nil="true"/>
4   <algorithmType>Glm</algorithmType>
5   <classificationThreshold>0.7383</classificationThreshold>
6   <label>Maximize Tenure</label>
7   <modelFields>
8      <label>Field</label>
9      <name>Field</name>
10      <type>Text</type>
11   </modelFields>
12   <modelFields>
13      <label>PTO</label>
14      <name>PTO</name>
15      <type>Number</type>
16   </modelFields>
17   <modelFields>
18      <label>Level</label>
19      <name>Level</name>
20      <type>Text</type>
21   </modelFields>
22   <modelFields>
23      <label>Salary</label>
24      <name>Salary</name>
25      <type>Number</type>
26   </modelFields>
27   <modelFields>
28      <label>Tenure</label>
29      <name>Tenure</name>
30      <type>Number</type>
31   </modelFields>
32   <modelRuntimeType>Discovery</modelRuntimeType>
33   <predictedField>Tenure</predictedField>
34   <predictionType>Classification</predictionType>
35   <sourceType>Discovery</sourceType>
36   <status>Enabled</status>
37</DiscoveryAIModel>

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

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