Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

DiscoveryAIModel

Represents the metadata associated with a model used in Einstein Discovery.

A model is a sophisticated, custom algorithm that Einstein Discovery generates based on a comprehensive, statistical understanding of past outcomes. Einstein Discovery uses models to predict future outcomes. A model accepts the values of one or more predictor variables as input and produces a predicted outcome as output, along with (optionally) top factors and improvements. In Package Manager, this type is listed as "Discovery Model".

You can also build models using a third-party modeling tool, and then import them into Salesforce using Model Manager in Analytics Studio.

Write operations for DiscoveryAIModel objects are generally not supported.

Note

Declarative Metadata File Suffix and Directory Location

A DiscoveryAIModel is stored in the discovery folder. DiscoveryAIModels have two files:

file with .model suffix contains the model's actual data
file named ModelName.model-meta.xml suffix contains the model's metadata

Here is a sample package.xml file:

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Maximize_Sales</members>
5        <name>DiscoveryAIModel</name>
6    </types>
7    <version>53.0</version>
8</Package>

Version

DiscoveryAIModels are available in API version 51.0 and later.

Fields

Field Name	Field Type	Description
algorithmType	DiscoveryAlgorithmType	Algorithm that Einstein Discovery used to create the model associated with this story.
classificationThreshold	double	Threshold value. Applies only to binary classification models. For regression models, this is null.
description	string	Model description.
label	string	Model label. If you package a model, this label appears in Package Manager.
modelFields	DiscoveryModelField[]	One or more model fields (variables).
modelRuntimeType	DiscoveryModelRuntimeType	Model run-time type.
predictedField	string	Name of the field that is predicted.
predictionType	DiscoveryPredictionType	Type of prediction. One of the following strings: Regression Classification Unknown
sourceType	DiscoveryModelSourceType	Source type.
status	DiscoveryAIModelStatus	Model status (enabled or disabled).
trainingMetrics	string	JSON object that represents metrics about the model when it was trained.
transformations	DiscoveryModelTransform	One or more model transformations.

DiscoveryAlgorithmType

Represents the algorithm that Einstein Discovery used to create the model.

Field Name	Field Type	Description
Best	string	Tournament Model. Genetic algorithm used to generate high-quality solutions to optimization and search problems, like optimizing decision trees for better performance.
Glm	string	Generalized Linear Model. Regression-based algorithm.
Gbm	string	Gradient Boost Machine. Decision tree-based ensemble machine learning algorithm.
Xgboost	string	XGBoost. Decision tree-based ensemble machine learning algorithm.
Drf	string	Random Forest. Supervised learning algorithm that uses multiple decision trees, randomization, and other optimization techniques.

DiscoveryModelField

Represents a field (variable) in the model.

Field Name	Field Type	Description
isDisparateImpact	boolean	Indicates whether the field is disparate impact (`true`) or not (`false`).
isSensitive	boolean	Indicates whether the field is sensitive (`true`) or not (`false`).
label	string	Field label displayed in the UI.
name	string	Field name.
type	DiscoveryModelFieldType	Field type. Enumerated.
values	string[]	A list of field values.

DiscoveryModelTransform

Represents a transformation in the model.

Field Name	Field Type	Description
config	string	The configuration for the transformation.
sourceFieldNames	string[]	A list of the source field names.
targetFieldNames	string[]	A list of the target field names.
type	DiscoveryAIModelTransformationType	Type of transformation.