Newer Version Available

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

MLPredictionDefinition

Represents a prediction definition that specifies details about the prediction. This type extends the Metadata metadata type and inherits its fullName field.

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

File Suffix and Directory Location

MLPredictionDefinition components have the suffix .mlPrediction and are stored in the mlPredictions folder.

Version

MLPredictionDefinition is available in API version 50.0 and later.

Fields

Field Name Field Type Description
aiApplicationDeveloperName string Required. Represents the developer name of the parent AI application. 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.
description string Description of the prediction.
developerName string Required. Represents the name of the prediction definition. 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.

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

Note

masterLabel string Label that identifies the ML prediction definition throughout the Salesforce user interface.
negativeExpression MLFilter Reserved for future use.
positiveExpression MLFilter Reserved for future use.
predictionField string Field that the prediction is based on.
priority int Reflects the priority of the MLPD object when an AIApplication has multiple child MLPDs. Nillable.
pushbackField string Field that the prediction writes scores to.
status MLPredictionDefinitionStatus (enumeration of type string) Required. The status of the prediction. Valid values are:
  • Enabled
  • Disabled
  • Draft
type AIPredictionType (enumeration of type string) Required. The type of model that returns the prediction values. Valid values are:
  • BinaryClassification
  • DeepLearningIntentClassification
  • DeepLearningNameEntityRecognition
  • GlobalDeepLearningIntentClassification
  • GlobalDeepLearningNameEntityRecognition
  • LanguageDetection
  • MulticlassClassification
  • Regression
  • ScoringSpecificOutcome

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.