MLPredictionDefinition

Represents the details about a prediction within a prediction definition used in a machine learning (ML) application. Available in API version 50.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
ApplicationId	Type reference Properties Filter, Group, Nillable, Sort Description The ID of the application associated with the prediction definition. This is a relationship field. Relationship Name Application Relationship Type Lookup Refers To AIApplication
Description	Type string Properties Filter, Group, Nillable, Sort Description Description of the prediction.
DeveloperName	Type string Properties Filter, Group, Nillable, 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. This field is automatically generated, but you can supply your own value if you create the record using the API. When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance may slow as a DeveloperName is generated for each record. Note
FullName	Type string Properties Create, Group, Nillable Description The full name of the associated MLPredictionDefinition type 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 MLPredictionDefinition.
ManageableState	Type ManageableState enumerated list Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates the manageable state of the specified component that is contained in a package: `beta` `deleted` `deprecated` `deprecatedEditable` `installed` `installedEditable` `released` `unmanaged`
MasterLabel	Type string Properties Filter, Group, Nillable, Sort Description Label that identifies the MLPredictionDefinition definition throughout the Salesforce user interface.
Metadata	Type AIApplication Properties Create, Nillable, Update Description The MLPredictionDefinition’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.
MLDataDefinitions	Type QueryResult Properties Nillable Description A list of prediction definition records associated with an ML application record.
NamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the `namespacePrefix__componentName` notation. The namespace prefix can have one of the following values: In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition organization of the package developer. In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.
NegativeExpressionId	Type reference Properties Filter, Group, Nillable, Sort Description Reserved for future use. This is a relationship field. Relationship Name NegativeExpression Relationship Type Lookup Refers To MLFilter
PositiveExpressionId	Type reference Properties Filter, Group, Nillable, Sort Description Reserved for future use. This is a relationship field. Relationship Name PositiveExpression Relationship Type Lookup Refers To MLFilter
PredictionField	Type string Properties Filter, Group, Nillable, Sort Description Field that the prediction is based on.
PredictionStrategy	Type string Properties Filter, Group, Nillable, Sort Description Strategy that the prediction is based on.
Priority	Type int Properties Filter, Group, Nillable, Sort Description Reflects the priority of the MLPredictionDefinition (MLPD) object when an AIApplication has multiple child MLPDs.
PushbackField	Type string Properties Filter, Group, Nillable, Sort Description Field that the prediction writes scores to.
Status	Type picklist Properties Filter, Group, Restricted picklist, Nillable, Sort Description The status of the prediction. Valid values are: `Disabled` `Draft` `Enabled`
Type	Type picklist Properties Filter, Group, Restricted picklist, Nillable, Sort Description The type of model that returns the prediction values. Valid values are: `BinaryClassification`—1 `DeepLearningIntentClassification`—5 `DeepLearningNameEntityRecognition`—6 `GlobalDeepLearningIntentClassification`—7 `GlobalDeepLearningNameEntityRecognition`—8 `LanguageDetection`—4 `MulticlassClassification`—2 `Regression`—3 `ScoringSpecificOutcome`—0

Tooling API

MLPredictionDefinition

Supported SOAP API Calls

Supported REST API Methods

Fields