Skip to main content
Server path: /datarobot-batch-predictions | Type: Application | PCID required: Yes

​
Tools

ToolDescription
datarobot_batch_predictions_batch_predictions_createCreates a new Batch Prediction job
datarobot_batch_predictions_batch_predictions_deleteCancel a Batch Prediction job
datarobot_batch_predictions_batch_predictions_listList batch prediction jobs
datarobot_batch_predictions_batch_predictions_retrieveRetrieve Batch Prediction job
datarobot_batch_predictions_batch_predictions_updateUpdate a Batch Prediction job
datarobot_batch_predictions_computed_training_predictions_listRetrieve training predictions
datarobot_batch_predictions_download_listDownload the scored data set of a batch prediction job
datarobot_batch_predictions_from_existing_createCreate a new a Batch Prediction job based on an existing Batch Prediction job.
datarobot_batch_predictions_from_job_definition_createLaunch a Batch Prediction job for scoring
datarobot_batch_predictions_jobs_deleteCancel a Batch job
datarobot_batch_predictions_jobs_download_listDownload the scored data set of a batch job
datarobot_batch_predictions_jobs_from_job_definition_createLaunch a Batch job for scoring
datarobot_batch_predictions_jobs_listList batch jobs
datarobot_batch_predictions_jobs_retrieveRetrieve Batch job
datarobot_batch_predictions_prediction_job_definitions_createCreates a new Batch Prediction job definition
datarobot_batch_predictions_prediction_job_definitions_deleteDelete Batch Prediction job definition
datarobot_batch_predictions_prediction_job_definitions_listList Batch Prediction job definitions
datarobot_batch_predictions_prediction_job_definitions_patchUpdate Batch Prediction job definition
datarobot_batch_predictions_prediction_job_definitions_portable_listRetrieve job definition snippet for PBP
datarobot_batch_predictions_prediction_job_definitions_retrieveRetrieve Batch Prediction job definition
datarobot_batch_predictions_projects_models_prediction_explanations_initialization_createCreate a new prediction explanations initialization.
datarobot_batch_predictions_projects_models_prediction_explanations_initialization_delete_manyDelete an existing PredictionExplanationsInitialization.
datarobot_batch_predictions_projects_models_prediction_explanations_initialization_listRetrieve the current PredictionExplanationsInitialization.
datarobot_batch_predictions_projects_predict_jobs_deleteCancel a queued prediction job.
datarobot_batch_predictions_projects_predict_jobs_listList all prediction jobs for a project.
datarobot_batch_predictions_projects_predict_jobs_retrieveLook up a particular prediction job.
datarobot_batch_predictions_projects_prediction_datasets_data_source_uploads_createUpload a dataset for predictions from a DataSource.
datarobot_batch_predictions_projects_prediction_datasets_dataset_uploads_createCreate prediction dataset
datarobot_batch_predictions_projects_prediction_datasets_deleteDelete a dataset that was uploaded for prediction.
datarobot_batch_predictions_projects_prediction_datasets_file_uploads_createUpload a file for predictions from an attached file.
datarobot_batch_predictions_projects_prediction_datasets_listList prediction datasets uploaded to a project.
datarobot_batch_predictions_projects_prediction_datasets_retrieveGet the metadata of a specific dataset. This only works for datasets uploaded to an existing project for prediction.
datarobot_batch_predictions_projects_prediction_datasets_url_uploads_createUpload a file for predictions from a URL.
datarobot_batch_predictions_projects_prediction_explanations_createCreate a new PredictionExplanations object (and its accompanying PredictionExplanationsRecord).
datarobot_batch_predictions_projects_prediction_explanations_listRetrieve stored Prediction Explanations.
datarobot_batch_predictions_projects_prediction_explanations_records_deleteDelete saved Prediction Explanations.
datarobot_batch_predictions_projects_prediction_explanations_records_listList PredictionExplanationsRecord objects for a project.
datarobot_batch_predictions_projects_prediction_explanations_records_retrieveRetrieve a PredictionExplanationsRecord object.
datarobot_batch_predictions_projects_predictions_createMake new predictions.
datarobot_batch_predictions_projects_predictions_listGet the list of prediction records.
datarobot_batch_predictions_projects_predictions_metadata_listGet the list of prediction metadata records.
datarobot_batch_predictions_projects_predictions_metadata_retrieveRetrieve metadata for a set of predictions.
datarobot_batch_predictions_projects_predictions_retrieveGet a completed set of predictions.
datarobot_batch_predictions_projects_training_predictions_createSubmits a job to compute predictions for training data
datarobot_batch_predictions_scheduled_jobs_listList scheduled deployment batch prediction jobs a user can view
datarobot_batch_predictions_training_predictions_listList training prediction jobs

​
datarobot_batch_predictions_batch_predictions_create

Creates a new Batch Prediction job Parameters:
ParameterTypeRequiredDefaultDescription
abortOnErrorbooleanYes—Should this job abort if too many errors are encountered
batchJobTypestringNo—Batch job type.
chunkSizeobjectNo—Which strategy should be used to determine the chunk size. Can be either a named strategy or a fixed size in bytes.
columnNamesRemappingobjectNo—Remap (rename or remove columns from) the output from this job
csvSettingsobjectYes—The CSV settings used for this job
deploymentIdstringNo—ID of deployment which is used in job for processing predictions dataset
disableRowLevelErrorHandlingbooleanYes—Skip row by row error handling
explanationAlgorithmstringNo—Which algorithm will be used to calculate prediction explanations
explanationClassNamesany[]No—Sets a list of selected class names for which corresponding explanations are returned in each row. This setting is mutually exclusive with numTopClasses. If neither parameter is specified, the default setting is numTopClasses=1.
explanationNumTopClassesintegerNo—Sets the number of most probable (top predicted) classes for which corresponding explanations are returned in each row. This setting is mutually exclusive with classNames. If neither parameter is specified, the default setting is numTopClasses=1.
includePredictionStatusbooleanYes—Include prediction status column in the output
includeProbabilitiesbooleanYes—Include probabilities for all classes
includeProbabilitiesClassesany[]Yes—Include only probabilities for these specific class names.
intakeSettingsobjectYes—The intake option configured for this job
maxExplanationsintegerYes—Number of explanations requested. Will be ordered by strength.
modelIdstringNo—ID of leaderboard model which is used in job for processing predictions dataset
modelPackageIdstringNo—ID of model package from registry is used in job for processing predictions dataset
monitoringBatchPrefixstringNo—Name of the batch to create with this job
numConcurrentintegerNo—Number of simultaneous requests to run against the prediction instance
outputSettingsobjectNo—The output option configured for this job
passthroughColumnsany[]No—Pass through columns from the original dataset
passthroughColumnsSetstringNo—Pass through all columns from the original dataset
pinnedModelIdstringNo—Specify a model ID used for scoring
predictionInstanceobjectNo—Override the default prediction instance from the deployment when scoring this job.
predictionThresholdnumberNo—Threshold is the point that sets the class boundary for a predicted value. The model classifies an observation below the threshold as FALSE, and an observation above the threshold as TRUE. In other words, DataRobot automatically assigns the positive class label to any prediction exceeding the threshold. This value can be set between 0.0 and 1.0.
predictionWarningEnabledbooleanNo—Enable prediction warnings.
secondaryDatasetsConfigIdstringNo—Configuration id for secondary datasets to use when making a prediction.
skipDriftTrackingbooleanYes—Skip drift tracking for this job.
thresholdHighnumberNo—Compute explanations for predictions above this threshold
thresholdLownumberNo—Compute explanations for predictions below this threshold
timeseriesSettingsobjectNo—Time Series settings included of this job is a Time Series job.

​
datarobot_batch_predictions_batch_predictions_delete

Cancel a Batch Prediction job Parameters:
ParameterTypeRequiredDefaultDescription
predictionJobIdstringYes—ID of the Batch Prediction job

​
datarobot_batch_predictions_batch_predictions_list

List batch prediction jobs Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—This many results will be skipped
limitintegerYes—At most this many results are returned
statusany[]No—Includes only jobs that have the status value that matches this flag. Repeat the parameter for filtering on multiple statuses.
sourceany[]No—Includes only jobs that have the source value that matches this flag. Repeat the parameter for filtering on multiple statuses.Prefix values with a dash (-) to exclude those sources.
deploymentIdstringNo—Includes only jobs for this particular deployment
modelIdstringNo—ID of leaderboard model which is used in job for processing predictions dataset
jobIdstringNo—Includes only job by specific id
orderBystringNo—Sort order which will be applied to batch prediction list. Prefix the attribute name with a dash to sort in descending order, e.g. “-created”.
allJobsbooleanNo—[DEPRECATED - replaced with RBAC permission model] - No effect
cutoffHoursintegerNo—Only list jobs created at most this amount of hours ago.
startDateTimestringNo—ISO-formatted datetime of the earliest time the job was added (inclusive). For example “2008-08-24T12:00:00Z”. Will ignore cutoffHours if set.
endDateTimestringNo—ISO-formatted datetime of the latest time the job was added (inclusive). For example “2008-08-24T12:00:00Z”.
batchPredictionJobDefinitionIdstringNo—Includes only jobs for this particular definition
hostnameany[]No—Includes only jobs for this particular prediction instance hostname
intakeTypeany[]No—Includes only jobs for these particular intakes type
outputTypeany[]No—Includes only jobs for these particular outputs type

​
datarobot_batch_predictions_batch_predictions_retrieve

Retrieve Batch Prediction job Parameters:
ParameterTypeRequiredDefaultDescription
predictionJobIdstringYes—ID of the Batch Prediction job

​
datarobot_batch_predictions_batch_predictions_update

Update a Batch Prediction job Parameters:
ParameterTypeRequiredDefaultDescription
predictionJobIdstringYes—ID of the Batch Prediction job
abortedstringNo—Time when job abortion happened
completedstringNo—Time when job completed scoring
failedRowsintegerNo—Number of rows that have failed scoring
hiddenbooleanNo—Hides or unhides the job from the job list
jobIntakeSizeintegerNo—Number of bytes in the intake dataset for this job
jobOutputSizeintegerNo—Number of bytes in the output dataset for this job
logsany[]No—The job log.
scoredRowsintegerNo—Number of rows that have been used in prediction computation
skippedRowsintegerNo—Number of rows that have been skipped during scoring. May contain non-zero value only in time-series predictions case if provided dataset contains more than required historical rows.
startedstringNo—Time when job scoring begin
statusstringNo—The current job status

​
datarobot_batch_predictions_computed_training_predictions_list

Retrieve training predictions Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—This many results will be skipped
limitintegerYes—At most this many results are returned
projectIdstringYes—Project ID to retrieve training predictions for
predictionIdstringYes—Prediction ID to retrieve training predictions for

​
datarobot_batch_predictions_download_list

Download the scored data set of a batch prediction job Parameters:
ParameterTypeRequiredDefaultDescription
predictionJobIdstringYes—ID of the Batch Prediction job

​
datarobot_batch_predictions_from_existing_create

Create a new a Batch Prediction job based on an existing Batch Prediction job. Parameters:
ParameterTypeRequiredDefaultDescription
predictionJobIdstringYes—ID of the Batch Prediction job to clone.

​
datarobot_batch_predictions_from_job_definition_create

Launch a Batch Prediction job for scoring Parameters:
ParameterTypeRequiredDefaultDescription
jobDefinitionIdstringYes—ID of the Batch Prediction job definition

​
datarobot_batch_predictions_jobs_delete

Cancel a Batch job Parameters:
ParameterTypeRequiredDefaultDescription
batchJobIdstringYes—ID of the Batch job

​
datarobot_batch_predictions_jobs_download_list

Download the scored data set of a batch job Parameters:
ParameterTypeRequiredDefaultDescription
batchJobIdstringYes—ID of the Batch job

​
datarobot_batch_predictions_jobs_from_job_definition_create

Launch a Batch job for scoring Parameters:
ParameterTypeRequiredDefaultDescription
jobDefinitionIdstringYes—ID of the Batch Prediction job definition

​
datarobot_batch_predictions_jobs_list

List batch jobs Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—This many results will be skipped
limitintegerYes—At most this many results are returned
statusany[]No—Includes only jobs that have the status value that matches this flag. Repeat the parameter for filtering on multiple statuses.
sourceany[]No—Includes only jobs that have the source value that matches this flag. Repeat the parameter for filtering on multiple statuses.Prefix values with a dash (-) to exclude those sources.
deploymentIdstringNo—Includes only jobs for this particular deployment
modelIdstringNo—ID of leaderboard model which is used in job for processing predictions dataset
jobIdstringNo—Includes only job by specific id
orderBystringNo—Sort order which will be applied to batch prediction list. Prefix the attribute name with a dash to sort in descending order, e.g. “-created”.
allJobsbooleanNo—[DEPRECATED - replaced with RBAC permission model] - No effect
cutoffHoursintegerNo—Only list jobs created at most this amount of hours ago.
startDateTimestringNo—ISO-formatted datetime of the earliest time the job was added (inclusive). For example “2008-08-24T12:00:00Z”. Will ignore cutoffHours if set.
endDateTimestringNo—ISO-formatted datetime of the latest time the job was added (inclusive). For example “2008-08-24T12:00:00Z”.
batchPredictionJobDefinitionIdstringNo—Includes only jobs for this particular definition
hostnameany[]No—Includes only jobs for this particular prediction instance hostname
batchJobTypeany[]No—Includes only jobs that have the batch job type that matches this flag. Repeat the parameter for filtering on multiple types.
intakeTypeany[]No—Includes only jobs for these particular intakes type
outputTypeany[]No—Includes only jobs for these particular outputs type

​
datarobot_batch_predictions_jobs_retrieve

Retrieve Batch job Parameters:
ParameterTypeRequiredDefaultDescription
batchJobIdstringYes—ID of the Batch job

​
datarobot_batch_predictions_prediction_job_definitions_create

Creates a new Batch Prediction job definition Parameters:
ParameterTypeRequiredDefaultDescription
abortOnErrorbooleanYes—Should this job abort if too many errors are encountered
batchJobTypestringNo—Batch job type.
chunkSizeobjectNo—Which strategy should be used to determine the chunk size. Can be either a named strategy or a fixed size in bytes.
columnNamesRemappingobjectNo—Remap (rename or remove columns from) the output from this job
csvSettingsobjectYes—The CSV settings used for this job
deploymentIdstringYes—ID of deployment which is used in job for processing predictions dataset
disableRowLevelErrorHandlingbooleanYes—Skip row by row error handling
enabledbooleanNo—If this job definition is enabled as a scheduled job. Optional if no schedule is supplied.
explanationAlgorithmstringNo—Which algorithm will be used to calculate prediction explanations
explanationClassNamesany[]No—Sets a list of selected class names for which corresponding explanations are returned in each row. This setting is mutually exclusive with numTopClasses. If neither parameter is specified, the default setting is numTopClasses=1.
explanationNumTopClassesintegerNo—Sets the number of most probable (top predicted) classes for which corresponding explanations are returned in each row. This setting is mutually exclusive with classNames. If neither parameter is specified, the default setting is numTopClasses=1.
includePredictionStatusbooleanYes—Include prediction status column in the output
includeProbabilitiesbooleanYes—Include probabilities for all classes
includeProbabilitiesClassesany[]Yes—Include only probabilities for these specific class names.
intakeSettingsobjectYes—The intake option configured for this job
maxExplanationsintegerYes—Number of explanations requested. Will be ordered by strength.
modelIdstringNo—ID of leaderboard model which is used in job for processing predictions dataset
modelPackageIdstringNo—ID of model package from registry is used in job for processing predictions dataset
monitoringBatchPrefixstringNo—Name of the batch to create with this job
namestringNo—A human-readable name for the definition, must be unique across organisations, if left out the backend will generate one for you.
numConcurrentintegerNo—Number of simultaneous requests to run against the prediction instance
outputSettingsobjectNo—The output option configured for this job
passthroughColumnsany[]No—Pass through columns from the original dataset
passthroughColumnsSetstringNo—Pass through all columns from the original dataset
pinnedModelIdstringNo—Specify a model ID used for scoring
predictionInstanceobjectNo—Override the default prediction instance from the deployment when scoring this job.
predictionThresholdnumberNo—Threshold is the point that sets the class boundary for a predicted value. The model classifies an observation below the threshold as FALSE, and an observation above the threshold as TRUE. In other words, DataRobot automatically assigns the positive class label to any prediction exceeding the threshold. This value can be set between 0.0 and 1.0.
predictionWarningEnabledbooleanNo—Enable prediction warnings.
scheduleobjectNo—The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.
secondaryDatasetsConfigIdstringNo—Configuration id for secondary datasets to use when making a prediction.
skipDriftTrackingbooleanYes—Skip drift tracking for this job.
thresholdHighnumberNo—Compute explanations for predictions above this threshold
thresholdLownumberNo—Compute explanations for predictions below this threshold
timeseriesSettingsobjectNo—Time Series settings included of this job is a Time Series job.

​
datarobot_batch_predictions_prediction_job_definitions_delete

Delete Batch Prediction job definition Parameters:
ParameterTypeRequiredDefaultDescription
jobDefinitionIdstringYes—ID of the Batch Prediction job definition

​
datarobot_batch_predictions_prediction_job_definitions_list

List Batch Prediction job definitions Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—This many results will be skipped
limitintegerYes—At most this many results are returned
searchNamestringNo—A human-readable name for the definition, must be unique across organisations.
deploymentIdstringNo—Includes only definitions for this particular deployment

​
datarobot_batch_predictions_prediction_job_definitions_patch

Update Batch Prediction job definition Parameters:
ParameterTypeRequiredDefaultDescription
jobDefinitionIdstringYes—ID of the Batch Prediction job definition
abortOnErrorbooleanNo—Should this job abort if too many errors are encountered
batchJobTypestringNo—Batch job type.
chunkSizeobjectNo—Which strategy should be used to determine the chunk size. Can be either a named strategy or a fixed size in bytes.
columnNamesRemappingobjectNo—Remap (rename or remove columns from) the output from this job
csvSettingsobjectNo—The CSV settings used for this job
deploymentIdstringNo—ID of deployment which is used in job for processing predictions dataset
disableRowLevelErrorHandlingbooleanNo—Skip row by row error handling
enabledbooleanNo—If this job definition is enabled as a scheduled job. Optional if no schedule is supplied.
explanationAlgorithmstringNo—Which algorithm will be used to calculate prediction explanations
explanationClassNamesany[]No—Sets a list of selected class names for which corresponding explanations are returned in each row. This setting is mutually exclusive with numTopClasses. If neither parameter is specified, the default setting is numTopClasses=1.
explanationNumTopClassesintegerNo—Sets the number of most probable (top predicted) classes for which corresponding explanations are returned in each row. This setting is mutually exclusive with classNames. If neither parameter is specified, the default setting is numTopClasses=1.
includePredictionStatusbooleanNo—Include prediction status column in the output
includeProbabilitiesbooleanNo—Include probabilities for all classes
includeProbabilitiesClassesany[]No—Include only probabilities for these specific class names.
intakeSettingsobjectNo—The intake option configured for this job
maxExplanationsintegerNo—Number of explanations requested. Will be ordered by strength.
modelIdstringNo—ID of leaderboard model which is used in job for processing predictions dataset
modelPackageIdstringNo—ID of model package from registry is used in job for processing predictions dataset
monitoringBatchPrefixstringNo—Name of the batch to create with this job
namestringNo—A human-readable name for the definition, must be unique across organisations, if left out the backend will generate one for you.
numConcurrentintegerNo—Number of simultaneous requests to run against the prediction instance
outputSettingsobjectNo—The output option configured for this job
passthroughColumnsany[]No—Pass through columns from the original dataset
passthroughColumnsSetstringNo—Pass through all columns from the original dataset
pinnedModelIdstringNo—Specify a model ID used for scoring
predictionInstanceobjectNo—Override the default prediction instance from the deployment when scoring this job.
predictionThresholdnumberNo—Threshold is the point that sets the class boundary for a predicted value. The model classifies an observation below the threshold as FALSE, and an observation above the threshold as TRUE. In other words, DataRobot automatically assigns the positive class label to any prediction exceeding the threshold. This value can be set between 0.0 and 1.0.
predictionWarningEnabledbooleanNo—Enable prediction warnings.
scheduleobjectNo—The scheduling information defining how often and when to execute this job to the Job Scheduling service. Optional if enabled = False.
secondaryDatasetsConfigIdstringNo—Configuration id for secondary datasets to use when making a prediction.
skipDriftTrackingbooleanNo—Skip drift tracking for this job.
thresholdHighnumberNo—Compute explanations for predictions above this threshold
thresholdLownumberNo—Compute explanations for predictions below this threshold
timeseriesSettingsobjectNo—Time Series settings included of this job is a Time Series job.

​
datarobot_batch_predictions_prediction_job_definitions_portable_list

Retrieve job definition snippet for PBP Parameters:
ParameterTypeRequiredDefaultDescription
jobDefinitionIdstringYes—ID of the Batch Prediction job definition

​
datarobot_batch_predictions_prediction_job_definitions_retrieve

Retrieve Batch Prediction job definition Parameters:
ParameterTypeRequiredDefaultDescription
jobDefinitionIdstringYes—ID of the Batch Prediction job definition

​
datarobot_batch_predictions_projects_models_prediction_explanations_initialization_create

Create a new prediction explanations initialization. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID.
modelIdstringYes—The model ID.
maxExplanationsintegerNo—The maximum number of prediction explanations to supply per row of the dataset.
thresholdHighnumberNo—The high threshold, above which a prediction must score in order for prediction explanations to be computed. If neither thresholdHigh nor thresholdLow is specified, prediction explanations will be computed for all rows.
thresholdLownumberNo—The lower threshold, below which a prediction must score in order for prediction explanations to be computed for a row in the dataset. If neither thresholdHigh nor thresholdLow is specified, prediction explanations will be computed for all rows.

​
datarobot_batch_predictions_projects_models_prediction_explanations_initialization_delete_many

Delete an existing PredictionExplanationsInitialization. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID.
modelIdstringYes—The model ID.

​
datarobot_batch_predictions_projects_models_prediction_explanations_initialization_list

Retrieve the current PredictionExplanationsInitialization. Parameters:
ParameterTypeRequiredDefaultDescription
excludeAdjustedPredictionsstringNo—Whether to include adjusted predictions in the PredictionExplanationsSample response.
projectIdstringYes—The project ID.
modelIdstringYes—The model ID.

​
datarobot_batch_predictions_projects_predict_jobs_delete

Cancel a queued prediction job. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID.
jobIdstringYes—The job ID.

​
datarobot_batch_predictions_projects_predict_jobs_list

List all prediction jobs for a project. Parameters:
ParameterTypeRequiredDefaultDescription
statusstringNo—If provided, only jobs with the same status will be included in the results; otherwise, queued and inprogress jobs (but not errored jobs) will be returned.
projectIdstringYes—The project ID.

​
datarobot_batch_predictions_projects_predict_jobs_retrieve

Look up a particular prediction job. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID.
jobIdstringYes—The job ID.

​
datarobot_batch_predictions_projects_prediction_datasets_data_source_uploads_create

Upload a dataset for predictions from a DataSource. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID to which the data source will be uploaded to.
actualValueColumnstringNo—The actual value column name, valid for the prediction files if the project is unsupervised and the dataset is considered as bulk predictions dataset.
credentialDataobjectNo—The credentials to authenticate with the database, to use instead of user/password or credential ID.
credentialIdstringNo—The credential ID to use for database authentication.
credentialsany[]No—A list of credentials for the secondary datasets used in feature discovery project.
dataSourceIdstringYes—The ID of DataSource.
forecastPointstringNo—For time series projects only. The time in the dataset relative to which predictions are generated. This value is optional. If not specified the default value is the value in the row with the latest specified timestamp. Specifying this value for a project that is not a time series project will result in an error.
passwordstringNo—The password (in cleartext) for database authentication. The password will be encrypted on the server side in scope of HTTP request and never saved or stored. DEPRECATED: please use credentialId or credentialData instead.
predictionsEndDatestringNo—The end date for bulk predictions, exclusive. Used for time series projects only. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsStartDate, and cannot be provided with the forecastPoint parameter.
predictionsStartDatestringNo—The start date for bulk predictions. Used for time series projects only. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsEndDate, and cannot be provided with the forecastPoint parameter.
relaxKnownInAdvanceFeaturesCheckbooleanNo—For time series projects only. If true, missing values in the known in advance features are allowed in the forecast window at the prediction time. This value is optional. If omitted or false, missing values are not allowed.
secondaryDatasetsConfigIdstringNo—For feature discovery projects only. The ID of the alternative secondary dataset config to use during prediction.
useKerberosbooleanNo—If true, use kerberos authentication for database authentication. Default is false.
userstringNo—The username for database authentication. DEPRECATED: please use credentialId or credentialData instead.

​
datarobot_batch_predictions_projects_prediction_datasets_dataset_uploads_create

Create prediction dataset Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID.
actualValueColumnstringNo—Actual value column name, valid for the prediction files if the project is unsupervised and the dataset is considered as bulk predictions dataset.
credentialDataobjectNo—The credentials to authenticate with the database, to be used instead of credential ID.
credentialIdstringNo—The ID of the set of credentials to authenticate with the database.
credentialsany[]No—List of credentials for the secondary datasets used in feature discovery project.
datasetIdstringYes—The ID of the dataset entry to use for prediction dataset.
datasetVersionIdstringNo—The ID of the dataset version to use for the prediction dataset. If not specified - uses latest version associated with datasetId.
forecastPointstringNo—For time series projects only. The time in the dataset relative to which predictions are generated. This value is optional. If not specified the default value is the value in the row with the latest specified timestamp. Specifying this value for a project that is not a time series project will result in an error.
passwordstringNo—The password (in cleartext) for database authentication. The password will be encrypted on the server side in scope of HTTP request and never saved or stored.DEPRECATED: please use credentialId or credentialData instead.
predictionsEndDatestringNo—The end date for bulk predictions, exclusive. Used for time series projects only. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsStartDate, and cannot be provided with the forecastPoint parameter.
predictionsStartDatestringNo—The start date for bulk predictions. Used for time series projects only. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsEndDate, and cannot be provided with the forecastPoint parameter.
relaxKnownInAdvanceFeaturesCheckbooleanNo—For time series projects only. If True, missing values in the known in advance features are allowed in the forecast window at the prediction time. If omitted or False, missing values are not allowed.
secondaryDatasetsConfigIdstringNo—For feature discovery projects only. The Id of the alternative secondary dataset config to use during prediction.
useKerberosbooleanNo—If true, use kerberos authentication for database authentication. Default is false.
userstringNo—The username for database authentication. DEPRECATED: please use credentialId or credentialData instead.

​
datarobot_batch_predictions_projects_prediction_datasets_delete

Delete a dataset that was uploaded for prediction. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID that owns the data.
datasetIdstringYes—The dataset ID to delete.

​
datarobot_batch_predictions_projects_prediction_datasets_file_uploads_create

Upload a file for predictions from an attached file. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID to which the data will be uploaded for prediction.
actualValueColumnstringNo—The actual value column name, valid for the prediction files if the project is unsupervised and the dataset is considered as bulk predictions dataset.
credentialsstringNo—The list of credentials for the secondary datasets used in feature discovery project.
filestringYes—The dataset file to upload for prediction.
forecastPointstringNo—For time series projects only. The time in the dataset relative to which predictions are generated. If not specified the default value is the value in the row with the latest specified timestamp. Specifying this value for a project that is not a time series project will result in an error.
predictionsEndDatestringNo—Used for time series projects only. The end date for bulk predictions. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsStartDate, and cannot be provided with the forecastPoint parameter.
predictionsStartDatestringNo—Used for time series projects only. The start date for bulk predictions. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsEndDate, and cannot be provided with the forecastPoint parameter.
relaxKnownInAdvanceFeaturesCheckstringNo—A boolean flag. If true, missing values in the known in advance features are allowed in the forecast window at the prediction time. If omitted or false, missing values are not allowed. For time series projects only.
secondaryDatasetsConfigIdstringNo—Optional, for feature discovery projects only. The ID of the alternative secondary dataset config to use during prediction.

​
datarobot_batch_predictions_projects_prediction_datasets_list

List prediction datasets uploaded to a project. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—This many results will be skipped.
limitintegerYes—At most this many results are returned. If 0, all results.
projectIdstringYes—The project ID to query.

​
datarobot_batch_predictions_projects_prediction_datasets_retrieve

Get the metadata of a specific dataset. This only works for datasets uploaded to an existing project for prediction. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID that owns the data.
datasetIdstringYes—The dataset ID to query for.

​
datarobot_batch_predictions_projects_prediction_datasets_url_uploads_create

Upload a file for predictions from a URL. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID to which the data will be uploaded for prediction.
actualValueColumnstringNo—The actual value column name, valid for the prediction files if the project is unsupervised and the dataset is considered as bulk predictions dataset. This value is optional.
credentialsany[]No—The list of credentials for the secondary datasets used in feature discovery project.
forecastPointstringNo—For time series projects only. The time in the dataset relative to which predictions are generated. If not specified the default value is the value in the row with the latest specified timestamp. Specifying this value for a project that is not a time series project will result in an error.
predictionsEndDatestringNo—Used for time series projects only. The end date for bulk predictions, exclusive. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsStartDate, and cannot be provided with the forecastPoint parameter.
predictionsStartDatestringNo—Used for time series projects only. The start date for bulk predictions. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsEndDate, and cannot be provided with the forecastPoint parameter.
relaxKnownInAdvanceFeaturesCheckbooleanNo—For time series projects only. If true, missing values in the known in advance features are allowed in the forecast window at the prediction time. This value is optional. If omitted or false, missing values are not allowed.
secondaryDatasetsConfigIdstringNo—For feature discovery projects only. The ID of the alternative secondary dataset config to use during prediction.
urlstringYes—The URL to download the dataset from.

​
datarobot_batch_predictions_projects_prediction_explanations_create

Create a new PredictionExplanations object (and its accompanying PredictionExplanationsRecord). Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID.
classNamesany[]No—Sets a list of selected class names for which corresponding explanations are returned in each row. This setting is mutually exclusive with numTopClasses. If neither parameter is specified, the default setting is numTopClasses=1.
datasetIdstringYes—The dataset ID.
maxExplanationsintegerNo—The maximum number of prediction explanations to supply per row of the dataset.
modelIdstringYes—The model ID.
numTopClassesintegerNo—Sets the number of most probable (top predicted) classes for which corresponding explanations are returned in each row. This setting is mutually exclusive with classNames. If neither parameter is specified, the default setting is numTopClasses=1.
thresholdHighnumberNo—The high threshold, above which a prediction must score in order for prediction explanations to be computed. If neither thresholdHigh nor thresholdLow is specified, prediction explanations will be computed for all rows.
thresholdLownumberNo—The lower threshold, below which a prediction must score in order for prediction explanations to be computed for a row in the dataset. If neither thresholdHigh nor thresholdLow is specified, prediction explanations will be computed for all rows.

​
datarobot_batch_predictions_projects_prediction_explanations_list

Retrieve stored Prediction Explanations. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNo—This many results will be skipped.
limitintegerYes—At most this many results are returned. The default may change and a new maximum limit may be imposed without notice.
excludeAdjustedPredictionsstringNo—Whether to include adjusted predictions in the PredictionExplanationsRow response.
projectIdstringYes—The project ID.
predictionExplanationsIdstringYes—The ID of the PredictionExplanationsRecord to retrieve.

​
datarobot_batch_predictions_projects_prediction_explanations_records_delete

Delete saved Prediction Explanations. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID.
predictionExplanationsIdstringYes—The ID of the PredictionExplanationsRecord to retrieve.

​
datarobot_batch_predictions_projects_prediction_explanations_records_list

List PredictionExplanationsRecord objects for a project. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNo—This many results will be skipped.
limitintegerNo—At most this many results are returned.
modelIdstringNo—If specified, only prediction explanations records computed for this model will be returned.
projectIdstringYes—The project ID.

​
datarobot_batch_predictions_projects_prediction_explanations_records_retrieve

Retrieve a PredictionExplanationsRecord object. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project ID.
predictionExplanationsIdstringYes—The ID of the PredictionExplanationsRecord to retrieve.

​
datarobot_batch_predictions_projects_predictions_create

Make new predictions. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—The project to make predictions within.
actualValueColumnstringNo—For time series projects only. The actual value column name, valid for the prediction files if the project is unsupervised and the dataset is considered as bulk predictions dataset. This value is optional.
datasetIdstringYes—The dataset to compute predictions for - must have previously been uploaded.
explanationAlgorithmstringNo—If set to shap, the response will include prediction explanations based on the SHAP explainer (SHapley Additive exPlanations). Defaults to null (no prediction explanations).
forecastPointstringNo—For time series projects only. The time in the dataset relative to which predictions are generated. This value is optional. If not specified the default value is the value in the row with the latest specified timestamp. Specifying this value for a project that is not a time series project will result in an error.
includeFdwCountsbooleanNo—For time series projects with partial history only. Indicates if feature derivation window counts featureDerivationWindowCounts will be part of the response.
includePredictionIntervalsbooleanNo—Specifies whether prediction intervals should be calculated for this request. Defaults to True if predictionIntervalsSize is specified, otherwise defaults to False.
maxExplanationsintegerNo—Specifies the maximum number of explanation values that should be returned for each row, ordered by absolute value, greatest to least. In the case of ‘shap’: If not set, explanations are returned for all features. If the number of features is greater than the ‘maxExplanations’, the sum of remaining values will also be returned as ‘shapRemainingTotal’. Defaults to null for datasets narrower than 100 columns, defaults to 100 for datasets wider than 100 columns. Cannot be set if ‘explanationAlgorithm’ is omitted.
modelIdstringYes—The model to make predictions on.
predictionIntervalsSizeintegerNo—Represents the percentile to use for the size of the prediction intervals. Defaults to 80 if includePredictionIntervals is True.
predictionsEndDatestringNo—The end date for bulk predictions, exclusive. Used for time series projects only. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsStartDate, and cannot be provided with the forecastPoint parameter.
predictionsStartDatestringNo—The start date for bulk predictions. Used for time series projects only. Note that this parameter is used for generating historical predictions using the training data, not for future predictions. If not specified, the dataset is not considered as a bulk predictions dataset. This parameter should be provided in conjunction with a predictionsEndDate, and cannot be provided with the forecastPoint parameter.
predictionThresholdnumberNo—Threshold used for binary classification in predictions. Accepts values from 0.0 to 1.0. If not specified, model default prediction threshold will be used.

​
datarobot_batch_predictions_projects_predictions_list

Get the list of prediction records. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—The number of results to skip.
limitintegerYes—At most this many results are returned. To specify no limit, use 0. The default may change and a maximum limit may be imposed without notice.
datasetIdstringNo—The dataset ID used to create the predictions.
modelIdstringNo—The model ID.
projectIdstringYes—The project of the predictions.

​
datarobot_batch_predictions_projects_predictions_metadata_list

Get the list of prediction metadata records. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—The number of results to skip.
limitintegerYes—At most this many results are returned. To specify no limit, use 0. The default may change and a maximum limit may be imposed without notice.
predictionDatasetIdstringNo—The dataset ID used to create the predictions.
modelIdstringNo—The model ID.
projectIdstringYes—The project of the predictions.

​
datarobot_batch_predictions_projects_predictions_metadata_retrieve

Retrieve metadata for a set of predictions. Parameters:
ParameterTypeRequiredDefaultDescription
predictionIdstringYes—The ID of the prediction record to retrieve. If you have the jobId, you can retrieve the predictionId using :http:get:/api/v2/projects/(projectId)/predictJobs/(jobId)/.
projectIdstringYes—The ID of the project the prediction belongs to.

​
datarobot_batch_predictions_projects_predictions_retrieve

Get a completed set of predictions. Parameters:
ParameterTypeRequiredDefaultDescription
predictionIdstringYes—The ID of the prediction record to retrieve. If you have the jobId, you can retrieve the predictionId using :http:get:/api/v2/projects/(projectId)/predictJobs/(jobId)/.
projectIdstringYes—The ID of the project the prediction belongs to.

​
datarobot_batch_predictions_projects_training_predictions_create

Submits a job to compute predictions for training data Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYes—Project ID to compute training predictions for
dataSubsetstringYes—Subset of data predicted on: The value “all” returns predictions for all rows in the dataset including data used for training, validation, holdout and any rows discarded. This is not available for large datasets or projects created with Date/Time partitioning. The value “validationAndHoldout” returns predictions for the rows used to calculate the validation score and the holdout score. Not available for large projects or Date/Time projects for models trained into the validation set. The value “holdout” returns predictions for the rows used to calculate the holdout score. Not available for projects created without a holdout or for models trained into holdout for large datasets or created with Date/Time partitioning. The value “allBacktests” returns predictions for the rows used to calculate the backtesting scores for Date/Time projects. The value “validation” returns predictions for the rows used to calculate the validation score.
explanationAlgorithmstringNo—If set to “shap”, the response will include prediction explanations based on the SHAP explainer (SHapley Additive exPlanations). Defaults to null (no prediction explanations)
maxExplanationsintegerNo—Specifies the maximum number of explanation values that should be returned for each row, ordered by absolute value, greatest to least. In the case of “shap”: If not set, explanations are returned for all features. If the number of features is greater than the “maxExplanations”, the sum of remaining values will also be returned as “shapRemainingTotal”. Defaults to null for datasets narrower than 100 columns, defaults to 100 for datasets wider than 100 columns. Cannot be set if “explanationAlgorithm” is omitted.
modelIdstringYes—The model to make predictions on

​
datarobot_batch_predictions_scheduled_jobs_list

List scheduled deployment batch prediction jobs a user can view Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—The number of scheduled jobs to skip. Defaults to 0.
limitintegerYes—The number of scheduled jobs (max 100) to return. Defaults to 20
orderBystringNo—The order to sort the scheduled jobs. Defaults to order by last successful run timestamp in descending order.
searchstringNo—Case insensitive search against scheduled jobs name or type name.
deploymentIdstringNo—Filter by the prediction integration deployment ID. Ignored for non prediction integration type ID.
typeIdstringNo—filter by scheduled job type ID.
queryByUserstringNo—Which user field to filter with.
filterEnabledstringNo—Filter jobs using the enabled field. If true, only enabled jobs are returned, otherwise if false, only disabled jobs are returned. The default returns both enabled and disabled jobs.

​
datarobot_batch_predictions_training_predictions_list

List training prediction jobs Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYes—This many results will be skipped
limitintegerYes—At most this many results are returned
projectIdstringYes—Project ID to retrieve training predictions for