この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

Predictions

機械学習の使用事例のスコア予測をリアルタイムで取得します。

AI アクセラレータ予測 API のコンポーネント

AI アクセラレータのリアルタイムスコアリング API は次のコンポーネントで構成されます。

設定解決
特徴抽出
スコアラ
DB ライター

設定解決

各 API 要求について、API は実行時に次の順序で設定値を解決します。

API 要求 (最も高い優先度)
設定 BPO での管理者設定。「AI アクセラレータ」を参照してください。
使用事例設定ファイルの設定

特徴抽出

このコンポーネントは、実行時に一部の特徴を導出または計算する必要がある使用事例にのみ適用されます。ここで特徴とは ML モデルへの入力のことです。

例として、不動産物件の価格を予測する ML の使用事例について考えてみましょう。これを実行するには、ML モデルに物件の平方フィート、床面積、場所、寝室の数、建築年、築年数などの特徴が必要になります。

築年数以外のすべての特徴が物件レコードにあるとします。この場合、API は特徴抽出を呼び出して、実行時に現在の年から建築年を引くことで築年数を計算します。

スコアラ

スコアラは、特徴を受け入れて、Einstein Discovery 予測 API を使用して ED プラットフォームとやりとりを行ってレコードのスコア付けを行います。

DB ライター

ML の使用事例で保持を設定した場合は、DB ライターが特徴、スコア、インサイトを、指定されたオブジェクトに、AIUsecaseFieldMapping オブジェクトで指定された項目対応付けに従って保持します。

AI アクセラレータ予測 API は次の出力コンポーネントを��します。

record、rawdata、recordoverrides、extractedrawdata、または extractedrecordoverrides ごとに 1 つの��測スコア。
最大 3 つの予測インサイトを通じてスコアがどのように設定されたかの詳細。これは、エンドユーザがスコアに対するさまざまな特徴の影響を理解するのに役立ちます。
スコアを改善するための予測改善。

リソース

1/connect/aiaccelerator/predictions

リソースの例

1https://yourInstance.salesforce.com/services/data/vXX.X/connect/aiaccelerator/predictions

使用可能なバージョン

55.0

Chatter が必要かどうか

いいえ

HTTP のメソッド

POST

POST のリクエストボディ

プロパティ

名前	型	説明	必須か省略可能	使用可能なバージョン
`async`	Boolean	実行モードが非同期か (`true`)、否か (`false`) を示します。	省略可能	55.0
`columnNames`	String[]	モデルで分析する列を表す列名のカンマ区切りリスト。これはスコアを予測するモデルへの入力となる特徴です。	省略可能この項目は、種別が `rawdata` または `recordOverrides` の場合は必須です。メモ	55.0
`enableFeaturePersistence`	Boolean	特徴を保持するか (`true`)、否か (`false`) を示します。	省略可能この項目は、未加工データの場合または特徴が抽出された場合のみ必須です。メモ	55.0
`enableInsightPersistence`	Boolean	インサイトを保持するか (`true`)、否か (`false`) を示します。インサイトを保持するには `enableScorePersistence` 項目が有効になっている必要があります。メモ	省略可能	55.0
`enableScorePersistence`	Boolean	予測スコアを保持するか (`true`)、否か (`false`) を示します。	省略可能	55.0
`enableSuggestionPersistence`	Boolean	提案を保持するか (`true`)、否か (`false`) を示します。提案を保持するには `enableScorePersistence` 項目が有効になっている必要があります。メモ	省略可能	55.0
`enrichModelClassification`	Boolean	分類モデル種別と分類しきい値を取得するか (`true`)、否か (`false`) を示します。	省略可能	55.0
`enrichModelFeatures`	Boolean	モデルの特徴の詳細 (表示ラベルやデータ型など) を取得するか (`true`)、否か (`false`) を示します。	省略可能	55.0
`enrichPredictionDefinition`	Boolean	予測定義の表示ラベルを取得するか (`true`)、否か (`false`) を示します。	省略可能	55.0
`featureColumnMap`	Map<String, String>	どの特徴をどこに保持する必要があるかが含まれた対応付けを表します。キーと値のペアには次の情報が含まれている必要があります。 `key` — 特徴名 `value` — ResponseObjects (管理 UI 設定で設定される).FieldName	省略可能	55.0
`featureExtractorDevName`	String	特徴抽出ツールレコードの API 参照名。	省略可能この項目を入力する必要があるのは、`usecaseModel` にデフォルトの特徴抽出ツールがなく、入力種別が `ExtractedRawData` または `ExtractedRecordOverrides` の場合です。メモ	55.0
`featureExtractionParameters`	Feature Extraction Parameters Field Map Value[]	予測を行うためにモデルに必要な特徴を特徴抽出で抽出するために必要な入力パラメータを表します。最大 200 件のレコードがサポートされています。	省略可能この項目は、入力種別が `ExtractedRawData` または `ExtractedRecordOverrides` の場合は必須です。メモ	55.0
`featureExtractorId`	String	AIFeatureExtractor オブジェクトの特徴抽出レコードの ID。指定された特徴抽出は予測用の特徴を抽出するために使用されます。カスタム特徴抽出インターフェース実装についての詳細は「CustomFeatureExtractor インターフェース」を参照してください。	省略可能	55.0
`historyReferencePoint`	String	現在の予測スコアと以前の予測スコアを比較するための参照ポイントを表します。	省略可能	55.0
`inputType`	String	予測を行うために使用される入力の種別。最大 200 件のレコードがサポートされています。可能な値は次のとおりです。 `Records` — モデルに使用するすべての特徴は Salesforce データベース内に存在します。 `RawData` — モデルに使用するすべての特徴は API 要求自体で提供されます。 `RecordOverrides` — API は指定されたレコード ID を使用してモデルに使用する特徴の一部を Salesforce データベースから読み込みます。残りの特徴は API 要求内で未加工データとして提供されます。 `ExtractedRawData` — API は設定されている特徴抽出を使用してモデルに使用する一部またはすべての特徴を実行時に計算します。その他の特徴は API 要求内で未加工データとして渡すことができます。 `ExtractedRecordOverrides` — 設定されている特徴抽出を使用してモデルに使用する一部の特徴を実行時に計算します。残りの特徴については、指定されたレコード ID を使用して Salesforce データベースを参照します。	必須	55.0
`insightColumnMap`	Map<String, String>	どのインサイトの名前/値をどのオブジェクトに保持する必要があるかが含まれた対応付けを表します。キーと値のペアには次の情報が含まれている必要があります。 `key` — INSIGHT1.Name / INSIGHT1.Value (最大 3 つのインサイトの名前/値) `value` — ResponseObjects (管理 UI 設定で設定される).FieldName	省略可能	55.0
`insightsSettings`	Map<String, Integer>	インサイトの設定を定義する対応付け。予測スコアに寄与する設定を次に示します。 `maxInsights` — 機械学習モデルで生成するインサイトの最大数。 `maxSuggestionCount` — 機械学習モデルで生成する提案の最大数。 `suggestionImpactMinimumPct` — 提案に基づいて予測スコアを改善するために対象となる最小パーセント。詳細は、『AI Accelerator Admin Guide (AI アクセラレータ管理ガイド)』の「Define Maximum Suggestions and Insights (提案とインサイトの最大数の定義)」を参照してください。	省略可能	55.0
`predictionDefinition`	String	DiscoveryGoal オブジェクトでの API 参照名。	必須	55.0
`rawData`	Raw Data Input Wrap[]	各行が `columnNames` で指定された特徴の値のカンマ区切りリストである行値の二次元配列。最大 200 件のレコードがサポートされています。	省略可能この項目は、入力種別が `RawData` または `RecordOverrides` の場合は必須です。メモ	55.0
`records`	String[]	予測を行うためのモデルの入力特徴として使用される Salesforce レコードの ID。	省略可能この項目は、入力種別が `Records`、`RecordOverrides`、または `ExtractedRecordOverrides` の場合は必須です。メモ	55.0
`scorePersistenceColumn`	String	保持する必要があるスコアの名前および値とどのオブジェクトに保持するかを表します。有効な形式は ResponseObject.FieldName です。	省略可能。この項目は、`enableScorePersistence` が true に設定されている場合は必須です。`enableScorePersistence` が true で、この値が指定されていない場合は、デフォルトで [設定] ページのスコア列の対応付けが使用されます。メモ	55.0
`suggestionColumnMap`	Map<String, String>	どの提案の名前/値をどのオブジェクトに保持する必要があるかが含まれた対応付けを表します。キーと値のペアには次の情報が含まれている必要があります。 `key` — SUGGESTION1.Name / SUGGESTION1.Value (最大 5 つの提案の名前/値) `value` — ResponseObjects (管理 UI 設定で設定される).FieldName	省略可能	55.0
`usecaseDefinition`	String	AIUsecaseDefinition オブジェクトでの使用事例定義レコードの ID。	省略可能	55.0
`usecaseDevname`	String	使用事例定義レコードの API 参照名。	必須	55.0

JSON の例

inputType が Records の場合の例。

1{
2  "usecaseDevname": "AIUsecaseDefinitionIdentifier",
3  "predictionDefinition": "PredictionDefinitionIdentifier",
4  "inputType": "Records",
5  "records": {
6    "wrappedList": [
7      "a00x0000000CHa0AAG"
8    ]
9  },
10  "insightsSettings": {
11    "insightsSettings": {
12      "maxSuggestionCount": 1,
13      "maxInsights": 1,
14      "suggestionImpactMinimumPct": 0
15    }
16  },
17  "insightColumnMap": {
18    "columnMap": {
19      "INSIGHT1.Name": "Demo__c.InsightName1Override__c",
20      "INSIGHT1.Value": "Demo__c.InsightValue1__c",
21      "INSIGHT1.Impact": "Demo__c.InsightImpact1__c"
22    }
23  },
24  "suggestionColumnMap": {
25    "columnMap": {
26      "SUGGESTION1.Name": "Demo__c.RecommendationName1__c",
27      "SUGGESTION1.Value": "Demo__c.RecommendationValue1__c",
28      "SUGGESTION1.Impact": "Demo__c.RecommendationImpact1Override__c"
29    }
30  },
31..”scorePersistenceColumn”:”Demo__c.Score__c”,
32..”enableInsightPersistence”:true,
33  "enableScorePersistence": true,
34..”enableSuggestionPersistence”:true,
35  "async": false
36}

inputType が RawData の場合の例。

1{
2  "usecaseDevname": "AIUsecaseDefinitionIdentifier",
3  "predictionDefinition": "PredictionDefinitionIdentifier",
4  "inputType": "RawData",
5  "columnNames": {
6    "wrappedList": [
7      "corp_year_week__c",
8      "sap_source_id__c",
9      "sap_ppg_id__c",
10      "sales_units__c"
11    ]
12  },
13  "rawData": {
14    "rawData": [
15      {
16        "rawDataInputWrap": {
17          "rawDataInput": [
18            "202016",
19            "0YQx0000000CaS8GAK",
20            "01tx00000006j2DAAQ",
21            "20"
22          ]
23        }
24      },
25      {
26        "rawDataInputWrap": {
27          "rawDataInput": [
28            "202016",
29            "0YQx0000000CaS8GAK",
30            "01tx00000006j2DAAQ",
31            "20000"
32          ]
33        }
34      }
35    ]
36  },
37  "featureColumnMap": {
38    "columnMap": {
39      "corp_year_week__c": "Demo__c.YearWeekFeature__c",
40      "sap_source_id__c": "Demo__c.StoreIdFeature__c",
41      "sap_ppg_id__c": "Demo__c.ProductIdFeature__c",
42      "sales_units__c": "Demo__c.SalesUnitsFeatureOverride__c"
43    }
44  },
45  "enableFeaturePersistence": true
46}

inputType が RecordOverrides の場合の例。

1{
2  "usecaseDevname": "AIUsecaseDefinitionIdentifier",
3  "predictionDefinition": "PredictionDefinitionIdentifier",
4  "inputType": "RecordOverrides",
5  "records": {
6    "wrappedList": [
7      "a00x0000000CHa0AAG"
8    ]
9  },
10  "columnNames": {
11    "wrappedList": [
12      "corp_year_week__c",
13      "sap_source_id__c",
14      "sap_ppg_id__c",
15      "sales_units__c"
16    ]
17  },
18  "rawData": {
19    "rawData": [
20      {
21        "rawDataInputWrap": {
22          "rawDataInput": [
23            "202016",
24            "0YQx0000000CaS8GAK",
25            "01tx00000006j2DAAQ",
26            "20"
27          ]
28        }
29      },
30      {
31        "rawDataInputWrap": {
32          "rawDataInput": [
33            "202016",
34            "0YQx0000000CaS8GAK",
35            "01tx00000006j2DAAQ",
36            "20000"
37          ]
38        }
39      }
40    ]
41  }
42}

inputType が ExtractedRawData の場合の例。

1{
2  "usecaseDevname": "AIUsecaseDefinitionIdentifier",
3  "predictionDefinition": "PredictionDefinitionIdentifier",
4  "inputType": "ExtractedRawData",
5..”featureExtractorDevName”: “featureExtractorIdentifier”,
6  "featureExtractionParameters": {
7    "featureExtractionParameters": [
8      {
9        "featureExtractionParametersMapValue": {
10          "recordId": "01tx00000006j2DAAQ1",
11          "rawData": {
12            "corp_year_week__c": "202016"
13          }
14        }
15      }
16    ]
17  },
18  "enableFeaturePersistence": true
19}

inputType が ExtractedRecordOverrides の場合の例。

1{
2  "usecaseDevname": "AIUsecaseDefinitionIdentifier",
3  "predictionDefinition": "PredictionDefinitionIdentifier",
4  "inputType": "ExtractedRecordOverrides",
5  "records": {
6    "wrappedList": [
7      "a00x0000000CHa0AAG"
8    ]
9  },
10..”featureExtractorDevName”: “featureExtractorIdentifier”,
11  "featureExtractionParameters": {
12    "featureExtractionParameters": [
13      {
14        "featureExtractionParametersMapValue": {
15          "recordId": "01tx00000006j2DAAQ1"
16        }
17      }
18    ]
19  }
20}

POST のレスポンスボディ

Prediction Output

Industries 共通リソース開発者ガイド

Predictions

AI アクセラレータ予測 API のコンポーネント