Industries Common Resources Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Industries Common Resources
AI Accelerator and Scoring Framework
AI Accelerator
AI Accelerator Standard Objects
AIFeatureExtractor
AIUsecaseDefinition
AIUsecaseFieldMapping
AIUsecaseModel
AI Accelerator Platform Event
AI Accelerator Business APIs
AI Accelerator Predictions API Using Apex
Apex Reference
AI Accelerator Metadata Types
AI Accelerator Tooling Objects
Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Collections and Recovery
Context Service
Criteria-Based Search and Filter
Data Processing Engine, Batch Management, and Monitor Workflow Services
Digital Lending
Discovery Framework
Decision Explainer
Einstein Relationship Insights
Einstein Standard Invocable Actions
Engagement
Group Membership and Households
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Process Compliance Navigator
Record Alerts
Record Rollup Definitions
Scheduled Reminders
Sentiment Insights
Service Process Studio
Timeline
Virtual Calls
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

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

create(), delete()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
CreatorType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The type of user who created the use case definition that's used by AI Accelerator. Available in API version 57.0 and later.
Possible values are:
  • INTERNAL_USER
  • SALESFORCE_ADMIN
The default value is INTERNAL_USER.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The developer name of the use case definition.
Language
Type
picklist
Properties
Create, Defaulted on create, 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
Create, Filter, Group, Sort, Update
Description
The label of the use case definition.
MaximumInsightCount
Type
int
Properties
Create, 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
Create, Filter, Group, Nillable, Sort, Update
Description
The maximum number of suggestions that can be returned by the scoring response.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Namespace prefix associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix.
PrimaryResponseObject
Type
string
Properties
Create, Filter, Group, Nillable, False, 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.
RecommendationResponseObject
Type
string
Properties
Create, Filter, Group, Nillable, False, Sort, Update
Description
The object in which the recommendations created by the Next Best Action Strategy are saved.
RecommendationSource
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The tool or platform that generates recommendations. Available in API version 57.0 and later.
Possible values are:
  • Next_Best_Action_Flow
  • None
The default value is Next_Best_Action_Flow.
SecondaryResponseObject
Type
string
Properties
Filter, Group, Nillable, False, 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
Create, 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.
ShouldSaveRecommendation
Type
boolean
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
Indicates whether to save the recommendations created by the Next Best Action Strategy.
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
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Required. The name of the use case.
This field is unique within your organization

Usage

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