datarobot (version 2.8.0)

GetReasonCodesMetadata: Retrieve metadata for specified reason codes

Description

Retrieve metadata for specified reason codes

Usage

GetReasonCodesMetadata(project, reasonCodeId)

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.

reasonCodeId

character. id of the reason codes.

Value

A named list which contains reason code metadata:

• id. Character string id of the record and reason codes computation result.

• projectId. Character string id of the project the model belongs to.

• modelId. Character string id of the model reason codes initialization is for.

• datasetId. Character string id of the prediction dataset reason codes were computed for.

• maxCodes. Integer maximum number of reason codes to supply per row of the dataset.

• thresholdLow. Numeric the low threshold, below which a prediction must score in order for reason codes to be computed for a row in the dataset.

• thresholdHigh. Numeric the high threshold, above which a prediction must score in order for reason codes to be computed for a row in the dataset.

• numColumns. Integer the number of columns reason codes were computed for.

• finishTime. Numeric timestamp referencing when computation for these reason codes finished.

• reasonCodesLocation. Character string where to retrieve the reason codes.

Examples

# NOT RUN {
  projectId <- "59a5af20c80891534e3c2bde"
  modelId <- "5996f820af07fc605e81ead4"
  datasets <- ListPredictionDatasets(projectId)
  dataset <- datasets[[1]]
  datasetId <- dataset$id
  model <- GetModel(model, datasetId)
  jobId <- RequestReasonCodes(model, datasetId)
  reasonCodeId <- GetReasonCodesMetadataFromJobId(projectId, jobId)
  GetReasonCodesMetadata(projectId, reasonCodeId)
# }