Custom Vision Prediction Client
Connect to Custom Vision Prediction Client with 1 MCP tools for AI-powered API automation.
COMMUNITYAPI KEY0 INSTALLS
OpenAPI Specificationv3.0
{
"openapi": "3.0.0",
"servers": [
{
"url": "https://southcentralus.api.cognitive.microsoft.com/customvision/v3.0/prediction"
},
{
"url": "{Endpoint}/customvision/v3.0/prediction",
"variables": {
"Endpoint": {
"default": "none",
"description": "Supported Cognitive Services endpoints.",
"x-ms-parameter-location": "client",
"x-ms-skip-url-encoding": true
}
}
}
],
"info": {
"contact": {
"x-twitter": "microsoft"
},
"title": "Custom Vision Prediction Client",
"version": "3.0",
"x-apisguru-categories": [
"developer_tools",
"cloud"
],
"x-logo": {
"url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_microsoft_profile_image.png"
},
"x-origin": [
{
"format": "openapi",
"url": "https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json",
"version": "3.0"
}
],
"x-preferred": true,
"x-providerName": "microsoft.com",
"x-serviceName": "cognitiveservices-Prediction",
"x-tags": [
"Microsoft"
]
},
"security": [
{
"apim_key": []
}
],
"paths": {
"/{projectId}/classify/iterations/{publishedName}/image": {
"post": {
"operationId": "ClassifyImage",
"parameters": [
{
"description": "The project id.",
"examples": {
"Successful ClassifyImage request": {
"value": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
},
"x-nullable": false
},
{
"description": "Specifies the name of the model to evaluate against.",
"examples": {
"Successful ClassifyImage request": {
"value": "MyModel1"
}
},
"in": "path",
"name": "publishedName",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional. Specifies the name of application using the endpoint.",
"in": "query",
"name": "application",
"required": false,
"schema": {
"type": "string"
},
"x-nullable": true
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ClassifyImage"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Successful ClassifyImage request": {
"$ref": "#/components/examples/Successful_ClassifyImage_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"application/xml": {
"examples": {
"Successful ClassifyImage request": {
"$ref": "#/components/examples/Successful_ClassifyImage_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"text/xml": {
"examples": {
"Successful ClassifyImage request": {
"$ref": "#/components/examples/Successful_ClassifyImage_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
}
},
"description": "Error response"
}
},
"summary": "Classify an image and saves the result.",
"tags": [
"ImagePredictionApi"
]
}
},
"/{projectId}/classify/iterations/{publishedName}/image/nostore": {
"post": {
"operationId": "ClassifyImageWithNoStore",
"parameters": [
{
"description": "The project id.",
"examples": {
"Successful ClassifyImageWithNoStore request": {
"value": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
},
"x-nullable": false
},
{
"description": "Specifies the name of the model to evaluate against.",
"examples": {
"Successful ClassifyImageWithNoStore request": {
"value": "MyModel1"
}
},
"in": "path",
"name": "publishedName",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional. Specifies the name of application using the endpoint.",
"in": "query",
"name": "application",
"required": false,
"schema": {
"type": "string"
},
"x-nullable": true
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ClassifyImageWithNoStore"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Successful ClassifyImageWithNoStore request": {
"$ref": "#/components/examples/Successful_ClassifyImageWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"application/xml": {
"examples": {
"Successful ClassifyImageWithNoStore request": {
"$ref": "#/components/examples/Successful_ClassifyImageWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"text/xml": {
"examples": {
"Successful ClassifyImageWithNoStore request": {
"$ref": "#/components/examples/Successful_ClassifyImageWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
}
},
"description": "Error response"
}
},
"summary": "Classify an image without saving the result.",
"tags": [
"ImagePredictionApi"
]
}
},
"/{projectId}/classify/iterations/{publishedName}/url": {
"post": {
"operationId": "ClassifyImageUrl",
"parameters": [
{
"description": "The project id.",
"examples": {
"Successful ClassifyImageUrl request": {
"value": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
},
"x-nullable": false
},
{
"description": "Specifies the name of the model to evaluate against.",
"examples": {
"Successful ClassifyImageUrl request": {
"value": "MyModel1"
}
},
"in": "path",
"name": "publishedName",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional. Specifies the name of application using the endpoint.",
"in": "query",
"name": "application",
"required": false,
"schema": {
"type": "string"
},
"x-nullable": true
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImageUrl2"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Successful ClassifyImageUrl request": {
"$ref": "#/components/examples/Successful_ClassifyImageUrl_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"application/xml": {
"examples": {
"Successful ClassifyImageUrl request": {
"$ref": "#/components/examples/Successful_ClassifyImageUrl_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"text/xml": {
"examples": {
"Successful ClassifyImageUrl request": {
"$ref": "#/components/examples/Successful_ClassifyImageUrl_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
}
},
"description": "Error response"
}
},
"summary": "Classify an image url and saves the result.",
"tags": [
"ImagePredictionApi"
]
}
},
"/{projectId}/classify/iterations/{publishedName}/url/nostore": {
"post": {
"operationId": "ClassifyImageUrlWithNoStore",
"parameters": [
{
"description": "The project id.",
"examples": {
"Successful ClassifyImageUrlWithNoStore request": {
"value": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
},
"x-nullable": false
},
{
"description": "Specifies the name of the model to evaluate against.",
"examples": {
"Successful ClassifyImageUrlWithNoStore request": {
"value": "MyModel1"
}
},
"in": "path",
"name": "publishedName",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional. Specifies the name of application using the endpoint.",
"in": "query",
"name": "application",
"required": false,
"schema": {
"type": "string"
},
"x-nullable": true
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImageUrl"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Successful ClassifyImageUrlWithNoStore request": {
"$ref": "#/components/examples/Successful_ClassifyImageUrlWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"application/xml": {
"examples": {
"Successful ClassifyImageUrlWithNoStore request": {
"$ref": "#/components/examples/Successful_ClassifyImageUrlWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"text/xml": {
"examples": {
"Successful ClassifyImageUrlWithNoStore request": {
"$ref": "#/components/examples/Successful_ClassifyImageUrlWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
}
},
"description": "Error response"
}
},
"summary": "Classify an image url without saving the result.",
"tags": [
"ImagePredictionApi"
]
}
},
"/{projectId}/detect/iterations/{publishedName}/image": {
"post": {
"operationId": "DetectImage",
"parameters": [
{
"description": "The project id.",
"examples": {
"Successful DetectImage request": {
"value": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
},
"x-nullable": false
},
{
"description": "Specifies the name of the model to evaluate against.",
"examples": {
"Successful DetectImage request": {
"value": "MyModel1"
}
},
"in": "path",
"name": "publishedName",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional. Specifies the name of application using the endpoint.",
"in": "query",
"name": "application",
"required": false,
"schema": {
"type": "string"
},
"x-nullable": true
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ClassifyImage"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Successful DetectImage request": {
"$ref": "#/components/examples/Successful_DetectImage_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"application/xml": {
"examples": {
"Successful DetectImage request": {
"$ref": "#/components/examples/Successful_DetectImage_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"text/xml": {
"examples": {
"Successful DetectImage request": {
"$ref": "#/components/examples/Successful_DetectImage_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
}
},
"description": "Error response"
}
},
"summary": "Detect objects in an image and saves the result.",
"tags": [
"ImagePredictionApi"
]
}
},
"/{projectId}/detect/iterations/{publishedName}/image/nostore": {
"post": {
"operationId": "DetectImageWithNoStore",
"parameters": [
{
"description": "The project id.",
"examples": {
"Successful DetectImageWithNoStore request": {
"value": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
},
"x-nullable": false
},
{
"description": "Specifies the name of the model to evaluate against.",
"examples": {
"Successful DetectImageWithNoStore request": {
"value": "MyModel1"
}
},
"in": "path",
"name": "publishedName",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional. Specifies the name of application using the endpoint.",
"in": "query",
"name": "application",
"required": false,
"schema": {
"type": "string"
},
"x-nullable": true
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ClassifyImageWithNoStore"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Successful DetectImageWithNoStore request": {
"$ref": "#/components/examples/Successful_DetectImageWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"application/xml": {
"examples": {
"Successful DetectImageWithNoStore request": {
"$ref": "#/components/examples/Successful_DetectImageWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"text/xml": {
"examples": {
"Successful DetectImageWithNoStore request": {
"$ref": "#/components/examples/Successful_DetectImageWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
}
},
"description": "Error response"
}
},
"summary": "Detect objects in an image without saving the result.",
"tags": [
"ImagePredictionApi"
]
}
},
"/{projectId}/detect/iterations/{publishedName}/url": {
"post": {
"operationId": "DetectImageUrl",
"parameters": [
{
"description": "The project id.",
"examples": {
"Successful DetectImageUrl request": {
"value": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
},
"x-nullable": false
},
{
"description": "Specifies the name of the model to evaluate against.",
"examples": {
"Successful DetectImageUrl request": {
"value": "MyModel1"
}
},
"in": "path",
"name": "publishedName",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional. Specifies the name of application using the endpoint.",
"in": "query",
"name": "application",
"required": false,
"schema": {
"type": "string"
},
"x-nullable": true
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImageUrl2"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Successful DetectImageUrl request": {
"$ref": "#/components/examples/Successful_DetectImageUrl_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"application/xml": {
"examples": {
"Successful DetectImageUrl request": {
"$ref": "#/components/examples/Successful_DetectImageUrl_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"text/xml": {
"examples": {
"Successful DetectImageUrl request": {
"$ref": "#/components/examples/Successful_DetectImageUrl_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
}
},
"description": "Error response"
}
},
"summary": "Detect objects in an image url and saves the result.",
"tags": [
"ImagePredictionApi"
]
}
},
"/{projectId}/detect/iterations/{publishedName}/url/nostore": {
"post": {
"operationId": "DetectImageUrlWithNoStore",
"parameters": [
{
"description": "The project id.",
"examples": {
"Successful DetectImageUrlWithNoStore request": {
"value": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"in": "path",
"name": "projectId",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
},
"x-nullable": false
},
{
"description": "Specifies the name of the model to evaluate against.",
"examples": {
"Successful DetectImageUrlWithNoStore request": {
"value": "MyModel1"
}
},
"in": "path",
"name": "publishedName",
"required": true,
"schema": {
"type": "string"
}
},
{
"description": "Optional. Specifies the name of application using the endpoint.",
"in": "query",
"name": "application",
"required": false,
"schema": {
"type": "string"
},
"x-nullable": true
}
],
"requestBody": {
"$ref": "#/components/requestBodies/ImageUrl"
},
"responses": {
"200": {
"content": {
"application/json": {
"examples": {
"Successful DetectImageUrlWithNoStore request": {
"$ref": "#/components/examples/Successful_DetectImageUrlWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"application/xml": {
"examples": {
"Successful DetectImageUrlWithNoStore request": {
"$ref": "#/components/examples/Successful_DetectImageUrlWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
},
"text/xml": {
"examples": {
"Successful DetectImageUrlWithNoStore request": {
"$ref": "#/components/examples/Successful_DetectImageUrlWithNoStore_request"
}
},
"schema": {
"$ref": "#/components/schemas/ImagePrediction"
}
}
},
"description": "OK"
},
"default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/CustomVisionError"
}
}
},
"description": "Error response"
}
},
"summary": "Detect objects in an image url without saving the result.",
"tags": [
"ImagePredictionApi"
]
}
}
},
"components": {
"examples": {
"Successful_ClassifyImageUrlWithNoStore_request": {
"value": {
"created": "2019-03-06T02:15:00Z",
"id": "951098b2-9b69-427b-bddb-d5cb618874e3",
"iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
"predictions": [
{
"probability": 0.05149666,
"tagId": "e31ff107-5505-4753-be42-b369b21b026c",
"tagName": "Hemlock"
},
{
"probability": 0.000193528482,
"tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
"tagName": "Japanese Cherry"
}
],
"project": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"Successful_ClassifyImageUrl_request": {
"value": {
"created": "2019-03-06T02:15:00Z",
"id": "951098b2-9b69-427b-bddb-d5cb618874e3",
"iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
"predictions": [
{
"probability": 0.05149666,
"tagId": "e31ff107-5505-4753-be42-b369b21b026c",
"tagName": "Hemlock"
},
{
"probability": 0.000193528482,
"tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
"tagName": "Japanese Cherry"
}
],
"project": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"Successful_ClassifyImageWithNoStore_request": {
"value": {
"created": "2019-03-06T02:15:00Z",
"id": "951098b2-9b69-427b-bddb-d5cb618874e3",
"iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
"predictions": [
{
"probability": 0.05149666,
"tagId": "e31ff107-5505-4753-be42-b369b21b026c",
"tagName": "Hemlock"
},
{
"probability": 0.000193528482,
"tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
"tagName": "Japanese Cherry"
}
],
"project": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"Successful_ClassifyImage_request": {
"value": {
"created": "2019-03-06T02:15:00Z",
"id": "951098b2-9b69-427b-bddb-d5cb618874e3",
"iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a",
"predictions": [
{
"probability": 0.05149666,
"tagId": "e31ff107-5505-4753-be42-b369b21b026c",
"tagName": "Hemlock"
},
{
"probability": 0.000193528482,
"tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a",
"tagName": "Japanese Cherry"
}
],
"project": "64b822c5-8082-4b36-a426-27225f4aa18c"
}
},
"Successful_DetectImageUrlWithNoStore_request": {
"value": {
"created": "2019-03-10T06:10:28Z",
"id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
"iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
"predictions": [
{
"boundingBox": {
"height": 0.156851858,
"left": 0.955476165,
"top": 0,
"width": 0.0412225723
},
"probability": 0.05149666,
"tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
"tagName": "Tag 1"
},
{
"boundingBox": {
"height": 0.6830492,
"left": 0.062178582,
"top": 0,
"width": 0.9378114
},
"probability": 0.000193528482,
"tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
"tagName": "Tag 2"
}
],
"project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1"
}
},
"Successful_DetectImageUrl_request": {
"value": {
"created": "2019-03-10T06:10:28Z",
"id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
"iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
"predictions": [
{
"boundingBox": {
"height": 0.156851858,
"left": 0.955476165,
"top": 0,
"width": 0.0412225723
},
"probability": 0.05149666,
"tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
"tagName": "Tag 1"
},
{
"boundingBox": {
"height": 0.6830492,
"left": 0.062178582,
"top": 0,
"width": 0.9378114
},
"probability": 0.000193528482,
"tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
"tagName": "Tag 2"
}
],
"project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1"
}
},
"Successful_DetectImageWithNoStore_request": {
"value": {
"created": "2019-03-10T06:10:28Z",
"id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
"iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
"predictions": [
{
"boundingBox": {
"height": 0.156851858,
"left": 0.955476165,
"top": 0,
"width": 0.0412225723
},
"probability": 0.05149666,
"tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
"tagName": "Tag 1"
},
{
"boundingBox": {
"height": 0.6830492,
"left": 0.062178582,
"top": 0,
"width": 0.9378114
},
"probability": 0.000193528482,
"tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
"tagName": "Tag 2"
}
],
"project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1"
}
},
"Successful_DetectImage_request": {
"value": {
"created": "2019-03-10T06:10:28Z",
"id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1",
"iteration": "45c79472-7198-46e1-8ed7-bad2ca111957",
"predictions": [
{
"boundingBox": {
"height": 0.156851858,
"left": 0.955476165,
"top": 0,
"width": 0.0412225723
},
"probability": 0.05149666,
"tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75",
"tagName": "Tag 1"
},
{
"boundingBox": {
"height": 0.6830492,
"left": 0.062178582,
"top": 0,
"width": 0.9378114
},
"probability": 0.000193528482,
"tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8",
"tagName": "Tag 2"
}
],
"project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1"
}
}
},
"parameters": {
"Endpoint": {
"description": "Supported Cognitive Services endpoints.",
"in": "path",
"name": "Endpoint",
"required": true,
"schema": {
"type": "string"
},
"x-ms-parameter-location": "client",
"x-ms-skip-url-encoding": true
}
},
"requestBodies": {
"ClassifyImage": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"imageData": {
"description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.",
"format": "binary",
"type": "string"
}
},
"required": [
"imageData"
],
"type": "object"
}
}
},
"required": true
},
"ClassifyImageWithNoStore": {
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"imageData": {
"description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 0MB.",
"format": "binary",
"type": "string"
}
},
"required": [
"imageData"
],
"type": "object"
}
}
},
"required": true
},
"ImageUrl": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageUrl"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ImageUrl"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ImageUrl"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ImageUrl"
}
}
},
"description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.",
"required": true
},
"ImageUrl2": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageUrl"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ImageUrl"
}
},
"application/xml": {
"schema": {
"$ref": "#/components/schemas/ImageUrl"
}
},
"text/xml": {
"schema": {
"$ref": "#/components/schemas/ImageUrl"
}
}
},
"description": "An ImageUrl that contains the url of the image to be evaluated.",
"required": true
}
},
"schemas": {
"BoundingBox": {
"description": "Bounding box that defines a region of an image.",
"properties": {
"height": {
"description": "Height.",
"format": "float",
"nullable": false,
"readOnly": false,
"type": "number"
},
"left": {
"description": "Coordinate of the left boundary.",
"format": "float",
"nullable": false,
"readOnly": false,
"type": "number"
},
"top": {
"description": "Coordinate of the top boundary.",
"format": "float",
"nullable": false,
"readOnly": false,
"type": "number"
},
"width": {
"description": "Width.",
"format": "float",
"nullable": false,
"readOnly": false,
"type": "number"
}
},
"required": [
"left",
"top",
"width",
"height"
],
"type": "object"
},
"CustomVisionError": {
"properties": {
"code": {
"description": "The error code.",
"enum": [
"NoError",
"BadRequest",
"BadRequestExceededBatchSize",
"BadRequestNotSupported",
"BadRequestInvalidIds",
"BadRequestProjectName",
"BadRequestProjectNameNotUnique",
"BadRequestProjectDescription",
"BadRequestProjectUnknownDomain",
"BadRequestProjectUnknownClassification",
"BadRequestProjectUnsupportedDomainTypeChange",
"BadRequestProjectUnsupportedExportPlatform",
"BadRequestIterationName",
"BadRequestIterationNameNotUnique",
"BadRequestIterationDescription",
"BadRequestIterationIsNotTrained",
"BadRequestWorkspaceCannotBeModified",
"BadRequestWorkspaceNotDeletable",
"BadRequestTagName",
"BadRequestTagNameNotUnique",
"BadRequestTagDescription",
"BadRequestTagType",
"BadRequestMultipleNegativeTag",
"BadRequestImageTags",
"BadRequestImageRegions",
"BadRequestNegativeAndRegularTagOnSameImage",
"BadRequestRequiredParamIsNull",
"BadRequestIterationIsPublished",
"BadRequestInvalidPublishName",
"BadRequestInvalidPublishTarget",
"BadRequestUnpublishFailed",
"BadRequestSubscriptionApi",
"BadRequestExceedProjectLimit",
"BadRequestExceedIterationPerProjectLimit",
"BadRequestExceedTagPerProjectLimit",
"BadRequestExceedTagPerImageLimit",
"BadRequestExceededQuota",
"BadRequestCannotMigrateProjectWithName",
"BadRequestNotLimitedTrial",
"BadRequestImageBatch",
"BadRequestImageStream",
"BadRequestImageUrl",
"BadRequestImageFormat",
"BadRequestImageSizeBytes",
"BadRequestImageExceededCount",
"BadRequestTrainingNotNeeded",
"BadRequestTrainingNotNeededButTrainingPipelineUpdated",
"BadRequestTrainingValidationFailed",
"BadRequestClassificationTrainingValidationFailed",
"BadRequestMultiClassClassificationTrainingValidationFailed",
"BadRequestMultiLabelClassificationTrainingValidationFailed",
"BadRequestDetectionTrainingValidationFailed",
"BadRequestTrainingAlreadyInProgress",
"BadRequestDetectionTrainingNotAllowNegativeTag",
"BadRequestInvalidEmailAddress",
"BadRequestDomainNotSupportedForAdvancedTraining",
"BadRequestExportPlatformNotSupportedForAdvancedTraining",
"BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining",
"BadRequestExportValidationFailed",
"BadRequestExportAlreadyInProgress",
"BadRequestPredictionIdsMissing",
"BadRequestPredictionIdsExceededCount",
"BadRequestPredictionTagsExceededCount",
"BadRequestPredictionResultsExceededCount",
"BadRequestPredictionInvalidApplicationName",
"BadRequestPredictionInvalidQueryParameters",
"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",
"ErrorProjectInvalidWorkspace",
"ErrorProjectInvalidPipelineConfiguration",
"ErrorProjectInvalidDomain",
"ErrorProjectTrainingRequestFailed",
"ErrorProjectExportRequestFailed",
"ErrorFeaturizationServiceUnavailable",
"ErrorFeaturizationQueueTimeout",
"ErrorFeaturizationInvalidFeaturizer",
"ErrorFeaturizationAugmentationUnavailable",
"ErrorFeaturizationUnrecognizedJob",
"ErrorFeaturizationAugmentationError",
"ErrorExporterInvalidPlatform",
"ErrorExporterInvalidFeaturizer",
"ErrorExporterInvalidClassifier",
"ErrorPredictionServiceUnavailable",
"ErrorPredictionModelNotFound",
"ErrorPredictionModelNotCached",
"ErrorPrediction",
"ErrorPredictionStorage",
"ErrorRegionProposal",
"ErrorInvalid"
],
"type": "string",
"x-ms-enum": {
"modelAsString": true,
"name": "CustomVisionErrorCodes"
}
},
"message": {
"description": "A message explaining the error reported by the service.",
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object"
},
"ImagePrediction": {
"description": "Result of an image prediction request.",
"properties": {
"created": {
"description": "Date this prediction was created.",
"format": "date-time",
"nullable": false,
"readOnly": true,
"type": "string"
},
"id": {
"description": "Prediction Id.",
"format": "uuid",
"nullable": false,
"readOnly": true,
"type": "string"
},
"iteration": {
"description": "Iteration Id.",
"format": "uuid",
"nullable": false,
"readOnly": true,
"type": "string"
},
"predictions": {
"description": "List of predictions.",
"items": {
"$ref": "#/components/schemas/Prediction"
},
"readOnly": true,
"type": "array"
},
"project": {
"description": "Project Id.",
"format": "uuid",
"nullable": false,
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ImageUrl": {
"description": "Image url.",
"properties": {
"url": {
"description": "Url of the image.",
"nullable": false,
"readOnly": false,
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
},
"Prediction": {
"description": "Prediction result.",
"properties": {
"boundingBox": {
"$ref": "#/components/schemas/BoundingBox"
},
"probability": {
"description": "Probability of the tag.",
"format": "float",
"nullable": false,
"readOnly": true,
"type": "number"
},
"tagId": {
"description": "Id of the predicted tag.",
"format": "uuid",
"nullable": false,
"readOnly": true,
"type": "string"
},
"tagName": {
"description": "Name of the predicted tag.",
"nullable": true,
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
},
"securitySchemes": {
"apim_key": {
"in": "header",
"name": "Prediction-Key",
"type": "apiKey"
}
}
}
}