Documents¶
This page outlines the operations, endpoints, parameters, and example requests and responses for the Documents.
GET /api/v2/datasets/{datasetId}/documentsDataQualityLog/¶
Retrieve the documents data quality log content and log length as JSON.
Code samples¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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}/versions/{datasetVersionId}/documentsDataQualityLog/¶
Retrieve the documents data quality log content and log length as JSON.
Code samples¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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¶
202 Response
{
"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/projects/{projectId}/documentPages/{documentPageId}/file/¶
Returns a file for a single document page.
Code samples¶
# You can also use wget
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¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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¶
200 Response
{
"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¶
# You can also use wget
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
Schemas¶
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 | Restrictions | 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 | Restrictions | 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 | Restrictions | 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 | Restrictions | 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 | Restrictions | 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(uri)¦null | true | URL pointing to the next page (if null, there is no next page). | |
previous | string(uri)¦null | 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 | Restrictions | Description |
---|---|---|---|---|
count | integer | false | Number of items returned on this page. | |
data | [DocumentTextExtractionDocumentElement] | true | A list of documents. | |
next | string(uri)¦null | true | URL pointing to the next page (if null, there is no next page). | |
previous | string(uri)¦null | true | URL pointing to the previous page (if null, there is no previous page). | |
targetBins | [TargetBin]¦null | true | List of bin objects for regression or null | |
targetValues | [string]¦null | 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 | Restrictions | Description |
---|---|---|---|---|
count | integer | false | Number of items returned on this page. | |
data | [DocumentTextExtractionPagesElement] | true | List of document pages | |
next | string(uri)¦null | true | URL pointing to the next page (if null, there is no next page). | |
previous | string(uri)¦null | true | URL pointing to the previous page (if null, there is no previous page). | |
targetBins | [TargetBin]¦null | true | List of bin objects for regression or null | |
targetValues | [string]¦null | 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 | Restrictions | Description |
---|---|---|---|---|
count | integer | false | Number of items returned on this page. | |
data | [DocumentThumbnailMetadataWithBins] | true | List of document thumbnail metadata, as described below | |
next | string(uri)¦null | true | URL pointing to the next page (if null, there is no next page). | |
previous | string(uri)¦null | 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 | Restrictions | Description |
---|---|---|---|---|
count | integer | false | Number of items returned on this page. | |
data | [DocumentThumbnailMetadataResponse] | true | A list of document thumbnail metadata elements | |
next | string(uri)¦null | true | URL pointing to the next page (if null, there is no next page). | |
previous | string(uri)¦null | 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 | Restrictions | 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 | Restrictions | 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 | Restrictions | 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(uri)¦null | true | URL pointing to the next page (if null, there is no next page). | |
previous | string(uri)¦null | 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]¦null | 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 |
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. |