afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/MLPredictionDefinition.json

67 lines
2.9 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields"
],
"title": "MLPredictionDefinition - Metadata API",
"description": "Represents a prediction definition that specifies details about the prediction. This type extends the Metadata metadata type and inherits its fullName field.",
"file_information": ".mlPrediction",
"directory_location": "mlPredictions",
"fields_columns": [
"type",
"description"
],
"fields": {
"aiApplicationDeveloperName": {
"type": "string",
"description": "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.",
"required": true
},
"description": {
"type": "string",
"description": "Description of the prediction."
},
"developerName": {
"type": "string",
"description": "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. Note: Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.",
"required": true
},
"masterLabel": {
"type": "string",
"description": "Label that identifies the ML prediction definition throughout the Salesforce user interface."
},
"negativeExpression": {
"type": "MLFilter",
"description": "Reserved for future use."
},
"positiveExpression": {
"type": "MLFilter",
"description": "Reserved for future use."
},
"predictionField": {
"type": "string",
"description": "Field that the prediction is based on."
},
"priority": {
"type": "int",
"description": "Reflects the priority of the MLPD object when an AIApplication has multiple child MLPDs. Nillable."
},
"pushbackField": {
"type": "string",
"description": "Field that the prediction writes scores to."
},
"status": {
"type": "MLPredictionDefinitionStatus (enumeration of type string)",
"description": "The status of the prediction. Valid values are: Enabled Disabled Draft",
"required": true
},
"type": {
"type": "AIPredictionType (enumeration of type string)",
"description": "The type of model that returns the prediction values. Valid values are: BinaryClassification DeepLearningIntentClassification DeepLearningNameEntityRecognition GlobalDeepLearningIntentClassification GlobalDeepLearningNameEntityRecognition LanguageDetection MulticlassClassification Regression ScoringSpecificOutcome",
"required": true
}
}
}