AIScoringModelDefinition

Represents information about a machine learning model that’s used by the Scoring Framework for Industries Cloud Einstein. The machine learning model is used for scoring, including its configuration. This object is available in API version 57.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

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Special Access Rules

To access this object, you must have the AI Accelerator User permission set with Scoring Framework enabled for Industries Cloud Einstein from Salesforce Setup. The Salesforce org must have the CRM Plus license and the product’s CRM license.

Fields

Field Details
AiModelConfig
Type
picklist
Properties
Filter, Group, Restricted picklist, Sort
Description
ID of an AI model configuration related to the AI scoring model record.
Valid values are:
  • Prediction_Scores_for_Accounts— Get predictions based on your account data.
  • Propensity_to_Purchase_Products—Get predictions about the customers’ likelihood of purchasing products.
  • FSCAccountContactScore—Get predictions based on your account or contact data for Financial Services Cloud.
  • FSCPropensity—Get predictions about the customers’ likelihood of purchasing products for Financial Services Cloud.
  • Student_Prospect_Score—Get predictions about prospects that are likely to convert to students for Education Cloud.
  • Opp_Scoring—Get predictions about opportunities that are likely to convert to accounts for Automotive Cloud.
  • Lead_Scoring—Used to get predictions about leads that are likely to convert to opportunities or accounts for Automotive Cloud.
Description
Type
string
Properties
Filter, Group, Nillable, Sort
Description
Description for an AIScoringModelDefinition record.
DeveloperName
Type
string
Properties
Filter, Group, Sort
Description
The unique name of the object in the API. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is Record Type Name.
FullName
Type
string
Properties
Create, Group, Nillable
Description
Full name of the associated AIScoringModelDefinition object in Metadata API. The full name can include a namespace prefix. Available in API version 58.0 and later.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Language
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Language of the AIScoringModelDefinition object.
Valid 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
Description
Label for the AIScoringModelDefinition object. In the UI, this field is AI Scoring Model Definition.
Metadata
Type
AIScoringModelDefinition
Properties
Create, Nillable, Update
Description
The AIScoringModelDefinition's metadata.
Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance.
Versions
Type
complexvalue
Properties
Create, Nillable, Update
Description
Represents information of various versions of an AI scoring model.