{
"swagger": "2.0",
"info": {
"title": "Custom_Vision_Training_2.1",
"version": "1.0"
},
"host": "cognitiveswwprod.cognitiveservices.azure.com",
"basePath": "/customvision/v2.1/Training",
"schemes": [
"https"
],
"securityDefinitions": {
"apiKeyHeader": {
"type": "apiKey",
"name": "Training-key",
"in": "header"
},
"apiKeyQuery": {
"type": "apiKey",
"name": "Training-key",
"in": "query"
}
},
"security": [
{
"apiKeyHeader": []
},
{
"apiKeyQuery": []
}
],
"x-servers": [
{
"url": "https://cognitiveswwprod.cognitiveservices.azure.com"
},
{
"url": "https://switzerlandwest.api.cognitive.microsoft.com"
},
{
"url": "https://cognitiveswwprod.openai.azure.com"
}
],
"paths": {
"/projects/{projectId}/images/regions": {
"post": {
"description": "This API accepts a batch of image regions, and optionally tags, to update existing images with region information.\nThere is a limit of 64 entries in the batch.",
"operationId": "5b23149ddad0a818dc4ef2b9",
"summary": "CreateImageRegions",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "imageRegionCreateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageRegionCreateBatch"
},
"description": "Batch of image regions which include a tag and bounding box. Limited to 64"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageRegionCreateSummary"
},
"examples": {
"application/json": {
"created": [
{
"imageId": "string",
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
},
"text/json": {
"created": [
{
"imageId": "string",
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
},
"application/xml": "\r\n \r\n string\r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n",
"text/xml": "\r\n \r\n string\r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n"
}
}
}
},
"delete": {
"description": "Delete a set of image regions",
"operationId": "5b23149ddad0a818dc4ef2ba",
"summary": "DeleteImageRegions",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "regionIds",
"in": "query",
"description": "Regions to delete. Limited to 64",
"required": true,
"type": "array"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/projects/{projectId}/images": {
"post": {
"description": "This API accepts body content as multipart/form-data and application/octet-stream. When using multipart\nmultiple image files can be sent at once, with a maximum of 64 files",
"operationId": "5b23149ddad0a818dc4ef2b2",
"summary": "CreateImagesFromData",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "tagIds",
"in": "query",
"description": "The tags ids with which to tag each image. Limited to 20",
"type": "array"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "imageData",
"in": "formData",
"required": true,
"type": "file"
}
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageCreateSummary"
},
"examples": {
"application/json": {
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
},
"text/json": {
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
},
"application/xml": "\r\n true\r\n \r\n string\r\n OK\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n",
"text/xml": "\r\n true\r\n \r\n string\r\n OK\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
},
"delete": {
"description": "Delete images from the set of training images",
"operationId": "5b23149ddad0a818dc4ef2b3",
"summary": "DeleteImages",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "imageIds",
"in": "query",
"description": "Ids of the images to be deleted. Limted to 256 images per batch",
"required": true,
"type": "array"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/projects/{projectId}/images/files": {
"post": {
"description": "This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.",
"operationId": "5b23149ddad0a818dc4ef2b4",
"summary": "CreateImagesFromFiles",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "imageFileCreateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageFileCreateBatch"
},
"description": "The batch of image files to add. Limited to 64 images and 20 tags per batch"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageCreateSummary"
},
"examples": {
"application/json": {
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
},
"text/json": {
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
},
"application/xml": "\r\n true\r\n \r\n string\r\n OK\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n",
"text/xml": "\r\n true\r\n \r\n string\r\n OK\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/predictions": {
"post": {
"description": "This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.",
"operationId": "5b23149ddad0a818dc4ef2b6",
"summary": "CreateImagesFromPredictions",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "imageIdCreateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageIdCreateBatch"
},
"description": "Image and tag ids. Limted to 64 images and 20 tags per batch"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageCreateSummary"
},
"examples": {
"application/json": {
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
},
"text/json": {
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
},
"application/xml": "\r\n true\r\n \r\n string\r\n OK\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n",
"text/xml": "\r\n true\r\n \r\n string\r\n OK\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/urls": {
"post": {
"description": "This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.",
"operationId": "5b23149ddad0a818dc4ef2b5",
"summary": "CreateImagesFromUrls",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "imageUrlCreateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageUrlCreateBatch"
},
"description": "Image urls and tag ids. Limited to 64 images and 20 tags per batch"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageCreateSummary"
},
"examples": {
"application/json": {
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
},
"text/json": {
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
}
]
},
"application/xml": "\r\n true\r\n \r\n string\r\n OK\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n",
"text/xml": "\r\n true\r\n \r\n string\r\n OK\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/tags": {
"post": {
"description": "Associate a set of images with a set of tags",
"operationId": "5b23149ddad0a818dc4ef2b7",
"summary": "CreateImageTags",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "imageTagCreateBatch",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageTagCreateBatch"
},
"description": "Batch of image tags. Limited to 128 tags per batch"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageTagCreateSummary"
},
"examples": {
"application/json": {
"created": [
{
"imageId": "string",
"tagId": "string"
}
],
"duplicated": [
{
"imageId": "string",
"tagId": "string"
}
],
"exceeded": [
{
"imageId": "string",
"tagId": "string"
}
]
},
"text/json": {
"created": [
{
"imageId": "string",
"tagId": "string"
}
],
"duplicated": [
{
"imageId": "string",
"tagId": "string"
}
],
"exceeded": [
{
"imageId": "string",
"tagId": "string"
}
]
},
"application/xml": "\r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n \r\n",
"text/xml": "\r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n \r\n"
}
}
}
},
"delete": {
"description": "Remove a set of tags from a set of images",
"operationId": "5b23149ddad0a818dc4ef2b8",
"summary": "DeleteImageTags",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "imageIds",
"in": "query",
"description": "Image ids. Limited to 64 images",
"required": true,
"type": "array"
},
{
"name": "tagIds",
"in": "query",
"description": "Tags to be deleted from the specified images. Limted to 20 tags",
"required": true,
"type": "array"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/projects": {
"post": {
"description": "Create a project",
"operationId": "5b23149ddad0a818dc4ef2c6",
"summary": "CreateProject",
"parameters": [
{
"name": "name",
"in": "query",
"description": "Name of the project",
"required": true,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "The description of the project",
"type": "string"
},
{
"name": "domainId",
"in": "query",
"description": "Format - uuid. The id of the domain to use for this project. Defaults to General",
"type": "string"
},
{
"name": "classificationType",
"in": "query",
"description": "The type of classifier to create for this project",
"type": "string",
"enum": [
"Multiclass",
"Multilabel"
]
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Project"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
},
"text/json": {
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
},
"application/xml": "\r\n string\r\n string\r\n string\r\n \r\n string\r\n Multiclass\r\n \r\n string\r\n string\r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n \r\n string\r\n Multiclass\r\n \r\n string\r\n string\r\n string\r\n"
}
}
}
},
"get": {
"description": "Get your projects",
"operationId": "5b23149ddad0a818dc4ef2c5",
"summary": "GetProjects",
"parameters": [
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ProjectArray"
},
"examples": {
"application/json": [
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
}
],
"text/json": [
{
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
}
],
"application/xml": "\r\n string\r\n string\r\n string\r\n \r\n string\r\n Multiclass\r\n \r\n string\r\n string\r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n \r\n string\r\n Multiclass\r\n \r\n string\r\n string\r\n string\r\n"
}
}
}
}
},
"/projects/{projectId}/tags": {
"post": {
"description": "Create a tag for the project",
"operationId": "5b23149ddad0a818dc4ef2d3",
"summary": "CreateTag",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "query",
"description": "The tag name",
"required": true,
"type": "string"
},
{
"name": "description",
"in": "query",
"description": "Optional description for the tag",
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Tag"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
},
"text/json": {
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
},
"application/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n"
}
}
}
},
"get": {
"description": "Get the tags for a given project and iteration",
"operationId": "5b23149ddad0a818dc4ef2d2",
"summary": "GetTags",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. Defaults to workspace",
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/TagArray"
},
"examples": {
"application/json": [
{
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
}
],
"text/json": [
{
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
}
],
"application/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n"
}
}
}
}
},
"/projects/{projectId}/iterations/{iterationId}": {
"delete": {
"description": "Delete a specific iteration of a project",
"operationId": "5b23149ddad0a818dc4ef2cd",
"summary": "DeleteIteration",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The iteration id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"description": "Get a specific iteration",
"operationId": "5b23149ddad0a818dc4ef2cc",
"summary": "GetIteration",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The id of the project the iteration belongs to",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The id of the iteration to get",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Iteration"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
},
"text/json": {
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
},
"application/xml": "\r\n string\r\n string\r\n true\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n string\r\n Multiclass\r\n",
"text/xml": "\r\n string\r\n string\r\n true\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n string\r\n Multiclass\r\n"
}
}
}
},
"patch": {
"description": "Update a specific iteration",
"operationId": "5b23149ddad0a818dc4ef2ce",
"summary": "UpdateIteration",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. Project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. Iteration id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "iteration",
"in": "body",
"schema": {
"$ref": "#/definitions/Iteration"
},
"description": "The updated iteration model"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Iteration"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
},
"text/json": {
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
},
"application/xml": "\r\n string\r\n string\r\n true\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n string\r\n Multiclass\r\n",
"text/xml": "\r\n string\r\n string\r\n true\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n string\r\n Multiclass\r\n"
}
}
}
}
},
"/projects/{projectId}/predictions": {
"delete": {
"description": "Delete a set of predicted images and their associated prediction results",
"operationId": "5b23149ddad0a818dc4ef2bc",
"summary": "DeletePrediction",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "ids",
"in": "query",
"description": "The prediction ids. Limited to 64",
"required": true,
"type": "array"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
}
},
"/projects/{projectId}": {
"delete": {
"description": "Delete a specific project",
"operationId": "5b23149ddad0a818dc4ef2c8",
"summary": "DeleteProject",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"description": "Get a specific project",
"operationId": "5b23149ddad0a818dc4ef2c7",
"summary": "GetProject",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The id of the project to get",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Project"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
},
"text/json": {
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
},
"application/xml": "\r\n string\r\n string\r\n string\r\n \r\n string\r\n Multiclass\r\n \r\n string\r\n string\r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n \r\n string\r\n Multiclass\r\n \r\n string\r\n string\r\n string\r\n"
}
}
}
},
"patch": {
"description": "Update a specific project",
"operationId": "5b23149ddad0a818dc4ef2c9",
"summary": "UpdateProject",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The id of the project to update",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "project",
"in": "body",
"schema": {
"$ref": "#/definitions/Project"
},
"description": "The updated project model"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Project"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
},
"text/json": {
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
},
"application/xml": "\r\n string\r\n string\r\n string\r\n \r\n string\r\n Multiclass\r\n \r\n string\r\n string\r\n string\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n \r\n string\r\n Multiclass\r\n \r\n string\r\n string\r\n string\r\n"
}
}
}
}
},
"/projects/{projectId}/tags/{tagId}": {
"delete": {
"description": "Delete a tag from the project",
"operationId": "5b23149ddad0a818dc4ef2d0",
"summary": "DeleteTag",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "tagId",
"in": "path",
"description": "Format - uuid. Id of the tag to be deleted",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "No Content"
}
}
},
"get": {
"description": "Get information about a specific tag",
"operationId": "5b23149ddad0a818dc4ef2cf",
"summary": "GetTag",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project this tag belongs to",
"required": true,
"type": "string"
},
{
"name": "tagId",
"in": "path",
"description": "Format - uuid. The tag id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set",
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Tag"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
},
"text/json": {
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
},
"application/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n"
}
}
}
},
"patch": {
"description": "Update a tag",
"operationId": "5b23149ddad0a818dc4ef2d1",
"summary": "UpdateTag",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "tagId",
"in": "path",
"description": "Format - uuid. The id of the target tag",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "tag",
"in": "body",
"schema": {
"$ref": "#/definitions/Tag"
},
"description": "The updated tag model"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Tag"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
},
"text/json": {
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
},
"application/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n 0\r\n"
}
}
}
}
},
"/projects/{projectId}/iterations/{iterationId}/export": {
"post": {
"description": "Export a trained iteration",
"operationId": "5b23149ddad0a818dc4ef2c4",
"summary": "ExportIteration",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The iteration id",
"required": true,
"type": "string"
},
{
"name": "platform",
"in": "query",
"description": "The target platform (coreml or tensorflow)",
"required": true,
"type": "string",
"enum": [
"CoreML",
"TensorFlow",
"DockerFile",
"ONNX"
]
},
{
"name": "flavor",
"in": "query",
"description": "The flavor of the target platform (Windows, Linux, ARM, or GPU)",
"type": "string",
"enum": [
"Linux",
"Windows"
]
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Export"
},
"examples": {
"application/json": {
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
},
"text/json": {
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
},
"application/xml": "\r\n CoreML\r\n Exporting\r\n string\r\n Linux\r\n true\r\n",
"text/xml": "\r\n CoreML\r\n Exporting\r\n string\r\n Linux\r\n true\r\n"
}
}
}
},
"get": {
"description": "Get the list of exports for a specific iteration",
"operationId": "5b23149ddad0a818dc4ef2c3",
"summary": "GetExports",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The iteration id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ExportArray"
},
"examples": {
"application/json": [
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
],
"text/json": [
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
],
"application/xml": "\r\n CoreML\r\n Exporting\r\n string\r\n Linux\r\n true\r\n",
"text/xml": "\r\n CoreML\r\n Exporting\r\n string\r\n Linux\r\n true\r\n"
}
}
}
}
},
"/domains/{domainId}": {
"get": {
"description": "Get information about a specific domain",
"operationId": "5b23149ddad0a818dc4ef2ac",
"summary": "GetDomain",
"parameters": [
{
"name": "domainId",
"in": "path",
"description": "Format - uuid. The id of the domain to get information about",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Domain"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
},
"text/json": {
"id": "string",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
},
"application/xml": "\r\n string\r\n string\r\n Classification\r\n true\r\n true\r\n",
"text/xml": "\r\n string\r\n string\r\n Classification\r\n true\r\n true\r\n"
}
}
}
}
},
"/domains": {
"get": {
"description": "Get a list of the available domains",
"operationId": "5b23149ddad0a818dc4ef2ab",
"summary": "GetDomains",
"parameters": [
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/DomainArray"
},
"examples": {
"application/json": [
{
"id": "string",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
],
"text/json": [
{
"id": "string",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
],
"application/xml": "\r\n string\r\n string\r\n Classification\r\n true\r\n true\r\n",
"text/xml": "\r\n string\r\n string\r\n Classification\r\n true\r\n true\r\n"
}
}
}
}
},
"/projects/{projectId}/iterations/{iterationId}/performance/images/count": {
"get": {
"description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
"operationId": "5b23149ddad0a818dc4ef2c2",
"summary": "GetImagePerformanceCount",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The iteration id. Defaults to workspace",
"required": true,
"type": "string"
},
{
"name": "tagIds",
"in": "query",
"description": "A list of tags ids to filter the images to count. Defaults to all tags when null.",
"type": "array"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Projects{projectId}Iterations{iterationId}PerformanceImagesCountGet200TextXmlResponse"
},
"examples": {
"application/json": 0,
"text/json": 0,
"application/xml": "0",
"text/xml": "0"
}
}
}
}
},
"/projects/{projectId}/iterations/{iterationId}/performance/images": {
"get": {
"description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
"operationId": "5b23149ddad0a818dc4ef2c1",
"summary": "GetImagePerformances",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The iteration id. Defaults to workspace",
"required": true,
"type": "string"
},
{
"name": "tagIds",
"in": "query",
"description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20",
"type": "array"
},
{
"name": "orderBy",
"in": "query",
"description": "The ordering. Defaults to newest",
"type": "string",
"enum": [
"Newest",
"Oldest"
]
},
{
"name": "take",
"in": "query",
"description": "Format - int32. Maximum number of images to return. Defaults to 50, limited to 256",
"type": "integer",
"default": 50
},
{
"name": "skip",
"in": "query",
"description": "Format - int32. Number of images to skip before beginning the image batch. Defaults to 0",
"type": "integer",
"default": 0
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePerformanceArray"
},
"examples": {
"application/json": [
{
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
],
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"text/json": [
{
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
],
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"application/xml": "\r\n \r\n 0\r\n string\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n",
"text/xml": "\r\n \r\n 0\r\n string\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n"
}
}
}
}
},
"/{projectId}/images/{imageId}/regionproposals": {
"post": {
"description": "This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.",
"operationId": "5b23149ddad0a818dc4ef2bb",
"summary": "GetImageRegionProposals",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "imageId",
"in": "path",
"description": "Format - uuid. The image id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageRegionProposal"
},
"examples": {
"application/json": {
"projectId": "string",
"imageId": "string",
"proposals": [
{
"confidence": 0.0,
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
},
"text/json": {
"projectId": "string",
"imageId": "string",
"proposals": [
{
"confidence": 0.0,
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
}
}
}
}
},
"/projects/{projectId}/images/id": {
"get": {
"description": "This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the\ncurrent workspace is used.",
"operationId": "5b23149ddad0a818dc4ef2b1",
"summary": "GetImagesByIds",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "imageIds",
"in": "query",
"description": "The list of image ids to retrieve. Limited to 256",
"type": "array"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. Defaults to workspace",
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageArray"
},
"examples": {
"application/json": [
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"text/json": [
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"application/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/iterations/{iterationId}/performance": {
"get": {
"description": "Get detailed performance information about an iteration",
"operationId": "5b23149ddad0a818dc4ef2c0",
"summary": "GetIterationPerformance",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The id of the project the iteration belongs to",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "path",
"description": "Format - uuid. The id of the iteration to get",
"required": true,
"type": "string"
},
{
"name": "threshold",
"in": "query",
"description": "Format - float. The threshold used to determine true predictions",
"type": "number"
},
{
"name": "overlapThreshold",
"in": "query",
"description": "Format - float. If applicable, the bounding box overlap threshold used to determine true predictions",
"type": "number"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IterationPerformance"
},
"examples": {
"application/json": {
"perTagPerformance": [
{
"id": "string",
"name": "string",
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
],
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
},
"text/json": {
"perTagPerformance": [
{
"id": "string",
"name": "string",
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
],
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
},
"application/xml": "\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n 0\r\n",
"text/xml": "\r\n \r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n 0\r\n"
}
}
}
}
},
"/projects/{projectId}/iterations": {
"get": {
"description": "Get iterations for the project",
"operationId": "5b23149ddad0a818dc4ef2cb",
"summary": "GetIterations",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/IterationArray"
},
"examples": {
"application/json": [
{
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
}
],
"text/json": [
{
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
}
],
"application/xml": "\r\n string\r\n string\r\n true\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n string\r\n Multiclass\r\n",
"text/xml": "\r\n string\r\n string\r\n true\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n string\r\n Multiclass\r\n"
}
}
}
}
},
"/projects/{projectId}/images/tagged/count": {
"get": {
"description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
"operationId": "5b23149ddad0a818dc4ef2af",
"summary": "GetTaggedImageCount",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. Defaults to workspace",
"type": "string"
},
{
"name": "tagIds",
"in": "query",
"description": "A list of tags ids to filter the images to count. Defaults to all tags when null.",
"type": "array"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Projects{projectId}ImagesTaggedCountGet200TextXmlResponse"
},
"examples": {
"application/json": 0,
"text/json": 0,
"application/xml": "0",
"text/xml": "0"
}
}
}
}
},
"/projects/{projectId}/images/tagged": {
"get": {
"description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned",
"operationId": "5b23149ddad0a818dc4ef2ad",
"summary": "GetTaggedImages",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. Defaults to workspace",
"type": "string"
},
{
"name": "tagIds",
"in": "query",
"description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20",
"type": "array"
},
{
"name": "orderBy",
"in": "query",
"description": "The ordering. Defaults to newest",
"type": "string",
"enum": [
"Newest",
"Oldest"
]
},
{
"name": "take",
"in": "query",
"description": "Format - int32. Maximum number of images to return. Defaults to 50, limited to 256",
"type": "integer",
"default": 50
},
{
"name": "skip",
"in": "query",
"description": "Format - int32. Number of images to skip before beginning the image batch. Defaults to 0",
"type": "integer",
"default": 0
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageArray"
},
"examples": {
"application/json": [
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"text/json": [
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"application/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/images/untagged/count": {
"get": {
"description": "This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the\ncurrent workspace is used.",
"operationId": "5b23149ddad0a818dc4ef2b0",
"summary": "GetUntaggedImageCount",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. Defaults to workspace",
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Projects{projectId}ImagesUntaggedCountGet200TextXmlResponse"
},
"examples": {
"application/json": 0,
"text/json": 0,
"application/xml": "0",
"text/xml": "0"
}
}
}
}
},
"/projects/{projectId}/images/untagged": {
"get": {
"description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\nUse the {take} and {skip} parameters to control how many images to return in a given batch.",
"operationId": "5b23149ddad0a818dc4ef2ae",
"summary": "GetUntaggedImages",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. The iteration id. Defaults to workspace",
"type": "string"
},
{
"name": "orderBy",
"in": "query",
"description": "The ordering. Defaults to newest",
"type": "string",
"enum": [
"Newest",
"Oldest"
]
},
{
"name": "take",
"in": "query",
"description": "Format - int32. Maximum number of images to return. Defaults to 50, limited to 256",
"type": "integer",
"default": 50
},
{
"name": "skip",
"in": "query",
"description": "Format - int32. Number of images to skip before beginning the image batch. Defaults to 0",
"type": "integer",
"default": 0
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImageArray"
},
"examples": {
"application/json": [
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"text/json": [
{
"id": "string",
"created": "string",
"width": 0,
"height": 0,
"imageUri": "string",
"thumbnailUri": "string",
"tags": [
{
"tagId": "string",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "string",
"tagName": "string",
"created": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"application/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n 0\r\n 0\r\n string\r\n string\r\n \r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/predictions/query": {
"post": {
"description": "Get images that were sent to your prediction endpoint",
"operationId": "5b23149ddad0a818dc4ef2bd",
"summary": "QueryPredictions",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "predictionQueryToken",
"in": "body",
"schema": {
"$ref": "#/definitions/PredictionQueryToken"
},
"description": "Parameters used to query the predictions. Limited to combining 2 tags"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/PredictionQueryResult"
},
"examples": {
"application/json": {
"token": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
},
"results": [
{
"imageUri": "string",
"thumbnailUri": "string",
"domain": "string",
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
]
},
"text/json": {
"token": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
},
"results": [
{
"imageUri": "string",
"thumbnailUri": "string",
"domain": "string",
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
]
},
"application/xml": "\r\n \r\n string\r\n string\r\n 0\r\n Newest\r\n \r\n string\r\n 0\r\n 0\r\n \r\n string\r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n 0\r\n string\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n",
"text/xml": "\r\n \r\n string\r\n string\r\n 0\r\n Newest\r\n \r\n string\r\n 0\r\n 0\r\n \r\n string\r\n string\r\n string\r\n string\r\n \r\n \r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n string\r\n \r\n 0\r\n string\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/quicktest/image": {
"post": {
"description": "Quick test an image",
"operationId": "5b23149ddad0a818dc4ef2bf",
"summary": "QuickTestImage",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.\r\n The default iteration for the project will be used when not specified.",
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "imageData",
"in": "formData",
"required": true,
"type": "file"
}
],
"consumes": [
"multipart/form-data"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
},
"text/json": {
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
},
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n \r\n 0\r\n string\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n \r\n 0\r\n string\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/quicktest/url": {
"post": {
"description": "Quick test an image url",
"operationId": "5b23149ddad0a818dc4ef2be",
"summary": "QuickTestImageUrl",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project to evaluate against",
"required": true,
"type": "string"
},
{
"name": "iterationId",
"in": "query",
"description": "Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.\r\n The default iteration for the project will be used when not specified.",
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
},
{
"name": "imageUrl",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageUrl"
},
"description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated"
}
],
"consumes": [
"application/json",
"text/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
},
"text/json": {
"id": "string",
"project": "string",
"iteration": "string",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "string",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
},
"application/xml": "\r\n string\r\n string\r\n string\r\n string\r\n \r\n 0\r\n string\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n",
"text/xml": "\r\n string\r\n string\r\n string\r\n string\r\n \r\n 0\r\n string\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n \r\n"
}
}
}
}
},
"/projects/{projectId}/train": {
"post": {
"description": "Queues project for training",
"operationId": "5b23149ddad0a818dc4ef2ca",
"summary": "TrainProject",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id",
"required": true,
"type": "string"
},
{
"name": "Training-Key",
"in": "header",
"required": true,
"type": "string"
}
],
"produces": [
"application/json",
"text/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Iteration"
},
"examples": {
"application/json": {
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
},
"text/json": {
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
},
"application/xml": "\r\n string\r\n string\r\n true\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n string\r\n Multiclass\r\n",
"text/xml": "\r\n string\r\n string\r\n true\r\n string\r\n string\r\n string\r\n string\r\n string\r\n true\r\n string\r\n Multiclass\r\n"
}
}
}
}
}
},
"definitions": {
"Domain": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"name": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"type": {
"enum": [
"Classification",
"ObjectDetection"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "DomainType",
"modelAsString": true
}
},
"exportable": {
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"enabled": {
"type": "boolean",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"Image": {
"description": "Image model to be sent as JSON",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"imageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"thumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageTag"
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageRegion"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"ImageTag": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"ImageRegion": {
"type": "object",
"properties": {
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"ImageCreateSummary": {
"type": "object",
"properties": {
"isBatchSuccessful": {
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"images": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageCreateResult"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"ImageCreateResult": {
"type": "object",
"properties": {
"sourceUrl": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"status": {
"enum": [
"OK",
"OKDuplicate",
"ErrorSource",
"ErrorImageFormat",
"ErrorImageSize",
"ErrorStorage",
"ErrorLimitExceed",
"ErrorTagLimitExceed",
"ErrorRegionLimitExceed",
"ErrorUnknown"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ImageCreateStatus",
"modelAsString": true
}
},
"image": {
"$ref": "#/definitions/Image",
"readOnly": true
}
},
"x-nullable": true
},
"ImageFileCreateBatch": {
"type": "object",
"properties": {
"images": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageFileCreateEntry"
},
"x-nullable": true
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"images": [
{
"name": "string",
"contents": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
},
"ImageFileCreateEntry": {
"type": "object",
"properties": {
"name": {
"type": "string",
"x-nullable": true
},
"contents": {
"format": "byte",
"type": "string",
"x-nullable": true
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"$ref": "#/definitions/Region"
},
"x-nullable": true
}
},
"x-nullable": true
},
"Region": {
"type": "object",
"properties": {
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"ImageUrlCreateBatch": {
"type": "object",
"properties": {
"images": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageUrlCreateEntry"
},
"x-nullable": true
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"images": [
{
"url": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
},
"ImageUrlCreateEntry": {
"type": "object",
"properties": {
"url": {
"type": "string",
"x-nullable": true
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"$ref": "#/definitions/Region"
},
"x-nullable": true
}
},
"x-nullable": true
},
"ImageIdCreateBatch": {
"type": "object",
"properties": {
"images": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageIdCreateEntry"
},
"x-nullable": true
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"images": [
{
"id": "string",
"tagIds": [
"string"
],
"regions": [
{
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"string"
]
}
},
"ImageIdCreateEntry": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"tagIds": {
"type": "array",
"items": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"$ref": "#/definitions/Region"
},
"x-nullable": true
}
},
"x-nullable": true
},
"ImageTagCreateBatch": {
"type": "object",
"properties": {
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageTagCreateEntry"
},
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"tags": [
{
"imageId": "string",
"tagId": "string"
}
]
}
},
"ImageTagCreateEntry": {
"type": "object",
"properties": {
"imageId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
}
},
"x-nullable": true
},
"ImageTagCreateSummary": {
"type": "object",
"properties": {
"created": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageTagCreateEntry"
},
"x-nullable": true
},
"duplicated": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageTagCreateEntry"
},
"x-nullable": true
},
"exceeded": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageTagCreateEntry"
},
"x-nullable": true
}
},
"x-nullable": true
},
"ImageRegionCreateBatch": {
"description": "Batch of image region information to create.",
"type": "object",
"properties": {
"regions": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageRegionCreateEntry"
},
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"regions": [
{
"imageId": "string",
"tagId": "string",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
},
"ImageRegionCreateEntry": {
"type": "object",
"properties": {
"imageId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"ImageRegionCreateSummary": {
"type": "object",
"properties": {
"created": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageRegionCreateResult"
},
"x-nullable": true
},
"duplicated": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageRegionCreateEntry"
},
"x-nullable": true
},
"exceeded": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageRegionCreateEntry"
},
"x-nullable": true
}
},
"x-nullable": true
},
"ImageRegionCreateResult": {
"type": "object",
"properties": {
"imageId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"regionId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"x-nullable": false
},
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"ImageRegionProposal": {
"type": "object",
"properties": {
"projectId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"imageId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"proposals": {
"type": "array",
"items": {
"$ref": "#/definitions/RegionProposal"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"RegionProposal": {
"type": "object",
"properties": {
"confidence": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"boundingBox": {
"$ref": "#/definitions/BoundingBox",
"readOnly": true
}
},
"x-nullable": true
},
"BoundingBox": {
"type": "object",
"properties": {
"left": {
"format": "float",
"type": "number",
"x-nullable": false
},
"top": {
"format": "float",
"type": "number",
"x-nullable": false
},
"width": {
"format": "float",
"type": "number",
"x-nullable": false
},
"height": {
"format": "float",
"type": "number",
"x-nullable": false
}
},
"x-nullable": true
},
"PredictionQueryToken": {
"type": "object",
"properties": {
"session": {
"type": "string",
"x-nullable": true
},
"continuation": {
"type": "string",
"x-nullable": true
},
"maxCount": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"orderBy": {
"enum": [
"Newest",
"Oldest",
"Suggested"
],
"type": "string",
"x-nullable": false,
"x-ms-enum": {
"name": "OrderBy",
"modelAsString": true
}
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/PredictionQueryTag"
},
"x-nullable": true
},
"iterationId": {
"format": "uuid",
"type": "string",
"x-nullable": true
},
"startTime": {
"format": "date-time",
"type": "string",
"x-nullable": true
},
"endTime": {
"format": "date-time",
"type": "string",
"x-nullable": true
},
"application": {
"type": "string",
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "string",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "string",
"startTime": "string",
"endTime": "string",
"application": "string"
}
},
"PredictionQueryTag": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"minThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"maxThreshold": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"PredictionQueryResult": {
"type": "object",
"properties": {
"token": {
"$ref": "#/definitions/PredictionQueryToken",
"readOnly": true
},
"results": {
"type": "array",
"items": {
"$ref": "#/definitions/StoredImagePrediction"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"StoredImagePrediction": {
"description": "result of an image classification request",
"type": "object",
"properties": {
"imageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"thumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"domain": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"project": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"iteration": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"predictions": {
"type": "array",
"items": {
"$ref": "#/definitions/Prediction"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"Prediction": {
"type": "object",
"properties": {
"probability": {
"format": "float",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"tagName": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"boundingBox": {
"$ref": "#/definitions/BoundingBox",
"readOnly": true
}
},
"x-nullable": true
},
"ImageUrl": {
"type": "object",
"properties": {
"url": {
"type": "string",
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"url": "string"
}
},
"ImagePrediction": {
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"project": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"iteration": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"predictions": {
"type": "array",
"items": {
"$ref": "#/definitions/Prediction"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"IterationPerformance": {
"description": "Represents the detailed performance data for a trained iteration",
"type": "object",
"properties": {
"perTagPerformance": {
"description": "Gets the per-tag performance details for this iteration",
"type": "array",
"items": {
"$ref": "#/definitions/TagPerformance"
},
"readOnly": true,
"x-nullable": true
},
"precision": {
"format": "float",
"description": "Gets the precision",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"precisionStdDeviation": {
"format": "float",
"description": "Gets the standard deviation for the precision",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"recall": {
"format": "float",
"description": "Gets the recall",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"recallStdDeviation": {
"format": "float",
"description": "Gets the standard deviation for the recall",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"averagePrecision": {
"format": "float",
"description": "Gets the average precision when applicable",
"type": "number",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"TagPerformance": {
"description": "Represents performance data for a particular tag in a trained iteration",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"name": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"precision": {
"format": "float",
"description": "Gets the precision",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"precisionStdDeviation": {
"format": "float",
"description": "Gets the standard deviation for the precision",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"recall": {
"format": "float",
"description": "Gets the recall",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"recallStdDeviation": {
"format": "float",
"description": "Gets the standard deviation for the recall",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"averagePrecision": {
"format": "float",
"description": "Gets the average precision when applicable",
"type": "number",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"ImagePerformance": {
"description": "Image performance model",
"type": "object",
"properties": {
"predictions": {
"type": "array",
"items": {
"$ref": "#/definitions/Prediction"
},
"readOnly": true,
"x-nullable": true
},
"id": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"created": {
"format": "date-time",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"width": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"height": {
"format": "int32",
"type": "integer",
"readOnly": true,
"x-nullable": false
},
"imageUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"thumbnailUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"tags": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageTag"
},
"readOnly": true,
"x-nullable": true
},
"regions": {
"type": "array",
"items": {
"$ref": "#/definitions/ImageRegion"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"Project": {
"description": "Represents a project",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Gets the project id",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"name": {
"description": "Gets or sets the name of the project",
"type": "string",
"x-nullable": true
},
"description": {
"description": "Gets or sets the description of the project",
"type": "string",
"x-nullable": true
},
"settings": {
"$ref": "#/definitions/ProjectSettings",
"description": "Gets or sets the project settings"
},
"created": {
"format": "date-time",
"description": "Gets the date this project was created",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"lastModified": {
"format": "date-time",
"description": "Gets the date this project was last modifed",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"thumbnailUri": {
"description": "Gets the thumbnail url representing the project",
"type": "string",
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true,
"example": {
"id": "string",
"name": "string",
"description": "string",
"settings": {
"domainId": "string",
"classificationType": "Multiclass"
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string"
}
},
"ProjectSettings": {
"description": "Represents settings associated with a project",
"type": "object",
"properties": {
"domainId": {
"format": "uuid",
"description": "Gets or sets the id of the Domain to use with this project",
"type": "string",
"x-nullable": false
},
"classificationType": {
"description": "Gets or sets the classification type of the project",
"enum": [
"Multiclass",
"Multilabel"
],
"type": "string",
"x-nullable": true,
"x-ms-enum": {
"name": "Classifier",
"modelAsString": true
}
}
},
"x-nullable": true
},
"Iteration": {
"description": "Iteration model to be sent over JSON",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Gets the id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"name": {
"description": "Gets or sets the name of the iteration",
"type": "string",
"x-nullable": true
},
"isDefault": {
"description": "Gets or sets a value indicating whether the iteration is the default iteration for the project",
"type": "boolean",
"x-nullable": false
},
"status": {
"description": "Gets the current iteration status",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"created": {
"format": "date-time",
"description": "Gets the time this iteration was completed",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"lastModified": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"trainedAt": {
"format": "date-time",
"description": "Gets the time this iteration was last modified",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"projectId": {
"format": "uuid",
"description": "Gets the project id of the iteration",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"exportable": {
"description": "Whether the iteration can be exported to another format for download",
"type": "boolean",
"readOnly": true,
"x-nullable": false
},
"domainId": {
"format": "uuid",
"description": "Get or sets a guid of the domain the iteration has been trained on",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"classificationType": {
"description": "Gets the classification type of the project",
"enum": [
"Multiclass",
"Multilabel"
],
"type": "string",
"readOnly": true,
"x-nullable": true,
"x-ms-enum": {
"name": "Classifier",
"modelAsString": true
}
}
},
"x-nullable": true,
"example": {
"id": "string",
"name": "string",
"isDefault": true,
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "string",
"exportable": true,
"domainId": "string",
"classificationType": "Multiclass"
}
},
"Export": {
"type": "object",
"properties": {
"platform": {
"enum": [
"CoreML",
"TensorFlow",
"DockerFile",
"ONNX"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ExportPlatform",
"modelAsString": true
}
},
"status": {
"enum": [
"Exporting",
"Failed",
"Done"
],
"type": "string",
"readOnly": true,
"x-nullable": false,
"x-ms-enum": {
"name": "ExportStatusModel",
"modelAsString": true
}
},
"downloadUri": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"flavor": {
"enum": [
"Linux",
"Windows"
],
"type": "string",
"readOnly": true,
"x-nullable": true,
"x-ms-enum": {
"name": "ExportFlavor",
"modelAsString": true
}
},
"newerVersionAvailable": {
"type": "boolean",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true
},
"Tag": {
"description": "Represents a Tag",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Gets the Tag ID",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"name": {
"description": "Gets or sets the name of the tag",
"type": "string",
"x-nullable": true
},
"description": {
"description": "Gets or sets the description of the tag",
"type": "string",
"x-nullable": true
},
"imageCount": {
"format": "int32",
"description": "Gets the number of images with this tag",
"type": "integer",
"readOnly": true,
"x-nullable": false
}
},
"x-nullable": true,
"example": {
"id": "string",
"name": "string",
"description": "string",
"imageCount": 0
}
},
"DomainArray": {
"type": "array",
"items": {
"$ref": "#/definitions/Domain"
},
"x-nullable": true
},
"ImageArray": {
"type": "array",
"items": {
"$ref": "#/definitions/Image"
},
"x-nullable": true
},
"Projects{projectId}ImagesTaggedCountGet200ApplicationJsonResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}ImagesTaggedCountGet200TextJsonResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}ImagesTaggedCountGet200ApplicationXmlResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}ImagesTaggedCountGet200TextXmlResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}ImagesUntaggedCountGet200ApplicationJsonResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}ImagesUntaggedCountGet200TextJsonResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}ImagesUntaggedCountGet200ApplicationXmlResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}ImagesUntaggedCountGet200TextXmlResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"ImagePerformanceArray": {
"type": "array",
"items": {
"$ref": "#/definitions/ImagePerformance"
},
"x-nullable": true
},
"Projects{projectId}Iterations{iterationId}PerformanceImagesCountGet200ApplicationJsonResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}Iterations{iterationId}PerformanceImagesCountGet200TextJsonResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}Iterations{iterationId}PerformanceImagesCountGet200ApplicationXmlResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"Projects{projectId}Iterations{iterationId}PerformanceImagesCountGet200TextXmlResponse": {
"format": "int32",
"type": "integer",
"x-nullable": false
},
"ProjectArray": {
"type": "array",
"items": {
"$ref": "#/definitions/Project"
},
"x-nullable": true
},
"IterationArray": {
"type": "array",
"items": {
"$ref": "#/definitions/Iteration"
},
"x-nullable": true
},
"ExportArray": {
"type": "array",
"items": {
"$ref": "#/definitions/Export"
},
"x-nullable": true
},
"TagArray": {
"type": "array",
"items": {
"$ref": "#/definitions/Tag"
},
"x-nullable": true
}
},
"tags": []
}