GetDeploymentAssociationId: Deployment Association ID

In datarobot: 'DataRobot' Predictive Modeling API

Deployment Association ID

Description

The association ID of a deployment is a foreign key for your prediction dataset that will be used to match up actual values with those predictions. The ID should correspond to an event for which you want to track the outcome.

Usage

GetDeploymentAssociationId(deployment)

UpdateDeploymentAssociationId(
  deployment,
  columnNames = c(),
  requiredInPredictionRequests = NULL,
  maxWait = 600
)

Arguments

deployment	An S3 object representing a model deployment, or the unique ID of such a deployment.
columnNames	character. Optional. Name(s) of the column(s) in your dataset that will be used to map actuals to predictions and determine accuracy. Note: This cannot be changed after the model has served predictions and the API will return an error.
requiredInPredictionRequests	logical. Optional. Whether the association ID is required in a prediction request.
maxWait	integer. How long to wait (in seconds) for the computation to complete before returning a timeout error? (Default 600 seconds)

Details

These functions are convenience methods to get and set the association ID settings for a deployment.

Value

An object classed dataRobotDeploymentAssociationIdSettings that contains:

columnNames

character. The columns that can be used as association IDs.

requiredInPredictionRequests

logical. Whether the association ID is required in a prediction request.

Functions

• UpdateDeploymentAssociationId(): Updates the association ID settings of a deployment. It will only update those settings that correspond to set arguments. This function will throw an error if the update fails and return the updated settings on success.

See Also

Other deployment accuracy functions: GetDeploymentAccuracyOverTime(), GetDeploymentAccuracy(), SubmitActuals()

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