AIUsecaseDefinition

Represents a collection of fields to set up the use case for which real-time predictions are to be made. This object is available in API version 55.0 and later.

Supported Calls

describeSObjects(), query(), retrieve(), update()

Special Access Rules

The AIUsecaseDefinition object is available when the admin settings for AI Accelerator and for the product related to the use case are enabled. The Salesforce org must have the CRM Plus license and the product’s CRM license.

Fields

Field	Details
DeveloperName	Type string Properties Filter, Group, Sort, Update Description The developer name of the use case definition.
Language	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The languages supported by the use case definition. Possible values are: `da`—Danish `de`—German `en_US`—English `es`—Spanish `es_MX`—Spanish (Mexico) `fi`—Finnish `fr`—French `it`—Italian `ja`—Japanese `ko`—Korean `nl_NL`—Dutch `no`—Norwegian `pt_BR`—Portuguese (Brazil) `ru`—Russian `sv`—Swedish `th`—Thai `zh_CN`—Chinese (Simplified) `zh_TW`—Chinese (Traditional)
MasterLabel	Type string Properties Filter, Group, Sort, Update Description The label of the use case definition.
MaximumInsightCount	Type int Properties Filter, Group, Nillable, Sort, Update Description The maximum number of insights that can be returned by the scoring response.
MaximumRecommendationCount	Type int Properties Filter, Group, Nillable, Sort, Update Description The maximum number of recommendations that can be returned by the Next Best Action Strategy. This field is available in API version 56.0 and later.
MaximumSuggestionCount	Type int Properties Filter, Group, Nillable, Sort, Update Description The maximum number of suggestions that can be returned by the scoring response.
PrimaryResponseObject	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The primary object in which the scoring response is saved based on the specified field mapping. A primary response object can be any standard object that is allowed by the use case’s cloud or any custom object. Note
SecondaryResponseObject	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The object in which the scoring response is saved based on the specified field mapping. A secondary response object can be any standard object that is allowed by the use case’s cloud or any custom object. Note
ShouldSaveFeatures	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to save the features extracted for the scoring request. The default value is `false`.
ShouldSaveInsights	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to save the prediction insights used to generate the score. The default value is `false`.
ShouldSaveScore	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to save the prediction score. The default value is `false`.
ShouldSaveSuggestions	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to save the suggestions for improving the prediction score. The default value is `false`.
SuggestionImpactMinimumPct	Type int Properties Filter, Group, Nillable, Sort, Update Description The minimum eligible percentage for improving the existing prediction score based on suggestions. Suggestions with an impact greater than the specified percentage on the score are displayed on the prediction scorecard.
UsecaseName	Type picklist Properties Filter, Group, Restricted picklist, Sort Description Required. The name of the use case. This field is unique within your organization

Usage

Use this object to specify whether to save the extracted features, prediction scores, insights about the predictions, and suggestions to improve the prediction scores, and then specify the objects where you want to save them. You can also define maximum number of insights and suggestions to get from the machine learning model.

Industries Common Resources Developer Guide

AIUsecaseDefinition

Supported Calls

Special Access Rules

Fields

Usage