/nanonets | Type: Application | PCID required: Yes
Tools
nanonets_get_image_classification_model
Get Model Details by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
}
},
"required": [
"PCID",
"id"
]
}
nanonets_get_ocr_model
Get Model Details by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
}
},
"required": [
"PCID",
"model_id"
]
}
nanonets_get_ocr_prediction
Get Prediction File by ID Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
id | string | Yes | — | The ID of the file for which the prediction has to be retrieved. It can be found in the response on uploading prediction files synchronously or asynchronously or while retrieving all prediction file data. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"id": {
"type": "string",
"description": "The ID of the file for which the prediction has to be retrieved. It can be found in the response on uploading prediction files [synchronously](#operation/ocr/predict/file) or [asynchronously](#operation/ocr/predict/file/async) or while [retrieving all prediction file data](#operation/ocr/predict/getFile). <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
}
},
"required": [
"PCID",
"model_id",
"id"
]
}
nanonets_list_image_classification_models
Get All Model DetailsShow inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
}
},
"required": [
"PCID"
]
}
nanonets_list_ocr_predictions
Get All Prediction Files Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
start_day_interval | integer | Yes | — | The start of the interval for which prediction files are needed. <br /> Format: Number of days since Unix epoch time <br /> Eg: 1620130500 seconds / 86400 seconds per day ~ 18,751 days |
current_batch_day | integer | Yes | — | The end of the interval for which prediction files are needed. <br /> Format: Number of days since Unix epoch time <br /> Eg: 1630930872 seconds / 86400 seconds per day ~ 18,876 days <br /> NOTE: The value of this parameter has to be greater than the value of the start_day_interval parameter. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"start_day_interval": {
"type": "integer",
"description": "The start of the interval for which prediction files are needed. <br /> **Format**: Number of days since [Unix epoch time](https://www.epochconverter.com) <br /> **Eg**: 1620130500 seconds / 86400 seconds per day ~ `18,751` days"
},
"current_batch_day": {
"type": "integer",
"description": "The end of the interval for which prediction files are needed. <br /> **Format**: Number of days since [Unix epoch time](https://www.epochconverter.com) <br /> **Eg**: 1630930872 seconds / 86400 seconds per day ~ `18,876` days <br /> **NOTE**: The value of this parameter has to be greater than the value of the [`start_day_interval` parameter](#operation/ocr/predict/getfile!in=query&path=start_day_interval&t=request)."
}
},
"required": [
"PCID",
"model_id",
"start_day_interval",
"current_batch_day"
]
}
nanonets_predict_classification_from_file
Prediction for Image File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
file | string | Yes | — | The file to be uploaded. <br /> Format: PNG, JPEG or PDF |
modelId | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"file": {
"type": "string",
"description": "The file to be uploaded. <br /> **Format**: PNG, JPEG or PDF"
},
"modelId": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
}
},
"required": [
"PCID",
"file",
"modelId"
]
}
nanonets_predict_classification_from_url
Prediction for Image URLs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modelId | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
urls | string | Yes | — | Array of URLs of the training files. <br /> Format: PNG, JPEG and/or PDF |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"modelId": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"urls": {
"type": "string",
"description": "Array of URLs of the training files. <br /> **Format**: PNG, JPEG and/or PDF"
}
},
"required": [
"PCID",
"modelId",
"urls"
]
}
nanonets_predict_ocr_from_file
Prediction for Image File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
file | string | Yes | — | The file to be uploaded. <br /> Format: PNG, JPEG or PDF |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"file": {
"type": "string",
"description": "The file to be uploaded. <br /> **Format**: PNG, JPEG or PDF"
}
},
"required": [
"PCID",
"model_id",
"file"
]
}
nanonets_predict_ocr_from_file_async
Async Prediction for Image File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
async | boolean | Yes | — | Indicates that the request has to be processed asynchronously. <br /> NOTE: true is the only accepted value. |
file | string | Yes | — | The file to be uploaded. <br /> Format: PNG, JPEG or PDF |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"async": {
"type": "boolean",
"description": "Indicates that the request has to be processed asynchronously. <br /> **NOTE**: `true` is the only accepted value."
},
"file": {
"type": "string",
"description": "The file to be uploaded. <br /> **Format**: PNG, JPEG or PDF"
}
},
"required": [
"PCID",
"model_id",
"async",
"file"
]
}
nanonets_predict_ocr_from_url
Prediction for Image URLs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
body | object | Yes | — | The parameters to be sent in the request’s body. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"body": {
"description": "The parameters to be sent in the request's body."
}
},
"required": [
"PCID",
"model_id",
"body"
]
}
nanonets_predict_ocr_from_url_async
Async Prediction for Image URLs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
async | boolean | Yes | — | Indicates that the request has to be processed asynchronously. <br /> NOTE: true is the only accepted value. |
body | object | Yes | — | The parameters to be sent in the request’s body. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"async": {
"type": "boolean",
"description": "Indicates that the request has to be processed asynchronously. <br /> **NOTE**: `true` is the only accepted value."
},
"body": {
"description": "The parameters to be sent in the request's body."
}
},
"required": [
"PCID",
"model_id",
"async",
"body"
]
}
nanonets_train_classification_model
Train Model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
modelId | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"modelId": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
}
},
"required": [
"PCID",
"modelId"
]
}
nanonets_train_ocr_model
Train Model Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
}
},
"required": [
"PCID",
"model_id"
]
}
nanonets_upload_classification_training_file
Upload Training Images by File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | object | Yes | — | The parameters to be sent in the request’s body. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"body": {
"description": "The parameters to be sent in the request's body."
}
},
"required": [
"PCID",
"body"
]
}
nanonets_upload_classification_training_urls
Upload Training Images by URLs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
category | string | Yes | — | TBD |
modelId | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
urls | string | Yes | — | Array of URLs of the training files. <br /> Format: PNG, JPEG and/or PDF |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"category": {
"type": "string",
"description": "TBD"
},
"modelId": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"urls": {
"type": "string",
"description": "Array of URLs of the training files. <br /> **Format**: PNG, JPEG and/or PDF"
}
},
"required": [
"PCID",
"category",
"modelId",
"urls"
]
}
nanonets_upload_ocr_training_file
Upload Training Images by File Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
data | string | Yes | — | The name of the file to be uploaded. <br /> Format: "data": "[{"filename": "filename.ext"}]". <br /> NOTE: The filename must be the same as the uploaded file name. |
file | string | Yes | — | The file to be uploaded. <br /> Format: PNG, JPEG or PDF |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"data": {
"type": "string",
"description": "The name of the file to be uploaded. <br /> **Format**: `\"data\": \"[{\"filename\": \"filename.ext\"}]\"`. <br /> **NOTE**: The `filename` must be the same as the uploaded file name."
},
"file": {
"type": "string",
"description": "The file to be uploaded. <br /> **Format**: PNG, JPEG or PDF"
}
},
"required": [
"PCID",
"model_id",
"data",
"file"
]
}
nanonets_upload_ocr_training_urls
Upload Training Images by URLs Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
Content-Type | string | Yes | — | Set the ‘Content-Type’ header value. <br /> Eg: "Content-Type": ""application/json"" |
model_id | string | Yes | — | The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> Eg: 0a0aa000-0000-0a0-aa00-000a0000000a |
body | object | Yes | — | The parameters to be sent in the request’s body. |
Show inputSchema
Show inputSchema
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Content-Type": {
"type": "string",
"description": "Set the ['Content-Type' header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type) value. <br /> **Eg**: `\"Content-Type\": \"\"application/json\"\"`"
},
"model_id": {
"type": "string",
"description": "The ID of the model on which the operation is to be performed. It can be found in the model settings. <br /> **Eg**: `0a0aa000-0000-0a0-aa00-000a0000000a`"
},
"body": {
"description": "The parameters to be sent in the request's body."
}
},
"required": [
"PCID",
"Content-Type",
"model_id",
"body"
]
}