ListAnomalyAssessmentRecords: Retrieve anomaly assessment records.

In datarobot: 'DataRobot' Predictive Modeling API

Retrieve anomaly assessment records.

Description

Retrieve anomaly assessment records.

Usage

ListAnomalyAssessmentRecords(
  projectId,
  modelId,
  backtest = NULL,
  source = NULL,
  seriesId = NULL,
  limit = 100,
  offset = 0
)

Arguments

projectId	character. The ID of the project.
modelId	character. The ID of the model.
backtest	integer or "holdout". Optional. The backtest to filter records by.
source	"training" or "validation". Optional. The source of the data to filter records by.
seriesId	character. Optional. Can be specified for multiseries projects. The series id to filter records by.
limit	integer, greater than zero. Optional. Defaults to 100. At most this many results are returned. The default may change without notice.
offset	integer. Optional. Default is 0. This many results will be skipped.

Value

A list of objects with anomaly assessment metadata:

• recordId. character. The ID of the record.

• projectId. character. The project ID of the record.

• modelId. character. The model ID of the record.

• backtest. character. The backtest of the record.

• source. character. The source of the record.

• seriesId. character. the series ID of the record.

• status. character. The status of the insight.

• statusDetails. character. The explanation of the status.

• startDate. POSIXct. Timestamp of the first prediction in the subset. Will be NULL if status is not completed.

• endDate. POSIXct. Timestamp of the last prediction in the subset. Will be NULL if status is not completed.

• predictionThreshold. numeric. The threshold, all rows with anomaly scores greater or equal to it have shap explanations computed. Will be NULL if status is not completed.

• previewLocation. character. URL to retrieve predictions preview for the subset. Will be NULL if status is not completed.

• latestExplanationsLocation. character. the URL to retrieve the latest predictions with the shap explanations. Will be NULL if status is not completed.

• deleteLocation. character. the URL to delete anomaly assessment record and relevant insight data.

See Also

Other Anomaly Assessment functions: DeleteAnomalyAssessmentRecord(), GetAnomalyAssessmentExplanations(), GetAnomalyAssessmentPredictionsPreview(), InitializeAnomalyAssessment()

Examples

## Not run: 
projectId <- "59a5af20c80891534e3c2bde"
modelId <- "59a5af20c80891534e3c2bdd"
records <- ListAnomalyAssessmentRecords(projectId, modelId, backtest=0, seriesId="Baltimore")

## End(Not run)

datarobot documentation built on May 29, 2024, 4:36 a.m.