ListPredictions {datarobot}

Fetch all computed predictions for a project.

Description

This function itemizes the predictions available for a given project, model, and/or dataset. Note that this function does not actually return the predictions. Use GetPredictions(projectId, predictionId) to get the predictions for a particular set of predictions.

Usage

ListPredictions(project, modelId = NULL, datasetId = NULL)

Arguments

project

character. Either (1) a character string giving the unique alphanumeric identifier for the project, or (2) a list containing the element projectId with this identifier.

modelId

numeric. Optional. Filter returned predictions to only be predictions made against the model specified by this model ID.

datasetId

numeric. Optional. Filter returned predictions to only be predictions made against the prediction dataset specified by this dataset ID.

Value

A data.frame specifying:

• projectId character. The ID of the project the predictions were made in.

• datasetId character. The dataset ID of the dataset used to make predictions

• modelId character. The model ID of the model used to make predictions.

• predictionId character. The unique ID corresponding to those predictions. Use GetPredictions(projectId, predictionId) to fetch the individual predictions.

• includesPredictionIntervals logical. Whether or not the predictions include prediction intervals. See Predict for details.

• predictionIntervalsSize integer. Optional. The size, in percent, of prediction intervals or NULL if there are no intervals. See Predict for details.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  predictions <- ListPredictions(projectId)

## End(Not run)