Recommendation Input

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

JSON Example

1{
2    "usecaseDefinitionName": "ChurnPredictionRealTime",
3    "strategyName": "flow_sample",
4    "rcmdStrategyParameters": [
5      {
6       "recordId": "a02xx000001nd0RAAQ",
7       "predictionScore": 96
8      }
9    ],
10    "maxRecommendationsCount": 1,
11    "recommendationFieldMapping": {}
12}

Properties

Name	Type	Description	Required or Optional	Available Version
`canPersistRecommendations`	Boolean	Indicates whether the recommendations are persisted (`true`) or not (`false`). The default value is `false`.	Optional	56.0
`isAsync`	Boolean	Indicates whether the execution mode is async (`true`) or not (`false`). The default value is `false`.	Optional	56.0
`maxRecommendationsCount`	Integer	The maximum recommendations to request. You can specify a maximum of four recommendations.	Optional	56.0
`rcmdRecordIdPersistenceColumn`	String	The name of the column from the PrimaryResponse object that persists the recommendation record ID when the `canPersistRecommendations` property is set to `true`.	Optional	56.0
`rcmdStrategyParameters`	Map<String,Object>[]	The list of parameters to pass to the flow action for the specified strategy to generate recommendations.	Required	56.0
`recommendationFieldMapping`	Map<String, String>	The field mapping that’s used to store the recommendations when the `canPersistRecommendations` property is set to `true`.	Optional	56.0
`strategyName`	String	The name of the strategy.	Required	56.0
`usecaseDefinitionName`	String	The API name of the use case definition.	Required	56.0