Prediction Output

Output representation of the prediction request.

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
batchDatasourceStringThe batch data source name where batch-computed features are stored.
Note: The batch data source name is null when the feature input used to generate predictions is real-time.
Small, 57.057.0
classificationThresholdDoubleThe classification threshold value to derive the type of model to be used for prediction. If prediction score is higher/lower than this threshold, positive/negative prediction labels are displayed based on scorecard configuration.Small, 55.055.0
classificationTypeStringSpecifies the classification model type. For example. Binary or ternary.Small, 55.055.0
executionModeWarningStringIndicates the change in execution mode from user specified to default mode configuration.Small, 54.054.0
featureExtractorStringThe class name of the feature extractor implementation used for the prediction.Small, 54.054.0
featureExtractorIdentifierStringThe API name of the feature extractor record.Small, 57.057.0
featureExtractorTypeStringThe feature extractor type used for the prediction.
Possible values are:
  • Apex
  • Hybrid
  • Java
Small, 54.054.0
featureInputTypeStringThe type of feature input used in generating predictions.
Possible values are:
  • Realtime_Input
  • Sample_Input
  • Batch_Input
Small, 57.057.0
inputTypeStringThe type of input used to make the prediction.Small, 55.055.0
insightsSettingsMap<String, Integer>A map for configuring insight settings.Small, 55.055.0
modelFeaturesModel Feature[]Specifies additional details of the model feature, including name, label, and data type.Small, 55.055.0
outcomeGoalStringIndicates whether predDef maximizes or minimizes the field value.Small, 55.055.0
predictionDefinitionStringThe model developer name or API name used to make prediction.Small, 55.055.0
predictionDefinitionLabelStringThe label corresponding to the model ID used for prediction.Small, 55.055.0
predictionPersistenceErrorMessageStringIndicates that an error occurred during persistence of prediction results or features.Small, 54.054.0
predictionPlatformStringThe machine learning platform that is used to make the prediction for a use case.Small, 55.055.0
predictionsPrediction Object[]A list of prediction results.Small, 55.055.0
primaryResponseObjRecordIdsString[]Indicates the list of recordIds where the response is persisted in primary response object.Small, 55.055.0
requestIdStringThe unique identifier for the request to be generated and used for listening to notifications in the async mode of the execution.Small, 55.055.0
secondaryResponseObjRecordIdsString[]Indicates the list of recordIds where the response is persisted in secondary response object.Small, 55.055.0
statusStatusIndicates whether the call succeeded or failed, and in case of failure, specifies the reason.Small, 55.055.0

JSON Example 

1{
2  "Prediction Purpose": "Use case Name Eg: Smart Selling Visit Recommendation",
3  "Prediction Platform": "Einstein Discovery / Einstein Platform (optional)",
4  "Prediction Definition": "PredictionDefinitionIdentifier",
5  "batchDatasource": “ApexSSVisitRecommendationsDataSource”,
6  "Input Type": "ExtractedRecordOverrides",
7  "featureInputType": "Sample_Input",
8  "Feature Extractor Type": "Hybrid",
9  "featureExtractorIdentifier": "ApexSSVisitRecommendationsExtractor",
10  "Feature Extractor": "SSVisitRecommendationsFeatureExtractorClass",
11  "Primary Response Obj RecordIds": [
12    "a00x0000000CHa0AAG",
13    "a00x0000000CHa0XXY"
14  ],
15  "Secondary Response Obj RecordIds": [
16    "a00x0000000CHa0PPS",
17    "a00x0000000CHa0QQW"
18  ],
19  "predictions": [
20    {
21      "model": {
22        "id": "1OtRM000000002b0AA"
23      },
24      "prediction": {
25        "score": 799315.4282959097,
26        "insights": [
27          {
28            "columns": [
29              {
30                "columnName": "Has Line Item",
31                "columnValue": "true"
32              }
33            ],
34            "value": 553763.66105859
35          }
36        ]
37      },
38      "status": "Success"
39    },
40    {
41      "model": {
42        "id": "1OtRM000000002b0AA"
43      },
44      "prediction": {
45        "score": 799315.4282959097,
46        "insights": [
47          {
48            "columns": [
49              {
50                "columnName": "Has Line Item",
51                "columnValue": "true"
52              }
53            ],
54            "value": 543763.66105859
55          }
56        ]
57      },
58      "status": "Success"
59    }
60  ],
61  "insightSettings": {
62    "maxPrescriptions": 0,
63    "maxInsights": 0
64  }
65}