Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Recommendation

Output representation of the recommendation request with Einstein Next Best Action.

JSON example

1{
2  "recommendationRecordIds" : [ "0prRM00000001abYAA" ],
3  "recommendationStrategyResult" : [ {
4    "errors" : [ ],
5    "isSuccess" : true,
6    "onBehalfOfId" : "a02xx000001nd0RAAQ",
7    "recommendations" : [ {
8      "acceptanceLabel" : "yes",
9      "actionReferenceId" : "301RM0000004tIcYAI",
10      "actionReferenceLabel" : "sendingEmailFlow",
11      "actionReferenceName" : "sendingEmailFlow",
12      "actionStrategyParameters" : [ {
13        "name" : "inputRecommendation",
14        "type" : "SObject",
15        "value" : {
16          "attributes" : {
17            "type" : "Recommendation",
18            "url" : "/services/data/v56.0/sobjects/Recommendation/0prRM00000001abYAA"
19          },
20          "AcceptanceLabel" : "yes",
21          "ActionReference" : "sendingEmailFlow",
22          "CreatedById" : "005RM000002WUlIYAW",
23          "CreatedDate" : "2022-07-14T20:06:32.000Z",
24          "Description" : "Recommendation description",
25          "ExternalId" : null,
26          "Id" : "0prRM00000001abYAA",
27          "ImageId" : null,
28          "IsActionActive" : true,
29          "IsDeleted" : false,
30          "LastModifiedById" : "005RM000002WUlIYAW",
31          "LastModifiedDate" : "2022-07-14T20:06:32.000Z",
32          "LastReferencedDate" : "2022-07-14T20:06:32.000Z",
33          "LastViewedDate" : "2022-07-14T20:06:32.000Z",
34          "Name" : "Rcmd2",
35          "RecommendationKey" : null,
36          "RejectionLabel" : "no",
37          "SystemModstamp" : "2022-07-14T20:06:32.000Z"
38        }
39      }, {
40        "name" : "recordId",
41        "type" : "String",
42        "value" : "a02xx000001nd0RAAQ"
43      }, {
44        "name" : "contextRecordId",
45        "type" : "String",
46        "value" : "a02xx000001nd0RAAQ"
47      } ],
48      "description" : "Recommendation description",
49      "id" : "0prRM00000001abYAA",
50      "name" : "Recommendation",
51      "rejectionLabel" : "no"
52    } ],
53    "recordId" : "a02xx000001nd0RAAQ"
54  } ],
55  "status" : {
56    "code" : 200,
57    "message" : "The request to get recommendations was submitted."
58  },
59  "strategyName" : "flow_sample",
60  "usecaseName" : "ChurnPredictionRealTime"
61}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`executionModeWarning`	String	The warning when the execution mode isn’t suitable.	Small, 56.0	56.0
`recommendationPersistenceErrorMessage`	String	The error message when persisting the recommendations fails.	Small, 56.0	56.0
`recommendationRecordIds`	String[]	The list of IDs of the recommendation records that are part of the recommendation result.	Small, 56.0	56.0
`recommendationStrategyResult`	Recommendation Strategy Result	The list of recommendations for each record in the request. Displays a maximum of four recommendations as specified in the `maxRecommendationsCount` property in the request.	Small, 56.0	56.0
`requestId`	String	The ID of the recommendation request that’s used in the async mode of execution to listen to the platform event.	Small, 56.0	56.0
`status`	String	The status of the recommendation request.	Small, 56.0	56.0
`strategyName`	String	The name of the strategy.	Small, 56.0	56.0
`usecaseName`	String	The `usecaseName` property value on the AIUsecaseDefinition object.	Small, 56.0	56.0

Industries Common Resources Developer Guide

Recommendation