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

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:
- 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.
Default value: Einstein_Discovery
Possible values:
- Data_Cloud
- Default—For internal use only.
- Einstein_Discovery
- Einstein_on_Data_Cloud—Available in API version 62.0 and later.