Now available for public preview, DataRobot has released version 2.29 of the R client. This version brings parity between the R client and version 2.29 of the Public API. As a result, it introduces significant changes to common methods and usage of the client. These changes are encapsulated in a new library (in addition to the datarobot library): datarobot.apicore, which provides auto-generated functions to access the Public API. The datarobot package provides a number of "API wrapper functions" around the apicore package to make it easier to use.
In addition to the release notes outlined below, reference the public preview documentation for an overview of the functions introduced with v2.29.
Generated API wrapper functions are organized into categories based on their tags from the OpenAPI specification.
These functions use camel-cased argument names to be consistent with the rest of the package.
Most function names follow a VerbObject pattern based on the OpenAPI specification.
Some function names match "legacy" functions that existed in v2.18 of the R Client if they invoked the same underlying endpoint. For example, the wrapper function is called GetModel, not RetrieveProjectsModels, since the latter is what was implemented in the R client for the endpoint /projects/{mId}/models/{mId}.
Similarly, these functions use the same arguments as the corresponding "legacy" functions to ensure DataRobot does not break existing code that calls those functions.
Added the DownloadDatasetAsCsv function to retrieve dataset as CSV using catalogId.
Added the GetFeatureDiscoveryRelationships function to get the feature discovery relationships for a project.
Other new features:
The R client (both datarobot and datarobot.apicore packages) will output a warning when you attempt to access certain resources (projects, models, deployments, etc.) that are deprecated or disabled by the DataRobot platform migration to Python 3.
Added the helper function EditConfig that allows you to interactively modify drconfig.yaml.
Many prominent features introduced in datarobot.apicore are listed below.
Review the breaking changes introduced in version 2.29:
The quickrun argument has been removed from the function SetTarget. Set mode = AutopilotMode.Quick instead.
The Transferable Models functions have been removed. Note that the underlying endpoints were also removed from the Public API with the removal of the Standalone Scoring Engine (SSE). The affected functions are listed below:
ListTransferableModels
GetTransferableModel
RequestTransferableModel
DownloadTransferableModel
UploadTransferableModel
UpdateTransferableModel
DeleteTransferableModel
Review the deprecations introduced in version 2.29:
Compliance Documentation API is deprecated. Instead use the Automated Documentation API.
The datarobot.apicore package can be configured in the following ways with the following options (using getOption() and setOption()):
datarobot.apicore.returnS3 is a boolean that, if TRUE, will return all API responses to the caller as S3 objects. If FALSE, the responses are returned as R6 objects. The default configuration is TRUE.
To work with R6 objects, run the following snippet: