Newer Version Available

This content describes an older version of this product. View Latest

AIUsecaseModel

Represents information about the machine learning models that generate predictions for your use case. This object is available in API version 55.0 and later.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

The AIUsecaseFieldMapping 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
AiFeatureExtractorId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the feature extractor that’s used by the use case model.
This field is a relationship field.
Relationship Name
AiFeatureExtractor
Relationship Type
Lookup
Refers To
AIFeatureExtractor
AiUsecaseDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Required. The ID of the use case definition that’s related to the use case model.
This field is a relationship field.
Relationship Name
AiUsecaseDefinition
Relationship Type
Lookup
Refers To
AIUsecaseDefinition
ArePredctGenInRealTime
Type
boolean
Properties
Defaulted on create, Filter, Group, Sort, Update
Description
Required. Indicates whether the prediction results are generated in real time by using AI Accelerator or whether they are generated by Data Cloud and stored in a Data Model Object. If this attribute is set to false, AI Accelerator reads and returns already generated prediction results from Data Cloud.
The default value is True.
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The developer name of the use case model.
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The languages supported by the use case model.
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 model.
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.
PredictionDefinition
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description

Required. The unique identifier of the prediction definition that’s related to the use case model. This identifier can be an external ID. If you use Einstein Discovery to create models, this field stores the developer name of the record.

This field is unique within your organization.

PredictionPlatform
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Required. The platform on which the machine learning model is created and deployed. Available in API version 57.0 and later.
Possible values are:
  • Default
  • Einstein_Discovery
The default value is Einstein_Discovery.

Usage

Use this object to configure the machine learning model for your use case. A use case can have multiple models for better performance or for changing the model’s objective.