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

Tools

ToolDescription
datarobot_projects_access_control_listGet the project access control list.
datarobot_projects_access_control_patch_manyUpdate the project’s access controls.
datarobot_projects_autopilot_createPause or unpause Autopilot
datarobot_projects_autopilots_createStart autopilot
datarobot_projects_configure_and_start_autopilotStart modeling.
datarobot_projects_datetime_partitioning_createPreview the fully specified datetime partitioning generated by the requested configuration. DEPRECATED API.
datarobot_projects_datetime_partitioning_listRetrieve datetime partitioning configuration.
datarobot_projects_deleted_projects_count_listCount soft-deleted projects.
datarobot_projects_deleted_projects_listRetrieve the list of soft-deleted projects.
datarobot_projects_deleted_projects_patchRecover soft-deleted project.
datarobot_projects_external_time_series_baseline_data_validation_jobs_createValidate baseline data.
datarobot_projects_external_time_series_baseline_data_validation_jobs_retrieveRetrieve the baseline validation job.
datarobot_projects_hdfs_projects_createCreate a project from an HDFS file source.
datarobot_projects_jobs_deleteCancel a job.
datarobot_projects_jobs_listList project jobs.
datarobot_projects_jobs_retrieveGet a job.
datarobot_projects_multiseries_ids_cross_series_properties_listRetrieve eligible cross-series group-by columns.
datarobot_projects_multiseries_names_listList the names of a multiseries project.
datarobot_projects_multiseries_properties_createDetect multiseries properties.
datarobot_projects_optimized_datetime_partitionings_createCreate an optimized datetime partitioning configuration using the target.
datarobot_projects_optimized_datetime_partitionings_datetime_partitioning_input_listRetrieve the optimized datetime partitioning input.
datarobot_projects_optimized_datetime_partitionings_datetime_partitioning_log_file_listRetrieve a text file containing the datetime partitioning log
datarobot_projects_optimized_datetime_partitionings_datetime_partitioning_log_listRetrieve the datetime partitioning log and log length as JSON
datarobot_projects_optimized_datetime_partitionings_listLists all created optimized datetime partitioning configurations.
datarobot_projects_optimized_datetime_partitionings_retrieveRetrieve the optimized datetime partitioning configuration.
datarobot_projects_project_cleanup_jobs_createSchedule project permadelete job.
datarobot_projects_project_cleanup_jobs_deleteCancel scheduled project permadelete job.
datarobot_projects_project_cleanup_jobs_download_listDownload a projects permadeletion report.
datarobot_projects_project_cleanup_jobs_listRetrieve project permadelete job status.
datarobot_projects_project_cleanup_jobs_retrieveRetrieve project permadelete job status.
datarobot_projects_project_cleanup_jobs_summary_listGet a projects cleanup jobs summary.
datarobot_projects_project_clones_createClone a project.
datarobot_projects_projects_createCreate a project.
datarobot_projects_projects_deleteDelete a project.
datarobot_projects_projects_listList projects.
datarobot_projects_projects_retrieveGet project.
datarobot_projects_projects_updateUpdate a project.
datarobot_projects_segmentation_task_job_results_retrieveRetrieve segmentation task statuses.
datarobot_projects_segmentation_tasks_createCreate segmentation tasks.
datarobot_projects_segmentation_tasks_listList segmentation tasks.
datarobot_projects_segmentation_tasks_mappings_listRetrieve series ID to segment ID mappings.
datarobot_projects_segmentation_tasks_retrieveRetrieve segmentation task.
datarobot_projects_segments_patchUpdate child segment project.
datarobot_projects_status_listCheck project status.

datarobot_projects_access_control_list

Get the project access control list. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerYesThis many results will be skipped
limitintegerYesAt most this many results are returned
usernamestringNoOptional, only return the access control information for a user with this username.
userIdstringNoOptional, only return the access control information for a user with this user ID.
projectIdstringYesThe project ID.

datarobot_projects_access_control_patch_many

Update the project’s access controls. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
dataany[]YesThe role to set for the user.
includeFeatureDiscoveryEntitiesbooleanNoWhether to share all the related entities.
sendNotificationbooleanNoSend an email notification.

datarobot_projects_autopilot_create

Pause or unpause Autopilot Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
commandstringYesIf start, will unpause the autopilot and run queued jobs if workers are available. If stop, will pause the autopilot so no new jobs will be started.

datarobot_projects_autopilots_create

Start autopilot Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
autopilotClusterListany[]NoOptional. A list of integers where each value will be used as the number of clusters in Autopilot model(s) for unsupervised clustering projects. Cannot be specified unless unsupervisedMode is true and unsupervisedType is set to ‘clustering’.
blendBestModelsbooleanNoBlend best models during Autopilot run. This option is not supported in SHAP-only mode or for multilabel projects.
considerBlendersInRecommendationbooleanNoInclude blenders when selecting a model to prepare for deployment in an Autopilot Run. This option is not supported in SHAP-only mode or for multilabel projects.
featurelistIdstringYesThe ID of a featurelist that should be used for autopilot.
modestringNoThe Autopilot mode.
prepareModelForDeploymentbooleanNoPrepare model for deployment during Autopilot run. The preparation includes creating reduced feature list models, retraining best model on higher sample size, computing insights and assigning “RECOMMENDED FOR DEPLOYMENT” label.
runLeakageRemovedFeatureListbooleanNoRun Autopilot on Leakage Removed feature list (if exists).
scoringCodeOnlybooleanNoKeep only models that can be converted to scorable java code during Autopilot run.
useGpubooleanNoUse GPU workers for Autopilot run.

datarobot_projects_configure_and_start_autopilot

Start modeling. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
accuracyOptimizedMbbooleanNoInclude additional, longer-running models that will be run by the autopilot and available to run manually.
aggregationTypestringNoFor multiseries projects only. The aggregation type to apply when creating cross-series features.
allowedPairwiseInteractionGroupsany[]NoFor GAM models - specify groups of columns for which pairwise interactions will be allowed. E.g. if set to [[‘A’, ‘B’, ‘C’], [‘C’, ‘D’]] then GAM models will allow interactions between columns AxB, BxC, AxC, CxD. All others (AxD, BxD) will not be considered. If not specified - all possible interactions will be considered by model.
allowedPairwiseInteractionGroupsFilenamestringNoFilename that was used to upload allowed_pairwise_interaction_groups. Necessary for persistence of UI/UX when you specify that parameter via file.
allowPartialHistoryTimeSeriesPredictionsbooleanNoSpecifies whether the time series predictions can use partial historical data.
autopilotClusterListany[]NoA list of integers where each value will be used as the number of clusters in Autopilot model(s) for unsupervised clustering projects. Cannot be specified unless unsupervisedMode is true and unsupervisedType is set to clustering.
autopilotDataSamplingMethodstringNoDefines how autopilot will select subsample from training dataset in OTV/TS projects. Defaults to ‘latest’ for ‘rowCount’ dataSelectionMethod and to ‘random’ for ‘duration’.
autopilotDataSelectionMethodstringYesThe Data Selection method to be used by autopilot when creating models for datetime-partitioned datasets.
autopilotWithFeatureDiscoverybooleanNoIf true, autopilot will run on a feature list that includes features found via search for interactions.
backtestsany[]NoAn array specifying the format of the backtests.
biasMitigationFeatureNamestringNoThe name of the protected feature used to mitigate bias on models.
biasMitigationTechniquestringNoMethod applied to perform bias mitigation.
blendBestModelsbooleanNoBlend best models during Autopilot run. This option is not supported in SHAP-only mode or for multilabel projects.
blueprintThresholdintegerNoThe runtime (in hours) which if exceeded will exclude a model from autopilot runs.
calendarIdstringNoThe ID of the calendar to be used in this project.
chunkDefinitionIdstringNoChunk definition id for incremental learning using chunking service
classMappingAggregationSettingsobjectNoClass mapping aggregation settings.
considerBlendersInRecommendationbooleanNoInclude blenders when selecting a model to prepare for deployment in an Autopilot Run. This option is not supported in SHAP-only mode or for multilabel projects.
credentialsany[]NoList of credentials for the secondary datasets used in feature discovery project.
crossSeriesGroupByColumnsany[]NoFor multiseries projects with cross-series features enabled only. List of columns (currently of length 1). Setting that indicates how to further split series into related groups. For example, if every series is sales of an individual product, the series group-by could be the product category with values like “men’s clothing”, “sports equipment”, etc.
cvHoldoutLevelobjectNoThe value of the partition column indicating a row is part of the holdout set. This level is optional - if not specified or if provided as null, then no holdout will be used in the project. The rest of the levels indicate which cross validation fold each row should fall into.
cvMethodstringNoThe partitioning method to be applied to the training data.
dateRemovalbooleanNoIf true, enable creating additional feature lists without dates (does not apply to time-aware projects).
datetimePartitionColumnstringNoThe date column that will be used as a datetime partition column.
datetimePartitioningIdstringNoThe ID of a datetime partitioning to use for the project.When datetime_partitioning_id is specified, no other datetime partitioning related field is allowed to be specified, as these fields get loaded from the already created partitioning.
defaultToAPrioribooleanNoRenamed to defaultToKnownInAdvance.
defaultToDoNotDerivebooleanNoFor time series projects only. Sets whether all features default to being treated as do-not-derive features, excluding them from feature derivation. Individual features can be set to a value different than the default by using the featureSettings parameter.
defaultToKnownInAdvancebooleanNoFor time series projects only. Sets whether all features default to being treated as known in advance features, which are features that are known into the future. Features marked as known in advance must be specified into the future when making predictions. The default is false, all features are not known in advance. Individual features can be set to a value different than the default using the featureSettings parameter. See the :ref:Time Series Overview <time_series_overview> for more context.
differencingMethodstringNoFor time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems simple and seasonal are not allowed. Parameter periodicities must be specified if seasonal is chosen. Defaults to auto.
disableHoldoutbooleanNoWhether to suppress allocating a holdout fold. If disableHoldout is set to true, holdoutStartDate and holdoutDuration must not be set.
eventsCountstringNoThe name of a column specifying events count. The data in this column must be pure numeric and non negative without missing values
exponentiallyWeightedMovingAlphanumberNoDiscount factor (alpha) used for exponentially weighted moving features
exposurestringNoThe name of a column specifying row exposure.The data in this column must be pure numeric (e.g. not currency, date, length, etc.) and without missing values
externalPredictionsany[]NoList of external prediction columns from the dataset.
externalTimeSeriesBaselineDatasetIdstringNoCatalog version id for external prediction data that can be used as a baseline to calculate new metrics.
externalTimeSeriesBaselineDatasetNamestringNoThe name of the time series baseline dataset for the project.
fairnessMetricsSetstringNoMetric to use for calculating fairness. Can be one of proportionalParity, equalParity, predictionBalance, trueFavorableAndUnfavorableRateParity or FavorableAndUnfavorablePredictiveValueParity. Used and required only if Bias & Fairness in AutoML feature is enabled.
fairnessThresholdnumberNoThe threshold value of the fairness metric. The valid range is [0:1]; the default fairness metric value is 0.8. This metric is only applicable if the Bias & Fairness in AutoML feature is enabled.
featureDerivationWindowEndintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the past relative to the forecast point the feature derivation window should end.
featureDerivationWindowStartintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the past relative to the forecast point the feature derivation window should begin.
featureDiscoverySupervisedFeatureReductionbooleanNoRun supervised feature reduction for feature discovery projects.
featureEngineeringPredictionPointstringNoThe date column to be used as the prediction point for time-based feature engineering.
featurelistIdstringNoThe ID of a featurelist to use for autopilot.
featureSettingsany[]NoAn array specifying per feature settings. Features can be left unspecified.
forecastDistancestringNoThe name of a column specifying the forecast distance to which each row of the dataset belongs. Column unique values are used to subset the modeling data and build a separate model for each unique column value. Similar to time series this column is well suited to be used as forecast distance.
forecastOffsetsany[]NoAn array of strings with names of a columns specifying row offsets. Columns values are used as offset or predictions to boost for models. The data in this column must be pure numeric (e.g. not currency, date, length, etc.).
forecastWindowEndintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the future relative to the forecast point the forecast window should end.
forecastWindowStartintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the future relative to the forecast point the forecast window should start.
gapDurationstringNoThe duration of the gap between holdout training and holdout scoring data. For time series projects, defaults to the duration of the gap between the end of the feature derivation window and the beginning of the forecast window. For OTV projects, defaults to a zero duration (P0Y0M0D).
holdoutDurationstringNoThe duration of holdout scoring data. When specifying holdoutDuration, holdoutStartDate must also be specified. This attribute cannot be specified when disableHoldout is true.
holdoutEndDatestringNoThe end date of holdout scoring data. When specifying holdoutEndDate, holdoutStartDate must also be specified. This attribute cannot be specified when disableHoldout is true.
holdoutLevelobjectNoThe value of the partition column indicating a row is part of the holdout set. This level is optional - if not specified or if provided as null, then no holdout will be used in the project. However, the column must have exactly 2 values in order for this option to be valid
holdoutPctnumberNoThe percentage of the dataset to assign to the holdout set
holdoutStartDatestringNoThe start date of holdout scoring data. When specifying holdoutStartDate, one of holdoutEndDate or holdoutDuration must also be specified. This attribute cannot be specified when disableHoldout is true.
includeBiasMitigationFeatureAsPredictorVariablebooleanNoSpecifies whether the mitigation feature will be used as a predictor variable (i.e., treated like other categorical features in the input to train the modeler), in addition to being used for bias mitigation. If false, the mitigation feature will be used only for bias mitigation, and not for training the modeler task.
incrementalLearningEarlyStoppingRoundsintegerNoEarly stopping rounds for the auto incremental learning service
incrementalLearningOnBestModelbooleanNoAutomatically run incremental learning on the best model during Autopilot run.
incrementalLearningOnlyModebooleanNoKeep only models that support incremental learning during Autopilot run.
isHoldoutModifiedbooleanNoA boolean value indicating whether holdout settings (start/end dates) have been modified by user.
majorityDownsamplingRatenumberNoThe percentage between 0 and 100 of the majority rows that should be kept. Must be specified only if using smart downsampling. If not specified, a default will be selected based on the dataset distribution. The chosen rate may not cause the majority class to become smaller than the minority class.
metricstringNoThe metric to use to select the best models. See /api/v2/projects/(projectId)/features/metrics/ for the metrics that may be valid for a potential target. Note that weighted metrics must be used with a weights column.
minSecondaryValidationModelCountintegerNoCompute ‘All backtest’ scores (datetime models) or cross validation scores for the specified number of highest ranking models on the Leaderboard, if over the Autopilot default.
modestringNoThe autopilot mode to use. Either ‘quick’, ‘auto’, ‘manual’, or ‘comprehensive’.
modelSplitsintegerNoSets the cap on the number of jobs per model used when building models to control number of jobs in the queue. Higher number of modelSplits will allow for less downsampling leading to the use of more post-processed data.
monotonicDecreasingFeaturelistIdstringNoThe ID of the featurelist that defines the set of features with a monotonically decreasing relationship to the target. If null, no such constraints are enforced. When specified, this will set a default for the project that can be overriden at model submission time if desired.
monotonicIncreasingFeaturelistIdstringNoThe ID of the featurelist that defines the set of features with a monotonically increasing relationship to the target. If null, no such constraints are enforced. When specified, this will set a default for the project that can be overriden at model submission time if desired.
multiseriesIdColumnsany[]NoMay be used only with time series projects. An array of the column names identifying the series to which each row of the dataset belongs. Currently only one multiseries ID column is supported. See the :ref:multiseries <multiseries> section of the time series documentation for more context.
numberOfBacktestsintegerNoThe number of backtests to use. If omitted, defaults to a positive value selected by the server based on the validation and gap durations.
numberOfIncrementalLearningIterationsBeforeBestModelSelectionintegerNoNumber of incremental_learning iterations before best model selection.
offsetany[]NoAn array of strings with names of a columns specifying row offsets.The data in this column must be pure numeric (e.g. not currency, date, length, etc.) and without missing values
onlyIncludeMonotonicBlueprintsbooleanYesWhen true, only blueprints that support enforcing montonic constraints will be available in the project or selected for autopilot.
partitionKeyColsany[]NoAn array containing a single string - the name of the group partition column
periodicitiesany[]NoA list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter ‘differencing_method’ will default to ‘seasonal’ if not provided or ‘auto’.
positiveClassobjectNoA value from the target column to use for the positive class. May only be specified for projects doing binary classification.If not specified, a positive class is selected automatically.
preferableTargetValueobjectNoA target value that should be treated as a positive outcome for the prediction. For example if we want to check gender discrimination for giving a loan and our target named is_bad, then the positive outcome for the prediction would be No, which means that the loan is good and that’s what we treat as a preferable result for the loaner. Used and required only if Bias & Fairness in AutoML feature is enabled.
prepareModelForDeploymentbooleanNoPrepare model for deployment during Autopilot run. The preparation includes creating reduced feature list models, retraining best model on higher sample size, computing insights and assigning ‘RECOMMENDED FOR DEPLOYMENT’ label.
primaryLocationColumnstringNoPrimary geospatial location column.
protectedFeaturesany[]NoA list of project feature to mark as protected for Bias metric calculation and Fairness correction. Used and required only if Bias & Fairness in AutoML feature is enabled.
quantileLevelnumberNoThe quantile level between 0.01 and 0.99 for specifying the Quantile metric.
quickrunbooleanNo(Deprecated): ‘quick’ should be used in the mode parameter instead of using this parameter. If set to true, autopilot mode will be set to ‘quick’.Cannot be set to true when mode is set to ‘comprehensive’ or ‘manual’.
rateTopPctThresholdnumberNoThe percentage threshold between 0.1 and 50 for specifying the Rate@Top% metric.
relationshipsConfigurationIdstringNoRelationships configuration id to be used for Feature Discovery projects.
repsintegerNoThe number of cross validation folds to use.
responseCapnumberNoUsed to cap the maximum response of a model
runLeakageRemovedFeatureListbooleanNoRun Autopilot on Leakage Removed feature list (if exists).
sampleStepPctnumberNoA float between 0 and 100 indicating the desired percentage of data to sample when training models in comprehensive Autopilot. Note: this only supported for comprehensive Autopilot and the specified value may be lowered in order to be compatible with the project’s dataset and partition settings.
scoringCodeOnlybooleanNoKeep only models that can be converted to scorable java code during Autopilot run.
seedintegerNoA seed to use for randomization.
segmentationTaskIdstringNoSpecifies the SegmentationTask that will be used for dividing the project up into multiple segmented projects.
seriesIdstringNoThe name of a column specifying the series ID to which each row of the dataset belongs. Typically the series was used to derive the additional features, that are independent from each other. Column unique values are used to subset the modeling data and build a separate model for each unique column value. Similar to time series this column is well suited to be used as multi-series ID column.
shapOnlyModebooleanNoKeep only models that support SHAP values during Autopilot run. Use SHAP-based insights wherever possible.
smartDownsampledbooleanNoWhether to use smart downsampling to throw away excess rows of the majority class. Only applicable to classification and zero-boosted regression projects.
stopWordsany[]NoA list of stop words to be used for text blueprints. Note: stop_words=True must be set in the blueprint preprocessing parameters for this list of stop words to actually be used during preprocessing.
targetstringNoThe name of the target feature.
targetTypestringNoUsed to specify the targetType to use for a project when it is ambiguous, i.e. a numeric target with a few unique values that could be used for either regression or multiclass.
trainingLevelobjectNoThe value of the partition column indicating a row is part of the training set.
treatAsExponentialstringNoFor time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems always is not allowed.
unsupervisedModebooleanNoIf True, unsupervised project (without target) will be created. target cannot be specified if unsupervisedMode is True.
unsupervisedTypestringNoThe type of unsupervised project. Only valid when unsupervisedMode is true. If unsupervisedMode, defaults to anomaly.
useCrossSeriesFeaturesbooleanNoIndicating if user wants to use cross-series features.
useGpubooleanNoIndicates whether project should use GPU workers
useProjectSettingsbooleanNoSpecifies whether datetime-partitioned project should use project settings (i.e. backtests configuration has been modified by the user).
userPartitionColstringNoThe name of the column containing the partition assignments.
useSupervisedFeatureReductionbooleanNoWhen true, during feature generation DataRobot runs a supervised algorithm that identifies those features with predictive impact on the target and builds feature lists using only qualifying features. Setting false can severely impact autopilot duration, especially for datasets with many features.
useTimeSeriesbooleanNoA boolean value indicating whether a time series project should be created instead of a regular project which uses datetime partitioning.
validationDurationstringNoThe default validation duration for all backtests. If the primary date/time feature in a time series project is irregular, you cannot set a default validation length. Instead, set each duration individually. For an OTV project setting the validation duration will always use regular partitioning. Omitting it will use irregular partitioning if the date/time feature is irregular.
validationLevelobjectNoThe value of the partition column indicating a row is part of the validation set.
validationPctnumberNoThe percentage of the dataset to assign to the validation set
validationTypestringNoThe validation method to be used. CV for cross validation or TVH for train-validation-holdout split.
weightsstringNoThe name of a column specifying row weights. The data in this column must be pure numeric (e.g. not currency, date, length, etc.) and without missing values
windowsBasisUnitstringNoFor time series projects only. Indicates which unit is basis for feature derivation window and forecast window. Valid options are detected time unit or ROW. If omitted, the default value is detected time unit.

datarobot_projects_datetime_partitioning_create

Preview the fully specified datetime partitioning generated by the requested configuration. DEPRECATED API. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
aggregationTypestringNoFor multiseries projects only. The aggregation type to apply when creating cross-series features.
allowPartialHistoryTimeSeriesPredictionsbooleanNoSpecifies whether the time series predictions can use partial historical data.
autopilotClusterListany[]NoA list of integers where each value will be used as the number of clusters in Autopilot model(s) for unsupervised clustering projects. Cannot be specified unless unsupervisedMode is true and unsupervisedType is set to clustering.
autopilotDataSamplingMethodstringNoDefines how autopilot will select subsample from training dataset in OTV/TS projects. Defaults to ‘latest’ for ‘rowCount’ dataSelectionMethod and to ‘random’ for ‘duration’.
autopilotDataSelectionMethodstringNoThe Data Selection method to be used by autopilot when creating models for datetime-partitioned datasets.
backtestsany[]NoAn array specifying individual backtests.
calendarIdstringNoThe ID of the calendar to be used in this project.
clusteringBufferDisabledbooleanNoA boolean value indicating whether an clustering buffer creation should be disabled for unsupervised time series clustering project.
crossSeriesGroupByColumnsany[]NoFor multiseries projects with cross-series features enabled only. List of columns (currently of length 1). Setting that indicates how to further split series into related groups. For example, if every series is sales of an individual product, the series group-by could be the product category with values like “men’s clothing”, “sports equipment”, etc.
datetimePartitionColumnstringYesThe date column that will be used as a datetime partition column.
defaultToAPrioribooleanNoRenamed to defaultToKnownInAdvance.
defaultToDoNotDerivebooleanNoFor time series projects only. Sets whether all features default to being treated as do-not-derive features, excluding them from feature derivation. Individual features can be set to a value different than the default by using the featureSettings parameter.
defaultToKnownInAdvancebooleanNoFor time series projects only. Sets whether all features default to being treated as known in advance features, which are features that are known into the future. Features marked as known in advance must be specified into the future when making predictions. The default is false, all features are not known in advance. Individual features can be set to a value different than the default using the featureSettings parameter. See the :ref:Time Series Overview <time_series_overview> for more context.
differencingMethodstringNoFor time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems simple and seasonal are not allowed. Parameter periodicities must be specified if seasonal is chosen. Defaults to auto.
disableHoldoutbooleanNoWhether to suppress allocating a holdout fold. If disableHoldout is set to true, holdoutStartDate and holdoutDuration must not be set.
featureDerivationWindowEndintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the past relative to the forecast point the feature derivation window should end.
featureDerivationWindowStartintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the past relative to the forecast point the feature derivation window should begin.
featureSettingsany[]NoAn array specifying per feature settings. Features can be left unspecified.
forecastWindowEndintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the future relative to the forecast point the forecast window should end.
forecastWindowStartintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the future relative to the forecast point the forecast window should start.
gapDurationstringNoThe duration of the gap between holdout training and holdout scoring data. For time series projects, defaults to the duration of the gap between the end of the feature derivation window and the beginning of the forecast window. For OTV projects, defaults to a zero duration (P0Y0M0D).
holdoutDurationstringNoThe duration of holdout scoring data. When specifying holdoutDuration, holdoutStartDate must also be specified. This attribute cannot be specified when disableHoldout is true.
holdoutEndDatestringNoThe end date of holdout scoring data. When specifying holdoutEndDate, holdoutStartDate must also be specified. This attribute cannot be specified when disableHoldout is true.
holdoutStartDatestringNoThe start date of holdout scoring data. When specifying holdoutStartDate, one of holdoutEndDate or holdoutDuration must also be specified. This attribute cannot be specified when disableHoldout is true.
isHoldoutModifiedbooleanNoA boolean value indicating whether holdout settings (start/end dates) have been modified by user.
modelSplitsintegerNoSets the cap on the number of jobs per model used when building models to control number of jobs in the queue. Higher number of modelSplits will allow for less downsampling leading to the use of more post-processed data.
multiseriesIdColumnsany[]NoMay be used only with time series projects. An array of the column names identifying the series to which each row of the dataset belongs. Currently only one multiseries ID column is supported. See the :ref:multiseries <multiseries> section of the time series documentation for more context.
numberOfBacktestsintegerNoThe number of backtests to use. If omitted, defaults to a positive value selected by the server based on the validation and gap durations.
periodicitiesany[]NoA list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter ‘differencing_method’ will default to ‘seasonal’ if not provided or ‘auto’.
treatAsExponentialstringNoFor time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems always is not allowed. Defaults to auto.
unsupervisedModebooleanNoA boolean value indicating whether an unsupervised project should be created.
unsupervisedTypestringNoThe type of unsupervised project. Only valid when unsupervisedMode is true. If unsupervisedMode, defaults to anomaly.
useCrossSeriesFeaturesbooleanNoFor multiseries projects only. Indicating whether to use cross-series features.
useSupervisedFeatureReductionbooleanNoWhen true, during feature generation DataRobot runs a supervised algorithm that identifies those features with predictive impact on the target and builds feature lists using only qualifying features. Setting false can severely impact autopilot duration, especially for datasets with many features.
useTimeSeriesbooleanNoA boolean value indicating whether a time series project should be created instead of a regular project which uses datetime partitioning.
validationDurationstringNoThe default validation duration for all backtests. If the primary date/time feature in a time series project is irregular, you cannot set a default validation length. Instead, set each duration individually. For an OTV project setting the validation duration will always use regular partitioning. Omitting it will use irregular partitioning if the date/time feature is irregular.
windowsBasisUnitstringNoFor time series projects only. Indicates which unit is basis for feature derivation window and forecast window. Valid options are detected time unit or ROW. If omitted, the default value is detected time unit.

datarobot_projects_datetime_partitioning_list

Retrieve datetime partitioning configuration. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.

datarobot_projects_deleted_projects_count_list

Count soft-deleted projects. Parameters:
ParameterTypeRequiredDefaultDescription
searchForstringNoProject or dataset name to filter by.
creatorstringNoCreator ID to filter projects by
organizationstringNoID of organization that projects should belong to. Given project belongs to the organization the user who created the project is part of that organization.If there are no users in organization, then no projects will match the query.
deletedBeforestringNoISO-8601 formatted date projects were deleted before
deletedAfterstringNoISO-8601 formatted date projects were deleted after
projectIdstringNoProject ID to search
limitintegerNoCount deleted projects until specified value reached.

datarobot_projects_deleted_projects_list

Retrieve the list of soft-deleted projects. Parameters:
ParameterTypeRequiredDefaultDescription
searchForstringNoProject or dataset name to filter by.
creatorstringNoCreator ID to filter projects by
organizationstringNoID of organization that projects should belong to. Given project belongs to the organization the user who created the project is part of that organization.If there are no users in organization, then no projects will match the query.
deletedBeforestringNoISO-8601 formatted date projects were deleted before
deletedAfterstringNoISO-8601 formatted date projects were deleted after
projectIdstringNoProject ID to search
limitintegerNoAt most this many results are returned.
offsetintegerNoThis many results will be skipped.
orderBystringNoOrder deleted projects by

datarobot_projects_deleted_projects_patch

Recover soft-deleted project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
actionstringYesAction to perform on a project

datarobot_projects_external_time_series_baseline_data_validation_jobs_create

Validate baseline data. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
backtestsany[]NoAn array of the configured backtests.
catalogVersionIdstringYesThe version ID of the external baseline data item in the AI catalog.
datetimePartitionColumnstringYesThe date column that will be used as the datetime partition column for the specified project.
forecastWindowEndintegerYesFor time series projects only. How many timeUnits of the datetimePartitionColumn into the future relative to the forecast point the forecast window should end.
forecastWindowStartintegerYesFor time series projects only. How many timeUnits of the datetimePartitionColumn into the future relative to the forecast point the forecast window should start.
holdoutEndDatestringNoThe end date of holdout scoring data.
holdoutStartDatestringNoThe start date of holdout scoring data.
multiseriesIdColumnsany[]NoAn array of column names identifying the multiseries ID column(s)to use to identify series within the data. Must match the multiseries ID column(s) for the specified project. Currently, only one multiseries ID column may be specified.
targetstringYesThe selected target of the specified project.

datarobot_projects_external_time_series_baseline_data_validation_jobs_retrieve

Retrieve the baseline validation job. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project to retrieve the validation job information from.
baselineValidationJobIdstringYesThe ID for the validation job.

datarobot_projects_hdfs_projects_create

Create a project from an HDFS file source. Parameters:
ParameterTypeRequiredDefaultDescription
passwordstringNoPassword for authenticating to HDFS using Kerberos. The password will be encrypted on the server side in scope of HTTP request and never saved or stored.
portintegerNoPort of the WebHDFS Namenode server. If not specified, defaults to HDFS default port 50070.
projectNamestringNoName of the project to be created. If not specified, project name will be based on the file name.
urlstringYesURL of the WebHDFS resource. Represent the file using the hdfs:// protocol marker (for example, hdfs:///tmp/somedataset.csv).
userstringNoUsername for authenticating to HDFS using Kerberos

datarobot_projects_jobs_delete

Cancel a job. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
jobIdstringYesThe job ID.

datarobot_projects_jobs_list

List project jobs. Parameters:
ParameterTypeRequiredDefaultDescription
statusstringNoIf 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.
projectIdstringYesThe project ID.

datarobot_projects_jobs_retrieve

Get a job. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
jobIdstringYesThe job ID.

datarobot_projects_multiseries_ids_cross_series_properties_list

Retrieve eligible cross-series group-by columns. Parameters:
ParameterTypeRequiredDefaultDescription
crossSeriesGroupByColumnsany[]NoThe names of the columns to retrieve the validation status for. If not specified, all eligible columns will be returned.
projectIdstringYesThe project to retrieve cross-series group-by columns for.
multiseriesIdstringYesThe name of the column to be used as the multiseries ID column.

datarobot_projects_multiseries_names_list

List the names of a multiseries project. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThe number of results to skip.
limitintegerNoAt most this many results are returned. The default may change without notice.
projectIdstringYesThe project ID.

datarobot_projects_multiseries_properties_create

Detect multiseries properties. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
datetimePartitionColumnstringYesThe date column that will be used to perform detection and validation for.
multiseriesIdColumnsany[]NoThe list of one or more names of potential multiseries ID columns. If not provided, all numerical and categorical columns are used.

datarobot_projects_optimized_datetime_partitionings_create

Create an optimized datetime partitioning configuration using the target. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
aggregationTypestringNoFor multiseries projects only. The aggregation type to apply when creating cross-series features.
allowPartialHistoryTimeSeriesPredictionsbooleanNoSpecifies whether the time series predictions can use partial historical data.
autopilotClusterListany[]NoA list of integers where each value will be used as the number of clusters in Autopilot model(s) for unsupervised clustering projects. Cannot be specified unless unsupervisedMode is true and unsupervisedType is set to clustering.
autopilotDataSamplingMethodstringNoDefines how autopilot will select subsample from training dataset in OTV/TS projects. Defaults to ‘latest’ for ‘rowCount’ dataSelectionMethod and to ‘random’ for ‘duration’.
autopilotDataSelectionMethodstringNoThe Data Selection method to be used by autopilot when creating models for datetime-partitioned datasets.
backtestsany[]NoAn array specifying individual backtests.
calendarIdstringNoThe ID of the calendar to be used in this project.
clusteringBufferDisabledbooleanNoA boolean value indicating whether an clustering buffer creation should be disabled for unsupervised time series clustering project.
crossSeriesGroupByColumnsany[]NoFor multiseries projects with cross-series features enabled only. List of columns (currently of length 1). Setting that indicates how to further split series into related groups. For example, if every series is sales of an individual product, the series group-by could be the product category with values like “men’s clothing”, “sports equipment”, etc.
datetimePartitionColumnstringYesThe date column that will be used as a datetime partition column.
defaultToAPrioribooleanNoRenamed to defaultToKnownInAdvance.
defaultToDoNotDerivebooleanNoFor time series projects only. Sets whether all features default to being treated as do-not-derive features, excluding them from feature derivation. Individual features can be set to a value different than the default by using the featureSettings parameter.
defaultToKnownInAdvancebooleanNoFor time series projects only. Sets whether all features default to being treated as known in advance features, which are features that are known into the future. Features marked as known in advance must be specified into the future when making predictions. The default is false, all features are not known in advance. Individual features can be set to a value different than the default using the featureSettings parameter. See the :ref:Time Series Overview <time_series_overview> for more context.
differencingMethodstringNoFor time series projects only. Used to specify which differencing method to apply if the data is stationary. For classification problems simple and seasonal are not allowed. Parameter periodicities must be specified if seasonal is chosen. Defaults to auto.
disableHoldoutbooleanNoWhether to suppress allocating a holdout fold. If disableHoldout is set to true, holdoutStartDate and holdoutDuration must not be set.
featureDerivationWindowEndintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the past relative to the forecast point the feature derivation window should end.
featureDerivationWindowStartintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the past relative to the forecast point the feature derivation window should begin.
featureSettingsany[]NoAn array specifying per feature settings. Features can be left unspecified.
forecastWindowEndintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the future relative to the forecast point the forecast window should end.
forecastWindowStartintegerNoFor time series projects only. How many timeUnits of the datetimePartitionColumn into the future relative to the forecast point the forecast window should start.
gapDurationstringNoThe duration of the gap between holdout training and holdout scoring data. For time series projects, defaults to the duration of the gap between the end of the feature derivation window and the beginning of the forecast window. For OTV projects, defaults to a zero duration (P0Y0M0D).
holdoutDurationstringNoThe duration of holdout scoring data. When specifying holdoutDuration, holdoutStartDate must also be specified. This attribute cannot be specified when disableHoldout is true.
holdoutEndDatestringNoThe end date of holdout scoring data. When specifying holdoutEndDate, holdoutStartDate must also be specified. This attribute cannot be specified when disableHoldout is true.
holdoutStartDatestringNoThe start date of holdout scoring data. When specifying holdoutStartDate, one of holdoutEndDate or holdoutDuration must also be specified. This attribute cannot be specified when disableHoldout is true.
isHoldoutModifiedbooleanNoA boolean value indicating whether holdout settings (start/end dates) have been modified by user.
modelSplitsintegerNoSets the cap on the number of jobs per model used when building models to control number of jobs in the queue. Higher number of modelSplits will allow for less downsampling leading to the use of more post-processed data.
multiseriesIdColumnsany[]NoMay be used only with time series projects. An array of the column names identifying the series to which each row of the dataset belongs. Currently only one multiseries ID column is supported. See the :ref:multiseries <multiseries> section of the time series documentation for more context.
numberOfBacktestsintegerNoThe number of backtests to use. If omitted, defaults to a positive value selected by the server based on the validation and gap durations.
periodicitiesany[]NoA list of periodicities for time series projects only. For classification problems periodicities are not allowed. If this is provided, parameter ‘differencing_method’ will default to ‘seasonal’ if not provided or ‘auto’.
targetstringNoThe name of the target column.
treatAsExponentialstringNoFor time series projects only. Used to specify whether to treat data as exponential trend and apply transformations like log-transform. For classification problems always is not allowed. Defaults to auto.
unsupervisedModebooleanNoA boolean value indicating whether an unsupervised project should be created.
unsupervisedTypestringNoThe type of unsupervised project. Only valid when unsupervisedMode is true. If unsupervisedMode, defaults to anomaly.
useCrossSeriesFeaturesbooleanNoFor multiseries projects only. Indicating whether to use cross-series features.
useSupervisedFeatureReductionbooleanNoWhen true, during feature generation DataRobot runs a supervised algorithm that identifies those features with predictive impact on the target and builds feature lists using only qualifying features. Setting false can severely impact autopilot duration, especially for datasets with many features.
useTimeSeriesbooleanNoA boolean value indicating whether a time series project should be created instead of a regular project which uses datetime partitioning.
validationDurationstringNoThe default validation duration for all backtests. If the primary date/time feature in a time series project is irregular, you cannot set a default validation length. Instead, set each duration individually. For an OTV project setting the validation duration will always use regular partitioning. Omitting it will use irregular partitioning if the date/time feature is irregular.
windowsBasisUnitstringNoFor time series projects only. Indicates which unit is basis for feature derivation window and forecast window. Valid options are detected time unit or ROW. If omitted, the default value is detected time unit.

datarobot_projects_optimized_datetime_partitionings_datetime_partitioning_input_list

Retrieve the optimized datetime partitioning input. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
datetimePartitioningIdstringYesThe ID of the datetime partitioning to retrieve.

datarobot_projects_optimized_datetime_partitionings_datetime_partitioning_log_file_list

Retrieve a text file containing the datetime partitioning log Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
datetimePartitioningIdstringYesThe ID of the datetime partitioning to retrieve.

datarobot_projects_optimized_datetime_partitionings_datetime_partitioning_log_list

Retrieve the datetime partitioning log and log length as JSON Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThe number of results to skip.
limitintegerNoAt most this many results are returned. The default may change without notice.
projectIdstringYesThe project ID.
datetimePartitioningIdstringYesThe ID of the datetime partitioning to retrieve.

datarobot_projects_optimized_datetime_partitionings_list

Lists all created optimized datetime partitioning configurations. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThis many results will be skipped.
limitintegerYesAt most this many results are returned.
projectIdstringYesThe project ID.

datarobot_projects_optimized_datetime_partitionings_retrieve

Retrieve the optimized datetime partitioning configuration. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
datetimePartitioningIdstringYesThe ID of the datetime partitioning to retrieve.

datarobot_projects_project_cleanup_jobs_create

Schedule project permadelete job. Parameters:
ParameterTypeRequiredDefaultDescription
creatorstringNoCreator ID to filter projects by
deletedAfterstringNoISO-8601 formatted date projects were deleted after
deletedBeforestringNoISO-8601 formatted date projects were deleted before
limitintegerNoAt most this many projects are deleted.
offsetintegerNoThis many projects will be skipped.
organizationstringNoID of organization that projects should belong to
projectIdsany[]NoThe list of project IDs to delete permanently.
searchForstringNoProject or dataset name to filter by.

datarobot_projects_project_cleanup_jobs_delete

Cancel scheduled project permadelete job. Parameters:
ParameterTypeRequiredDefaultDescription
statusIdstringYesThe ID of the status object.

datarobot_projects_project_cleanup_jobs_download_list

Download a projects permadeletion report. Parameters:
ParameterTypeRequiredDefaultDescription
statusIdstringYesThe ID of the status object.

datarobot_projects_project_cleanup_jobs_list

Retrieve project permadelete job status.

datarobot_projects_project_cleanup_jobs_retrieve

Retrieve project permadelete job status. Parameters:
ParameterTypeRequiredDefaultDescription
statusIdstringYesThe ID of the status object.

datarobot_projects_project_cleanup_jobs_summary_list

Get a projects cleanup jobs summary. Parameters:
ParameterTypeRequiredDefaultDescription
statusIdstringYesThe ID of the status object.

datarobot_projects_project_clones_create

Clone a project. Parameters:
ParameterTypeRequiredDefaultDescription
copyOptionsbooleanNoWhether all project options should be copied to the cloned project.
projectIdstringYesThe ID of the project to clone.
projectNamestringNoThe name of the project to be created.

datarobot_projects_projects_create

Create a project. Parameters:
ParameterTypeRequiredDefaultDescription
credentialDataobjectNoThe credentials to authenticate with the database, to be used instead of credential ID. Can only be used along with datasetId or dataSourceId.
credentialIdstringNoThe ID of the set of credentials to authenticate with the database. Can only be used along with datasetId or dataSourceId.
datasetIdstringNoThe ID of the dataset entry to use for the project dataset.
datasetVersionIdstringNoOnly used when also providing a datasetId, and specifies the the ID of the dataset version to use for the project dataset. If not specified, the latest version associated with the dataset ID is used.
dataSourceIdstringNoIdentifier for the data source to retrieve.
passwordstringNoThe password (in cleartext) for database authentication. The password will be encrypted on the server side as part of the HTTP request and never saved or stored. Can only be used along with datasetId or dataSourceId. DEPRECATED: please use credentialId or credentialData instead.
projectNamestringNoThe name of the project to be created. If not specified, ‘Untitled Project’ will be used for database connections and file name will be used as the project name.
recipeIdstringNoThe ID of the wrangling recipe that will be used for project creation.
urlstringNoThe URL to download the dataset used to create the project.
useKerberosbooleanNoIf true, use Kerberos authentication for database authentication. Default is false. Can only be used along with datasetId or dataSourceId.
userstringNoThe username for database authentication. Can only be used along with datasetId or dataSourceId. DEPRECATED: please use credentialId or credentialData instead.

datarobot_projects_projects_delete

Delete a project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.

datarobot_projects_projects_list

List projects. Parameters:
ParameterTypeRequiredDefaultDescription
projectNamestringNoif provided will filter returned projects for projects with matching names
projectIdany[]Noif provided will filter returned projects with matching project IDs
orderBystringNoif provided will order the results by this field
featureDiscoverystringNoReturn only feature discovery projects
offsetintegerNoThis many results will be skipped.
limitintegerNoAt most this many results are returned.

datarobot_projects_projects_retrieve

Get project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.

datarobot_projects_projects_update

Update a project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
gpuWorkerCountintegerNoThe desired new number of gpu workers if the number of gpu workers should be changed. Must not exceed the number of gpu workers available to the user. 0 is allowed. -1 requests the maximum number available to the user.
holdoutUnlockedstringNoIf specified, the holdout will be unlocked; note that the holdout cannot be relocked after unlocking
projectDescriptionstringNoThe new description of the project, if the description should be updated.
projectNamestringNoThe new name of the project, if it should be renamed.
workerCountintegerNoThe desired new number of workers if the number of workers should be changed. Must not exceed the number of workers available to the user. 0 is allowed. (New in version v2.14) -1 requests the maximum number available to the user.

datarobot_projects_segmentation_task_job_results_retrieve

Retrieve segmentation task statuses. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
segmentationTaskIdstringYesThe ID of the segmentation task to check the status of.

datarobot_projects_segmentation_tasks_create

Create segmentation tasks. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
datetimePartitionColumnstringNoThe date column that will be used to identify the date in time series segmentation.
modelPackageIdstringNoThe model package ID for using an external model registry package.
multiseriesIdColumnsany[]NoThe list of one or more names of multiseries ID columns.
targetstringYesThe target for the dataset.
useAutomatedSegmentationbooleanNoEnable the use of automated segmentation tasks.
userDefinedSegmentIdColumnsany[]NoThe list of one or more names of columns to be used for user-defined business rule segmentations.
useTimeSeriesbooleanNoEnable time series-based segmentation tasks.

datarobot_projects_segmentation_tasks_list

List segmentation tasks. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThis many results will be skipped.
limitintegerNoAt most this many results are returned.
projectIdstringYesThe project ID.

datarobot_projects_segmentation_tasks_mappings_list

Retrieve series ID to segment ID mappings. Parameters:
ParameterTypeRequiredDefaultDescription
offsetintegerNoThis many results will be skipped.
limitintegerNoAt most this many results are returned.
projectIdstringYesThe project ID.
segmentationTaskIdstringYesThe ID of the segmentation task.

datarobot_projects_segmentation_tasks_retrieve

Retrieve segmentation task. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
segmentationTaskIdstringYesThe ID of the segmentation task.

datarobot_projects_segments_patch

Update child segment project. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.
segmentIdstringYesThe name of the segment.
operationstringNoThe name of the operation to perform on the project segment.

datarobot_projects_status_list

Check project status. Parameters:
ParameterTypeRequiredDefaultDescription
projectIdstringYesThe project ID.