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
Scoring Framework
Scoring Framework Metadata Types
Scoring Framework Tooling Objects
AINaturalLangProcessRslt
AIScoringModelDefinition
AIScoringModelDefVersion
AIScoringStep
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

AIScoringModelDefVersion

Represents information about a version of an AI scoring model that’s used by the Scoring Framework for Industries Cloud Einstein. 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
AIScoringModelDefinitionId
Type
reference
Properties
Filter, Group, Sort
Description
ID of the parent AIScoringModelDefinition record that’s related to an AIScoringModelDefVersion record.
This field is a relationship field.
Relationship Name
AIScoringModelDefinition
Relationship Type
Lookup
Refers To
AIScoringModelDefinition
AdditionalInformation
Type
textarea
Properties
Nillable
Description
Stores the metadata about a scoring model version.
AiUsecaseDefinitionId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of the parent AIUsecaseDefinition record that’s related to an AIScoringModelDefVersion record.
This field is a relationship field.
Relationship Name
AiUsecaseDefinition
Relationship Type
Lookup
Refers To
AIUsecaseDefinition
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
The full name of the associated AIScoringModelDefVersion object in Metadata API. The full name can include a namespace prefix.
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
The 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 AIScoringModelDefVersion object. In the UI, this field is AI scoring model definition version.
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.
ModelMode
Type
picklist
Properties
Defaulted on create, Filter, Group, Restricted picklist, Sort
Description
Mode of an AI scoring model.
Valid values are:
  • DEPLOY
  • TRAIN
  • TRAIN_AND_DEPLOY
The default value is TRAIN_AND_DEPLOY.
Status
Type
picklist
Properties
Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
Description
Status of an AIScoringModelDefVersion record. Available in API version 58.0 and later.
Valid values are:
  • ACTIVATING
  • ACTIVATIONFAILED
  • ACTIVE
  • DEACTIVATING
  • DEACTIVATIONFAILED
  • DRAFT
  • FAILED
  • INACTIVE
Steps
Type
complexvalue
Properties
Nillable, Update
Description
Represents information about a step associated with an AI scoring model version. Available in API version 58.0 and later.