DataRobot API resources > API reference documentation > DataRobot REST API > Data preparation > Data management

Features¶

This page outlines the operations, endpoints, parameters, and example requests and responses for the Features.

GET /api/v2/calendarCountryCodes/¶

Retrieve the list of allowed country codes to request preloaded calendars generation for.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/calendarCountryCodes/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Number of results to skip.
limit	query	integer	false	At most this many results are returned. The default may change without notice.

Example responses¶


{
  "count": 0,
  "data": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Request for the list of allowed country codes that have the generated preloaded calendars.	PreloadedCalendarListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/calendars/¶

List all the calendars which the user has access to.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/calendars/?offset=0&limit=0 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	query	string	false	Optional, if provided will filter returned calendars to those being used in the specified project.
offset	query	integer	true	Optional (default: `0`), this many results will be skipped.
limit	query	integer	true	Optional (default: `0`), at most this many results will be returned. If `0`, all results will be returned.

Example responses¶


{
  "count": 0,
  "data": [
    {
      "created": "2019-08-24T14:15:22Z",
      "datetimeFormat": "%m/%d/%Y",
      "earliestEvent": "2019-08-24T14:15:22Z",
      "id": "string",
      "latestEvent": "2019-08-24T14:15:22Z",
      "multiseriesIdColumns": [
        "string"
      ],
      "name": "string",
      "numEventTypes": 0,
      "numEvents": 0,
      "projectId": [
        "string"
      ],
      "role": "ADMIN",
      "source": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	A list of Calendar objects.	CalendarListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/calendars/fileUpload/¶

Create a calendar from a file in a csv or xlsx format. The calendar file specifies the dates or events in a dataset such that DataRobot automatically derives and creates special features based on the calendar events (e.g., time until the next event, labeling the most recent event).

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/calendars/fileUpload/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CalendarFileUpload}'

Body parameter¶


{
  "file": "string",
  "multiseriesIdColumns": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CalendarFileUpload	false	none

Example responses¶

{}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Request for calendar generation was submitted. See Location header.	Empty

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/calendars/fromCountryCode/¶

Initialize generation of preloaded calendars. Preloaded calendars are available only for time series projects. Preloaded calendars do not support multiseries calendars.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/calendars/fromCountryCode/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{PreloadedCalendar}'

Body parameter¶


{
  "countryCode": "AR",
  "endDate": "2019-08-24T14:15:22Z",
  "startDate": "2019-08-24T14:15:22Z"
}

Parameters

Name	In	Type	Required	Description
body	body	PreloadedCalendar	false	none

Example responses¶

{}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Request for calendar generation was submitted. See Location header.	Empty

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/calendars/fromDataset/¶

Create a calendar from the dataset.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/calendars/fromDataset/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{CalendarFromDataset}'

Body parameter¶


{
  "datasetId": "string",
  "datasetVersionId": "string",
  "deleteOnError": true,
  "multiseriesIdColumns": [
    "string"
  ],
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	CalendarFromDataset	false	none

Example responses¶


{
  "statusId": "string"
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Successfully created a calendar from the dataset.	CreatedCalendarDatasetResponse

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/calendars/{calendarId}/¶

Delete a calendar. This can only be done if all projects and deployments using the calendar have been deleted.

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/calendars/{calendarId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
calendarId	path	string	true	The ID of this calendar.

Example responses¶

{}

Responses¶

Status	Meaning	Description	Schema
204	No Content	Calendar successfully deleted.	Empty
404	Not Found	Invalid `calendarId` provided, or user does not have permissions to delete calendar.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/calendars/{calendarId}/¶

List all the information about a calendar such as the total number of event dates, the earliest calendar event date, the IDs of projects currently using this calendar and the others.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/calendars/{calendarId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
calendarId	path	string	true	The ID of this calendar.

Example responses¶


{
  "created": "2019-08-24T14:15:22Z",
  "datetimeFormat": "%m/%d/%Y",
  "earliestEvent": "2019-08-24T14:15:22Z",
  "id": "string",
  "latestEvent": "2019-08-24T14:15:22Z",
  "multiseriesIdColumns": [
    "string"
  ],
  "name": "string",
  "numEventTypes": 0,
  "numEvents": 0,
  "projectId": [
    "string"
  ],
  "role": "ADMIN",
  "source": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Request for a Calendar object was successful.	CalendarRecord

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/calendars/{calendarId}/¶

Update a calendar's name

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/calendars/{calendarId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
calendarId	path	string	true	The ID of this calendar.
body	body	CalendarNameUpdate	false	none

Example responses¶

{}

Responses¶

Status	Meaning	Description	Schema
200	OK	Calendar name successfully updated.	Empty
404	Not Found	Invalid `calendarId` provided, or user does not have permissions to update calendar.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/calendars/{calendarId}/accessControl/¶

Get a list of users who have access to this calendar and their roles on the calendar.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/calendars/{calendarId}/accessControl/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
username	query	string	false	Optional, only return the access control information for a user with this username. Should not be specified if `userId` is specified.
userId	query	string	false	Optional, only return the access control information for a user with this user ID. Should not be specified if `username` is specified.
offset	query	integer	false	Optional (default: `0`), this many results will be skipped.
limit	query	integer	false	Optional (default: `0`), at most this many results will be returned. If `0`, all results will be returned.
calendarId	path	string	true	The ID of this calendar.

Example responses¶


{
  "count": 0,
  "data": [
    {
      "canShare": true,
      "role": "ADMIN",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Request for the list of users who have access to this calendar and their roles on the calendar was successful.	CalendarAccessControlListResponse
400	Bad Request	Both `username` and `userId` were specified.	None
404	Not Found	Entity not found. Either the calendar does not exist or the user does not have permissions to view the calendar.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/calendars/{calendarId}/accessControl/¶

Update the access control for this calendar. See the entity sharing documentation <sharing> for more information.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/calendars/{calendarId}/accessControl/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "users": [
    {
      "role": "ADMIN",
      "username": "string"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
calendarId	path	string	true	The ID of this calendar.
body	body	CalendarAccessControlUpdate	false	none

Responses¶

Status	Meaning	Description	Schema
200	OK	Request to update the accesss control for this calendar was sussessful.	None
404	Not Found	Invalid `calendarId` provided, or user has no access whatsoever on the specified calendar.	None
422	Unprocessable Entity	Invalid `username` provided to modify access for the specified calendar.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/datasets/{datasetId}/documentsDataQualityLog/¶

Retrieve the documents data quality log content and log length as JSON.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/datasets/{datasetId}/documentsDataQualityLog/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
datasetId	path	string	true	The ID of the dataset

Example responses¶


{
  "count": 0,
  "data": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Paginated list of lines of the documents data quality log.	DocumentsDataQualityLogLinesResponse
404	Not Found	Documents data quality assessment log not available.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/datasets/{datasetId}/documentsDataQualityLog/file/¶

Retrieve a text file containing the documents data quality log.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/datasets/{datasetId}/documentsDataQualityLog/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
datasetId	path	string	true	The ID of the dataset

Responses¶

Status	Meaning	Description	Schema
200	OK	The response will contain a text file with the contents of the data quality log.	None
404	Not Found	The data quality assessment log is not available.	None

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		`attachment;filename=<filename>.txt` The suggested filename is dynamically generated
200	Content-Type	string		MIME type of the returned data.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/datasets/{datasetId}/imagesDataQualityLog/¶

Retrieve the images data quality log content and log length as JSON

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/datasets/{datasetId}/imagesDataQualityLog/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
datasetId	path	string	true	The ID of the dataset

Example responses¶


{
  "count": 0,
  "data": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Paginated list of lines of the image data quality log	ImagesDataQualityLogLinesResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/datasets/{datasetId}/imagesDataQualityLog/file/¶

Retrieve a text file containing the images data quality log.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/datasets/{datasetId}/imagesDataQualityLog/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
datasetId	path	string	true	The ID of the dataset

Responses¶

Status	Meaning	Description	Schema
200	OK	The response will contain a text file with the contents of the images data quality log.	None

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		`attachment;filename=<filename>.txt` The suggested filename is dynamically generated
200	Content-Type	string		MIME type of the returned data

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/documentsDataQualityLog/¶

Retrieve the documents data quality log content and log length as JSON.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/datasets/{datasetId}/versions/{datasetVersionId}/documentsDataQualityLog/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
datasetId	path	string	true	The ID of the dataset.
datasetVersionId	path	string	true	The ID of the dataset version.

Example responses¶


{
  "count": 0,
  "data": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Paginated list of lines of the documents data quality log.	DocumentsDataQualityLogLinesResponse
404	Not Found	Documents data quality assessment log not available.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/datasets/{datasetId}/versions/{datasetVersionId}/documentsDataQualityLog/file/¶

Retrieve a text file containing the documents data quality log.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/datasets/{datasetId}/versions/{datasetVersionId}/documentsDataQualityLog/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
datasetId	path	string	true	The ID of the dataset.
datasetVersionId	path	string	true	The ID of the dataset version.

Responses¶

Status	Meaning	Description	Schema
200	OK	The response will contain a text file with the contents of the data quality log.	None
404	Not Found	The data quality assessment log is not available.	None

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		`attachment;filename=<filename>.txt` The suggested filename is dynamically generated
200	Content-Type	string		MIME type of the returned data.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/models/{modelId}/documentTextExtractionSampleDocuments/¶

Retrieve documents with computed document text extraction samples.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/models/{modelId}/documentTextExtractionSampleDocuments/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Number of results to skip.
limit	query	integer	false	At most this many results are returned. The default may change without notice.
featureName	query	string	true	The name of the feature to retrieve documents for.
documentTask	query	string	false	The document task to retrieve documents for.
modelId	path	string	true	Model Id

Enumerated Values¶

Parameter	Value
documentTask	[`DOCUMENT_TEXT_EXTRACTOR`, `TESSERACT_OCR`]

Example responses¶


{
  "count": 0,
  "data": [
    {
      "actualTargetValue": "string",
      "documentIndex": 0,
      "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
      "featureName": "string",
      "prediction": {
        "labels": [
          "string"
        ],
        "values": [
          0
        ]
      },
      "thumbnailHeight": 0,
      "thumbnailId": "string",
      "thumbnailLink": "http://example.com",
      "thumbnailWidth": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ],
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Documents with computed document text extraction samples.	DocumentTextExtractionSamplesRetrieveDocumentsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/models/{modelId}/documentTextExtractionSamplePages/¶

Retrieve document pages with recognized text lines and bounding boxes enclosing the text lines.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/models/{modelId}/documentTextExtractionSamplePages/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Number of results to skip.
limit	query	integer	false	At most this many results are returned. The default may change without notice.
featureName	query	string	true	The name of the feature.
documentIndex	query	integer	false	The index of the document within the dataset.
documentTask	query	string	false	The document task to retrieve pages for.
modelId	path	string	true	Model Id

Enumerated Values¶

Parameter	Value
documentTask	[`DOCUMENT_TEXT_EXTRACTOR`, `TESSERACT_OCR`]

Example responses¶


{
  "count": 0,
  "data": [
    {
      "actualTargetValue": "string",
      "documentIndex": 0,
      "documentPageHeight": 0,
      "documentPageId": "string",
      "documentPageLink": "http://example.com",
      "documentPageWidth": 0,
      "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
      "featureName": "string",
      "pageIndex": 0,
      "prediction": {
        "labels": [
          "string"
        ],
        "values": [
          0
        ]
      },
      "textLines": [
        {
          "bottom": 0,
          "left": 0,
          "right": 0,
          "text": "string",
          "top": 0
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ],
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Document pages with recognized text lines and bounding boxes enclosing the text lines.	DocumentTextExtractionSamplesRetrievePagesResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/models/{modelId}/documentTextExtractionSamples/¶

Requests the computation of document text extraction samples for the specified model.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/models/{modelId}/documentTextExtractionSamples/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
modelId	path	string	true	Model Id

Example responses¶


{
  "id": "string",
  "isBlocked": true,
  "jobType": "compute_document_text_extraction_samples",
  "message": "string",
  "modelId": "string",
  "projectId": "string",
  "status": "queue",
  "url": "string"
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Document text extraction samples computation has been successfully requested.	DocumentTextExtractionSamplesComputeResponse
422	Unprocessable Entity	Cannot compute document text extraction samples: if the insight was already computed for the model or there was another issue creating this job.	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string	url	a url that can be polled to check the status of the job.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/ocrJobResources/¶

Retrieve user's OCR job resources.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/ocrJobResources/?offset=0&limit=100 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	true	The number of results to skip (for pagination).
limit	query	integer	true	The max number of results to return.

Example responses¶


{
  "count": 0,
  "data": [
    {
      "id": "string",
      "inputCatalogId": "string",
      "jobStarted": true,
      "language": "ENGLISH",
      "outputCatalogId": "string",
      "userId": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	OCR job resources	OCRJobResourceListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/ocrJobResources/¶

Create an OCR job resource. This creates several entities, including an empty Dataset for writing the results and associates the input dataset with them.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/ocrJobResources/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{OCRJobCreationRequest}'

Body parameter¶


{
  "datasetId": "string",
  "language": "ENGLISH"
}

Parameters

Name	In	Type	Required	Description
body	body	OCRJobCreationRequest	false	none

Example responses¶


{
  "id": "string",
  "inputCatalogId": "string",
  "jobStarted": true,
  "language": "ENGLISH",
  "outputCatalogId": "string",
  "userId": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	OCR job resource	OCRJobResourceResponse
202	Accepted	An OCR job resource is successfully created.	None
403	Forbidden	User doesn't have permission to access dataset associated with OCR job resource.	None
404	Not Found	OCR input dataset is not found.	None
422	Unprocessable Entity	Language param in the request is invalid.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/ocrJobResources/{jobResourceId}/¶

Retrieve an OCR job resource.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/ocrJobResources/{jobResourceId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
jobResourceId	path	string	true	OCR job resource id

Example responses¶


{
  "id": "string",
  "inputCatalogId": "string",
  "jobStarted": true,
  "language": "ENGLISH",
  "outputCatalogId": "string",
  "userId": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	OCR job resource	OCRJobResourceResponse
404	Not Found	OCR job resource is not found for the requested job resource id	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/ocrJobResources/{jobResourceId}/errorReport/¶

Download the OCR job error report.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/ocrJobResources/{jobResourceId}/errorReport/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
jobResourceId	path	string	true	OCR job resource id

Responses¶

Status	Meaning	Description	Schema
200	OK	OCR job error report	None
404	Not Found	OCR job error report is not found for the requested OCR job resource id	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PUT /api/v2/ocrJobResources/{jobResourceId}/errorReport/¶

Upload the job error report to the associated OCR job resource for later downloading.

Code samples¶


curl -X PUT https://app.datarobot.com/api/v2/ocrJobResources/{jobResourceId}/errorReport/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "file": "string"
}

Parameters

Name	In	Type	Required	Description
jobResourceId	path	string	true	OCR job resource id
body	body	OCRJobErrorReportPutRequest	false	none

Responses¶

Status	Meaning	Description	Schema
200	OK	none	None
403	Forbidden	User doesn't have permission to save error report	None
404	Not Found	Dataset with which the error report is associated is not found	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/ocrJobResources/{jobResourceId}/jobStatus/¶

Get the status of a running OCR job from the OCR Service.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/ocrJobResources/{jobResourceId}/jobStatus/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
jobResourceId	path	string	true	OCR job resource id

Example responses¶


{
  "jobStatus": "executing"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	OCR job status	OCRJobStatusesResponse
404	Not Found	OCR job resource is not found for the requested job resource id	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/ocrJobResources/{jobResourceId}/start/¶

Start an OCR job from the information in the OCR job resource. Each OCR job may be started exactly once.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/ocrJobResources/{jobResourceId}/start/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶

{}

Parameters

Name	In	Type	Required	Description
jobResourceId	path	string	true	OCR job resource id
body	body	OCRJobPostPayload	false	none

Example responses¶


{
  "errorReportLocation": "http://example.com",
  "jobStatusLocation": "http://example.com",
  "outputLocation": "http://example.com"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	OCR job info	OCRJobPostResponse
202	Accepted	An OCR job is successfully created.	None
404	Not Found	Job resource is not found.	None
422	Unprocessable Entity	OCR job is already started.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/batchTypeTransformFeatures/¶

Create multiple new features by changing the type of existing features.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/batchTypeTransformFeatures/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "parentNames": [
    "string"
  ],
  "prefix": "string",
  "suffix": "string",
  "variableType": "text"
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project to create the feature in.
body	body	BatchFeatureTransform	false	none

Responses¶

Status	Meaning	Description	Schema
200	OK	Creation has successfully started. See the Location header.	None
422	Unprocessable Entity	Unable to process the request	None

Response Headers¶

Status	Header	Type	Format	Description
200	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/batchTypeTransformFeaturesResult/{jobId}/¶

Retrieve the result of a batch variable type transformation.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/batchTypeTransformFeaturesResult/{jobId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "parentNames": [
    "string"
  ],
  "prefix": "string",
  "suffix": "string",
  "variableType": "text"
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project containing transformed features.
jobId	path	integer	true	ID of the batch variable type transformation job.
body	body	BatchFeatureTransform	false	none

Example responses¶


{
  "failures": {},
  "newFeatureNames": [
    "string"
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Names of successfully created features.	BatchFeatureTransformRetrieveResponse
404	Not Found	Could not find specified transformation report	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/calendarEvents/¶

List available calendar events for the project.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/calendarEvents/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
seriesId	query	string	false	The name of the series to retrieve specific series for. If specified, retrieves only series specific to the event and common events.
startDate	query	string(date-time)	false	The start of the date range to return, inclusive. If not specified, start date for the first calendar event will be used.
endDate	query	string(date-time)	false	The end of the date range to return, exclusive. If not specified, end date capturing the last calendar event will be used.
offset	query	integer	false	Optional (default: `0`), this many results will be skipped.
limit	query	integer	false	Optional (default: `1000`), at most this many results will be returned.
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "date": "2019-08-24T14:15:22Z",
      "name": "string",
      "seriesId": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	A list of calendar events.	CalendarEventsResponseQuery

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/crossSeriesProperties/¶

Validate columns for potential use as the group-by column for cross-series functionality.

The group-by column is an optional setting that indicates how to further splitseries into related groups. For example, if each series represents sales of an individual product, the group-by column could be the product category, e.g., "clothing" or "sports equipment".

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/crossSeriesProperties/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "crossSeriesGroupByColumns": [
    "string"
  ],
  "datetimePartitionColumn": "string",
  "multiseriesIdColumn": "string",
  "userDefinedSegmentIdColumn": "string"
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
body	body	CrossSeriesGroupByColumnValidatePayload	false	none

Example responses¶


{
  "message": "string"
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Cross-series group-by column validation job was successfully submitted. See Location header.	CrossSeriesGroupByColumnValidateResponse

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/discardedFeatures/¶

Get features which were discarded during feature reduction process.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/discardedFeatures/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
search	query	string	false	Case insensitive search against discarded feature names.
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "features": [
    "string"
  ],
  "remainingRestoreLimit": 0,
  "totalRestoreLimit": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Discarded features.	DiscardedFeaturesResponse
422	Unprocessable Entity	Unable to process the request	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/documentPages/{documentPageId}/file/¶

Returns a file for a single document page.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/documentPages/{documentPageId}/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
documentPageId	path	string	true	Id of the document page

Responses¶

Status	Meaning	Description	Schema
200	OK	The response is an image file (not JSON) that can be saved or displayed.	None
404	Not Found	Document page not found	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/documentTextExtractionSamples/¶

Lists metadata on all computed document text extraction samples in the project across all models.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/documentTextExtractionSamples/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Number of results to skip.
limit	query	integer	false	At most this many results are returned. The default may change without notice.
projectId	path	string	true	Project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
      "featureName": "string",
      "modelId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Metadata on computed document text extraction samples in the project.	DocumentTextExtractionSamplesListMetadataResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/documentThumbnailBins/¶

Lists document thumbnail bins for every target value or range including the metadata for one example thumbnail of the bin.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/documentThumbnailBins/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
featureName	query	string	true	Name of the document feature
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "documentPageId": "string",
      "height": 0,
      "targetBinEnd": 0,
      "targetBinRowCount": 0,
      "targetBinStart": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Returns a list of document thumbnail bins for every target value or range including the metadata for one example thumbnail of the bin.	DocumentThumbnailBinsListResponse
422	Unprocessable Entity	The request cannot be processed	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/documentThumbnailSamples/¶

List all metadata for document thumbnails in the EDA sample.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/documentThumbnailSamples/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
featureName	query	string	true	Name of the document feature
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "documentPageId": "string",
      "height": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	A paginated list of document thumbnail metadata.	DocumentThumbnailMetadataListResponse
422	Unprocessable Entity	The request cannot be processed	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/documentThumbnails/¶

Returns a list of document thumbnail metadata elements.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/documentThumbnails/?offset=0&limit=100 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
featureName	query	string	false	Name of the document feature
targetValue	query	any	false	For classification projects, when specified, returns only document pages corresponding to this target value. Mutually exclusive with targetBinStart/targetBinEnd.
targetBinStart	query	any	false	For regression projects, when specified, returns only document pages corresponding to the target values above this value. Mutually exclusive with targetValue. Must be specified with targetBinEnd.
targetBinEnd	query	any	false	For regression projects, when specified, only document thumbnails corresponding to the target values below this will be returned. Mutually exclusive with targetValue. Must be specified with targetBinStart.
offset	query	integer	true	This many results will be skipped
limit	query	integer	true	At most this many results are returned
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "documentPageId": "string",
      "height": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Returns a list of document thumbnail metadata elements.	DocumentThumbnailMetadataListResponse
422	Unprocessable Entity	The request cannot be processed. Possible reasons include: - Cannot supply value for both TargetValue and TargetBin. - Must supply both TargetBinStart and TargetBinEnd. - TargetBin parameters are only valid for regression projects. - TargetValue parameter is only valid for classification projects.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/documentsDataQualityLog/¶

Retrieve the documents data quality log content and log length as JSON.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/documentsDataQualityLog/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	A paginated list of lines of the document data quality log.	DocumentsDataQualityLogLinesResponse
422	Unprocessable Entity	Not a data quality enabled project	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/documentsDataQualityLog/file/¶

Retrieve a text file containing the documents data quality log.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/documentsDataQualityLog/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID

Responses¶

Status	Meaning	Description	Schema
200	OK	The response will contain a text file with the contents of the documents data quality log.	None
422	Unprocessable Entity	Not a data quality enabled project	None

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		`attachment;filename=<filename>.txt` The suggested filename is dynamically generated
200	Content-Type	string		MIME type of the returned data.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/duplicateImages/{column}/¶

Get a list of duplicate images containing the number of occurrences of each image

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/duplicateImages/{column}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
projectId	path	string	true	The project ID
column	path	string	true	Column parameter to filter the list of duplicate images returned

Example responses¶


{
  "count": 0,
  "data": [
    {
      "imageId": "string",
      "rowCount": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of image metadata	DuplicateImageTableResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureDiscoveryDatasetDownload/¶

Download the project dataset with features added by feature discovery

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/featureDiscoveryDatasetDownload/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
datasetId	query	string	false	The ID of the dataset to use for the prediction.
projectId	path	string	true	The project ID

Responses¶

Status	Meaning	Description	Schema
200	OK	Project dataset file.	None
404	Not Found	Data is not found.	None
422	Unprocessable Entity	Unable to process the request.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureDiscoveryLogs/¶

Retrieve the feature discovery log content and log length for a feature discovery project. This route is only supported for feature discovery projects that have finished partitioning

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/featureDiscoveryLogs/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Number of results to skip.
limit	query	integer	false	At most this many results are returned. The default may change without notice.
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "featureDiscoveryLog": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalLogLines": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Feature discovery log data.	FeatureDiscoveryLogListResponse
422	Unprocessable Entity	Unable to process the request.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureDiscoveryLogs/download/¶

Retrieve a text file containing the feature discovery log. This route is only supported for feature discovery projects that have finished partitioning.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/featureDiscoveryLogs/download/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID

Responses¶

Status	Meaning	Description	Schema
200	OK	Feature discovery log file.	None
422	Unprocessable Entity	Unable to process the request.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureDiscoveryRecipeSQLs/download/¶

Download feature discovery SQL recipe for a project

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/featureDiscoveryRecipeSQLs/download/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
modelId	query	string	false	Model ID to export recipe for
statusOnly	query	string	false	Return status only for availability check
asText	query	string	false	Determines whether to download the file or just return text.
projectId	path	string	true	The project ID

Enumerated Values¶

Parameter	Value
statusOnly	[`false`, `False`, `true`, `True`]
asText	[`false`, `False`, `true`, `True`]

Responses¶

Status	Meaning	Description	Schema
200	OK	Project feature discovery SQL recipe file.	None
400	Bad Request	Unable to process the request	None
404	Not Found	Data not found	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/featureDiscoveryRecipeSqlExports/¶

Generate feature discovery SQL recipe for a project

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/featureDiscoveryRecipeSqlExports/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "modelId": "string"
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
body	body	FeatureDiscoveryRecipeSQLsExport	false	none

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Creation has successfully started. See the Location header.	None
404	Not Found	Data not found	None
422	Unprocessable Entity	Unable to process the request	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureHistograms/{featureName}/¶

Get histogram chart data for a specific feature. Information that can be used to build histogram charts. Plot data returned is based on raw data that is calculated during initial project creation and updated after the project's target variable has been selected. The number of bins in the histogram is no greater than the requested limit.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/featureHistograms/{featureName}/?binLimit=60 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
binLimit	query	integer	true	maximum number of bins in the returned plot
key	query	string	false	name of the top 50 key for which plot to be retrieved. (Only required for the Summarized categorical feature)
projectId	path	string	true	The ID of the project
featureName	path	string	true	the name of the feature Note: DataRobot renames some features, so the feature name may not be the one from your original data. You can use GET /api/v2/projects/{projectId}/features/ to list the features and check the name. Note to users with non-ascii features names: The feature name should be utf-8-encoded (before URL-quoting)

Example responses¶


{
  "plot": [
    {
      "count": 0,
      "label": "string",
      "target": 0
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The feature histogram chart data	FeatureHistogramResponse
404	Not Found	A Histogram is unavailable for this feature because the data contains unsupportedfeature types (e.g., image, location).	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featureLineages/{featureLineageId}/¶

Retrieve single Feature Discovery feature lineage.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/featureLineages/{featureLineageId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project to retrieve a lineage from.
featureLineageId	path	string	true	id of a feature lineage object to return. You can access the id with ModelingFeatureRetrieveController.

Example responses¶


{
  "steps": [
    {
      "arguments": {},
      "catalogId": "string",
      "catalogVersionId": "string",
      "description": "string",
      "groupBy": [
        "string"
      ],
      "id": 0,
      "isTimeAware": true,
      "joinInfo": {
        "joinType": "left, right",
        "leftTable": {
          "columns": [
            "string"
          ],
          "datasteps": [
            1
          ]
        },
        "rightTable": {
          "columns": [
            "string"
          ],
          "datasteps": [
            1
          ]
        }
      },
      "name": "string",
      "parents": [
        0
      ],
      "stepType": "data",
      "timeInfo": {
        "duration": {
          "duration": 0,
          "timeUnit": "string"
        },
        "latest": {
          "duration": 0,
          "timeUnit": "string"
        }
      }
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	FeatureLineageResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featurelists/¶

List all featurelists for a project.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/featurelists/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
sortBy	query	string	false	Property to sort featurelists by in the response
searchFor	query	string	false	Limit results by specific featurelists. Performs a substring search for the term you provide in featurelist names.
projectId	path	string	true	The project ID

Enumerated Values¶

Parameter	Value
sortBy	[`name`, `description`, `features`, `numModels`, `created`, `isUserCreated`, `-name`, `-description`, `-features`, `-numModels`, `-created`, `-isUserCreated`]

Example responses¶


[
  {
    "created": "string",
    "description": "string",
    "features": [
      "string"
    ],
    "id": "string",
    "isUserCreated": true,
    "name": "string",
    "numModels": 0,
    "projectId": "string"
  }
]

Responses¶

Status	Meaning	Description	Schema
200	OK	The list of featurelists	Inline

Response Schema¶

Status Code 200

Name	Type	Required	Description
anonymous	[FeaturelistResponse]	false	none
» created	string	true	A :ref:`timestamp <time_format>` string specifying when the featurelist was created.
» description	string,null	false	User-friendly description of the featurelist, which can be updated by users.
» features	[string]	true	Names of features included in the featurelist.
» id	string	true	Featurelist ID.
» isUserCreated	boolean	true	Whether the featurelist was created manually by a user or by DataRobot automation.
» name	string	true	the name of the featurelist
» numModels	integer	true	The number of models that currently use this featurelist. A model is considered to use a featurelist if it is used to train the model or as a monotonic constraint featurelist, or if the model is a blender with at least one component model using the featurelist.
» projectId	string	true	Project ID the featurelist belongs to.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/featurelists/¶

Create a new featurelist from list of feature names.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/featurelists/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "features": [
    "string"
  ],
  "name": "string",
  "skipDatetimePartitionColumn": false
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
body	body	CreateFeaturelist	false	none

Example responses¶


{
  "created": "string",
  "description": "string",
  "features": [
    "string"
  ],
  "id": "string",
  "isUserCreated": true,
  "name": "string",
  "numModels": 0,
  "projectId": "string"
}

Responses¶

Status	Meaning	Description	Schema
201	Created	The newly created featurelist in the same format as GET /api/v2/projects/{projectId}/featurelists/{featurelistId}/.	FeaturelistResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/projects/{projectId}/featurelists/{featurelistId}/¶

Delete a specified featurelist. All models using a featurelist, whether as the training featurelist or as a monotonic constraint featurelist, will also be deleted when the deletion is executed and any queued or running jobs using it will be cancelled. Similarly, predictions made on these models will also be deleted. All the entities that are to be deleted with a featurelist are described as "dependencies" of it. When deleting a featurelist with dependencies, users must pass an additional query parameter deleteDependencies to confirm they want to delete the featurelist and all its dependencies. Without that option, only featurelists with no dependencies may be successfully deleted. Featurelists configured into the project as a default featurelist or as a default monotonic constraint featurelist cannot be deleted. Featurelists used in a model deployment cannot be deleted until the model deployment is deleted.

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/projects/{projectId}/featurelists/{featurelistId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
dryRun	query	string	false	Preview the deletion results without actually deleting the featurelist.
deleteDependencies	query	string	false	Automatically delete all dependencies of a featurelist. If false (default), will only delete the featurelist if it has no dependencies. The value of deleteDependencies will not be used if dryRun is true.If a featurelist has dependencies, deleteDependencies must be true for the request to succeed.
projectId	path	string	true	The project ID.
featurelistId	path	string	true	The featurelist ID.

Enumerated Values¶

Parameter	Value
dryRun	[`false`, `False`, `true`, `True`]
deleteDependencies	[`false`, `False`, `true`, `True`]

Example responses¶


{
  "canDelete": "false",
  "deletionBlockedReason": "string",
  "dryRun": "false",
  "numAffectedJobs": 0,
  "numAffectedModels": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	FeaturelistDestroyResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/featurelists/{featurelistId}/¶

Retrieve a single known feature list.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/featurelists/{featurelistId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID.
featurelistId	path	string	true	The featurelist ID.

Example responses¶


{
  "created": "string",
  "description": "string",
  "features": [
    "string"
  ],
  "id": "string",
  "isUserCreated": true,
  "name": "string",
  "numModels": 0,
  "projectId": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Retrieve a single known feature list.	FeaturelistResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/projects/{projectId}/featurelists/{featurelistId}/¶

Update an existing featurelist by ID.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/projects/{projectId}/featurelists/{featurelistId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "description": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID.
featurelistId	path	string	true	The featurelist ID.
body	body	UpdateFeaturelist	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	The featurelist was successfully updated.	None
422	Unprocessable Entity	Update failed due to an invalid payload. This may be because the name is identical to an existing featurelist name.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/features/¶

List the features from a project with descriptive information.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/features/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
sortBy	query	string	false	Property to sort features by in the response
searchFor	query	string	false	Limit results by specific features. Performs a substring search for the term you provide in featurelist names.
featurelistId	query	string	false	Filter features by a specific featurelist ID.
forSegmentedAnalysis	query	string	false	When True, features returned will be filtered to those usable for segmented analysis.
projectId	path	string	true	The project ID.

Enumerated Values¶

Parameter	Value
sortBy	[`name`, `id`, `importance`, `featureType`, `uniqueCount`, `naCount`, `mean`, `stdDev`, `median`, `min`, `max`, `-name`, `-id`, `-importance`, `-featureType`, `-uniqueCount`, `-naCount`, `-mean`, `-stdDev`, `-median`, `-min`, `-max`]
forSegmentedAnalysis	[`false`, `False`, `true`, `True`]

Example responses¶


[
  {
    "dataQualities": "ISSUES_FOUND",
    "dateFormat": "string",
    "featureLineageId": "string",
    "featureType": "Boolean",
    "id": 0,
    "importance": 0,
    "isRestoredAfterReduction": true,
    "isZeroInflated": true,
    "keySummary": {
      "key": "string",
      "summary": {
        "dataQualities": "ISSUES_FOUND",
        "max": 0,
        "mean": 0,
        "median": 0,
        "min": 0,
        "pctRows": 0,
        "stdDev": 0
      }
    },
    "language": "string",
    "lowInformation": true,
    "lowerQuartile": "string",
    "max": "string",
    "mean": "string",
    "median": "string",
    "min": "string",
    "multilabelInsights": {
      "multilabelInsightsKey": "string"
    },
    "naCount": 0,
    "name": "string",
    "parentFeatureNames": [
      "string"
    ],
    "projectId": "string",
    "stdDev": "string",
    "targetLeakage": "FALSE",
    "targetLeakageReason": "string",
    "timeSeriesEligibilityReason": "string",
    "timeSeriesEligible": true,
    "timeStep": 0,
    "timeUnit": "string",
    "uniqueCount": 0,
    "upperQuartile": "string"
  }
]

Responses¶

Status	Meaning	Description	Schema
200	OK	The list of features	Inline

Response Schema¶

Status Code 200

Name	Type	Required	Description
anonymous	[ProjectFeatureResponse]	false	none
» dataQualities	string	false	Data Quality Status
» dateFormat	string,null	true	the date format string for how this feature was interpreted (or null if not a date feature). If not null, it will be compatible with https://docs.python.org/2/library/time.html#time.strftime .
» featureLineageId	string,null	true	id of a lineage for automatically generated features.
» featureType	string	true	Feature type.
» id	integer	true	the feature ID. (Note: Throughout the API, features are specified using their names, not this ID.)
» importance	number,null	true	numeric measure of the strength of relationship between the feature and target (independent of any model or other features)
» isRestoredAfterReduction	boolean	false	Whether feature is restored after feature reduction
» isZeroInflated	boolean,null	false	Whether feature has an excessive number of zeros
» keySummary	any	false	Per key summaries for Summarized Categorical or Multicategorical columns

oneOf

Name	Type	Required	Description
»» anonymous	FeatureKeySummaryResponseValidatorSummarizedCategorical	false	For a Summarized Categorical columns, this will contain statistics for the top 50 keys (truncated to 103 characters)
»»» key	string	true	Name of the key.
»»» summary	FeatureKeySummaryDetailsResponseValidatorSummarizedCategorical	true	Statistics of the key.
»»»» dataQualities	string	true	The indicator of data quality assessment of the feature.
»»»» max	number	true	Maximum value of the key.
»»»» mean	number	true	Mean value of the key.
»»»» median	number	true	Median value of the key.
»»»» min	number	true	Minimum value of the key.
»»»» pctRows	number	true	Percentage occurrence of key in the EDA sample of the feature.
»»»» stdDev	number	true	Standard deviation of the key.

xor

Name	Type	Required	Description
»» anonymous	[FeatureKeySummaryResponseValidatorMultilabel]	false	For a Multicategorical columns, this will contain statistics for the top classes
»»» key	string	true	Name of the key.
»»» summary	FeatureKeySummaryDetailsResponseValidatorMultilabel	true	Statistics of the key.
»»»» max	number	true	Maximum value of the key.
»»»» mean	number	true	Mean value of the key.
»»»» median	number	true	Median value of the key.
»»»» min	number	true	Minimum value of the key.
»»»» pctRows	number	true	Percentage occurrence of key in the EDA sample of the feature.
»»»» stdDev	number	true	Standard deviation of the key.

continued

Name	Type	Required	Description
» language	string	false	Feature's detected language.
» lowInformation	boolean	true	whether feature has too few values to be informative
» lowerQuartile	any	true	Lower quartile point of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false		Lower quartile point of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	number	false		Lower quartile point of EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
» max	any	true		maximum value of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false		maximum value of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	number	false		maximum value of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
» mean	any	true		arithmetic mean of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false		arithmetic mean of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	number	false		arithmetic mean of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
» median	any	true		median of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false		median of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	number	false		median of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
» min	any	true		minimum value of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false		minimum value of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	number	false		minimum value of the EDA sample of the feature.

continued

Name	Type	Required	Description
» multilabelInsights	MultilabelInsightsResponse	false	Multilabel project specific information
»» multilabelInsightsKey	string	true	Key for multilabel insights, unique per project, feature, and EDA stage. The response will contain the key for the most recent, finished EDA stage.
» naCount	integer	true	Number of missing values.
» name	string	true	feature name
» parentFeatureNames	[string]	false	an array of string feature names indicating which features in the input data were used to create this feature if the feature is a transformation.
» projectId	string	true	the ID of the project the feature belongs to
» stdDev	any	true	standard deviation of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false		standard deviation of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	number	false		standard deviation of EDA sample of the feature.

continued

Name	Type	Required	Description
» targetLeakage	string	true	the detected level of risk for target leakage, if any. 'SKIPPED_DETECTION' indicates leakage detection was not run on the feature, 'FALSE' indicates no leakage, 'MODERATE_RISK' indicates a moderate risk of target leakage, and 'HIGH_RISK' indicates a high risk of target leakage.
» targetLeakageReason	string	true	descriptive sentence explaining the reason for target leakage.
» timeSeriesEligibilityReason	string	true	why the feature is ineligible for time series projects, or 'suitable' if it is eligible.
» timeSeriesEligible	boolean	true	whether this feature can be used as a datetime partitioning feature for time series projects. Only sufficiently regular date features can be selected as the datetime feature for time series projects. Always false for non-date features. Date features that cannot be used in datetime partitioning for a time series project may be eligible for an OTV project, which has less stringent requirements.
» timeStep	integer,null	true	The minimum time step that can be used to specify time series windows. The units for this value are the `timeUnit`. When specifying windows for time series projects, all windows must have durations that are integer multiples of this number. Only present for date features that are eligible for time series projects and null otherwise.
» timeUnit	string,null	true	the unit for the interval between values of this feature, e.g. DAY, MONTH, HOUR. When specifying windows for time series projects, the windows are expressed in terms of this unit. Only present for date features eligible for time series projects, and null otherwise.
» uniqueCount	integer	false	number of unique values
» upperQuartile	any	true	Upper quartile point of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	string	false		Upper quartile point of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
»» anonymous	number	false		Upper quartile point of EDA sample of the feature.

Enumerated Values¶

Property	Value
dataQualities	[`ISSUES_FOUND`, `NOT_ANALYZED`, `NO_ISSUES_FOUND`]
featureType	[`Boolean`, `Categorical`, `Currency`, `Date`, `Date Duration`, `Document`, `Image`, `Interaction`, `Length`, `Location`, `Multicategorical`, `Numeric`, `Percentage`, `Summarized Categorical`, `Text`, `Time`]
dataQualities	[`ISSUES_FOUND`, `NOT_ANALYZED`, `NO_ISSUES_FOUND`]
targetLeakage	[`FALSE`, `HIGH_RISK`, `MODERATE_RISK`, `SKIPPED_DETECTION`]

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/features/metrics/¶

List the appropriate metrics if a feature were chosen as the target. The metrics listed will include both weighted and unweighted metrics - which are appropriate will depend on whether a weights column is used.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/features/metrics/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
featureName	query	string	true	The name of the feature to check
projectId	path	string	true	The project ID.

Example responses¶


{
  "availableMetrics": [
    "string"
  ],
  "featureName": "string",
  "metricDetails": [
    {
      "ascending": true,
      "metricName": "string",
      "supportsBinary": true,
      "supportsMulticlass": true,
      "supportsRegression": true,
      "supportsTimeseries": true
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The feature's metrics	FeatureMetricsResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/features/{featureName}/¶

Retrieve the specified feature with descriptive information. Descriptive information for features also includes summary statistics as of v2.8. These are returned via the fields max, min, mean, median, and stdDev. These fields are formatted according to the original feature type of the feature. For example, the format will be numeric if your feature is numeric, in feet and inches if your feature is length type, in currency if your feature is currency type, in time format if your feature is time type, or in ISO date format if your feature is a date type. Numbers will be rounded so that they have at most two non-zero decimal digits. For projects created prior to v2.8, these descriptive statistics will not be available. Also, some features, like categorical and text features, may not have summary statistics.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/features/{featureName}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The ID of the project
featureName	path	string	true	the name of the feature Note: DataRobot renames some features, so the feature name may not be the one from your original data. You can use GET /api/v2/projects/{projectId}/features/ to list the features and check the name. Note to users with non-ascii features names: The feature name should be utf-8-encoded (before URL-quoting)

Responses¶

Status	Meaning	Description	Schema
200	OK	The feature information	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/features/{featureName}/multiseriesProperties/¶

Time series projects require that each timestamp have at most one row corresponding to it. However, multiple series of data can be handled within a single project by designating a multiseries ID column that assigns each row to a particular series. See the :ref:multiseries <multiseries> docs on time series projects for more information.

Note that detection will have to be triggered via POST /api/v2/projects/{projectId}/multiseriesProperties/ in order for multiseries id columns to appear here. The route will return successfully with an empty array of detected columns if detection hasn't run yet, or hasn't found any valid columns.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/features/{featureName}/multiseriesProperties/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID to retrieve multiseries properties from.
featureName	path	string	true	The feature to be used to the datetime partition column.

Example responses¶


{
  "datetimePartitionColumn": "string",
  "detectedMultiseriesIdColumns": [
    {
      "multiseriesIdColumns": [
        "string"
      ],
      "timeStep": 0,
      "timeUnit": "MILLISECOND"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Request to retrieve the potential multiseries ID columns was successful.	MultiseriesRetrieveResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/imageBins/¶

List image bins and covers for every target value or range.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imageBins/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
featureName	query	string	true	Name of the image feature
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetBinEnd": 0,
      "targetBinRowCount": 0,
      "targetBinStart": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Returns a list of image metadata	ImageBinsListResponse
422	Unprocessable Entity	The request cannot be processed	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/imageEmbeddings/¶

List all Image Embeddings for the project.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imageEmbeddings/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	The number of items to skip over.
limit	query	integer	false	The number of items to return.
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "featureName": "string",
      "modelId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Image Embeddings	EmbeddingsListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/imageSamples/¶

List all metadata for images in the EDA sample

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imageSamples/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
featureName	query	string	true	Name of the image feature
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Paginated list of image metadata	ImageMetadataListResponse
422	Unprocessable Entity	The request cannot be processed	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/images/¶

Returns a list of image metadata elements.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/images/?offset=0&limit=100 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
column	query	string	false	Name of the column to query
targetValue	query	any	false	For classification projects - when specified, only images corresponding to this target value will be returned. Mutually exclusive with targetBinStart/targetBinEnd.
targetBinStart	query	any	false	For regression projects - when specified, only images corresponding to the target values above this will be returned. Mutually exclusive with targetValue. Must be specified with targetBinEnd.
targetBinEnd	query	any	false	For regression projects - when specified, only images corresponding to the target values below this will be returned. Mutually exclusive with targetValue. Must be specified with targetBinStart.
offset	query	integer	true	This many results will be skipped
limit	query	integer	true	At most this many results are returned
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Returns a list of image metadata elements.	ImageMetadataListResponse
422	Unprocessable Entity	The request cannot be processed. Possible reasons include: - Cannot supply value for both TargetValue and TargetBin. - Must supply both TargetBinStart and TargetBinEnd. - TargetBin parameters are only valid for regression projects. - TargetValue parameter is only valid for classification projects.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/images/{imageId}/¶

Returns a single image metadata.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/images/{imageId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
imageId	path	string	true	Id of the image

Example responses¶


{
  "height": 0,
  "imageId": "string",
  "targetValue": 0,
  "width": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Metadata for a single image	ImageMetadataResponse
404	Not Found	Image not found	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/images/{imageId}/file/¶

Returns a file for a single image

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/images/{imageId}/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
imageId	path	string	true	Id of the image

Responses¶

Status	Meaning	Description	Schema
200	OK	The response is an image file (not JSON) that can be saved or displayed.	None
404	Not Found	Image not found	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/imagesDataQualityLog/¶

Retrieve the images data quality log content and log length as JSON

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imagesDataQualityLog/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "data": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Paginated list of lines of the image data quality log	ImagesDataQualityLogLinesResponse
422	Unprocessable Entity	Not a data quality enabled project	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/imagesDataQualityLog/file/¶

Retrieve a text file containing the images data quality log

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/imagesDataQualityLog/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID

Responses¶

Status	Meaning	Description	Schema
200	OK	The response will contain a text file with the contents of the images data quality log.	None

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		`attachment;filename=<filename>.txt` The suggested filename is dynamically generated
200	Content-Type	string		MIME type of the returned data

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/modelingFeaturelists/¶

List all modeling featurelists from the project requested by ID. This route will only become available after the target and partitioning options have been set for a project. Modeling featurelists are featurelists of modeling features, and are the correct featurelists to use when creating models or restarting the autopilot. In a time series project, these will differ from those returned from GET /api/v2/projects/{projectId}/featurelists/ while in other projects these will be identical. See the :ref:documentation <input_vs_modeling> for more information on the distinction between input and modeling data in time series projects.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/modelingFeaturelists/?offset=0&limit=0 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
sortBy	query	string	false	Property to sort featurelists by in the response
searchFor	query	string	false	Limit results by specific featurelists. Performs a substring search for the term you provide in featurelist names.
offset	query	integer	true	This many results will be skipped.
limit	query	integer	true	At most this many results are returned. If 0, all results.
projectId	path	string	true	The project ID

Enumerated Values¶

Parameter	Value
sortBy	[`name`, `description`, `features`, `numModels`, `created`, `isUserCreated`, `-name`, `-description`, `-features`, `-numModels`, `-created`, `-isUserCreated`]

Example responses¶


{
  "count": 0,
  "data": [
    {
      "created": "string",
      "description": "string",
      "features": [
        "string"
      ],
      "id": "string",
      "isUserCreated": true,
      "name": "string",
      "numModels": 0,
      "projectId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of requested project modeling featurelists.	FeaturelistListResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/modelingFeaturelists/¶

Create new modeling featurelist from list of feature names. Only time series projects differentiate between modeling and input featurelists. On other projects, this route will behave the same as POST /api/v2/projects/{projectId}/featurelists/. On time series projects, this can be used after the target has been set in order to create a new featurelist on the modeling features, although the previously mentioned route for creating featurelists will be disabled. On time series projects, only modeling features may be passed to this route to create a featurelist.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/modelingFeaturelists/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "features": [
    "string"
  ],
  "name": "string",
  "skipDatetimePartitionColumn": false
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
body	body	CreateFeaturelist	false	none

Example responses¶


{
  "created": "string",
  "description": "string",
  "features": [
    "string"
  ],
  "id": "string",
  "isUserCreated": true,
  "name": "string",
  "numModels": 0,
  "projectId": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	The newly created featurelist in the same format as GET /api/v2/projects/{projectId}/modelingFeaturelists/{featurelistId}/.	FeaturelistResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/projects/{projectId}/modelingFeaturelists/{featurelistId}/¶

Delete a specified modeling featurelist. All models using a featurelist, whether as the training featurelist or as a monotonic constraint featurelist, will also be deleted when the deletion is executed and any queued or running jobs using it will be cancelled. Similarly, predictions made on these models will also be deleted. All the entities that are to be deleted with a featurelist are described as "dependencies" of it. When deleting a featurelist with dependencies, users must pass an additional query parameter deleteDependencies to confirm they want to delete the featurelist and all its dependencies. Without that option, only featurelists with no dependencies may be successfully deleted. Featurelists configured into the project as a default featurelist or as a default monotonic constraint featurelist cannot be deleted. Featurelists used in a model deployment cannot be deleted until the model deployment is deleted. Modeling featurelists are featurelists of modeling features, and are the appropriate featurelists to use when creating models or restarting the autopilot. In a time series project, these will be distinct from those returned from GET /api/v2/projects/{projectId}/featurelists/ while in other projects these will be identical.

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/projects/{projectId}/modelingFeaturelists/{featurelistId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
dryRun	query	string	false	Preview the deletion results without actually deleting the featurelist.
deleteDependencies	query	string	false	Automatically delete all dependencies of a featurelist. If false (default), will only delete the featurelist if it has no dependencies. The value of deleteDependencies will not be used if dryRun is true.If a featurelist has dependencies, deleteDependencies must be true for the request to succeed.
projectId	path	string	true	The project ID.
featurelistId	path	string	true	The featurelist ID.

Enumerated Values¶

Parameter	Value
dryRun	[`false`, `False`, `true`, `True`]
deleteDependencies	[`false`, `False`, `true`, `True`]

Example responses¶


{
  "canDelete": "false",
  "deletionBlockedReason": "string",
  "dryRun": "false",
  "numAffectedJobs": 0,
  "numAffectedModels": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	FeaturelistDestroyResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/modelingFeaturelists/{featurelistId}/¶

Retrieve a single modeling featurelist by ID. When reporting the number of models that "use" a featurelist, a model is considered to use a featurelist if it is used as to train the model or as a monotonic constraint featurelist, or if the model is a blender with component models that use the featurelist. This route will only become available after the target and partitioning options have been set for a project. Modeling featurelists are featurelists of modeling features, and are the appropriate featurelists to use when creating models or restarting the autopilot. In a time series project, these will be distinct from those returned from GET /api/v2/projects/{projectId}/featurelists/ while in other projects these will be identical.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/modelingFeaturelists/{featurelistId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID.
featurelistId	path	string	true	The featurelist ID.

Example responses¶


{
  "created": "string",
  "description": "string",
  "features": [
    "string"
  ],
  "id": "string",
  "isUserCreated": true,
  "name": "string",
  "numModels": 0,
  "projectId": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Modeling featurelist with specified ID.	FeaturelistResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PATCH /api/v2/projects/{projectId}/modelingFeaturelists/{featurelistId}/¶

Update an existing modeling featurelist by ID. In non-time series projects, "modeling featurelists" and "featurelists" routes behave the same, except "modeling featurelists" are only accessible after the project is ready for modeling. In time series projects, "featurelists" contain the input features before feature derivation that are used to derive the time series features, while "modeling featurelists" contain the derived time series features used for modeling.

Code samples¶


curl -X PATCH https://app.datarobot.com/api/v2/projects/{projectId}/modelingFeaturelists/{featurelistId}/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "description": "string",
  "name": "string"
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID.
featurelistId	path	string	true	The featurelist ID.
body	body	UpdateFeaturelist	false	none

Responses¶

Status	Meaning	Description	Schema
204	No Content	The modeling featurelist was successfully updated.	None
422	Unprocessable Entity	Update failed due to an invalid payload. This may be because the name is identical to an existing featurelist name.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/modelingFeatures/¶

List the features from a project that are used for modeling with descriptive information.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/modelingFeatures/?offset=0&limit=0 \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
sortBy	query	string	false	Property to sort features by in the response
searchFor	query	string	false	Limit results by specific features. Performs a substring search for the term you provide in featurelist names.
featurelistId	query	string	false	Filter features by a specific featurelist ID.
offset	query	integer	true	This many results will be skipped.
limit	query	integer	true	At most this many results are returned. If 0, all results.
projectId	path	string	true	The project ID

Enumerated Values¶

Parameter	Value
sortBy	[`name`, `id`, `importance`, `featureType`, `uniqueCount`, `naCount`, `mean`, `stdDev`, `median`, `min`, `max`, `-name`, `-id`, `-importance`, `-featureType`, `-uniqueCount`, `-naCount`, `-mean`, `-stdDev`, `-median`, `-min`, `-max`]

Example responses¶


{
  "count": 0,
  "data": [
    {
      "dataQualities": "ISSUES_FOUND",
      "dateFormat": "string",
      "featureLineageId": "string",
      "featureType": "Boolean",
      "importance": 0,
      "isRestoredAfterReduction": true,
      "isZeroInflated": true,
      "keySummary": {
        "key": "string",
        "summary": {
          "dataQualities": "ISSUES_FOUND",
          "max": 0,
          "mean": 0,
          "median": 0,
          "min": 0,
          "pctRows": 0,
          "stdDev": 0
        }
      },
      "language": "string",
      "lowInformation": true,
      "lowerQuartile": "string",
      "max": "string",
      "mean": "string",
      "median": "string",
      "min": "string",
      "multilabelInsights": {
        "multilabelInsightsKey": "string"
      },
      "naCount": 0,
      "name": "string",
      "parentFeatureNames": [
        "string"
      ],
      "projectId": "string",
      "stdDev": "string",
      "targetLeakage": "FALSE",
      "targetLeakageReason": "string",
      "uniqueCount": 0,
      "upperQuartile": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Descriptive information for features.	ModelingFeatureListResponse
422	Unprocessable Entity	Unable to process the request	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/modelingFeatures/fromDiscardedFeatures/¶

Restore discarded time series features.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/modelingFeatures/fromDiscardedFeatures/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "featuresToRestore": [
    "string"
  ]
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
body	body	ModelingFeaturesCreateFromDiscarded	false	none

Example responses¶


{
  "featuresToRestore": [
    "string"
  ],
  "warnings": [
    "string"
  ]
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Creation has successfully started. See the Location header.	ModelingFeaturesCreateFromDiscardedResponse
404	Not Found	No discarded time series features information available.	None
422	Unprocessable Entity	Unable to process the request.	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/modelingFeatures/{featureName}/¶

Retrieve the specified modeling feature with descriptive information.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/modelingFeatures/{featureName}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The ID of the project
featureName	path	string	true	the name of the feature Note: DataRobot renames some features, so the feature name may not be the one from your original data. You can use GET /api/v2/projects/{projectId}/features/ to list the features and check the name. Note to users with non-ascii features names: The feature name should be utf-8-encoded (before URL-quoting)

Example responses¶


{
  "dataQualities": "ISSUES_FOUND",
  "dateFormat": "string",
  "featureLineageId": "string",
  "featureType": "Boolean",
  "importance": 0,
  "isRestoredAfterReduction": true,
  "isZeroInflated": true,
  "keySummary": {
    "key": "string",
    "summary": {
      "dataQualities": "ISSUES_FOUND",
      "max": 0,
      "mean": 0,
      "median": 0,
      "min": 0,
      "pctRows": 0,
      "stdDev": 0
    }
  },
  "language": "string",
  "lowInformation": true,
  "lowerQuartile": "string",
  "max": "string",
  "mean": "string",
  "median": "string",
  "min": "string",
  "multilabelInsights": {
    "multilabelInsightsKey": "string"
  },
  "naCount": 0,
  "name": "string",
  "parentFeatureNames": [
    "string"
  ],
  "projectId": "string",
  "stdDev": "string",
  "targetLeakage": "FALSE",
  "targetLeakageReason": "string",
  "uniqueCount": 0,
  "upperQuartile": "string"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Descriptive information for feature.	ModelingFeatureResponse
404	Not Found	Feature does not exist.	None
422	Unprocessable Entity	Unable to process the request	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/models/{modelId}/imageEmbeddings/¶

Retrieve ImageEmbeddings for a feature of a model.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/imageEmbeddings/?featureName=string \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
featureName	query	string	true	Name of the feature to query
projectId	path	string	true	The project ID
modelId	path	string	true	The model ID

Example responses¶


{
  "embeddings": [
    {
      "actualTargetValue": "string",
      "imageId": "string",
      "positionX": 0,
      "positionY": 0,
      "prediction": {
        "labels": [
          "string"
        ],
        "values": [
          0
        ]
      }
    }
  ],
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Image Embeddings	EmbeddingsRetrieveResponse
422	Unprocessable Entity	Unable to process request.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/models/{modelId}/imageEmbeddings/¶

Request the computation of image embeddings for the specified model.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/models/{modelId}/imageEmbeddings/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
modelId	path	string	true	The model ID

Example responses¶


{
  "id": "string",
  "isBlocked": true,
  "jobType": "compute_image_embeddings",
  "message": "string",
  "modelId": "string",
  "projectId": "string",
  "status": "queue",
  "url": "string"
}

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Image embedding computation has been successfully requested	ImageEmbeddingsComputeResponse
422	Unprocessable Entity	Cannot compute image embeddings: if image embeddings were already computed for the model or there was another issue creating this job	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string	url	a url that can be polled to check the status of the job.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/relationshipQualityAssessments/¶

Submit a job to assess the quality of the relationship configuration within a Feature Discovery project.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/relationshipQualityAssessments/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "credentials": [
    {
      "catalogVersionId": "string",
      "credentialId": "string",
      "url": "string"
    }
  ],
  "datetimePartitionColumn": "string",
  "featureEngineeringPredictionPoint": "string",
  "relationshipsConfiguration": {
    "datasetDefinitions": [
      {
        "catalogId": "string",
        "catalogVersionId": "string",
        "featureListId": "string",
        "identifier": "string",
        "primaryTemporalKey": "string",
        "snapshotPolicy": "specified"
      }
    ],
    "featureDiscoveryMode": "default",
    "featureDiscoverySettings": [
      {
        "description": "string",
        "family": "string",
        "name": "string",
        "settingType": "string",
        "value": true,
        "verboseName": "string"
      }
    ],
    "id": "string",
    "relationships": [
      {
        "dataset1Identifier": "string",
        "dataset1Keys": [
          "string"
        ],
        "dataset2Identifier": "string",
        "dataset2Keys": [
          "string"
        ],
        "featureDerivationWindowEnd": 0,
        "featureDerivationWindowStart": 0,
        "featureDerivationWindowTimeUnit": "MILLISECOND",
        "featureDerivationWindows": [
          {
            "end": 0,
            "start": 0,
            "unit": "MILLISECOND"
          }
        ],
        "predictionPointRounding": 30,
        "predictionPointRoundingTimeUnit": "MILLISECOND"
      }
    ],
    "snowflakePushDownCompatible": true
  },
  "userId": "string"
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
body	body	RelationshipQualityAssessmentsCreate	false	none

Responses¶

Status	Meaning	Description	Schema
202	Accepted	Relationship quality assessment has successfully started. See the Location header.	None
422	Unprocessable Entity	Unable to process the request	None

Response Headers¶

Status	Header	Type	Format	Description
202	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/relationshipsConfiguration/¶

Retrieve relationships configuration for a project

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/relationshipsConfiguration/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
configId	query	string	false	Id of Secondary Dataset Configuration
projectId	path	string	true	The project ID

Example responses¶


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "dataSource": {
        "catalog": "string",
        "dataSourceId": "string",
        "dataStoreId": "string",
        "dataStoreName": "string",
        "dbtable": "string",
        "schema": "string",
        "url": "string"
      },
      "dataSources": [
        {
          "catalog": "string",
          "dataSourceId": "string",
          "dataStoreId": "string",
          "dataStoreName": "string",
          "dbtable": "string",
          "schema": "string",
          "url": "string"
        }
      ],
      "featureListId": "string",
      "featureLists": [
        "string"
      ],
      "identifier": "string",
      "isDeleted": true,
      "originalIdentifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "description": "string",
      "family": "string",
      "name": "string",
      "settingType": "string",
      "value": true,
      "verboseName": "string"
    }
  ],
  "id": "string",
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND"
    }
  ],
  "snowflakePushDownCompatible": true
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Project relationships configuration.	RelationshipsConfigResponse
404	Not Found	Data was not found.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/secondaryDatasetsConfigurations/¶

List all secondary dataset configurations for a project, optionally filtered by feature list id.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/secondaryDatasetsConfigurations/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
featurelistId	query	string	false	feature list ID of the model
modelId	query	string	false	ID of the model
offset	query	integer	false	This many results will be skipped.
limit	query	integer	false	At most this many results are returned.
includeDeleted	query	string	false	Include deleted records.
projectId	path	string	true	The project ID

Enumerated Values¶

Parameter	Value
includeDeleted	[`false`, `False`, `true`, `True`]

Example responses¶


{
  "count": 0,
  "data": [
    {
      "config": [
        {
          "featureEngineeringGraphId": "string",
          "secondaryDatasets": [
            {
              "catalogId": "string",
              "catalogVersionId": "string",
              "identifier": "string",
              "snapshotPolicy": "specified"
            }
          ]
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "creatorFullName": "string",
      "creatorUserId": "string",
      "credentialIds": [
        {
          "catalogVersionId": "string",
          "credentialId": "string",
          "url": "string"
        }
      ],
      "featurelistId": "string",
      "id": "string",
      "isDefault": true,
      "name": "string",
      "projectId": "string",
      "projectVersion": "string",
      "secondaryDatasets": [
        {
          "catalogId": "string",
          "catalogVersionId": "string",
          "identifier": "string",
          "requiredFeatures": [
            "string"
          ],
          "snapshotPolicy": "specified"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Responses¶

Status	Meaning	Description	Schema
200	OK	List of secondary dataset configurations.	SecondaryDatasetConfigListResponse
404	Not Found	Data is not found.	None
422	Unprocessable Entity	Unable to process the request	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/secondaryDatasetsConfigurations/¶

Create secondary dataset configurations for a project.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/secondaryDatasetsConfigurations/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "config": [
    {
      "featureEngineeringGraphId": "string",
      "secondaryDatasets": [
        {
          "catalogId": "string",
          "catalogVersionId": "string",
          "identifier": "string",
          "snapshotPolicy": "specified"
        }
      ]
    }
  ],
  "featurelistId": "string",
  "modelId": "string",
  "name": "string",
  "save": true,
  "secondaryDatasets": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "identifier": "string",
      "snapshotPolicy": "specified"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID
body	body	SecondaryDatasetCreate	false	none

Responses¶

Status	Meaning	Description	Schema
200	OK	Secondary dataset configuration created with allowable type mismatches	None
201	Created	Secondary dataset configuration created with no errors.	None
204	No Content	Validation of secondary dataset configuration is successful	None
422	Unprocessable Entity	Validation of secondary dataset configuration failed.	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/projects/{projectId}/secondaryDatasetsConfigurations/{secondaryDatasetConfigId}/¶

Soft deletes a secondary dataset configuration.

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/projects/{projectId}/secondaryDatasetsConfigurations/{secondaryDatasetConfigId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID.
secondaryDatasetConfigId	path	string	true	Secondary dataset configuration ID

Responses¶

Status	Meaning	Description	Schema
204	No Content	Secondary dataset configuration successfully soft deleted.	None
404	Not Found	Data is not found.	None
409	Conflict	Dataset has already been deleted	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/secondaryDatasetsConfigurations/{secondaryDatasetConfigId}/¶

Retrieve secondary dataset configuration by ID.

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/secondaryDatasetsConfigurations/{secondaryDatasetConfigId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID.
secondaryDatasetConfigId	path	string	true	Secondary dataset configuration ID

Example responses¶


{
  "config": [
    {
      "featureEngineeringGraphId": "string",
      "secondaryDatasets": [
        {
          "catalogId": "string",
          "catalogVersionId": "string",
          "identifier": "string",
          "snapshotPolicy": "specified"
        }
      ]
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "creatorFullName": "string",
  "creatorUserId": "string",
  "credentialIds": [
    {
      "catalogVersionId": "string",
      "credentialId": "string",
      "url": "string"
    }
  ],
  "featurelistId": "string",
  "id": "string",
  "isDefault": true,
  "name": "string",
  "projectId": "string",
  "projectVersion": "string",
  "secondaryDatasets": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "identifier": "string",
      "requiredFeatures": [
        "string"
      ],
      "snapshotPolicy": "specified"
    }
  ]
}

Responses¶

Status	Meaning	Description	Schema
200	OK	Secondary dataset configuration.	ProjectSecondaryDatasetConfigResponse
404	Not Found	Data is not found.	None
422	Unprocessable Entity	Unable to process the request	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/timeSeriesFeatureLog/¶

Retrieve the feature derivation log content and log length for a time series project as JSON.

The Time Series Feature Log provides details about the feature generation process for a time series project. It includes information about which features are generated and their priority,as well as the detected properties of the time series data such as whether the series is stationary, and periodicities detected.

This route is only supported for time series projects that have finished partitioning.

The feature derivation log will include information about:

Detected stationarity of the series, e.g., Series detected as non-stationary
Detected presence of multiplicative trend in the series, e.g., Multiplicative trend detected
Detected periodicities in the series, e.g., Detected periodicities: 7 day
Maximum number of feature to be generated, e.g., Maximum number of feature to be generated is 1440
Window sizes used in rolling statistics / lag extractors, e.g., The window sizes chosen to be: 2 months
Features that are specified as known-in-advance, e.g., Variables treated as apriori: holiday
Details about features generated as timeseries features, and their priority, e.g., Generating feature "date (actual)" from "date" (priority: 1)
Details about why certain variables are transformed in the input data, e.g., Generating variable "y (log)" from "y" because multiplicative trend is detected

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/timeSeriesFeatureLog/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
offset	query	integer	false	Number of results to skip.
limit	query	integer	false	At most this many results are returned. The default may change without notice.
projectId	path	string	true	The project ID

Example responses¶


{
  "count": 0,
  "featureLog": "string",
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalLogLines": 0
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	TimeSeriesFeatureLogListControllerResponse

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/projects/{projectId}/timeSeriesFeatureLog/file/¶

Retrieve a text file containing the time series project feature log.

The Time Series Feature Log provides details about the feature generation process for a time series project. It includes information about which features are generated and their priority,as well as the detected properties of the time series data such as whether the series is stationary, and periodicities detected.

This route is only supported for time series projects that have finished partitioning.

The feature derivation log will include information about:

Maximum number of feature to be generated, e.g., Limit on the maximum number of feature in this project is 500
Number of derived features tested during the feature generation process, e.g., Total number of derived features during the feature generation process is 571
Number of generated features removed during the feature reduction process e.g. Total number of features removed during the feature reduction process is 472
Number of remaining features after the combined feature generation and reduction process, e.g., The finalized number of features is 99
Detected stationarity of the series, e.g., Series detected as non-stationary
Detected presence of multiplicative trend in the series, e.g., Multiplicative trend detected
Detected periodicities in the series, e.g., Detected periodicities: 7 day
Window sizes used in rolling statistics / lag extractors, e.g., The window sizes chosen to be: 2 months (because the time step is 1 month and Feature Derivation Window is 2 months)
Features that are specified as known-in-advance, e.g., Variables treated as apriori: holiday
Details about why certain variables are transformed in the input data, e.g., Generating variable "y (log)" from "y" because multiplicative trend is detected
Details about features generated as time series features, and their priority, e.g., Generating feature "date (actual)" from "date" (priority: 1)

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/projects/{projectId}/timeSeriesFeatureLog/file/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project ID

Responses¶

Status	Meaning	Description	Schema
200	OK	none	None

Response Headers¶

Status	Header	Type	Format	Description
200	Content-Disposition	string		`attachment;filename=<filename>.txt` The suggested filename is dynamically generated
200	Content-Type	string		MIME type of the returned data

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/projects/{projectId}/typeTransformFeatures/¶

Create a new feature by changing the type of an existing one.

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/projects/{projectId}/typeTransformFeatures/ \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "dateExtraction": "year",
  "name": "string",
  "parentName": "string",
  "replacement": "string",
  "variableType": "text"
}

Parameters

Name	In	Type	Required	Description
projectId	path	string	true	The project to create the feature in.
body	body	FeatureTransform	false	none

Responses¶

Status	Meaning	Description	Schema
200	OK	Creation has successfully started. See the Location header.	None
422	Unprocessable Entity	Unable to process the request	None

Response Headers¶

Status	Header	Type	Format	Description
200	Location	string		A url that can be polled to check the status.

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

POST /api/v2/relationshipsConfigurations/¶

Create a relationships configuration

Code samples¶


curl -X POST https://app.datarobot.com/api/v2/relationshipsConfigurations/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{RelationshipsConfigCreate}'

Body parameter¶


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "featureListId": "string",
      "identifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "name": "string",
      "value": true
    }
  ],
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
body	body	RelationshipsConfigCreate	false	none

Example responses¶


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "dataSource": {
        "catalog": "string",
        "dataSourceId": "string",
        "dataStoreId": "string",
        "dataStoreName": "string",
        "dbtable": "string",
        "schema": "string",
        "url": "string"
      },
      "dataSources": [
        {
          "catalog": "string",
          "dataSourceId": "string",
          "dataStoreId": "string",
          "dataStoreName": "string",
          "dbtable": "string",
          "schema": "string",
          "url": "string"
        }
      ],
      "featureListId": "string",
      "featureLists": [
        "string"
      ],
      "identifier": "string",
      "isDeleted": true,
      "originalIdentifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "description": "string",
      "family": "string",
      "name": "string",
      "settingType": "string",
      "value": true,
      "verboseName": "string"
    }
  ],
  "id": "string",
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND"
    }
  ],
  "snowflakePushDownCompatible": true
}

Responses¶

Status	Meaning	Description	Schema
201	Created	none	RelationshipsConfigResponse
422	Unprocessable Entity	User input fails validation	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

DELETE /api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/¶

Delete a relationships configuration

Code samples¶


curl -X DELETE https://app.datarobot.com/api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/ \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
relationshipsConfigurationId	path	string	true	Id of the relationships configuration to delete

Responses¶

Status	Meaning	Description	Schema
204	No Content	none	None
404	Not Found	Relationships configuration not found	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/¶

Retrieve a relationships configuration

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
includeRelationshipQuality	query	string	false	Flag indicating whether or not to include relationship quality information in the returned result
relationshipsConfigurationId	path	string	true	Id of the relationships configuration to delete

Enumerated Values¶

Parameter	Value
includeRelationshipQuality	[`false`, `False`, `true`, `True`]

Example responses¶


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "dataSource": {
        "catalog": "string",
        "dataSourceId": "string",
        "dataStoreId": "string",
        "dataStoreName": "string",
        "dbtable": "string",
        "schema": "string",
        "url": "string"
      },
      "dataSources": [
        {
          "catalog": "string",
          "dataSourceId": "string",
          "dataStoreId": "string",
          "dataStoreName": "string",
          "dbtable": "string",
          "schema": "string",
          "url": "string"
        }
      ],
      "featureListId": "string",
      "featureLists": [
        "string"
      ],
      "identifier": "string",
      "isDeleted": true,
      "originalIdentifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "description": "string",
      "family": "string",
      "name": "string",
      "settingType": "string",
      "value": true,
      "verboseName": "string"
    }
  ],
  "id": "string",
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND",
      "relationshipQuality": {
        "detailedReport": [
          {
            "enrichmentRate": {
              "action": "string",
              "category": "green",
              "message": "string"
            },
            "enrichmentRateValue": 0,
            "featureDerivationWindow": "string",
            "mostRecentData": {
              "action": "string",
              "category": "green",
              "message": "string"
            },
            "overallCategory": "green",
            "windowSettings": {
              "action": "string",
              "category": "green",
              "message": "string"
            }
          }
        ],
        "lastUpdated": "2019-08-24T14:15:22Z",
        "problemCount": 0,
        "samplingFraction": 0,
        "status": "Complete",
        "statusId": [
          "string"
        ],
        "summaryCategory": "green",
        "summaryMessage": "string"
      }
    }
  ],
  "snowflakePushDownCompatible": true
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	ExtendedRelationshipsConfigRetrieve
404	Not Found	Relationships configuration cannot be found	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

PUT /api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/¶

Replace a relationships configuration

Code samples¶


curl -X PUT https://app.datarobot.com/api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/ \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
  -d '{undefined}'

Body parameter¶


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "featureListId": "string",
      "identifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "name": "string",
      "value": true
    }
  ],
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND"
    }
  ]
}

Parameters

Name	In	Type	Required	Description
relationshipsConfigurationId	path	string	true	Id of the relationships configuration to delete
body	body	RelationshipsConfigCreate	false	none

Example responses¶


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "dataSource": {
        "catalog": "string",
        "dataSourceId": "string",
        "dataStoreId": "string",
        "dataStoreName": "string",
        "dbtable": "string",
        "schema": "string",
        "url": "string"
      },
      "dataSources": [
        {
          "catalog": "string",
          "dataSourceId": "string",
          "dataStoreId": "string",
          "dataStoreName": "string",
          "dbtable": "string",
          "schema": "string",
          "url": "string"
        }
      ],
      "featureListId": "string",
      "featureLists": [
        "string"
      ],
      "identifier": "string",
      "isDeleted": true,
      "originalIdentifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "description": "string",
      "family": "string",
      "name": "string",
      "settingType": "string",
      "value": true,
      "verboseName": "string"
    }
  ],
  "id": "string",
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND"
    }
  ],
  "snowflakePushDownCompatible": true
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	RelationshipsConfigResponse
422	Unprocessable Entity	User input fails validation	None

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

GET /api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/projects/{projectId}/¶

Retrieve the relationships configuration with extended information

Code samples¶


curl -X GET https://app.datarobot.com/api/v2/relationshipsConfigurations/{relationshipsConfigurationId}/projects/{projectId}/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Parameters

Name	In	Type	Required	Description
includeRelationshipQuality	query	string	false	Flag indicating whether or not to include relationship quality information in the returned result
projectId	path	string	true	The project ID
relationshipsConfigurationId	path	string	true	The relationships configuration ID

Enumerated Values¶

Parameter	Value
includeRelationshipQuality	[`false`, `False`, `true`, `True`]

Example responses¶


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "dataSource": {
        "catalog": "string",
        "dataSourceId": "string",
        "dataStoreId": "string",
        "dataStoreName": "string",
        "dbtable": "string",
        "schema": "string",
        "url": "string"
      },
      "dataSources": [
        {
          "catalog": "string",
          "dataSourceId": "string",
          "dataStoreId": "string",
          "dataStoreName": "string",
          "dbtable": "string",
          "schema": "string",
          "url": "string"
        }
      ],
      "featureListId": "string",
      "featureLists": [
        "string"
      ],
      "identifier": "string",
      "isDeleted": true,
      "originalIdentifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "description": "string",
      "family": "string",
      "name": "string",
      "settingType": "string",
      "value": true,
      "verboseName": "string"
    }
  ],
  "id": "string",
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND",
      "relationshipQuality": {
        "detailedReport": [
          {
            "enrichmentRate": {
              "action": "string",
              "category": "green",
              "message": "string"
            },
            "enrichmentRateValue": 0,
            "featureDerivationWindow": "string",
            "mostRecentData": {
              "action": "string",
              "category": "green",
              "message": "string"
            },
            "overallCategory": "green",
            "windowSettings": {
              "action": "string",
              "category": "green",
              "message": "string"
            }
          }
        ],
        "lastUpdated": "2019-08-24T14:15:22Z",
        "problemCount": 0,
        "samplingFraction": 0,
        "status": "Complete",
        "statusId": [
          "string"
        ],
        "summaryCategory": "green",
        "summaryMessage": "string"
      }
    }
  ],
  "snowflakePushDownCompatible": true
}

Responses¶

Status	Meaning	Description	Schema
200	OK	none	ExtendedRelationshipsConfigRetrieve

To perform this operation, you must be authenticated by means of one of the following methods:

BearerAuth

Schemas¶

AssessmentNewFormat


{
  "enrichmentRate": {
    "action": "string",
    "category": "green",
    "message": "string"
  },
  "enrichmentRateValue": 0,
  "featureDerivationWindow": "string",
  "mostRecentData": {
    "action": "string",
    "category": "green",
    "message": "string"
  },
  "overallCategory": "green",
  "windowSettings": {
    "action": "string",
    "category": "green",
    "message": "string"
  }
}

Properties¶

Name	Type	Required	Description
enrichmentRate	Warnings	true	Warning about the enrichment rate
enrichmentRateValue	number	true	Percentage of primary table records that can be enriched with a record in this dataset
featureDerivationWindow	string,null	false	Feature derivation window.
mostRecentData	Warnings	false	Warning about the enrichment rate
overallCategory	string	true	Class of the relationship quality
windowSettings	Warnings	false	Warning about the enrichment rate

Enumerated Values¶

Property	Value
overallCategory	[`green`, `yellow`]

BatchFeatureTransform


{
  "parentNames": [
    "string"
  ],
  "prefix": "string",
  "suffix": "string",
  "variableType": "text"
}

Properties¶

Name	Type	Required	Restrictions	Description
parentNames	[string]	true	maxItems: 500 minItems: 1	List of feature names that will be transformed into a new variable type.
prefix	string	false	maxLength: 500	The string that will preface all feature names. Optional if suffix is present. (One or both are required.)
suffix	string	false	maxLength: 500	The string that will be appended at the end to all feature names. Optional if prefix is present. (One or both are required.)
variableType	string	true		The type of the new feature. Must be one of `text`, `categorical` (Deprecated in version v2.21), `numeric`, or `categoricalInt`.

Enumerated Values¶

Property	Value
variableType	[`text`, `categorical`, `numeric`, `categoricalInt`]

BatchFeatureTransformRetrieveResponse


{
  "failures": {},
  "newFeatureNames": [
    "string"
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
failures	object	true		An object keyed by original feature names, the values are strings indicating why the transformation failed.
newFeatureNames	[string]	true		List of new feature names.

CalendarAccessControlListResponse


{
  "count": 0,
  "data": [
    {
      "canShare": true,
      "role": "ADMIN",
      "userId": "string",
      "username": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true	minimum: 0	The number of items returned on this page.
data	[CalendarUserRoleRecordResponse]	true		Records of users and their roles on the calendar.
next	string,null	true		A URL pointing to the next page (if `null`, there is no next page).
previous	string,null	true		A URL pointing to the previous page (if `null`, there is no previous page).

CalendarAccessControlUpdate


{
  "users": [
    {
      "role": "ADMIN",
      "username": "string"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
users	[CalendarUsernameRole]	true	maxItems: 100	The list of users and their updated roles used to modify the access for this calendar.

CalendarEvent


{
  "date": "2019-08-24T14:15:22Z",
  "name": "string",
  "seriesId": "string"
}

Properties¶

Name	Type	Required	Description
date	string(date-time)	true	The date of the calendar event.
name	string	true	Name of the calendar event.
seriesId	string,null	true	The series ID for the event. If this event does not specify a series ID, then this will be `null`, indicating that the event applies to all series.

CalendarEventsResponseQuery


{
  "count": 0,
  "data": [
    {
      "date": "2019-08-24T14:15:22Z",
      "name": "string",
      "seriesId": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true	minimum: 0	The number of items returned on this page.
data	[CalendarEvent]	true	maxItems: 1000	An array of calendar events
next	string,null	true		A URL pointing to the next page (if `null`, there is no next page).
previous	string,null	true		A URL pointing to the previous page (if `null`, there is no previous page).

CalendarFileUpload


{
  "file": "string",
  "multiseriesIdColumns": "string",
  "name": "string"
}

Properties¶

Name	Type	Required	Description
file	string(binary)	true	The calendar file used to create a calendar. The calendar file expect to meet the following criteria: Must be in a csv or xlsx format. Must have a header row. The names themselves in the header row can be anything. Must have a single date column, in YYYY-MM-DD format. May optionally have a name column as the second column. May optionally have one series ID column that states what series each event is applicable for. If present, the name of this column must be specified in the `multiseriesIdColumns` parameter.
multiseriesIdColumns	string	false	An array of multiseries ID column names for the calendar file. Currently only one multiseries ID column is supported. If not specified, the calendar is considered to be single series.
name	string	false	The name of the calendar file. If not provided, this will be set to the name of the provided file.

CalendarFromDataset


{
  "datasetId": "string",
  "datasetVersionId": "string",
  "deleteOnError": true,
  "multiseriesIdColumns": [
    "string"
  ],
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
datasetId	string	true		The ID of the dataset from which to create the calendar.
datasetVersionId	string	false		The ID of the dataset version from which to create the calendar.
deleteOnError	boolean	false		Whether delete calendar file from Catalog if it's not valid.
multiseriesIdColumns	[string]	false	maxItems: 1	Optional multiseries id columns for calendar.
name	string	false		Optional name for catalog.

CalendarListResponse


{
  "count": 0,
  "data": [
    {
      "created": "2019-08-24T14:15:22Z",
      "datetimeFormat": "%m/%d/%Y",
      "earliestEvent": "2019-08-24T14:15:22Z",
      "id": "string",
      "latestEvent": "2019-08-24T14:15:22Z",
      "multiseriesIdColumns": [
        "string"
      ],
      "name": "string",
      "numEventTypes": 0,
      "numEvents": 0,
      "projectId": [
        "string"
      ],
      "role": "ADMIN",
      "source": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true	minimum: 0	The number of items returned on this page.
data	[CalendarRecord]	true		An array of calendars, each in the form described under GET /api/v2/calendars/.
next	string,null	true		A URL pointing to the next page (if `null`, there is no next page).
previous	string,null	true		A URL pointing to the previous page (if `null`, there is no previous page).

CalendarNameUpdate


{
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true		The new name to assign to the calendar.

CalendarRecord


{
  "created": "2019-08-24T14:15:22Z",
  "datetimeFormat": "%m/%d/%Y",
  "earliestEvent": "2019-08-24T14:15:22Z",
  "id": "string",
  "latestEvent": "2019-08-24T14:15:22Z",
  "multiseriesIdColumns": [
    "string"
  ],
  "name": "string",
  "numEventTypes": 0,
  "numEvents": 0,
  "projectId": [
    "string"
  ],
  "role": "ADMIN",
  "source": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
created	string(date-time)	true		An ISO-8601 string with the time that this calendar was created.
datetimeFormat	string	true		The datetime format detected for the uploaded calendar file.
earliestEvent	string(date-time)	true		An ISO-8601 date string of the earliest event seen in this calendar.
id	string	true		The ID of this calendar.
latestEvent	string(date-time)	true		An ISO-8601 date string of the latest event seen in this calendar.
multiseriesIdColumns	[string]	true	maxItems: 1	An array of multiseries ID column names in this calendar file. Currently only one multiseries ID column is supported. Will be `null` if this calendar is single-series.
name	string	true		The name of this calendar. This will be the same as `source` if no name was specified when the calendar was created.
numEventTypes	integer	true		The number of distinct eventTypes in this calendar.
numEvents	integer	true		The number of dates that are marked as having an event in this calendar.
projectId	[string]	true		The project IDs of projects currently using this calendar.
role	string	true		The role the requesting user has on this calendar.
source	string	true		The name of the source file that was used to create this calendar.

Enumerated Values¶

Property Value

datetimeFormat [%m/%d/%Y, %m/%d/%y, %d/%m/%y, %m-%d-%Y, %m-%d-%y, %Y/%m/%d, %Y-%m-%d, %Y-%m-%d %H:%M:%S, %Y/%m/%d %H:%M:%S, %Y.%m.%d %H:%M:%S, %Y-%m-%d %H:%M, %Y/%m/%d %H:%M, %y/%m/%d, %y-%m-%d, %y-%m-%d %H:%M:%S, %y.%m.%d %H:%M:%S, %y/%m/%d %H:%M:%S, %y-%m-%d %H:%M, %y.%m.%d %H:%M, %y/%m/%d %H:%M, %m/%d/%Y %H:%M, %m/%d/%y %H:%M, %d/%m/%Y %H:%M, %d/%m/%y %H:%M, %m-%d-%Y %H:%M, %m-%d-%y %H:%M, %d-%m-%Y %H:%M, %d-%m-%y %H:%M, %m.%d.%Y %H:%M, %m/%d.%y %H:%M, %d.%m.%Y %H:%M, %d.%m.%y %H:%M, %m/%d/%Y %H:%M:%S, %m/%d/%y %H:%M:%S, %m-%d-%Y %H:%M:%S, %m-%d-%y %H:%M:%S, %m.%d.%Y %H:%M:%S, %m.%d.%y %H:%M:%S, %d/%m/%Y %H:%M:%S, %d/%m/%y %H:%M:%S, %Y-%m-%d %H:%M:%S.%f, %y-%m-%d %H:%M:%S.%f, %Y-%m-%dT%H:%M:%S.%fZ, %y-%m-%dT%H:%M:%S.%fZ, %Y-%m-%dT%H:%M:%S.%f, %y-%m-%dT%H:%M:%S.%f, %Y-%m-%dT%H:%M:%S, %y-%m-%dT%H:%M:%S, %Y-%m-%dT%H:%M:%SZ, %y-%m-%dT%H:%M:%SZ, %Y.%m.%d %H:%M:%S.%f, %y.%m.%d %H:%M:%S.%f, %Y.%m.%dT%H:%M:%S.%fZ, %y.%m.%dT%H:%M:%S.%fZ, %Y.%m.%dT%H:%M:%S.%f, %y.%m.%dT%H:%M:%S.%f, %Y.%m.%dT%H:%M:%S, %y.%m.%dT%H:%M:%S, %Y.%m.%dT%H:%M:%SZ, %y.%m.%dT%H:%M:%SZ, %Y%m%d, %m %d %Y %H %M %S, %m %d %y %H %M %S, %H:%M, %M:%S, %H:%M:%S, %Y %m %d %H %M %S, %y %m %d %H %M %S, %Y %m %d, %y %m %d, %d/%m/%Y, %Y-%d-%m, %y-%d-%m, %Y/%d/%m %H:%M:%S.%f, %Y/%d/%m %H:%M:%S.%fZ, %Y/%m/%d %H:%M:%S.%f, %Y/%m/%d %H:%M:%S.%fZ, %y/%d/%m %H:%M:%S.%f, %y/%d/%m %H:%M:%S.%fZ, %y/%m/%d %H:%M:%S.%f, %y/%m/%d %H:%M:%S.%fZ, %m.%d.%Y, %m.%d.%y, %d.%m.%y, %d.%m.%Y, %Y.%m.%d, %Y.%d.%m, %y.%m.%d, %y.%d.%m, %Y-%m-%d %I:%M:%S %p, %Y/%m/%d %I:%M:%S %p, %Y.%m.%d %I:%M:%S %p, %Y-%m-%d %I:%M %p, %Y/%m/%d %I:%M %p, %y-%m-%d %I:%M:%S %p, %y.%m.%d %I:%M:%S %p, %y/%m/%d %I:%M:%S %p, %y-%m-%d %I:%M %p, %y.%m.%d %I:%M %p, %y/%m/%d %I:%M %p, %m/%d/%Y %I:%M %p, %m/%d/%y %I:%M %p, %d/%m/%Y %I:%M %p, %d/%m/%y %I:%M %p, %m-%d-%Y %I:%M %p, %m-%d-%y %I:%M %p, %d-%m-%Y %I:%M %p, %d-%m-%y %I:%M %p, %m.%d.%Y %I:%M %p, %m/%d.%y %I:%M %p, %d.%m.%Y %I:%M %p, %d.%m.%y %I:%M %p, %m/%d/%Y %I:%M:%S %p, %m/%d/%y %I:%M:%S %p, %m-%d-%Y %I:%M:%S %p, %m-%d-%y %I:%M:%S %p, %m.%d.%Y %I:%M:%S %p, %m.%d.%y %I:%M:%S %p, %d/%m/%Y %I:%M:%S %p, %d/%m/%y %I:%M:%S %p, %Y-%m-%d %I:%M:%S.%f %p, %y-%m-%d %I:%M:%S.%f %p, %Y-%m-%dT%I:%M:%S.%fZ %p, %y-%m-%dT%I:%M:%S.%fZ %p, %Y-%m-%dT%I:%M:%S.%f %p, %y-%m-%dT%I:%M:%S.%f %p, %Y-%m-%dT%I:%M:%S %p, %y-%m-%dT%I:%M:%S %p, %Y-%m-%dT%I:%M:%SZ %p, %y-%m-%dT%I:%M:%SZ %p, %Y.%m.%d %I:%M:%S.%f %p, %y.%m.%d %I:%M:%S.%f %p, %Y.%m.%dT%I:%M:%S.%fZ %p, %y.%m.%dT%I:%M:%S.%fZ %p, %Y.%m.%dT%I:%M:%S.%f %p, %y.%m.%dT%I:%M:%S.%f %p, %Y.%m.%dT%I:%M:%S %p, %y.%m.%dT%I:%M:%S %p, %Y.%m.%dT%I:%M:%SZ %p, %y.%m.%dT%I:%M:%SZ %p, %m %d %Y %I %M %S %p, %m %d %y %I %M %S %p, %I:%M %p, %I:%M:%S %p, %Y %m %d %I %M %S %p, %y %m %d %I %M %S %p, %Y/%d/%m %I:%M:%S.%f %p, %Y/%d/%m %I:%M:%S.%fZ %p, %Y/%m/%d %I:%M:%S.%f %p, %Y/%m/%d %I:%M:%S.%fZ %p, %y/%d/%m %I:%M:%S.%f %p, %y/%d/%m %I:%M:%S.%fZ %p, %y/%m/%d %I:%M:%S.%f %p, %y/%m/%d %I:%M:%S.%fZ %p]

role [ADMIN, CONSUMER, DATA_SCIENTIST, EDITOR, OBSERVER, OWNER, READ_ONLY, READ_WRITE, USER]

CalendarUserRoleRecordResponse


{
  "canShare": true,
  "role": "ADMIN",
  "userId": "string",
  "username": "string"
}

Properties¶

Name	Type	Required	Description
canShare	boolean	true	Whether this user can share this calendar with other users.
role	string	true	The role of the user on this calendar.
userId	string	true	The ID of the user.
username	string	true	The username of a user with access to this calendar.

Enumerated Values¶

Property	Value
role	[`ADMIN`, `CONSUMER`, `DATA_SCIENTIST`, `EDITOR`, `OBSERVER`, `OWNER`, `READ_ONLY`, `READ_WRITE`, `USER`]

CalendarUsernameRole


{
  "role": "ADMIN",
  "username": "string"
}

Each item in users refers to the username record and its newly assigned role.

Properties¶

Name	Type	Required	Restrictions	Description
role	string,null	true		The new role to assign to the specified user.
username	string	true		The username of the user to modify access for.

Enumerated Values¶

Property	Value
role	[`ADMIN`, `CONSUMER`, `DATA_SCIENTIST`, `EDITOR`, `OBSERVER`, `OWNER`, `READ_ONLY`, `READ_WRITE`, `USER`]

CatalogPasswordCredentials


{
  "catalogVersionId": "string",
  "password": "string",
  "url": "string",
  "user": "string"
}

Properties¶

Name	Type	Required	Description
catalogVersionId	string	false	Identifier of the catalog version
password	string	true	The password (in cleartext) for database authentication. The password will be encrypted on the server side as part of the HTTP request and never saved or stored.
url	string	false	URL that is subject to credentials.
user	string	true	The username for database authentication.

CreateFeaturelist


{
  "features": [
    "string"
  ],
  "name": "string",
  "skipDatetimePartitionColumn": false
}

Properties¶

Name	Type	Required	Restrictions	Description
features	[string]	true	minItems: 1	List of features for new featurelist.
name	string	true	maxLength: 100	New featurelist name.
skipDatetimePartitionColumn	boolean	false		Whether featurelist should contain datetime partition column.

CreatedCalendarDatasetResponse


{
  "statusId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
statusId	string	true		ID that can be used with GET /api/v2/status/ to poll for the testing job's status.

CrossSeriesGroupByColumnValidatePayload


{
  "crossSeriesGroupByColumns": [
    "string"
  ],
  "datetimePartitionColumn": "string",
  "multiseriesIdColumn": "string",
  "userDefinedSegmentIdColumn": "string"
}

Properties¶

Name	Type	Required	Description
crossSeriesGroupByColumns	[string]	false	If specified, these columns will be validated for usage as the group-by column for creating cross-series features. If not present, then all columns from the dataset will be validated and only the eligible ones returned. To be valid, a column should be categorical or numerical (but not float), not be the series ID or equivalent to the series ID, not split any series, and not consist of only one value.
datetimePartitionColumn	string	true	The name of the column that will be used as the datetime partitioning column.
multiseriesIdColumn	string	true	The name of the column that wil be used as the multiseries ID column for this project.
userDefinedSegmentIdColumn	string	false	The name of the column that wil be used as the user defined segment ID column for this project.

CrossSeriesGroupByColumnValidateResponse


{
  "message": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
message	string	true		An extended message about the result. For example, if a job is submitted that is a duplicate of a job that has already been added to the queue, the message will mention that no new job was created.

DataSource


{
  "catalog": "string",
  "dataSourceId": "string",
  "dataStoreId": "string",
  "dataStoreName": "string",
  "dbtable": "string",
  "schema": "string",
  "url": "string"
}

Data source details for a JDBC dataset

Properties¶

Name	Type	Required	Description
catalog	string,null	false	Catalog name of the data source.
dataSourceId	string	false	ID of the data source.
dataStoreId	string	true	ID of the data store.
dataStoreName	string	true	Name of the data store.
dbtable	string	true	Table name of the data source.
schema	string,null	true	Schema name of the data source.
url	string	true	URL of the data store.

DatasetDefinition


{
  "catalogId": "string",
  "catalogVersionId": "string",
  "featureListId": "string",
  "identifier": "string",
  "primaryTemporalKey": "string",
  "snapshotPolicy": "specified"
}

Properties¶

Name	Type	Required	Restrictions	Description
catalogId	string	true		ID of the catalog item.
catalogVersionId	string	true		ID of the catalog item version.
featureListId	string,null	false		ID of the feature list. This decides which columns in the dataset are used for feature generation.
identifier	string	true	maxLength: 20 minLength: 1 minLength: 1	Short name of the dataset (used directly as part of the generated feature names).
primaryTemporalKey	string,null	false		Name of the column indicating time of record creation.
snapshotPolicy	string	false		Policy for using dataset snapshots when creating a project or making predictions. Must be one of the following values: 'specified': Use specific snapshot specified by catalogVersionId. 'latest': Use latest snapshot from the same catalog item. 'dynamic': Get data from the source (only applicable for JDBC datasets).

Enumerated Values¶

Property	Value
snapshotPolicy	[`specified`, `latest`, `dynamic`]

DatasetDefinitionResponse


{
  "catalogId": "string",
  "catalogVersionId": "string",
  "dataSource": {
    "catalog": "string",
    "dataSourceId": "string",
    "dataStoreId": "string",
    "dataStoreName": "string",
    "dbtable": "string",
    "schema": "string",
    "url": "string"
  },
  "dataSources": [
    {
      "catalog": "string",
      "dataSourceId": "string",
      "dataStoreId": "string",
      "dataStoreName": "string",
      "dbtable": "string",
      "schema": "string",
      "url": "string"
    }
  ],
  "featureListId": "string",
  "featureLists": [
    "string"
  ],
  "identifier": "string",
  "isDeleted": true,
  "originalIdentifier": "string",
  "primaryTemporalKey": "string",
  "snapshotPolicy": "specified"
}

Properties¶

Name	Type	Required	Restrictions	Description
catalogId	string,null	true		ID of the catalog item.
catalogVersionId	string	true		ID of the catalog item version.
dataSource	DataSource	false		Data source details for a JDBC dataset
dataSources	[DataSource]	false		Data source details for a JDBC dataset
featureListId	string	true		ID of the feature list. This decides which columns in the dataset are used for feature generation.
featureLists	[string]	false		List of available feature list ids for the dataset
identifier	string	true	maxLength: 20 minLength: 1 minLength: 1	Short name of the dataset (used directly as part of the generated feature names).
isDeleted	boolean,null	false		Is this dataset deleted?
originalIdentifier	string,null	false	maxLength: 20 minLength: 1 minLength: 1	Original identifier of the dataset if it was updated to resolve name conflicts.
primaryTemporalKey	string,null	false		Name of the column indicating time of record creation.
snapshotPolicy	string	true		Policy for using dataset snapshots when creating a project or making predictions. Must be one of the following values: 'specified': Use specific snapshot specified by catalogVersionId. 'latest': Use latest snapshot from the same catalog item. 'dynamic': Get data from the source (only applicable for JDBC datasets).

Enumerated Values¶

Property	Value
snapshotPolicy	[`specified`, `latest`, `dynamic`]

DatasetsCredential


{
  "catalogVersionId": "string",
  "credentialId": "string",
  "url": "string"
}

Properties¶

Name	Type	Required	Description
catalogVersionId	string	true	ID of the catalog version
credentialId	string	true	ID of the credential store to be used for the given catalog version
url	string,null	false	The URL of the datasource

DiscardedFeaturesResponse


{
  "count": 0,
  "features": [
    "string"
  ],
  "remainingRestoreLimit": 0,
  "totalRestoreLimit": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true	minimum: 0	Discarded features count.
features	[string]	true		Discarded features.
remainingRestoreLimit	integer	true	minimum: 0	The remaining available number of the features which can be restored in this project.
totalRestoreLimit	integer	true	minimum: 0	The total limit indicating how many features can be restored in this project.

DocumentTextExtractionDocumentElement


{
  "actualTargetValue": "string",
  "documentIndex": 0,
  "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
  "featureName": "string",
  "prediction": {
    "labels": [
      "string"
    ],
    "values": [
      0
    ]
  },
  "thumbnailHeight": 0,
  "thumbnailId": "string",
  "thumbnailLink": "http://example.com",
  "thumbnailWidth": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
actualTargetValue	any	true		Actual target value of the dataset row

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false		none

continued

Name	Type	Required	Description
documentIndex	integer	true	The index of the document within the dataset.
documentTask	string	true	The document task this document belongs to.
featureName	string	true	The name of the feature.
prediction	InsightsPredictionField	true	Object that describes prediction value of the dataset row.
thumbnailHeight	integer	true	The height of the thumbnail in pixels.
thumbnailId	string	true	The document page ID of the thumbnail.
thumbnailLink	string(uri)	true	The URL of the thumbnail image.
thumbnailWidth	integer	true	The width of the thumbnail in pixels.

Enumerated Values¶

Property	Value
documentTask	[`DOCUMENT_TEXT_EXTRACTOR`, `TESSERACT_OCR`]

DocumentTextExtractionPagesElement


{
  "actualTargetValue": "string",
  "documentIndex": 0,
  "documentPageHeight": 0,
  "documentPageId": "string",
  "documentPageLink": "http://example.com",
  "documentPageWidth": 0,
  "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
  "featureName": "string",
  "pageIndex": 0,
  "prediction": {
    "labels": [
      "string"
    ],
    "values": [
      0
    ]
  },
  "textLines": [
    {
      "bottom": 0,
      "left": 0,
      "right": 0,
      "text": "string",
      "top": 0
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
actualTargetValue	any	true		Actual target value of the dataset row

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false		none

continued

Name	Type	Required	Description
documentIndex	integer	true	The index of the document within the dataset.
documentPageHeight	integer	true	The height of the thumbnail in pixels.
documentPageId	string	true	The document page ID of the thumbnail.
documentPageLink	string(uri)	true	The URL of the thumbnail image.
documentPageWidth	integer	true	The width of the thumbnail in pixels.
documentTask	string	true	The document task that this page belongs to.
featureName	string	true	The name of the feature.
pageIndex	integer	true	The index of this page within the document
prediction	InsightsPredictionField	true	Object that describes prediction value of the dataset row.
textLines	[TextLine]	true	The recognized text lines of this document page with bounding box coordinates for each text line.

Enumerated Values¶

Property	Value
documentTask	[`DOCUMENT_TEXT_EXTRACTOR`, `TESSERACT_OCR`]

DocumentTextExtractionSampleMetadataElement


{
  "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
  "featureName": "string",
  "modelId": "string"
}

Properties¶

Name	Type	Required	Description
documentTask	string	true	The document task that this data belongs to.
featureName	string	true	Name of feature
modelId	string	true	The model ID of the target model.

Enumerated Values¶

Property	Value
documentTask	[`DOCUMENT_TEXT_EXTRACTOR`, `TESSERACT_OCR`]

DocumentTextExtractionSamplesComputeResponse


{
  "id": "string",
  "isBlocked": true,
  "jobType": "compute_document_text_extraction_samples",
  "message": "string",
  "modelId": "string",
  "projectId": "string",
  "status": "queue",
  "url": "string"
}

Properties¶

Name	Type	Required	Description
id	string	true	The job ID.
isBlocked	boolean	true	True if the job is waiting for its dependencies to be resolved first.
jobType	string	true	The type of the job.
message	string	true	Error message in case of failure.
modelId	string	true	The model ID of the target model.
projectId	string	true	The project the job belongs to.
status	string	true	The job status.
url	string	true	A URL that can be used to request details about the job.

Enumerated Values¶

Property	Value
jobType	`compute_document_text_extraction_samples`
status	[`queue`, `inprogress`, `error`, `ABORTED`, `COMPLETED`]

DocumentTextExtractionSamplesListMetadataResponse


{
  "count": 0,
  "data": [
    {
      "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
      "featureName": "string",
      "modelId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[DocumentTextExtractionSampleMetadataElement]	true	A list of Model ID feature name pairs with computed document text extraction samples.
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

DocumentTextExtractionSamplesRetrieveDocumentsResponse


{
  "count": 0,
  "data": [
    {
      "actualTargetValue": "string",
      "documentIndex": 0,
      "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
      "featureName": "string",
      "prediction": {
        "labels": [
          "string"
        ],
        "values": [
          0
        ]
      },
      "thumbnailHeight": 0,
      "thumbnailId": "string",
      "thumbnailLink": "http://example.com",
      "thumbnailWidth": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ],
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[DocumentTextExtractionDocumentElement]	true	A list of documents.
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
targetBins	[TargetBin]	true	List of bin objects for regression or null
targetValues	[string]	true	List of target values for classification or null
totalCount	integer	true	The total number of items across all pages.

DocumentTextExtractionSamplesRetrievePagesResponse


{
  "count": 0,
  "data": [
    {
      "actualTargetValue": "string",
      "documentIndex": 0,
      "documentPageHeight": 0,
      "documentPageId": "string",
      "documentPageLink": "http://example.com",
      "documentPageWidth": 0,
      "documentTask": "DOCUMENT_TEXT_EXTRACTOR",
      "featureName": "string",
      "pageIndex": 0,
      "prediction": {
        "labels": [
          "string"
        ],
        "values": [
          0
        ]
      },
      "textLines": [
        {
          "bottom": 0,
          "left": 0,
          "right": 0,
          "text": "string",
          "top": 0
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ],
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[DocumentTextExtractionPagesElement]	true	List of document pages
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
targetBins	[TargetBin]	true	List of bin objects for regression or null
targetValues	[string]	true	List of target values for classification or null
totalCount	integer	true	The total number of items across all pages.

DocumentThumbnailBinsListResponse


{
  "count": 0,
  "data": [
    {
      "documentPageId": "string",
      "height": 0,
      "targetBinEnd": 0,
      "targetBinRowCount": 0,
      "targetBinStart": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[DocumentThumbnailMetadataWithBins]	true	List of document thumbnail metadata, as described below
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

DocumentThumbnailMetadataListResponse


{
  "count": 0,
  "data": [
    {
      "documentPageId": "string",
      "height": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[DocumentThumbnailMetadataResponse]	true	A list of document thumbnail metadata elements
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

DocumentThumbnailMetadataResponse


{
  "documentPageId": "string",
  "height": 0,
  "targetValue": 0,
  "width": 0
}

Properties¶

Name	Type	Required	Description
documentPageId	string	true	The ID of the document page. The actual document page can be retrieved with GET /api/v2/projects/{projectId}/documentPages/{documentPageId}/file/.
height	integer	true	The height of the document page in pixels.
targetValue	any	false	Target value

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	number	false		For regression projects

xor

Name	Type	Required	Restrictions	Description
» anonymous	string	false		For classification projects

xor

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false		none

continued

Name	Type	Required	Restrictions	Description
width	integer	true		The width of the document page in pixels.

DocumentThumbnailMetadataWithBins


{
  "documentPageId": "string",
  "height": 0,
  "targetBinEnd": 0,
  "targetBinRowCount": 0,
  "targetBinStart": 0,
  "targetValue": 0,
  "width": 0
}

Properties¶

Name	Type	Required	Description
documentPageId	string	true	The ID of the document page. The actual document page can be retrieved with GET /api/v2/projects/{projectId}/documentPages/{documentPageId}/file/.
height	integer	true	The height of the document page in pixels.
targetBinEnd	integer,null	false	Target value for bin end for regression, null for classification
targetBinRowCount	integer	true	The number of rows in the target bin.
targetBinStart	integer,null	false	Target value for bin start for regression, null for classification
targetValue	any	false	Target value

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	number	false		For regression projects

xor

Name	Type	Required	Restrictions	Description
» anonymous	string	false		For classification projects

xor

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false		none

continued

Name	Type	Required	Restrictions	Description
width	integer	true		The width of the document page in pixels.

DocumentsDataQualityLogLinesResponse


{
  "count": 0,
  "data": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[string]	true	The content in the form of lines of the documents data quality log
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

DuplicateImageItem


{
  "imageId": "string",
  "rowCount": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
imageId	string	true		Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
rowCount	integer	true		The count of duplicate images i.e. number of times this image is used in column

DuplicateImageTableResponse


{
  "count": 0,
  "data": [
    {
      "imageId": "string",
      "rowCount": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[DuplicateImageItem]	true	List of image metadata
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

EmbeddingsListResponse


{
  "count": 0,
  "data": [
    {
      "featureName": "string",
      "modelId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[ImageInsightsMetadataElement]	true	List of Image Embeddings
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

EmbeddingsRetrieveResponse


{
  "embeddings": [
    {
      "actualTargetValue": "string",
      "imageId": "string",
      "positionX": 0,
      "positionY": 0,
      "prediction": {
        "labels": [
          "string"
        ],
        "values": [
          0
        ]
      }
    }
  ],
  "targetBins": [
    {
      "targetBinEnd": 0,
      "targetBinStart": 0
    }
  ],
  "targetValues": [
    "string"
  ]
}

Properties¶

Name	Type	Required	Description
embeddings	[ImageEmbedding]	true	List of Image Embedding objects
targetBins	[TargetBin]	true	List of bin objects for regression or null
targetValues	[string]	true	List of target values for classification or null

Empty

{}

Properties¶

None

ExtendedRelationship


{
  "dataset1Identifier": "string",
  "dataset1Keys": [
    "string"
  ],
  "dataset2Identifier": "string",
  "dataset2Keys": [
    "string"
  ],
  "featureDerivationWindowEnd": 0,
  "featureDerivationWindowStart": 0,
  "featureDerivationWindowTimeUnit": "MILLISECOND",
  "featureDerivationWindows": [
    {
      "end": 0,
      "start": 0,
      "unit": "MILLISECOND"
    }
  ],
  "predictionPointRounding": 30,
  "predictionPointRoundingTimeUnit": "MILLISECOND",
  "relationshipQuality": {
    "detailedReport": [
      {
        "enrichmentRate": {
          "action": "string",
          "category": "green",
          "message": "string"
        },
        "enrichmentRateValue": 0,
        "featureDerivationWindow": "string",
        "mostRecentData": {
          "action": "string",
          "category": "green",
          "message": "string"
        },
        "overallCategory": "green",
        "windowSettings": {
          "action": "string",
          "category": "green",
          "message": "string"
        }
      }
    ],
    "lastUpdated": "2019-08-24T14:15:22Z",
    "problemCount": 0,
    "samplingFraction": 0,
    "status": "Complete",
    "statusId": [
      "string"
    ],
    "summaryCategory": "green",
    "summaryMessage": "string"
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
dataset1Identifier	string,null	false	maxLength: 20 minLength: 1 minLength: 1	Identifier of the first dataset in the relationship. If this is not provided, it represents the primary dataset.
dataset1Keys	[string]	true	maxItems: 10 minItems: 1	column(s) in the first dataset that are used to join to the second dataset.
dataset2Identifier	string	true	maxLength: 20 minLength: 1 minLength: 1	Identifier of the second dataset in the relationship.
dataset2Keys	[string]	true	maxItems: 10 minItems: 1	column(s) in the second dataset that are used to join to the first dataset.
featureDerivationWindowEnd	integer	false	maximum: 0	How many featureDerivationWindowUnits of each dataset's primary temporal key into the past relative to the datetimePartitionColumn the feature derivation window should end. Will be a non-positive integer, if present. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.
featureDerivationWindowStart	integer	false		How many featureDerivationWindowUnits of each dataset's primary temporal key into the past relative to the datetimePartitionColumn the feature derivation window should begin. Will be a negative integer, if present. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.
featureDerivationWindowTimeUnit	string	false		Time unit of the feature derivation window. Supported values are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.
featureDerivationWindows	[FeatureDerivationWindow]	false	maxItems: 3	List of feature derivation window definitions that will be used.
predictionPointRounding	integer	false	maximum: 30	Closest value of predictionPointRoundingTimeUnit to round the prediction point into the past when applying the feature derivation window. Will be a positive integer, if present. Only applicable when table1Identifier is not provided.
predictionPointRoundingTimeUnit	string	false		Time unit of the prediction point rounding. Supported values are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR. Only applicable when table1Identifier is not provided.
relationshipQuality	any	false		Summary of the relationship quality information

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	RelationshipQualitySummaryNewFormat	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	RelationshipQualitySummary	false		none

Enumerated Values¶

Property	Value
featureDerivationWindowTimeUnit	[`MILLISECOND`, `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`]
predictionPointRoundingTimeUnit	[`MILLISECOND`, `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`]

ExtendedRelationshipsConfigRetrieve


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "dataSource": {
        "catalog": "string",
        "dataSourceId": "string",
        "dataStoreId": "string",
        "dataStoreName": "string",
        "dbtable": "string",
        "schema": "string",
        "url": "string"
      },
      "dataSources": [
        {
          "catalog": "string",
          "dataSourceId": "string",
          "dataStoreId": "string",
          "dataStoreName": "string",
          "dbtable": "string",
          "schema": "string",
          "url": "string"
        }
      ],
      "featureListId": "string",
      "featureLists": [
        "string"
      ],
      "identifier": "string",
      "isDeleted": true,
      "originalIdentifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "description": "string",
      "family": "string",
      "name": "string",
      "settingType": "string",
      "value": true,
      "verboseName": "string"
    }
  ],
  "id": "string",
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND",
      "relationshipQuality": {
        "detailedReport": [
          {
            "enrichmentRate": {
              "action": "string",
              "category": "green",
              "message": "string"
            },
            "enrichmentRateValue": 0,
            "featureDerivationWindow": "string",
            "mostRecentData": {
              "action": "string",
              "category": "green",
              "message": "string"
            },
            "overallCategory": "green",
            "windowSettings": {
              "action": "string",
              "category": "green",
              "message": "string"
            }
          }
        ],
        "lastUpdated": "2019-08-24T14:15:22Z",
        "problemCount": 0,
        "samplingFraction": 0,
        "status": "Complete",
        "statusId": [
          "string"
        ],
        "summaryCategory": "green",
        "summaryMessage": "string"
      }
    }
  ],
  "snowflakePushDownCompatible": true
}

Properties¶

Name	Type	Required	Restrictions	Description
datasetDefinitions	[DatasetDefinitionResponse]	true		List of dataset definitions.
featureDiscoveryMode	string,null	false		Mode of feature discovery. Supported values are 'default' and 'manual'.
featureDiscoverySettings	[FeatureDiscoverySettingResponse]	false		List of feature discovery settings used to customize the feature discovery process.
id	string	false		ID of relationships configuration.
relationships	[ExtendedRelationship]	true	maxItems: 100 minItems: 1	A list of relationships with quality assessment information
snowflakePushDownCompatible	boolean,null	false		Is this configuration compatible with pushdown computation on Snowflake?

Enumerated Values¶

Property	Value
featureDiscoveryMode	[`default`, `manual`]

FeatureDerivationWindow


{
  "end": 0,
  "start": 0,
  "unit": "MILLISECOND"
}

Properties¶

Name	Type	Required	Restrictions	Description
end	integer	true	maximum: 0	How many featureDerivationWindowUnits of each dataset's primary temporal key into the past relative to the datetimePartitionColumn the feature derivation window should end. Will be a non-positive integer, if present. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.
start	integer	true		How many featureDerivationWindowUnits of each dataset's primary temporal key into the past relative to the datetimePartitionColumn the feature derivation window should begin. Will be a negative integer, if present. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.
unit	string	true		Time unit of the feature derivation window. Supported values are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.

Enumerated Values¶

Property	Value
unit	[`MILLISECOND`, `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`]

FeatureDiscoveryLogListResponse


{
  "count": 0,
  "featureDiscoveryLog": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalLogLines": 0
}

Properties¶

Name	Type	Required	Description
count	integer	true	Number of items returned on this page
featureDiscoveryLog	[string]	true	List of lines retrieved from the feature discovery log
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page)
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page)
totalLogLines	integer	true	total number of lines in feature derivation log

FeatureDiscoveryRecipeSQLsExport


{
  "modelId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
modelId	string	false		Model ID to export recipe for

FeatureDiscoverySetting


{
  "name": "string",
  "value": true
}

Properties¶

Name	Type	Required	Restrictions	Description
name	string	true	maxLength: 100	Name of this feature discovery setting
value	boolean	true		Value of this feature discovery setting

FeatureDiscoverySettingResponse


{
  "description": "string",
  "family": "string",
  "name": "string",
  "settingType": "string",
  "value": true,
  "verboseName": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
description	string	true		Description of this feature discovery setting
family	string	true		Family of this feature discovery setting
name	string	true	maxLength: 100	Name of this feature discovery setting
settingType	string	true		Type of this feature discovery setting
value	boolean	true		Value of this feature discovery setting
verboseName	string	true		Human readable name of this feature discovery setting

FeatureHistogramPlotResponse


{
  "count": 0,
  "label": "string",
  "target": 0
}

Properties¶

Name	Type	Required	Description
count	number	true	number of values in the bin (or weights if project is weighted)
label	string	true	bin start for numerical/uncapped, or string value for categorical. The bin `==Missing==` is created for rows that did not have the feature.
target	number,null	true	Average value of the target feature values for the bin. For regression projects, it will be null, if the feature was deemed as low informative or project target has not been selected yet or AIM processing has not finished yet. You can use GET /api/v2/projects/{projectId}/features/ endpoint to find more about low informative features. For binary classification, the same conditions apply as above, but the value should be treated as the ratio of total positives in the bin to bin's total size (`count`). For multiclass projects the value is always null.

FeatureHistogramResponse


{
  "plot": [
    {
      "count": 0,
      "label": "string",
      "target": 0
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
plot	[FeatureHistogramPlotResponse]	true		plot data based on feature values.

FeatureKeySummaryDetailsResponseValidatorMultilabel


{
  "max": 0,
  "mean": 0,
  "median": 0,
  "min": 0,
  "pctRows": 0,
  "stdDev": 0
}

Statistics of the key.

Properties¶

Name	Type	Required	Description
max	number	true	Maximum value of the key.
mean	number	true	Mean value of the key.
median	number	true	Median value of the key.
min	number	true	Minimum value of the key.
pctRows	number	true	Percentage occurrence of key in the EDA sample of the feature.
stdDev	number	true	Standard deviation of the key.

FeatureKeySummaryDetailsResponseValidatorSummarizedCategorical


{
  "dataQualities": "ISSUES_FOUND",
  "max": 0,
  "mean": 0,
  "median": 0,
  "min": 0,
  "pctRows": 0,
  "stdDev": 0
}

Statistics of the key.

Properties¶

Name	Type	Required	Description
dataQualities	string	true	The indicator of data quality assessment of the feature.
max	number	true	Maximum value of the key.
mean	number	true	Mean value of the key.
median	number	true	Median value of the key.
min	number	true	Minimum value of the key.
pctRows	number	true	Percentage occurrence of key in the EDA sample of the feature.
stdDev	number	true	Standard deviation of the key.

Enumerated Values¶

Property	Value
dataQualities	[`ISSUES_FOUND`, `NOT_ANALYZED`, `NO_ISSUES_FOUND`]

FeatureKeySummaryResponseValidatorMultilabel


{
  "key": "string",
  "summary": {
    "max": 0,
    "mean": 0,
    "median": 0,
    "min": 0,
    "pctRows": 0,
    "stdDev": 0
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
key	string	true		Name of the key.
summary	FeatureKeySummaryDetailsResponseValidatorMultilabel	true		Statistics of the key.

FeatureKeySummaryResponseValidatorSummarizedCategorical


{
  "key": "string",
  "summary": {
    "dataQualities": "ISSUES_FOUND",
    "max": 0,
    "mean": 0,
    "median": 0,
    "min": 0,
    "pctRows": 0,
    "stdDev": 0
  }
}

For a Summarized Categorical columns, this will contain statistics for the top 50 keys (truncated to 103 characters)

Properties¶

Name	Type	Required	Restrictions	Description
key	string	true		Name of the key.
summary	FeatureKeySummaryDetailsResponseValidatorSummarizedCategorical	true		Statistics of the key.

FeatureLineageJoin


{
  "joinType": "left, right",
  "leftTable": {
    "columns": [
      "string"
    ],
    "datasteps": [
      1
    ]
  },
  "rightTable": {
    "columns": [
      "string"
    ],
    "datasteps": [
      1
    ]
  }
}

join step details.

Properties¶

Name	Type	Required	Description
joinType	string	true	Kind of SQL JOIN applied.
leftTable	FeatureLineageJoinTable	true	Information about a dataset which was considered left in a join.
rightTable	FeatureLineageJoinTable	true	Information about a dataset which was considered left in a join.

Enumerated Values¶

Property	Value
joinType	`left, right`

FeatureLineageJoinTable


{
  "columns": [
    "string"
  ],
  "datasteps": [
    1
  ]
}

Information about a dataset which was considered left in a join.

Properties¶

Name	Type	Required	Restrictions	Description
columns	[string]	true	minItems: 1	List of columns which datasets were joined by.
datasteps	[integer]	true		List of data steps id which brought the columns into the current step dataset.

FeatureLineageResponse


{
  "steps": [
    {
      "arguments": {},
      "catalogId": "string",
      "catalogVersionId": "string",
      "description": "string",
      "groupBy": [
        "string"
      ],
      "id": 0,
      "isTimeAware": true,
      "joinInfo": {
        "joinType": "left, right",
        "leftTable": {
          "columns": [
            "string"
          ],
          "datasteps": [
            1
          ]
        },
        "rightTable": {
          "columns": [
            "string"
          ],
          "datasteps": [
            1
          ]
        }
      },
      "name": "string",
      "parents": [
        0
      ],
      "stepType": "data",
      "timeInfo": {
        "duration": {
          "duration": 0,
          "timeUnit": "string"
        },
        "latest": {
          "duration": 0,
          "timeUnit": "string"
        }
      }
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
steps	[FeatureLineageStep]	true		List of steps which were applied to build the feature.

FeatureLineageStep


{
  "arguments": {},
  "catalogId": "string",
  "catalogVersionId": "string",
  "description": "string",
  "groupBy": [
    "string"
  ],
  "id": 0,
  "isTimeAware": true,
  "joinInfo": {
    "joinType": "left, right",
    "leftTable": {
      "columns": [
        "string"
      ],
      "datasteps": [
        1
      ]
    },
    "rightTable": {
      "columns": [
        "string"
      ],
      "datasteps": [
        1
      ]
    }
  },
  "name": "string",
  "parents": [
    0
  ],
  "stepType": "data",
  "timeInfo": {
    "duration": {
      "duration": 0,
      "timeUnit": "string"
    },
    "latest": {
      "duration": 0,
      "timeUnit": "string"
    }
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
arguments	object	false		Generic key-value pairs to describe action step additional parameters.
catalogId	string	false		ID of the catalog for a data step.
catalogVersionId	string	false		id of the catalog version for a data step.
description	string	false		Description of the step.
groupBy	[string]	false		List of columns which this action step aggregated.
id	integer	true	minimum: 0	Step id starting with 0.
isTimeAware	boolean	false		Indicator of step being time aware. Mandatory only for action and join steps. action step provides additional information about feature derivation window in the `timeInfo` field.
joinInfo	FeatureLineageJoin	false		join step details.
name	string	false		Name of the step.
parents	[integer]	true		`id` of steps which use this step output as their input.
stepType	string	true		One of four types of a step. data - source features. action - data aggregation or trasformation. join - SQL JOIN. generatedData - final feature. There is always one generatedData step and at least one data step.
timeInfo	FeatureLineageTimeInfo	false		Description of a feature derivation window which was applied to this action step.

Enumerated Values¶

Property	Value
stepType	[`data`, `action`, `join`, `generatedData`]

FeatureLineageTimeInfo


{
  "duration": {
    "duration": 0,
    "timeUnit": "string"
  },
  "latest": {
    "duration": 0,
    "timeUnit": "string"
  }
}

Description of a feature derivation window which was applied to this action step.

Properties¶

Name	Type	Required	Restrictions	Description
duration	TimeDelta	true		End of the feature derivation window applied.
latest	TimeDelta	true		End of the feature derivation window applied.

FeatureMetricDetailsResponse


{
  "ascending": true,
  "metricName": "string",
  "supportsBinary": true,
  "supportsMulticlass": true,
  "supportsRegression": true,
  "supportsTimeseries": true
}

Properties¶

Name	Type	Required	Description
ascending	boolean	true	Should the metric be sorted in ascending order
metricName	string	true	Name of the metric
supportsBinary	boolean	true	This metric is valid for binary classifciaton
supportsMulticlass	boolean	true	This metric is valid for mutliclass classifciaton
supportsRegression	boolean	true	This metric is valid for regression
supportsTimeseries	boolean	true	This metric is valid for timeseries

FeatureMetricsResponse


{
  "availableMetrics": [
    "string"
  ],
  "featureName": "string",
  "metricDetails": [
    {
      "ascending": true,
      "metricName": "string",
      "supportsBinary": true,
      "supportsMulticlass": true,
      "supportsRegression": true,
      "supportsTimeseries": true
    }
  ]
}

Properties¶

Name	Type	Required	Description
availableMetrics	[string]	true	an array of strings representing the appropriate metrics. If the feature cannot be selected as the target, then this array will be empty.
featureName	string	true	the name of the feature that was looked up
metricDetails	[FeatureMetricDetailsResponse]	true	the list of metricDetails objects.

FeatureTransform


{
  "dateExtraction": "year",
  "name": "string",
  "parentName": "string",
  "replacement": "string",
  "variableType": "text"
}

Properties¶

Name	Type	Required	Description
dateExtraction	string	false	The value to extract from the date column, of these options: `[year\|yearDay\|month\|monthDay\|week\|weekDay]`. Required for transformation of a date column. Otherwise must not be provided.
name	string	true	The name of the new feature. Must not be the same as any existing features for this project. Must not contain '/' character.
parentName	string	true	The name of the parent feature.
replacement	any	false	The replacement in case of a failed transformation.

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string,null	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	boolean,null	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	number,null	false		none

or

Name	Type	Required	Restrictions	Description
» anonymous	integer,null	false		none

continued

Name	Type	Required	Restrictions	Description
variableType	string	true		The type of the new feature. Must be one of `text`, `categorical` (Deprecated in version v2.21), `numeric`, or `categoricalInt`. See the description of this method for more information.

Enumerated Values¶

Property	Value
dateExtraction	[`year`, `yearDay`, `month`, `monthDay`, `week`, `weekDay`]
variableType	[`text`, `categorical`, `numeric`, `categoricalInt`]

FeaturelistDestroyResponse


{
  "canDelete": "false",
  "deletionBlockedReason": "string",
  "dryRun": "false",
  "numAffectedJobs": 0,
  "numAffectedModels": 0
}

Properties¶

Name	Type	Required	Description
canDelete	string	true	Whether the featurelist can be deleted.
deletionBlockedReason	string	true	If the featurelist can't be deleted, this explains why.
dryRun	string	true	Whether this was a dry-run or the featurelist was actually deleted.
numAffectedJobs	integer	true	Number of incomplete jobs using this featurelist.
numAffectedModels	integer	true	Number of models using this featurelist.

Enumerated Values¶

Property	Value
canDelete	[`false`, `False`, `true`, `True`]
dryRun	[`false`, `False`, `true`, `True`]

FeaturelistListResponse


{
  "count": 0,
  "data": [
    {
      "created": "string",
      "description": "string",
      "features": [
        "string"
      ],
      "id": "string",
      "isUserCreated": true,
      "name": "string",
      "numModels": 0,
      "projectId": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[FeaturelistResponse]	true	An array of modeling features.
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

FeaturelistResponse


{
  "created": "string",
  "description": "string",
  "features": [
    "string"
  ],
  "id": "string",
  "isUserCreated": true,
  "name": "string",
  "numModels": 0,
  "projectId": "string"
}

Properties¶

Name	Type	Required	Description
created	string	true	A :ref:`timestamp <time_format>` string specifying when the featurelist was created.
description	string,null	false	User-friendly description of the featurelist, which can be updated by users.
features	[string]	true	Names of features included in the featurelist.
id	string	true	Featurelist ID.
isUserCreated	boolean	true	Whether the featurelist was created manually by a user or by DataRobot automation.
name	string	true	the name of the featurelist
numModels	integer	true	The number of models that currently use this featurelist. A model is considered to use a featurelist if it is used to train the model or as a monotonic constraint featurelist, or if the model is a blender with at least one component model using the featurelist.
projectId	string	true	Project ID the featurelist belongs to.

FormattedSummary


{
  "enrichmentRate": {
    "action": "string",
    "category": "green",
    "message": "string"
  },
  "mostRecentData": {
    "action": "string",
    "category": "green",
    "message": "string"
  },
  "windowSettings": {
    "action": "string",
    "category": "green",
    "message": "string"
  }
}

Relationship quality assessment report associated with the relationship

Properties¶

Name	Type	Required	Description
enrichmentRate	Warnings	true	Warning about the enrichment rate
mostRecentData	Warnings	false	Warning about the enrichment rate
windowSettings	Warnings	false	Warning about the enrichment rate

ImageBinsListResponse


{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetBinEnd": 0,
      "targetBinRowCount": 0,
      "targetBinStart": 0,
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[ImageMetadataWithBins]	true	List of image metadata, as described below
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

ImageEmbedding


{
  "actualTargetValue": "string",
  "imageId": "string",
  "positionX": 0,
  "positionY": 0,
  "prediction": {
    "labels": [
      "string"
    ],
    "values": [
      0
    ]
  }
}

Properties¶

Name	Type	Required	Restrictions	Description
actualTargetValue	any	true		Actual target value of the dataset row

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false		none

continued

Name	Type	Required	Description
imageId	string	true	Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/.
positionX	number	true	x coordinate of the image in the embedding space.
positionY	number	true	y coordinate of the image in the embedding space.
prediction	InsightsPredictionField	true	Object that describes prediction value of the dataset row.

ImageEmbeddingsComputeResponse


{
  "id": "string",
  "isBlocked": true,
  "jobType": "compute_image_embeddings",
  "message": "string",
  "modelId": "string",
  "projectId": "string",
  "status": "queue",
  "url": "string"
}

Properties¶

Name	Type	Required	Description
id	string	true	The job ID.
isBlocked	boolean	true	True if the job is waiting for its dependencies to be resolved first.
jobType	string	true	the type of the job
message	string	true	Error message in case of failure.
modelId	string	true	the model ID of the target model
projectId	string	true	The project the job belongs to.
status	string	true	The job status.
url	string	true	A URL that can be used to request details about the job.

Enumerated Values¶

Property	Value
jobType	`compute_image_embeddings`
status	[`queue`, `inprogress`, `error`, `ABORTED`, `COMPLETED`]

ImageInsightsMetadataElement


{
  "featureName": "string",
  "modelId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
featureName	string	true		Name of feature
modelId	string	true		Model ID of the target model

ImageMetadataListResponse


{
  "count": 0,
  "data": [
    {
      "height": 0,
      "imageId": "string",
      "targetValue": 0,
      "width": 0
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[ImageMetadataResponse]	true	List of image metadata elements
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

ImageMetadataResponse


{
  "height": 0,
  "imageId": "string",
  "targetValue": 0,
  "width": 0
}

Properties¶

Name	Type	Required	Description
height	integer	true	Height of the image in pixels
imageId	string	true	Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
targetValue	number	false	Target value
width	integer	true	Width of the image in pixels

ImageMetadataWithBins


{
  "height": 0,
  "imageId": "string",
  "targetBinEnd": 0,
  "targetBinRowCount": 0,
  "targetBinStart": 0,
  "targetValue": 0,
  "width": 0
}

Properties¶

Name	Type	Required	Description
height	integer	true	Height of the image in pixels
imageId	string	true	Id of the image. The actual image file can be retrieved with GET /api/v2/projects/{projectId}/images/{imageId}/file/
targetBinEnd	integer,null	false	Target value for bin end for regression, null for classification
targetBinRowCount	integer	true	Number of rows in this target bin
targetBinStart	integer,null	false	Target value for bin start for regression, null for classification
targetValue	number	false	Target value
width	integer	true	Width of the image in pixels

ImagesDataQualityLogLinesResponse


{
  "count": 0,
  "data": [
    "string"
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[string]	true	The content in the form of lines of the images data quality log
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

InsightsPredictionField


{
  "labels": [
    "string"
  ],
  "values": [
    0
  ]
}

Object that describes prediction value of the dataset row.

Properties¶

Name	Type	Required	Restrictions	Description
labels	[string]	true		List of predicted label names corresponding to values.
values	[oneOf]	true		Predicted value or probability of the class identified by the label.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	number	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	[number]	false		none

ModelingFeatureListResponse


{
  "count": 0,
  "data": [
    {
      "dataQualities": "ISSUES_FOUND",
      "dateFormat": "string",
      "featureLineageId": "string",
      "featureType": "Boolean",
      "importance": 0,
      "isRestoredAfterReduction": true,
      "isZeroInflated": true,
      "keySummary": {
        "key": "string",
        "summary": {
          "dataQualities": "ISSUES_FOUND",
          "max": 0,
          "mean": 0,
          "median": 0,
          "min": 0,
          "pctRows": 0,
          "stdDev": 0
        }
      },
      "language": "string",
      "lowInformation": true,
      "lowerQuartile": "string",
      "max": "string",
      "mean": "string",
      "median": "string",
      "min": "string",
      "multilabelInsights": {
        "multilabelInsightsKey": "string"
      },
      "naCount": 0,
      "name": "string",
      "parentFeatureNames": [
        "string"
      ],
      "projectId": "string",
      "stdDev": "string",
      "targetLeakage": "FALSE",
      "targetLeakageReason": "string",
      "uniqueCount": 0,
      "upperQuartile": "string"
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalCount": 0
}

Properties¶

Name	Type	Required	Description
count	integer	false	Number of items returned on this page.
data	[ModelingFeatureResponse]	true	Modeling features data.
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalCount	integer	true	The total number of items across all pages.

ModelingFeatureResponse


{
  "dataQualities": "ISSUES_FOUND",
  "dateFormat": "string",
  "featureLineageId": "string",
  "featureType": "Boolean",
  "importance": 0,
  "isRestoredAfterReduction": true,
  "isZeroInflated": true,
  "keySummary": {
    "key": "string",
    "summary": {
      "dataQualities": "ISSUES_FOUND",
      "max": 0,
      "mean": 0,
      "median": 0,
      "min": 0,
      "pctRows": 0,
      "stdDev": 0
    }
  },
  "language": "string",
  "lowInformation": true,
  "lowerQuartile": "string",
  "max": "string",
  "mean": "string",
  "median": "string",
  "min": "string",
  "multilabelInsights": {
    "multilabelInsightsKey": "string"
  },
  "naCount": 0,
  "name": "string",
  "parentFeatureNames": [
    "string"
  ],
  "projectId": "string",
  "stdDev": "string",
  "targetLeakage": "FALSE",
  "targetLeakageReason": "string",
  "uniqueCount": 0,
  "upperQuartile": "string"
}

Properties¶

Name	Type	Required	Description
dataQualities	string	false	Data Quality Status
dateFormat	string,null	true	the date format string for how this feature was interpreted (or null if not a date feature). If not null, it will be compatible with https://docs.python.org/2/library/time.html#time.strftime .
featureLineageId	string,null	true	id of a lineage for automatically generated features.
featureType	string	true	Feature type.
importance	number,null	true	numeric measure of the strength of relationship between the feature and target (independent of any model or other features)
isRestoredAfterReduction	boolean	false	Whether feature is restored after feature reduction
isZeroInflated	boolean,null	false	Whether feature has an excessive number of zeros
keySummary	any	false	Per key summaries for Summarized Categorical or Multicategorical columns

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	FeatureKeySummaryResponseValidatorSummarizedCategorical	false		For a Summarized Categorical columns, this will contain statistics for the top 50 keys (truncated to 103 characters)

xor

Name	Type	Required	Restrictions	Description
» anonymous	[FeatureKeySummaryResponseValidatorMultilabel]	false		For a Multicategorical columns, this will contain statistics for the top classes

continued

Name	Type	Required	Description
language	string	false	Feature's detected language.
lowInformation	boolean	true	whether feature has too few values to be informative
lowerQuartile	any	true	Lower quartile point of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		Lower quartile point of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		Lower quartile point of EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
max	any	true		maximum value of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		maximum value of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		maximum value of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
mean	any	true		arithmetic mean of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		arithmetic mean of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		arithmetic mean of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
median	any	true		median of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		median of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		median of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
min	any	true		minimum value of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		minimum value of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		minimum value of the EDA sample of the feature.

continued

Name	Type	Required	Description
multilabelInsights	MultilabelInsightsResponse	false	Multilabel project specific information
naCount	integer	true	Number of missing values.
name	string	true	feature name
parentFeatureNames	[string]	false	an array of string feature names indicating which features in the input data were used to create this feature if the feature is a transformation.
projectId	string	true	the ID of the project the feature belongs to
stdDev	any	true	standard deviation of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		standard deviation of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		standard deviation of EDA sample of the feature.

continued

Name	Type	Required	Description
targetLeakage	string	true	the detected level of risk for target leakage, if any. 'SKIPPED_DETECTION' indicates leakage detection was not run on the feature, 'FALSE' indicates no leakage, 'MODERATE_RISK' indicates a moderate risk of target leakage, and 'HIGH_RISK' indicates a high risk of target leakage.
targetLeakageReason	string	true	descriptive sentence explaining the reason for target leakage.
uniqueCount	integer	false	number of unique values
upperQuartile	any	true	Upper quartile point of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		Upper quartile point of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		Upper quartile point of EDA sample of the feature.

Enumerated Values¶

Property	Value
dataQualities	[`ISSUES_FOUND`, `NOT_ANALYZED`, `NO_ISSUES_FOUND`]
featureType	[`Boolean`, `Categorical`, `Currency`, `Date`, `Date Duration`, `Document`, `Image`, `Interaction`, `Length`, `Location`, `Multicategorical`, `Numeric`, `Percentage`, `Summarized Categorical`, `Text`, `Time`]
targetLeakage	[`FALSE`, `HIGH_RISK`, `MODERATE_RISK`, `SKIPPED_DETECTION`]

ModelingFeaturesCreateFromDiscarded


{
  "featuresToRestore": [
    "string"
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
featuresToRestore	[string]	true	minItems: 1	Discarded features to restore.

ModelingFeaturesCreateFromDiscardedResponse


{
  "featuresToRestore": [
    "string"
  ],
  "warnings": [
    "string"
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
featuresToRestore	[string]	true		Features to add back to the project.
warnings	[string]	true		Warnings about features which can not be restored.

MultilabelInsightsResponse


{
  "multilabelInsightsKey": "string"
}

Multilabel project specific information

Properties¶

Name	Type	Required	Restrictions	Description
multilabelInsightsKey	string	true		Key for multilabel insights, unique per project, feature, and EDA stage. The response will contain the key for the most recent, finished EDA stage.

MultiseriesIdColumnsRecord


{
  "multiseriesIdColumns": [
    "string"
  ],
  "timeStep": 0,
  "timeUnit": "MILLISECOND"
}

Detected multiseries ID columns along with timeStep and timeUnit information

Properties¶

Name	Type	Required	Restrictions	Description
multiseriesIdColumns	[string]	true	minItems: 1	A list of one or more names of columns that contain the individual series identifiers if the dataset consists of multiple time series.
timeStep	integer	true		timeStep: detected time step
timeUnit	string	true		detected time unit (e.g. DAY, HOUR, etc.)

Enumerated Values¶

Property	Value
timeUnit	[`MILLISECOND`, `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`, `ROW`]

MultiseriesRetrieveResponse


{
  "datetimePartitionColumn": "string",
  "detectedMultiseriesIdColumns": [
    {
      "multiseriesIdColumns": [
        "string"
      ],
      "timeStep": 0,
      "timeUnit": "MILLISECOND"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
datetimePartitionColumn	string	true		The datetime partition column name.
detectedMultiseriesIdColumns	[MultiseriesIdColumnsRecord]	true		A list of detected multiseries ID columns along with timeStep and timeUnit information. Note that if no eligible columns have been detected, this list will be empty.

OCRJobCreationRequest


{
  "datasetId": "string",
  "language": "ENGLISH"
}

Properties¶

Name	Type	Required	Restrictions	Description
datasetId	string	true		OCR input dataset id
language	string	true		Supported OCR dataset language

Enumerated Values¶

Property	Value
language	[`ENGLISH`, `JAPANESE`]

OCRJobErrorReportPutRequest


{
  "file": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
file	string(binary)	true		The file to be uploaded

OCRJobPostPayload

{}

Properties¶

None

OCRJobPostResponse


{
  "errorReportLocation": "http://example.com",
  "jobStatusLocation": "http://example.com",
  "outputLocation": "http://example.com"
}

Properties¶

Name	Type	Required	Description
errorReportLocation	string(uri)	true	URL to retrieve OCR job error report
jobStatusLocation	string(uri)	true	URL to retrieve OCR job status
outputLocation	string(uri)	true	URL to retrieve OCR job output

OCRJobResourceListResponse


{
  "count": 0,
  "data": [
    {
      "id": "string",
      "inputCatalogId": "string",
      "jobStarted": true,
      "language": "ENGLISH",
      "outputCatalogId": "string",
      "userId": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true		Number of records on this page
data	[OCRJobResourceResponse]	true	maxItems: 1000	List of ocr job resources
next	string,null	true		URL to the next page, or `null` if there is no such page
previous	string,null	true		URL to the previous page, or `null` if there is no such page

OCRJobResourceResponse


{
  "id": "string",
  "inputCatalogId": "string",
  "jobStarted": true,
  "language": "ENGLISH",
  "outputCatalogId": "string",
  "userId": "string"
}

Properties¶

Name	Type	Required	Description
id	string	true	OCR job resource id
inputCatalogId	string	true	OCR input dataset catalog id
jobStarted	boolean	true	Job started
language	string	true	Supported OCR dataset language
outputCatalogId	string	true	OCR output dataset catalog id
userId	string	true	User id

Enumerated Values¶

Property	Value
language	[`ENGLISH`, `JAPANESE`]

OCRJobStatusesResponse


{
  "jobStatus": "executing"
}

Properties¶

Name	Type	Required	Restrictions	Description
jobStatus	string	true		Status of general progress of OCR job resource creation

Enumerated Values¶

Property	Value
jobStatus	[`executing`, `failure`, `pending`, `stopped`, `success`, `unknown`]

PreloadedCalendar


{
  "countryCode": "AR",
  "endDate": "2019-08-24T14:15:22Z",
  "startDate": "2019-08-24T14:15:22Z"
}

Properties¶

Name	Type	Required	Description
countryCode	string	true	Code of the country for which holidays should be generated. Code needs to be uppercase and should belong to the list of countries which can be retrieved via GET /api/v2/calendarCountryCodes/
endDate	string(date-time)	true	Last date of the range of dates for which holidays are generated.
startDate	string(date-time)	true	First date of the range of dates for which holidays are generated.

Enumerated Values¶

Property	Value
countryCode	[`AR`, `AT`, `AU`, `AW`, `BE`, `BG`, `BR`, `BY`, `CA`, `CH`, `CL`, `CO`, `CZ`, `DE`, `DK`, `DO`, `EE`, `ES`, `FI`, `FRA`, `GB`, `HK`, `HND`, `HR`, `HU`, `IE`, `IND`, `IS`, `IT`, `JP`, `KE`, `LT`, `LU`, `MX`, `NG`, `NI`, `NL`, `NO`, `NZ`, `PE`, `PL`, `PT`, `RU`, `SE`, `SE(NS)`, `SI`, `SK`, `TAR`, `UA`, `UK`, `US`, `ZA`]

PreloadedCalendarCountryCodeRecord


{
  "code": "string",
  "name": "string"
}

Each item has the country code and the full name of the corresponding country

Properties¶

Name	Type	Required	Restrictions	Description
code	string	true		Country code that can be used for calendars generation.
name	string	true		Full name of the country.

PreloadedCalendarListResponse


{
  "count": 0,
  "data": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "next": "string",
  "previous": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
count	integer	true	minimum: 0	The number of items returned on this page considering offset and limit values.
data	[PreloadedCalendarCountryCodeRecord]	true		An array of dictionaries which contain country code and full name of the countries corresponding to codes.
next	string,null	true		A URL pointing to the next page (if `null`, there is no next page).
previous	string,null	true		A URL pointing to the previous page (if `null`, there is no previous page).

ProjectFeatureResponse


{
  "dataQualities": "ISSUES_FOUND",
  "dateFormat": "string",
  "featureLineageId": "string",
  "featureType": "Boolean",
  "id": 0,
  "importance": 0,
  "isRestoredAfterReduction": true,
  "isZeroInflated": true,
  "keySummary": {
    "key": "string",
    "summary": {
      "dataQualities": "ISSUES_FOUND",
      "max": 0,
      "mean": 0,
      "median": 0,
      "min": 0,
      "pctRows": 0,
      "stdDev": 0
    }
  },
  "language": "string",
  "lowInformation": true,
  "lowerQuartile": "string",
  "max": "string",
  "mean": "string",
  "median": "string",
  "min": "string",
  "multilabelInsights": {
    "multilabelInsightsKey": "string"
  },
  "naCount": 0,
  "name": "string",
  "parentFeatureNames": [
    "string"
  ],
  "projectId": "string",
  "stdDev": "string",
  "targetLeakage": "FALSE",
  "targetLeakageReason": "string",
  "timeSeriesEligibilityReason": "string",
  "timeSeriesEligible": true,
  "timeStep": 0,
  "timeUnit": "string",
  "uniqueCount": 0,
  "upperQuartile": "string"
}

Properties¶

Name	Type	Required	Description
dataQualities	string	false	Data Quality Status
dateFormat	string,null	true	the date format string for how this feature was interpreted (or null if not a date feature). If not null, it will be compatible with https://docs.python.org/2/library/time.html#time.strftime .
featureLineageId	string,null	true	id of a lineage for automatically generated features.
featureType	string	true	Feature type.
id	integer	true	the feature ID. (Note: Throughout the API, features are specified using their names, not this ID.)
importance	number,null	true	numeric measure of the strength of relationship between the feature and target (independent of any model or other features)
isRestoredAfterReduction	boolean	false	Whether feature is restored after feature reduction
isZeroInflated	boolean,null	false	Whether feature has an excessive number of zeros
keySummary	any	false	Per key summaries for Summarized Categorical or Multicategorical columns

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	FeatureKeySummaryResponseValidatorSummarizedCategorical	false		For a Summarized Categorical columns, this will contain statistics for the top 50 keys (truncated to 103 characters)

xor

Name	Type	Required	Restrictions	Description
» anonymous	[FeatureKeySummaryResponseValidatorMultilabel]	false		For a Multicategorical columns, this will contain statistics for the top classes

continued

Name	Type	Required	Description
language	string	false	Feature's detected language.
lowInformation	boolean	true	whether feature has too few values to be informative
lowerQuartile	any	true	Lower quartile point of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		Lower quartile point of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		Lower quartile point of EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
max	any	true		maximum value of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		maximum value of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		maximum value of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
mean	any	true		arithmetic mean of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		arithmetic mean of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		arithmetic mean of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
median	any	true		median of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		median of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		median of the EDA sample of the feature.

continued

Name	Type	Required	Restrictions	Description
min	any	true		minimum value of the EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		minimum value of the EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		minimum value of the EDA sample of the feature.

continued

Name	Type	Required	Description
multilabelInsights	MultilabelInsightsResponse	false	Multilabel project specific information
naCount	integer	true	Number of missing values.
name	string	true	feature name
parentFeatureNames	[string]	false	an array of string feature names indicating which features in the input data were used to create this feature if the feature is a transformation.
projectId	string	true	the ID of the project the feature belongs to
stdDev	any	true	standard deviation of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		standard deviation of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		standard deviation of EDA sample of the feature.

continued

Name	Type	Required	Description
targetLeakage	string	true	the detected level of risk for target leakage, if any. 'SKIPPED_DETECTION' indicates leakage detection was not run on the feature, 'FALSE' indicates no leakage, 'MODERATE_RISK' indicates a moderate risk of target leakage, and 'HIGH_RISK' indicates a high risk of target leakage.
targetLeakageReason	string	true	descriptive sentence explaining the reason for target leakage.
timeSeriesEligibilityReason	string	true	why the feature is ineligible for time series projects, or 'suitable' if it is eligible.
timeSeriesEligible	boolean	true	whether this feature can be used as a datetime partitioning feature for time series projects. Only sufficiently regular date features can be selected as the datetime feature for time series projects. Always false for non-date features. Date features that cannot be used in datetime partitioning for a time series project may be eligible for an OTV project, which has less stringent requirements.
timeStep	integer,null	true	The minimum time step that can be used to specify time series windows. The units for this value are the `timeUnit`. When specifying windows for time series projects, all windows must have durations that are integer multiples of this number. Only present for date features that are eligible for time series projects and null otherwise.
timeUnit	string,null	true	the unit for the interval between values of this feature, e.g. DAY, MONTH, HOUR. When specifying windows for time series projects, the windows are expressed in terms of this unit. Only present for date features eligible for time series projects, and null otherwise.
uniqueCount	integer	false	number of unique values
upperQuartile	any	true	Upper quartile point of EDA sample of the feature.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false		Upper quartile point of EDA sample of the feature.

xor

Name	Type	Required	Restrictions	Description
» anonymous	number	false		Upper quartile point of EDA sample of the feature.

Enumerated Values¶

Property	Value
dataQualities	[`ISSUES_FOUND`, `NOT_ANALYZED`, `NO_ISSUES_FOUND`]
featureType	[`Boolean`, `Categorical`, `Currency`, `Date`, `Date Duration`, `Document`, `Image`, `Interaction`, `Length`, `Location`, `Multicategorical`, `Numeric`, `Percentage`, `Summarized Categorical`, `Text`, `Time`]
targetLeakage	[`FALSE`, `HIGH_RISK`, `MODERATE_RISK`, `SKIPPED_DETECTION`]

ProjectSecondaryDatasetConfigResponse


{
  "config": [
    {
      "featureEngineeringGraphId": "string",
      "secondaryDatasets": [
        {
          "catalogId": "string",
          "catalogVersionId": "string",
          "identifier": "string",
          "snapshotPolicy": "specified"
        }
      ]
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "creatorFullName": "string",
  "creatorUserId": "string",
  "credentialIds": [
    {
      "catalogVersionId": "string",
      "credentialId": "string",
      "url": "string"
    }
  ],
  "featurelistId": "string",
  "id": "string",
  "isDefault": true,
  "name": "string",
  "projectId": "string",
  "projectVersion": "string",
  "secondaryDatasets": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "identifier": "string",
      "requiredFeatures": [
        "string"
      ],
      "snapshotPolicy": "specified"
    }
  ]
}

Properties¶

Name	Type	Required	Description
config	[SecondaryDatasetConfig]	false	Graph-specific secondary datasets. Deprecated in version v2.23.
created	string,null(date-time)	true	DR-formatted datetime, null for legacy (before DR 6.0) db records.
creatorFullName	string,null	true	Fullname or email of the user created this config. null for legacy (before DR 6.0) db records.
creatorUserId	string,null	true	ID of the user created this config, null for legacy (before DR 6.0) db records.
credentialIds	[DatasetsCredential]	false	List of credentials used by the secondary datasets if the datasets used in the configuration are from datasource.
featurelistId	string,null	false	Id of the feature list.
id	string	true	ID of the secondary datasets configuration.
isDefault	boolean,null	true	Secondary datasets config is default config or not.
name	string,null	true	Name of the secondary datasets config.
projectId	string,null	true	ID of the project.
projectVersion	string,null	false	DataRobot project version.
secondaryDatasets	[SecondaryDatasetResponse]	false	List of secondary datasets used in the config.

Relationship


{
  "dataset1Identifier": "string",
  "dataset1Keys": [
    "string"
  ],
  "dataset2Identifier": "string",
  "dataset2Keys": [
    "string"
  ],
  "featureDerivationWindowEnd": 0,
  "featureDerivationWindowStart": 0,
  "featureDerivationWindowTimeUnit": "MILLISECOND",
  "featureDerivationWindows": [
    {
      "end": 0,
      "start": 0,
      "unit": "MILLISECOND"
    }
  ],
  "predictionPointRounding": 30,
  "predictionPointRoundingTimeUnit": "MILLISECOND"
}

Properties¶

Name	Type	Required	Restrictions	Description
dataset1Identifier	string,null	false	maxLength: 20 minLength: 1 minLength: 1	Identifier of the first dataset in the relationship. If this is not provided, it represents the primary dataset.
dataset1Keys	[string]	true	maxItems: 10 minItems: 1	column(s) in the first dataset that are used to join to the second dataset.
dataset2Identifier	string	true	maxLength: 20 minLength: 1 minLength: 1	Identifier of the second dataset in the relationship.
dataset2Keys	[string]	true	maxItems: 10 minItems: 1	column(s) in the second dataset that are used to join to the first dataset.
featureDerivationWindowEnd	integer	false	maximum: 0	How many featureDerivationWindowUnits of each dataset's primary temporal key into the past relative to the datetimePartitionColumn the feature derivation window should end. Will be a non-positive integer, if present. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.
featureDerivationWindowStart	integer	false		How many featureDerivationWindowUnits of each dataset's primary temporal key into the past relative to the datetimePartitionColumn the feature derivation window should begin. Will be a negative integer, if present. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.
featureDerivationWindowTimeUnit	string	false		Time unit of the feature derivation window. Supported values are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR. If present, time-aware joins will be used. Only applicable when table1Identifier is not provided.
featureDerivationWindows	[FeatureDerivationWindow]	false	maxItems: 3	List of feature derivation window definitions that will be used.
predictionPointRounding	integer	false	maximum: 30	Closest value of predictionPointRoundingTimeUnit to round the prediction point into the past when applying the feature derivation window. Will be a positive integer, if present. Only applicable when table1Identifier is not provided.
predictionPointRoundingTimeUnit	string	false		Time unit of the prediction point rounding. Supported values are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR. Only applicable when table1Identifier is not provided.

Enumerated Values¶

Property	Value
featureDerivationWindowTimeUnit	[`MILLISECOND`, `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`]
predictionPointRoundingTimeUnit	[`MILLISECOND`, `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`]

RelationshipQualityAssessmentsCreate


{
  "credentials": [
    {
      "catalogVersionId": "string",
      "credentialId": "string",
      "url": "string"
    }
  ],
  "datetimePartitionColumn": "string",
  "featureEngineeringPredictionPoint": "string",
  "relationshipsConfiguration": {
    "datasetDefinitions": [
      {
        "catalogId": "string",
        "catalogVersionId": "string",
        "featureListId": "string",
        "identifier": "string",
        "primaryTemporalKey": "string",
        "snapshotPolicy": "specified"
      }
    ],
    "featureDiscoveryMode": "default",
    "featureDiscoverySettings": [
      {
        "description": "string",
        "family": "string",
        "name": "string",
        "settingType": "string",
        "value": true,
        "verboseName": "string"
      }
    ],
    "id": "string",
    "relationships": [
      {
        "dataset1Identifier": "string",
        "dataset1Keys": [
          "string"
        ],
        "dataset2Identifier": "string",
        "dataset2Keys": [
          "string"
        ],
        "featureDerivationWindowEnd": 0,
        "featureDerivationWindowStart": 0,
        "featureDerivationWindowTimeUnit": "MILLISECOND",
        "featureDerivationWindows": [
          {
            "end": 0,
            "start": 0,
            "unit": "MILLISECOND"
          }
        ],
        "predictionPointRounding": 30,
        "predictionPointRoundingTimeUnit": "MILLISECOND"
      }
    ],
    "snowflakePushDownCompatible": true
  },
  "userId": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
credentials	[oneOf]	false	maxItems: 30	Credentials for dynamic policy secondary datasets.

oneOf

Name	Type	Required	Restrictions	Description
» anonymous	StoredCredentials	false		none

xor

Name	Type	Required	Restrictions	Description
» anonymous	CatalogPasswordCredentials	false		none

continued

Name	Type	Required	Description
datetimePartitionColumn	string,null	false	If a datetime partition column was used, the name of the column.
featureEngineeringPredictionPoint	string,null	false	The date column to be used as the prediction point for time-based feature engineering.
relationshipsConfiguration	RelationshipsConfigPayload	true	Object describing how secondary datasets are related to the primary dataset
userId	string	false	Mongo Id of the User who created the request

RelationshipQualitySummary


{
  "enrichmentRate": 0,
  "formattedSummary": {
    "enrichmentRate": {
      "action": "string",
      "category": "green",
      "message": "string"
    },
    "mostRecentData": {
      "action": "string",
      "category": "green",
      "message": "string"
    },
    "windowSettings": {
      "action": "string",
      "category": "green",
      "message": "string"
    }
  },
  "lastUpdated": "2019-08-24T14:15:22Z",
  "overallCategory": "green",
  "status": "Complete",
  "statusId": [
    "string"
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
enrichmentRate	number	true		Percentage of records that can be enriched with a record in the primary table
formattedSummary	FormattedSummary	true		Relationship quality assessment report associated with the relationship
lastUpdated	string(date-time)	true		Last updated timestamp
overallCategory	string	true		Class of the relationship quality
status	string	false		Relationship quality assessment status
statusId	[string]	false	maxItems: 3 minItems: 1	List of status Ids

Enumerated Values¶

Property	Value
overallCategory	[`green`, `yellow`]
status	[`Complete`, `In progress`, `Error`]

RelationshipQualitySummaryNewFormat


{
  "detailedReport": [
    {
      "enrichmentRate": {
        "action": "string",
        "category": "green",
        "message": "string"
      },
      "enrichmentRateValue": 0,
      "featureDerivationWindow": "string",
      "mostRecentData": {
        "action": "string",
        "category": "green",
        "message": "string"
      },
      "overallCategory": "green",
      "windowSettings": {
        "action": "string",
        "category": "green",
        "message": "string"
      }
    }
  ],
  "lastUpdated": "2019-08-24T14:15:22Z",
  "problemCount": 0,
  "samplingFraction": 0,
  "status": "Complete",
  "statusId": [
    "string"
  ],
  "summaryCategory": "green",
  "summaryMessage": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
detailedReport	[AssessmentNewFormat]	true	maxItems: 3	Detailed report of the relationship quality information
lastUpdated	string(date-time)	true		Last updated timestamp
problemCount	integer	true		Total count of problems detected
samplingFraction	number	true		Primary dataset sampling fraction used for relationship quality assessment speedup
status	string	false		Relationship quality assessment status
statusId	[string]	false	maxItems: 3 minItems: 1	List of status Ids
summaryCategory	string	true		Class of the summary warning of the relationship
summaryMessage	string	true		Summary warning message about the relationship

Enumerated Values¶

Property	Value
status	[`Complete`, `In progress`, `Error`]
summaryCategory	[`green`, `yellow`]

RelationshipResponse


{
  "dataset1Identifier": "string",
  "dataset1Keys": [
    "string"
  ],
  "dataset2Identifier": "string",
  "dataset2Keys": [
    "string"
  ],
  "featureDerivationWindowEnd": 0,
  "featureDerivationWindowStart": 0,
  "featureDerivationWindowTimeUnit": "MILLISECOND",
  "featureDerivationWindows": [
    {
      "end": 0,
      "start": 0,
      "unit": "MILLISECOND"
    }
  ],
  "predictionPointRounding": 30,
  "predictionPointRoundingTimeUnit": "MILLISECOND"
}

Properties¶

Name	Type	Required	Restrictions	Description
dataset1Identifier	string,null	true	maxLength: 20 minLength: 1 minLength: 1	Identifier of the first dataset in the relationship. If this is not provided, it represents the primary dataset.
dataset1Keys	[string]	true	maxItems: 10 minItems: 1	column(s) in the first dataset that are used to join to the second dataset.
dataset2Identifier	string	true	maxLength: 20 minLength: 1 minLength: 1	Identifier of the second dataset in the relationship.
dataset2Keys	[string]	true	maxItems: 10 minItems: 1	column(s) in the second dataset that are used to join to the first dataset.
featureDerivationWindowEnd	integer,null	false	maximum: 0	How many featureDerivationWindowUnits of each dataset's primary temporal key into the past relative to the datetimePartitionColumn the feature derivation window should end. Will be a non-positive integer, if present. If present, time-aware joins will be used.
featureDerivationWindowStart	integer,null	false		How many featureDerivationWindowUnits of each dataset's primary temporal key into the past relative to the datetimePartitionColumn the feature derivation window should begin. Will be a negative integer, if present. If present, time-aware joins will be used.
featureDerivationWindowTimeUnit	string,null	false		Time unit of the feature derivation window. Supported values are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR. If present, time-aware joins will be used.
featureDerivationWindows	[FeatureDerivationWindow]	false		List of feature derivation window definitions that will be used.
predictionPointRounding	integer,null	false	maximum: 30	Can be null, closest value of predictionPointRoundingTimeUnit to round the prediction point into the past when applying the feature derivation window. Will be a positive integer, if present.
predictionPointRoundingTimeUnit	string,null	false		Time unit of the prediction point rounding. Supported values are MILLISECOND, SECOND, MINUTE, HOUR, DAY, WEEK, MONTH, QUARTER, YEAR.

Enumerated Values¶

Property	Value
featureDerivationWindowTimeUnit	[`MILLISECOND`, `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`]
predictionPointRoundingTimeUnit	[`MILLISECOND`, `SECOND`, `MINUTE`, `HOUR`, `DAY`, `WEEK`, `MONTH`, `QUARTER`, `YEAR`]

RelationshipsConfigCreate


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "featureListId": "string",
      "identifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "name": "string",
      "value": true
    }
  ],
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND"
    }
  ]
}

Properties¶

Name	Type	Required	Description
datasetDefinitions	[DatasetDefinition]	true	List of dataset definitions.
featureDiscoveryMode	string	false	Mode of feature discovery. Supported values are 'default' and 'manual'.
featureDiscoverySettings	[FeatureDiscoverySetting]	false	List of feature discovery settings used to customize the feature discovery process. Applicable when feature_discovery_mode is 'manual'.
relationships	[Relationship]	true	List of relationship between datasets specified in datasetDefinitions.

Enumerated Values¶

Property	Value
featureDiscoveryMode	[`default`, `manual`]

RelationshipsConfigPayload


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "featureListId": "string",
      "identifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "description": "string",
      "family": "string",
      "name": "string",
      "settingType": "string",
      "value": true,
      "verboseName": "string"
    }
  ],
  "id": "string",
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND"
    }
  ],
  "snowflakePushDownCompatible": true
}

Object describing how secondary datasets are related to the primary dataset

Properties¶

Name	Type	Required	Restrictions	Description
datasetDefinitions	[DatasetDefinition]	true	maxItems: 30 minItems: 1	A list of datasets
featureDiscoveryMode	string,null	false		Mode of feature discovery. Supported values are 'default' and 'manual'.
featureDiscoverySettings	[FeatureDiscoverySettingResponse]	false	maxItems: 100	List of feature discovery settings used to customize the feature discovery process.
id	string	true		Id of the relationship configuration
relationships	[Relationship]	true	maxItems: 70 minItems: 1	A list of relationships
snowflakePushDownCompatible	boolean,null	false		Flag indicating if the relationships configuration is compatible with Snowflake push down processing.

Enumerated Values¶

Property	Value
featureDiscoveryMode	[`default`, `manual`]

RelationshipsConfigResponse


{
  "datasetDefinitions": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "dataSource": {
        "catalog": "string",
        "dataSourceId": "string",
        "dataStoreId": "string",
        "dataStoreName": "string",
        "dbtable": "string",
        "schema": "string",
        "url": "string"
      },
      "dataSources": [
        {
          "catalog": "string",
          "dataSourceId": "string",
          "dataStoreId": "string",
          "dataStoreName": "string",
          "dbtable": "string",
          "schema": "string",
          "url": "string"
        }
      ],
      "featureListId": "string",
      "featureLists": [
        "string"
      ],
      "identifier": "string",
      "isDeleted": true,
      "originalIdentifier": "string",
      "primaryTemporalKey": "string",
      "snapshotPolicy": "specified"
    }
  ],
  "featureDiscoveryMode": "default",
  "featureDiscoverySettings": [
    {
      "description": "string",
      "family": "string",
      "name": "string",
      "settingType": "string",
      "value": true,
      "verboseName": "string"
    }
  ],
  "id": "string",
  "relationships": [
    {
      "dataset1Identifier": "string",
      "dataset1Keys": [
        "string"
      ],
      "dataset2Identifier": "string",
      "dataset2Keys": [
        "string"
      ],
      "featureDerivationWindowEnd": 0,
      "featureDerivationWindowStart": 0,
      "featureDerivationWindowTimeUnit": "MILLISECOND",
      "featureDerivationWindows": [
        {
          "end": 0,
          "start": 0,
          "unit": "MILLISECOND"
        }
      ],
      "predictionPointRounding": 30,
      "predictionPointRoundingTimeUnit": "MILLISECOND"
    }
  ],
  "snowflakePushDownCompatible": true
}

Properties¶

Name	Type	Required	Description
datasetDefinitions	[DatasetDefinitionResponse]	true	List of dataset definitions.
featureDiscoveryMode	string,null	false	Mode of feature discovery. Supported values are 'default' and 'manual'.
featureDiscoverySettings	[FeatureDiscoverySettingResponse]	false	List of feature discovery settings used to customize the feature discovery process.
id	string	false	ID of relationships configuration.
relationships	[RelationshipResponse]	true	List of relationship between datasets specified in datasetDefinitions.
snowflakePushDownCompatible	boolean,null	false	Is this configuration compatible with pushdown computation on Snowflake?

Enumerated Values¶

Property	Value
featureDiscoveryMode	[`default`, `manual`]

SecondaryDataset


{
  "catalogId": "string",
  "catalogVersionId": "string",
  "identifier": "string",
  "snapshotPolicy": "specified"
}

Properties¶

Name	Type	Required	Restrictions	Description
catalogId	string	true		Id of the catalog item version.
catalogVersionId	string	true		Id of the catalog item.
identifier	string	true	maxLength: 45 minLength: 1 minLength: 1	Short name of this table (used directly as part of generated feature names).
snapshotPolicy	string	false		Type of snapshot policy to use by the dataset.

Enumerated Values¶

Property	Value
snapshotPolicy	[`specified`, `latest`, `dynamic`]

SecondaryDatasetConfig


{
  "featureEngineeringGraphId": "string",
  "secondaryDatasets": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "identifier": "string",
      "snapshotPolicy": "specified"
    }
  ]
}

Properties¶

Name	Type	Required	Restrictions	Description
featureEngineeringGraphId	string	true		Id of the feature engineering graph
secondaryDatasets	[SecondaryDataset]	true		list of secondary datasets used by the feature engineering graph

SecondaryDatasetConfigListResponse


{
  "count": 0,
  "data": [
    {
      "config": [
        {
          "featureEngineeringGraphId": "string",
          "secondaryDatasets": [
            {
              "catalogId": "string",
              "catalogVersionId": "string",
              "identifier": "string",
              "snapshotPolicy": "specified"
            }
          ]
        }
      ],
      "created": "2019-08-24T14:15:22Z",
      "creatorFullName": "string",
      "creatorUserId": "string",
      "credentialIds": [
        {
          "catalogVersionId": "string",
          "credentialId": "string",
          "url": "string"
        }
      ],
      "featurelistId": "string",
      "id": "string",
      "isDefault": true,
      "name": "string",
      "projectId": "string",
      "projectVersion": "string",
      "secondaryDatasets": [
        {
          "catalogId": "string",
          "catalogVersionId": "string",
          "identifier": "string",
          "requiredFeatures": [
            "string"
          ],
          "snapshotPolicy": "specified"
        }
      ]
    }
  ],
  "next": "http://example.com",
  "previous": "http://example.com"
}

Properties¶

Name	Type	Required	Description
count	integer	true	Number of items returned on this page.
data	[ProjectSecondaryDatasetConfigResponse]	true	Secondary dataset configurations.
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).

SecondaryDatasetCreate


{
  "config": [
    {
      "featureEngineeringGraphId": "string",
      "secondaryDatasets": [
        {
          "catalogId": "string",
          "catalogVersionId": "string",
          "identifier": "string",
          "snapshotPolicy": "specified"
        }
      ]
    }
  ],
  "featurelistId": "string",
  "modelId": "string",
  "name": "string",
  "save": true,
  "secondaryDatasets": [
    {
      "catalogId": "string",
      "catalogVersionId": "string",
      "identifier": "string",
      "snapshotPolicy": "specified"
    }
  ]
}

Properties¶

Name	Type	Required	Description
config	[SecondaryDatasetConfig]	false	Graph-specific secondary datasets. Deprecated in version v2.23
featurelistId	string	false	Feature list ID of the configuration.
modelId	string	false	ID of the model.
name	string	true	Name of the configuration.
save	boolean	false	Determines if the configuration will be saved. If set to False the configuration is validated but not saved. Defaults to True.
secondaryDatasets	[SecondaryDataset]	false	List of secondary dataset definitions to use in the configuration.

SecondaryDatasetResponse


{
  "catalogId": "string",
  "catalogVersionId": "string",
  "identifier": "string",
  "requiredFeatures": [
    "string"
  ],
  "snapshotPolicy": "specified"
}

Properties¶

Name	Type	Required	Restrictions	Description
catalogId	string,null	true		ID of the catalog item.
catalogVersionId	string	true		ID of the catalog version.
identifier	string	true	maxLength: 45 minLength: 1 minLength: 1	Short name of this table (used directly as part of generated feature names).
requiredFeatures	[string]	false		List of required feature names used by the table.
snapshotPolicy	string,null	true		Policy to be used by a dataset while making prediction.

Enumerated Values¶

Property	Value
snapshotPolicy	[`specified`, `latest`, `dynamic`]

StoredCredentials


{
  "catalogVersionId": "string",
  "credentialId": "string",
  "url": "string"
}

Properties¶

Name	Type	Required	Description
catalogVersionId	string	false	Identifier of the catalog version
credentialId	string	true	ID of the credentials object in credential store.Can only be used along with catalogVersionId.
url	string,null	false	URL that is subject to credentials.

TargetBin


{
  "targetBinEnd": 0,
  "targetBinStart": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
targetBinEnd	number	true		End value for the target bin
targetBinStart	number	true		Start value for the target bin

TextLine


{
  "bottom": 0,
  "left": 0,
  "right": 0,
  "text": "string",
  "top": 0
}

Properties¶

Name	Type	Required	Restrictions	Description
bottom	integer	true	minimum: 0	Bottom coordinate of the bounding box belonging to this text line in number of pixels from the top image side.
left	integer	true	minimum: 0	Left coordinate of the bounding box belonging to this text line in number of pixels from the left image side.
right	integer	true	minimum: 0	Right coordinate of the bounding box belonging to this text line in number of pixels from the left image side.
text	string	true		The text in this text line.
top	integer	true	minimum: 0	Top coordinate of the bounding box belonging to this text line in number of pixels from the top image side.

TimeDelta


{
  "duration": 0,
  "timeUnit": "string"
}

End of the feature derivation window applied.

Properties¶

Name	Type	Required	Restrictions	Description
duration	integer	true	minimum: 0	Value/size of this time delta.
timeUnit	string	true		Time unit name like 'MINUTE', 'DAY', 'MONTH' etc.

TimeSeriesFeatureLogListControllerResponse


{
  "count": 0,
  "featureLog": "string",
  "next": "http://example.com",
  "previous": "http://example.com",
  "totalLogLines": 0
}

Properties¶

Name	Type	Required	Description
count	integer	true	The number of items returned on this page.
featureLog	string	true	The content of the feature log.
next	string,null(uri)	true	URL pointing to the next page (if null, there is no next page).
previous	string,null(uri)	true	URL pointing to the previous page (if null, there is no previous page).
totalLogLines	integer	true	The total number of lines in feature derivation log.

UpdateFeaturelist


{
  "description": "string",
  "name": "string"
}

Properties¶

Name	Type	Required	Restrictions	Description
description	string	false	maxLength: 1000	The new featurelist description.
name	string	false	maxLength: 100	The new featurelist name.

Warnings


{
  "action": "string",
  "category": "green",
  "message": "string"
}

Warning about the enrichment rate

Properties¶

Name	Type	Required	Description
action	string,null	true	Suggested action to fix the relationship
category	string	true	Class of the warning about an aspect of the relationship
message	string	true	Warning message about an aspect of the relationship

Enumerated Values¶

Property	Value
category	[`green`, `yellow`]