DeletePredictionExplanations: Function to delete prediction explanations

View source: R/PredictionExplanations.R

DeletePredictionExplanationsR Documentation

Function to delete prediction explanations

Description

This function deletes prediction explanations specified by project and predictionExplanationId.

Usage

DeletePredictionExplanations(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

Logical TRUE and displays a message to the user if the delete request was successful; otherwise an error message is displayed.

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
  DeletePredictionExplanations(projectId, predictionExplanationId)

## End(Not run)

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