GetPredictionExplanationsMetadata: Retrieve metadata for specified prediction explanations

In datarobot: 'DataRobot' Predictive Modeling API

Retrieve metadata for specified prediction explanations

Description

Retrieve metadata for specified prediction explanations

Usage

GetPredictionExplanationsMetadata(project, predictionExplanationId)

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.
predictionExplanationId	character. Id of the prediction explanations.

Value

A named list which contains prediction explanation metadata:

• id character. ID of the record and prediction explanations computation result.

• projectId character. ID of the project the model belongs to.

• modelId character. ID of the model prediction explanations initialization is for.

• datasetId character. ID of the prediction dataset prediction explanations were computed for.

• maxExplanations integer. Maximum number of prediction explanations to supply per row of the dataset.

• thresholdLow numeric. The low threshold, below which a prediction must score in order for prediction explanations to be computed for a row in the dataset.

• thresholdHigh numeric. The high threshold, above which a prediction must score in order for prediction explanations to be computed for a row in the dataset.

• numColumns integer. The number of columns prediction explanations were computed for.

• finishTime. Numeric timestamp referencing when computation for these prediction explanations finished.

• predictionExplanationsLocation character. Where to retrieve the prediction explanations.

Examples

## Not run: 
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  datasets <- ListPredictionDatasets(projectId)
  dataset <- datasets[[1]]
  datasetId <- dataset$id
  model <- GetModel(projectId, modelId)
  jobId <- RequestPredictionExplanations(model, datasetId)
  predictionExplanationId <- GetPredictionExplanationsMetadataFromJobId(projectId, jobId)$id
  GetPredictionExplanationsMetadata(projectId, predictionExplanationId)

## End(Not run)

datarobot documentation built on Nov. 3, 2023, 1:07 a.m.