Industries Common Resources Developer Guide

Industries Common Resources
AI Accelerator and Scoring Framework
AI Accelerator
AI Accelerator Standard Objects
AI Accelerator Platform Event
AI Accelerator Business APIs
AI Accelerator Predictions API Using Apex
Apex Reference
AI Accelerator Metadata Types
AI Accelerator Tooling Objects
AIFeatureExtractor
AIUsecaseDefinition
AIUsecaseFieldMapping
AIUsecaseModel
Scoring Framework
Action Launcher
Actionable List Members
Actionable Segmentation
Business Rules Engine
Context Service
Data Processing Engine, Batch Management, and Monitor Workflow Services
Discovery Framework
Decision Table
Decision Explainer
Einstein Relationship Insights
Engagement
Identity Verification
Intelligent Document Reader
Intelligent Form Reader
Interest Tagging
Omnistudio Business APIs
Outcome Management Developer Guide
Outreach List
Record Alerts
Sentiment Insights
Service Process Studio
Timeline Tooling API Object
Associated Objects
IndustriesSettings
Industries Object Access by Community License
Access Industries Features Deployed Using Managed Packages
PDF

Newer Version Available

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

AIUsecaseModel

Represents information about the object that stores the machine learning models that generate predictions for use cases. 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

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

Supported REST API Methods

DELETE, GET, HEAD, PATCH, POST, Query

Fields

Field Details
AiFeatureExtractorId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The ID of the feature extractor that’s related to the use case model.
This is a relationship field.
Relationship Name
AiFeatureExtractor
Relationship Type
Lookup
Refers To
AIFeatureExtractor
AiUsecaseDefinitionId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
The ID of the use case definition that’s associated with the use case model.
This is a relationship field.
Relationship Name
AiUsecaseDefinition
Relationship Type
Lookup
Refers To
AIUsecaseDefinition
DeveloperName
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The developer name of the use case model.

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.

Note
Language
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The language of the use case model.
ManageableState
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Indicates the manageable state of the specified component that is contained in a package.
Possible values are:
  • beta—Managed-Beta
  • deleted—Managed-Proposed-Deleted
  • deprecated—Managed-Proposed-Deprecated
  • deprecatedEditable—SecondGen-Installed-Deprecated
  • installed—Managed-Installed
  • installedEditable—SecondGen-Installed-Editable
  • released—Managed-Released
  • unmanaged—Unmanaged
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The label for 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
The unique identifier of the prediction definition that’s related to the use case model. This identifier can be an external ID.
PredictionPlatform
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
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.