AIUsecaseDefinition

Represents a collection of fields that are used 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.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Supported SOAP API Calls

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

Supported REST API Methods

GET, HEAD, PATCH, Query

Fields

Field	Details
DeveloperName	Type string Properties Filter, Group, Sort, Update Description The developer name of the use case definition. Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field. Note
Language	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description The language of the use case definition.
MasterLabel	Type string Properties Filter, Group, Sort, Update Description The label for 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 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. 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 response.
PrimaryResponseObject	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort, Update Description Specifies the primary object. The object is used to save the scoring response that is based on the 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 Specifies the secondary object. The object is used to save the scoring response that is based on the 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 (`true`) or not (`false`). 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 (`true`) or not (`false`). The default value is `false`.
ShouldSaveRequestResponse	Type boolean Properties Defaulted on create, Filter, Group, Sort Description Indicates whether to save the scoring request response (`true`) or not (`false`). The default value is `false`.
ShouldSaveScore	Type boolean Properties Defaulted on create, Filter, Group, Sort, Update Description Indicates whether to save the prediction score (`true`) or not (`false`). 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 (`true`) or not (`false`). 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 The unique name of the use case definition.

Industries Common Resources Developer Guide

AIUsecaseDefinition

Supported SOAP API Calls

Supported REST API Methods

Fields