{
"swagger": "2.0",
"info": {
"title": "Custom_Vision_Prediction_3.1",
"version": "1.0"
},
"host": "cognitiveusw2prod.cognitiveservices.azure.com",
"basePath": "/customvision/v3.1/Prediction",
"schemes": [
"https"
],
"securityDefinitions": {
"apiKeyHeader": {
"type": "apiKey",
"name": "Prediction-key",
"in": "header"
},
"apiKeyQuery": {
"type": "apiKey",
"name": "Prediction-key",
"in": "query"
}
},
"security": [
{
"apiKeyHeader": []
},
{
"apiKeyQuery": []
}
],
"x-servers": [
{
"url": "https://cognitiveusw2prod.cognitiveservices.azure.com"
},
{
"url": "https://cognitiveusw2prod.openai.azure.com"
},
{
"url": "https://westus2.api.cognitive.microsoft.com"
}
],
"paths": {
"/{projectId}/classify/iterations/{publishedName}/image": {
"post": {
"description": "Classify an image and saves the result.",
"operationId": "5eb37d24548b571998fde5f3",
"summary": "ClassifyImage",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "publishedName",
"in": "path",
"description": "Specifies the name of the model to evaluate against.",
"required": true,
"type": "string"
},
{
"name": "application",
"in": "query",
"description": "Optional. Specifies the name of application using the endpoint.",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"example": "------ExampleFormBoundary12345\nContent-Disposition: form-data; name=\"imageData\"; filename=\"filename.jpg\"\nContent-Type: image/jpeg\n\n[Binary image data]\n------ExampleFormBoundary12345--\n"
}
}
],
"consumes": [
"application/octet-stream",
"multipart/form-data"
],
"produces": [
"application/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
},
"application/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n",
"text/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n"
}
},
"500": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CustomVisionError"
},
"examples": {
"application/json": {
"code": "NoError",
"message": "string"
},
"application/xml": "\r\n NoError
\r\n string\r\n",
"text/xml": "\r\n NoError
\r\n string\r\n"
}
}
}
}
},
"/{projectId}/classify/iterations/{publishedName}/url": {
"post": {
"description": "Classify an image url and saves the result.",
"operationId": "5eb37d24548b571998fde5f5",
"summary": "ClassifyImageUrl",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "publishedName",
"in": "path",
"description": "Specifies the name of the model to evaluate against.",
"required": true,
"type": "string"
},
{
"name": "application",
"in": "query",
"description": "Optional. Specifies the name of application using the endpoint.",
"type": "string"
},
{
"name": "imageUrl",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageUrl"
},
"description": "An ImageUrl that contains the url of the image to be evaluated."
}
],
"consumes": [
"application/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
},
"application/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n",
"text/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n"
}
},
"500": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CustomVisionError"
},
"examples": {
"application/json": {
"code": "NoError",
"message": "string"
},
"application/xml": "\r\n NoError
\r\n string\r\n",
"text/xml": "\r\n NoError
\r\n string\r\n"
}
}
}
}
},
"/{projectId}/classify/iterations/{publishedName}/url/nostore": {
"post": {
"description": "Classify an image url without saving the result.",
"operationId": "5eb37d24548b571998fde5f6",
"summary": "ClassifyImageUrlWithNoStore",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "publishedName",
"in": "path",
"description": "Specifies the name of the model to evaluate against.",
"required": true,
"type": "string"
},
{
"name": "application",
"in": "query",
"description": "Optional. Specifies the name of application using the endpoint.",
"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",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
},
"application/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n",
"text/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n"
}
},
"500": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CustomVisionError"
},
"examples": {
"application/json": {
"code": "NoError",
"message": "string"
},
"application/xml": "\r\n NoError
\r\n string\r\n",
"text/xml": "\r\n NoError
\r\n string\r\n"
}
}
}
}
},
"/{projectId}/classify/iterations/{publishedName}/image/nostore": {
"post": {
"description": "Classify an image without saving the result.",
"operationId": "5eb37d24548b571998fde5f4",
"summary": "ClassifyImageWithNoStore",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "publishedName",
"in": "path",
"description": "Specifies the name of the model to evaluate against.",
"required": true,
"type": "string"
},
{
"name": "application",
"in": "query",
"description": "Optional. Specifies the name of application using the endpoint.",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"example": "------ExampleFormBoundary12345\nContent-Disposition: form-data; name=\"imageData\"; filename=\"filename.jpg\"\nContent-Type: image/jpeg\n\n[Binary image data]\n------ExampleFormBoundary12345--\n"
}
}
],
"consumes": [
"application/octet-stream",
"multipart/form-data"
],
"produces": [
"application/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
},
"application/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n",
"text/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n"
}
},
"500": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CustomVisionError"
},
"examples": {
"application/json": {
"code": "NoError",
"message": "string"
},
"application/xml": "\r\n NoError
\r\n string\r\n",
"text/xml": "\r\n NoError
\r\n string\r\n"
}
}
}
}
},
"/{projectId}/detect/iterations/{publishedName}/image": {
"post": {
"description": "Detect objects in an image and saves the result.",
"operationId": "5eb37d24548b571998fde5f7",
"summary": "DetectImage",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "publishedName",
"in": "path",
"description": "Specifies the name of the model to evaluate against.",
"required": true,
"type": "string"
},
{
"name": "numTagsPerBoundingBox",
"in": "query",
"description": "Format - int32. Optional. Specifies the num of predicted tags per bounding box.",
"type": "integer"
},
{
"name": "application",
"in": "query",
"description": "Optional. Specifies the name of application using the endpoint.",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"example": "------ExampleFormBoundary12345\nContent-Disposition: form-data; name=\"imageData\"; filename=\"filename.jpg\"\nContent-Type: image/jpeg\n\n[Binary image data]\n------ExampleFormBoundary12345--\n"
}
}
],
"consumes": [
"application/octet-stream",
"multipart/form-data"
],
"produces": [
"application/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
},
"application/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n",
"text/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n"
}
},
"500": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CustomVisionError"
},
"examples": {
"application/json": {
"code": "NoError",
"message": "string"
},
"application/xml": "\r\n NoError
\r\n string\r\n",
"text/xml": "\r\n NoError
\r\n string\r\n"
}
}
}
}
},
"/{projectId}/detect/iterations/{publishedName}/url": {
"post": {
"description": "Detect objects in an image url and saves the result.",
"operationId": "5eb37d24548b571998fde5f9",
"summary": "DetectImageUrl",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "publishedName",
"in": "path",
"description": "Specifies the name of the model to evaluate against.",
"required": true,
"type": "string"
},
{
"name": "numTagsPerBoundingBox",
"in": "query",
"description": "Format - int32. Optional. Specifies the num of predicted tags per bounding box.",
"type": "integer"
},
{
"name": "application",
"in": "query",
"description": "Optional. Specifies the name of application using the endpoint.",
"type": "string"
},
{
"name": "imageUrl",
"in": "body",
"schema": {
"$ref": "#/definitions/ImageUrl"
},
"description": "An ImageUrl that contains the url of the image to be evaluated."
}
],
"consumes": [
"application/json",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
},
"application/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n",
"text/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n"
}
},
"500": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CustomVisionError"
},
"examples": {
"application/json": {
"code": "NoError",
"message": "string"
},
"application/xml": "\r\n NoError
\r\n string\r\n",
"text/xml": "\r\n NoError
\r\n string\r\n"
}
}
}
}
},
"/{projectId}/detect/iterations/{publishedName}/url/nostore": {
"post": {
"description": "Detect objects in an image url without saving the result.",
"operationId": "5eb37d24548b571998fde5fa",
"summary": "DetectImageUrlWithNoStore",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "publishedName",
"in": "path",
"description": "Specifies the name of the model to evaluate against.",
"required": true,
"type": "string"
},
{
"name": "numTagsPerBoundingBox",
"in": "query",
"description": "Format - int32. Optional. Specifies the num of predicted tags per bounding box.",
"type": "integer"
},
{
"name": "application",
"in": "query",
"description": "Optional. Specifies the name of application using the endpoint.",
"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",
"application/xml",
"text/xml",
"application/x-www-form-urlencoded"
],
"produces": [
"application/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
},
"application/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n",
"text/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n"
}
},
"500": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CustomVisionError"
},
"examples": {
"application/json": {
"code": "NoError",
"message": "string"
},
"application/xml": "\r\n NoError
\r\n string\r\n",
"text/xml": "\r\n NoError
\r\n string\r\n"
}
}
}
}
},
"/{projectId}/detect/iterations/{publishedName}/image/nostore": {
"post": {
"description": "Detect objects in an image without saving the result.",
"operationId": "5eb37d24548b571998fde5f8",
"summary": "DetectImageWithNoStore",
"parameters": [
{
"name": "projectId",
"in": "path",
"description": "Format - uuid. The project id.",
"required": true,
"type": "string"
},
{
"name": "publishedName",
"in": "path",
"description": "Specifies the name of the model to evaluate against.",
"required": true,
"type": "string"
},
{
"name": "numTagsPerBoundingBox",
"in": "query",
"description": "Format - int32. Optional. Specifies the num of predicted tags per bounding box.",
"type": "integer"
},
{
"name": "application",
"in": "query",
"description": "Optional. Specifies the name of application using the endpoint.",
"type": "string"
},
{
"name": "body",
"in": "body",
"schema": {
"example": "------ExampleFormBoundary12345\nContent-Disposition: form-data; name=\"imageData\"; filename=\"filename.jpg\"\nContent-Type: image/jpeg\n\n[Binary image data]\n------ExampleFormBoundary12345--\n"
}
}
],
"consumes": [
"application/octet-stream",
"multipart/form-data"
],
"produces": [
"application/json",
"application/xml",
"text/xml"
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/ImagePrediction"
},
"examples": {
"application/json": {
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
},
"application/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n",
"text/xml": "\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 00000000-0000-0000-0000-000000000000\r\n string\r\n \r\n 0\r\n 0\r\n 0\r\n 0\r\n \r\n Regular\r\n \r\n"
}
},
"500": {
"description": "Error response",
"schema": {
"$ref": "#/definitions/CustomVisionError"
},
"examples": {
"application/json": {
"code": "NoError",
"message": "string"
},
"application/xml": "\r\n NoError
\r\n string\r\n",
"text/xml": "\r\n NoError
\r\n string\r\n"
}
}
}
}
}
},
"definitions": {
"BoundingBox": {
"description": "Bounding box that defines a region of an image.",
"required": [
"left",
"top",
"width",
"height"
],
"type": "object",
"properties": {
"left": {
"format": "float",
"description": "Coordinate of the left boundary.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"top": {
"format": "float",
"description": "Coordinate of the top boundary.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"width": {
"format": "float",
"description": "Width.",
"type": "number",
"readOnly": false,
"x-nullable": false
},
"height": {
"format": "float",
"description": "Height.",
"type": "number",
"readOnly": false,
"x-nullable": false
}
}
},
"CustomVisionError": {
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "The error code.",
"enum": [
"NoError",
"BadRequest",
"BadRequestExceededBatchSize",
"BadRequestNotSupported",
"BadRequestInvalidIds",
"BadRequestProjectName",
"BadRequestProjectNameNotUnique",
"BadRequestProjectDescription",
"BadRequestProjectUnknownDomain",
"BadRequestProjectUnknownClassification",
"BadRequestProjectUnsupportedDomainTypeChange",
"BadRequestProjectUnsupportedExportPlatform",
"BadRequestProjectImagePreprocessingSettings",
"BadRequestProjectDuplicated",
"BadRequestIterationName",
"BadRequestIterationNameNotUnique",
"BadRequestIterationDescription",
"BadRequestIterationIsNotTrained",
"BadRequestIterationValidationFailed",
"BadRequestWorkspaceCannotBeModified",
"BadRequestWorkspaceNotDeletable",
"BadRequestTagName",
"BadRequestTagNameNotUnique",
"BadRequestTagDescription",
"BadRequestTagType",
"BadRequestMultipleNegativeTag",
"BadRequestMultipleGeneralProductTag",
"BadRequestImageTags",
"BadRequestImageRegions",
"BadRequestNegativeAndRegularTagOnSameImage",
"BadRequestUnsupportedDomain",
"BadRequestRequiredParamIsNull",
"BadRequestIterationIsPublished",
"BadRequestInvalidPublishName",
"BadRequestInvalidPublishTarget",
"BadRequestUnpublishFailed",
"BadRequestIterationNotPublished",
"BadRequestSubscriptionApi",
"BadRequestExceedProjectLimit",
"BadRequestExceedIterationPerProjectLimit",
"BadRequestExceedTagPerProjectLimit",
"BadRequestExceedTagPerImageLimit",
"BadRequestExceededQuota",
"BadRequestCannotMigrateProjectWithName",
"BadRequestNotLimitedTrial",
"BadRequestImageBatch",
"BadRequestImageStream",
"BadRequestImageUrl",
"BadRequestImageFormat",
"BadRequestImageSizeBytes",
"BadRequestImageDimensions",
"BadRequestImageExceededCount",
"BadRequestTrainingNotNeeded",
"BadRequestTrainingNotNeededButTrainingPipelineUpdated",
"BadRequestTrainingValidationFailed",
"BadRequestClassificationTrainingValidationFailed",
"BadRequestMultiClassClassificationTrainingValidationFailed",
"BadRequestMultiLabelClassificationTrainingValidationFailed",
"BadRequestDetectionTrainingValidationFailed",
"BadRequestTrainingAlreadyInProgress",
"BadRequestDetectionTrainingNotAllowNegativeTag",
"BadRequestInvalidEmailAddress",
"BadRequestDomainNotSupportedForAdvancedTraining",
"BadRequestExportPlatformNotSupportedForAdvancedTraining",
"BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining",
"BadRequestExportValidationFailed",
"BadRequestExportAlreadyInProgress",
"BadRequestPredictionIdsMissing",
"BadRequestPredictionIdsExceededCount",
"BadRequestPredictionTagsExceededCount",
"BadRequestPredictionResultsExceededCount",
"BadRequestPredictionInvalidApplicationName",
"BadRequestPredictionInvalidQueryParameters",
"BadRequestInvalidImportToken",
"BadRequestExportWhileTraining",
"BadRequestImageMetadataKey",
"BadRequestImageMetadataValue",
"BadRequestOperationNotSupported",
"BadRequestInvalidArtifactUri",
"BadRequestInvalid",
"UnsupportedMediaType",
"Forbidden",
"ForbiddenUser",
"ForbiddenUserResource",
"ForbiddenUserSignupDisabled",
"ForbiddenUserSignupAllowanceExceeded",
"ForbiddenUserDoesNotExist",
"ForbiddenUserDisabled",
"ForbiddenUserInsufficientCapability",
"ForbiddenDRModeEnabled",
"ForbiddenInvalid",
"NotFound",
"NotFoundProject",
"NotFoundProjectDefaultIteration",
"NotFoundIteration",
"NotFoundIterationPerformance",
"NotFoundTag",
"NotFoundImage",
"NotFoundDomain",
"NotFoundApimSubscription",
"NotFoundInvalid",
"Conflict",
"ConflictInvalid",
"ErrorUnknown",
"ErrorIterationCopyFailed",
"ErrorPreparePerformanceMigrationFailed",
"ErrorProjectInvalidWorkspace",
"ErrorProjectInvalidPipelineConfiguration",
"ErrorProjectInvalidDomain",
"ErrorProjectTrainingRequestFailed",
"ErrorProjectImportRequestFailed",
"ErrorProjectExportRequestFailed",
"ErrorFeaturizationServiceUnavailable",
"ErrorFeaturizationQueueTimeout",
"ErrorFeaturizationInvalidFeaturizer",
"ErrorFeaturizationAugmentationUnavailable",
"ErrorFeaturizationUnrecognizedJob",
"ErrorFeaturizationAugmentationError",
"ErrorExporterInvalidPlatform",
"ErrorExporterInvalidFeaturizer",
"ErrorExporterInvalidClassifier",
"ErrorPredictionServiceUnavailable",
"ErrorPredictionModelNotFound",
"ErrorPredictionModelNotCached",
"ErrorPrediction",
"ErrorPredictionStorage",
"ErrorRegionProposal",
"ErrorInvalid"
],
"type": "string",
"x-ms-enum": {
"name": "CustomVisionErrorCodes",
"modelAsString": true
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
}
},
"ImagePrediction": {
"description": "Result of an image prediction request.",
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "Prediction Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"project": {
"format": "uuid",
"description": "Project Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"iteration": {
"format": "uuid",
"description": "Iteration Id.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"created": {
"format": "date-time",
"description": "Date this prediction was created.",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"predictions": {
"description": "List of predictions.",
"type": "array",
"items": {
"$ref": "#/definitions/Prediction",
"x-nullable": false
},
"readOnly": true
}
}
},
"ImageUrl": {
"description": "Image url.",
"required": [
"url"
],
"type": "object",
"properties": {
"url": {
"description": "Url of the image.",
"type": "string",
"readOnly": false,
"x-nullable": false
}
},
"example": {
"url": "string"
}
},
"Prediction": {
"description": "Prediction result.",
"type": "object",
"properties": {
"probability": {
"format": "float",
"description": "Probability of the tag.",
"type": "number",
"readOnly": true,
"x-nullable": false
},
"tagId": {
"format": "uuid",
"description": "Id of the predicted tag.",
"type": "string",
"readOnly": true,
"example": "00000000-0000-0000-0000-000000000000",
"x-nullable": false
},
"tagName": {
"description": "Name of the predicted tag.",
"type": "string",
"readOnly": true,
"x-nullable": true
},
"boundingBox": {
"$ref": "#/definitions/BoundingBox",
"description": "Bounding box of the prediction.",
"readOnly": true,
"x-nullable": true
},
"tagType": {
"description": "Type of the predicted tag.",
"enum": [
"Regular",
"Negative",
"GeneralProduct"
],
"type": "string",
"readOnly": true,
"x-nullable": true,
"x-ms-enum": {
"name": "TagType",
"modelAsString": true
}
}
}
}
},
"tags": []
}