From 2607541fc01cb363857f090cbf0bc47e93cc3305 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Wed, 6 Feb 2019 22:19:47 -0800 Subject: [PATCH 01/18] Base commit to diff new version vs old version --- .../Prediction/stable/v3.0/Prediction.json | 433 ++ .../stable/v3.0/examples/PredictImage.json | 33 + .../stable/v3.0/examples/PredictImageUrl.json | 35 + .../examples/PredictImageUrlWithNoStore.json | 35 + .../examples/PredictImageWithNoStore.json | 33 + .../Training/stable/v3.0/Training.json | 3820 +++++++++++++++++ .../v3.0/examples/CreateImageRegions.json | 30 + .../stable/v3.0/examples/CreateImageTags.json | 31 + .../v3.0/examples/CreateImagesFromData.json | 60 + .../v3.0/examples/CreateImagesFromFiles.json | 49 + .../examples/CreateImagesFromPredictions.json | 48 + .../v3.0/examples/CreateImagesFromUrls.json | 48 + .../stable/v3.0/examples/CreateProject.json | 26 + .../stable/v3.0/examples/CreateTag.json | 22 + .../v3.0/examples/DeleteImageRegions.json | 15 + .../stable/v3.0/examples/DeleteImageTags.json | 22 + .../stable/v3.0/examples/DeleteImages.json | 18 + .../stable/v3.0/examples/DeleteIteration.json | 15 + .../v3.0/examples/DeletePrediction.json | 18 + .../stable/v3.0/examples/DeleteProject.json | 14 + .../stable/v3.0/examples/DeleteTag.json | 15 + .../stable/v3.0/examples/ExportIteration.json | 20 + .../stable/v3.0/examples/GetDomain.json | 18 + .../stable/v3.0/examples/GetDomains.json | 54 + .../stable/v3.0/examples/GetExports.json | 21 + .../examples/GetImagePerformanceCount.json | 16 + .../v3.0/examples/GetImagePerformances.json | 43 + .../examples/GetImageRegionProposals.json | 29 + .../stable/v3.0/examples/GetImagesByIds.json | 15 + .../stable/v3.0/examples/GetIteration.json | 26 + .../examples/GetIterationPerformance.json | 39 + .../stable/v3.0/examples/GetIterations.json | 50 + .../stable/v3.0/examples/GetProject.json | 24 + .../stable/v3.0/examples/GetProjects.json | 25 + .../Training/stable/v3.0/examples/GetTag.json | 20 + .../v3.0/examples/GetTaggedImageCount.json | 15 + .../stable/v3.0/examples/GetTaggedImages.json | 15 + .../stable/v3.0/examples/GetTags.json | 21 + .../v3.0/examples/GetUntaggedImageCount.json | 15 + .../v3.0/examples/GetUntaggedImages.json | 15 + .../v3.0/examples/QueryPredictions.json | 64 + .../stable/v3.0/examples/QuickTestImage.json | 33 + .../v3.0/examples/QuickTestImageUrl.json | 35 + .../stable/v3.0/examples/TrainProject.json | 24 + .../stable/v3.0/examples/UpdateIteration.json | 29 + .../stable/v3.0/examples/UpdateProject.json | 28 + .../stable/v3.0/examples/UpdateTag.json | 24 + 47 files changed, 5538 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImage.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrl.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrlWithNoStore.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageWithNoStore.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImageRegions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImageTags.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateTag.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImageRegions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImageTags.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImages.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeletePrediction.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteTag.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/ExportIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomain.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomains.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetExports.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformanceCount.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformances.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImageRegionProposals.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagesByIds.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterationPerformance.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTag.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTaggedImageCount.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTaggedImages.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTags.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetUntaggedImageCount.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetUntaggedImages.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImage.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImageUrl.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateTag.json diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json new file mode 100644 index 000000000000..21bf65009c37 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json @@ -0,0 +1,433 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.0", + "title": "Custom Vision Prediction Client" + }, + "host": "southcentralus.api.cognitive.microsoft.com", + "basePath": "/customvision/v2.0/Prediction", + "schemes": [ + "https" + ], + "paths": { + "/{projectId}/url": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Predict an image url and saves the result", + "operationId": "PredictImageUrl", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageUrl", + "in": "body", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "iterationId", + "in": "query", + "description": "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", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful PredictImageUrl request": { + "$ref": "./examples/PredictImageUrl.json" + } + } + } + }, + "/{projectId}/image": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Predict an image and saves the result", + "operationId": "PredictImage", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "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", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful PredictImage request": { + "$ref": "./examples/PredictImage.json" + } + } + } + }, + "/{projectId}/url/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Predict an image url without saving the result", + "operationId": "PredictImageUrlWithNoStore", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageUrl", + "in": "body", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "iterationId", + "in": "query", + "description": "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", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful PredictImageUrlWithNoStore request": { + "$ref": "./examples/PredictImageUrlWithNoStore.json" + } + } + } + }, + "/{projectId}/image/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Predict an image without saving the result", + "operationId": "PredictImageWithNoStore", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "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", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful PredictImageWithNoStore request": { + "$ref": "./examples/PredictImageWithNoStore.json" + } + } + } + } + }, + "definitions": { + "ImageUrl": { + "type": "object", + "properties": { + "url": { + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "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 + }, + "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 + }, + "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 + } + }, + "parameters": { + "ApiKey": { + "name": "Prediction-Key", + "in": "header", + "required": true, + "type": "string", + "x-ms-client-name": "ApiKey", + "x-ms-parameter-location": "client" + }, + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImage.json new file mode 100644 index 000000000000..397ea4bc3c04 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImage.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrl.json new file mode 100644 index 000000000000..78a95d198ca5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrl.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrlWithNoStore.json new file mode 100644 index 000000000000..78a95d198ca5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrlWithNoStore.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageWithNoStore.json new file mode 100644 index 000000000000..397ea4bc3c04 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageWithNoStore.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json new file mode 100644 index 000000000000..2056a6a71d06 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -0,0 +1,3820 @@ +{ + "swagger": "2.0", + "info": { + "version": "2.2", + "title": "Custom Vision Training Client" + }, + "host": "southcentralus.api.cognitive.microsoft.com", + "basePath": "/customvision/v2.2/Training", + "schemes": [ + "https" + ], + "paths": { + "/domains": { + "get": { + "tags": [ + "DomainsApi" + ], + "summary": "Get a list of the available domains.", + "operationId": "GetDomains", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Domain" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetDomains request": { + "$ref": "./examples/GetDomains.json" + } + } + } + }, + "/domains/{domainId}": { + "get": { + "tags": [ + "DomainsApi" + ], + "summary": "Get information about a specific domain.", + "operationId": "GetDomain", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "domainId", + "in": "path", + "description": "The id of the domain to get information about.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Domain" + } + } + }, + "x-ms-examples": { + "Successful GetDomain request": { + "$ref": "./examples/GetDomain.json" + } + } + } + }, + "/projects/{projectId}/images/tagged/count": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Gets the number of images tagged with the provided {tagIds}.", + "description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetTaggedImageCount", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images to count. Defaults to all tags when null.", + "required": false, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetTaggedImageCount request": { + "$ref": "./examples/GetTaggedImageCount.json" + } + } + } + }, + "/projects/{projectId}/images/untagged/count": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Gets the number of untagged images.", + "description": "This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the\r\ncurrent workspace is used.", + "operationId": "GetUntaggedImageCount", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetUntaggedImageCount request": { + "$ref": "./examples/GetUntaggedImageCount.json" + } + } + } + }, + "/projects/{projectId}/images/tags": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Associate a set of images with a set of tags.", + "operationId": "CreateImageTags", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "Batch of image tags. Limited to 128 tags per batch.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageTagCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTagCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImageTags request": { + "$ref": "./examples/CreateImageTags.json" + } + } + }, + "delete": { + "tags": [ + "ImageApi" + ], + "summary": "Remove a set of tags from a set of images.", + "operationId": "DeleteImageTags", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageIds", + "in": "query", + "description": "Image ids. Limited to 64 images.", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "tagIds", + "in": "query", + "description": "Tags to be deleted from the specified images. Limited to 20 tags.", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImageTags request": { + "$ref": "./examples/DeleteImageTags.json" + } + } + } + }, + "/projects/{projectId}/images/regions": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Create a set of image regions.", + "description": "This API accepts a batch of image regions, and optionally tags, to update existing images with region information.\r\nThere is a limit of 64 entries in the batch.", + "operationId": "CreateImageRegions", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "Batch of image regions which include a tag and bounding box. Limited to 64.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageRegionCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageRegionCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImageRegions request": { + "$ref": "./examples/CreateImageRegions.json" + } + } + }, + "delete": { + "tags": [ + "ImageApi" + ], + "summary": "Delete a set of image regions.", + "operationId": "DeleteImageRegions", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "regionIds", + "in": "query", + "description": "Regions to delete. Limited to 64.", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImageRegions request": { + "$ref": "./examples/DeleteImageRegions.json" + } + } + } + }, + "/projects/{projectId}/images/tagged": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Get tagged images for a given project iteration.", + "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\r\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetTaggedImages", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.", + "required": false, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest.", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "name": "take", + "in": "query", + "description": "Maximum number of images to return. Defaults to 50, limited to 256.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50 + }, + { + "name": "skip", + "in": "query", + "description": "Number of images to skip before beginning the image batch. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetTaggedImages request": { + "$ref": "./examples/GetTaggedImages.json" + } + } + } + }, + "/projects/{projectId}/images/untagged": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Get untagged images for a given project iteration.", + "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.", + "operationId": "GetUntaggedImages", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest.", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "name": "take", + "in": "query", + "description": "Maximum number of images to return. Defaults to 50, limited to 256.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50 + }, + { + "name": "skip", + "in": "query", + "description": "Number of images to skip before beginning the image batch. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetUntaggedImages request": { + "$ref": "./examples/GetUntaggedImages.json" + } + } + } + }, + "/projects/{projectId}/images/id": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Get images by id for a given project iteration.", + "description": "This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the\r\ncurrent workspace is used.", + "operationId": "GetImagesByIds", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageIds", + "in": "query", + "description": "The list of image ids to retrieve. Limited to 256.", + "required": false, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetImagesByIds request": { + "$ref": "./examples/GetImagesByIds.json" + } + } + } + }, + "/projects/{projectId}/images": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Add the provided images to the set of training images.", + "description": "This API accepts body content as multipart/form-data and application/octet-stream. When using multipart\r\nmultiple image files can be sent at once, with a maximum of 64 files", + "operationId": "CreateImagesFromData", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagIds", + "in": "query", + "description": "The tags ids with which to tag each image. Limited to 20.", + "required": false, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data.", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromData request": { + "$ref": "./examples/CreateImagesFromData.json" + } + } + }, + "delete": { + "tags": [ + "ImageApi" + ], + "summary": "Delete images from the set of training images.", + "operationId": "DeleteImages", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageIds", + "in": "query", + "description": "Ids of the images to be deleted. Limited to 256 images per batch.", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteImages request": { + "$ref": "./examples/DeleteImages.json" + } + } + } + }, + "/projects/{projectId}/images/files": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Add the provided batch of images to the set of training images.", + "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": "CreateImagesFromFiles", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "The batch of image files to add. Limited to 64 images and 20 tags per batch.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageFileCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromFiles request": { + "$ref": "./examples/CreateImagesFromFiles.json" + } + } + } + }, + "/projects/{projectId}/images/urls": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Add the provided images urls to the set of training images.", + "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": "CreateImagesFromUrls", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "Image urls and tag ids. Limited to 64 images and 20 tags per batch.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrlCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromUrls request": { + "$ref": "./examples/CreateImagesFromUrls.json" + } + } + } + }, + "/projects/{projectId}/images/predictions": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Add the specified predicted images to the set of training images.", + "description": "This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.", + "operationId": "CreateImagesFromPredictions", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "Image and tag ids. Limited to 64 images and 20 tags per batch.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageIdCreateBatch" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromPredictions request": { + "$ref": "./examples/CreateImagesFromPredictions.json" + } + } + } + }, + "/{projectId}/images/{imageId}/regionproposals": { + "post": { + "tags": [ + "ImageRegionProposalApi" + ], + "summary": "Get region proposals for an image. Returns empty array if no proposals are found.", + "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": "GetImageRegionProposals", + "consumes": [], + "produces": [ + "application/json", + "text/json" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageId", + "in": "path", + "description": "The image id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageRegionProposal" + } + } + }, + "x-ms-examples": { + "Successful GetImageRegionProposals request": { + "$ref": "./examples/GetImageRegionProposals.json" + } + } + } + }, + "/projects/{projectId}/predictions": { + "delete": { + "tags": [ + "PredictionsApi" + ], + "summary": "Delete a set of predicted images and their associated prediction results.", + "operationId": "DeletePrediction", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "ids", + "in": "query", + "description": "The prediction ids. Limited to 64.", + "required": true, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeletePrediction request": { + "$ref": "./examples/DeletePrediction.json" + } + } + } + }, + "/projects/{projectId}/quicktest/url": { + "post": { + "tags": [ + "PredictionsApi" + ], + "summary": "Quick test an image url.", + "operationId": "QuickTestImageUrl", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project to evaluate against.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageUrl", + "in": "body", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "iterationId", + "in": "query", + "description": "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.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful QuickTestImageUrl request": { + "$ref": "./examples/QuickTestImageUrl.json" + } + } + } + }, + "/projects/{projectId}/quicktest/image": { + "post": { + "tags": [ + "PredictionsApi" + ], + "summary": "Quick test an image.", + "operationId": "QuickTestImage", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "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.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data.", + "required": true, + "type": "file" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + } + }, + "x-ms-examples": { + "Successful QuickTestImage request": { + "$ref": "./examples/QuickTestImage.json" + } + } + } + }, + "/projects/{projectId}/predictions/query": { + "post": { + "tags": [ + "PredictionsApi" + ], + "summary": "Get images that were sent to your prediction endpoint.", + "operationId": "QueryPredictions", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "query", + "in": "body", + "description": "Parameters used to query the predictions. Limited to combining 2 tags.", + "required": true, + "schema": { + "$ref": "#/definitions/PredictionQueryToken" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PredictionQueryResult" + } + } + }, + "x-ms-examples": { + "Successful QueryPredictions request": { + "$ref": "./examples/QueryPredictions.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/performance": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get detailed performance information about an iteration.", + "operationId": "GetIterationPerformance", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The id of the project the iteration belongs to.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The id of the iteration to get.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "threshold", + "in": "query", + "description": "The threshold used to determine true predictions.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "overlapThreshold", + "in": "query", + "description": "If applicable, the bounding box overlap threshold used to determine true predictions.", + "required": false, + "type": "number", + "format": "float" + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IterationPerformance" + } + } + }, + "x-ms-examples": { + "Successful GetIterationPerformance request": { + "$ref": "./examples/GetIterationPerformance.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/performance/images": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get image with its prediction for a given project iteration.", + "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\r\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetImagePerformances", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id. Defaults to workspace.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.", + "required": false, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest.", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ], + "x-nullable": false + }, + { + "name": "take", + "in": "query", + "description": "Maximum number of images to return. Defaults to 50, limited to 256.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50 + }, + { + "name": "skip", + "in": "query", + "description": "Number of images to skip before beginning the image batch. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ImagePerformance" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetImagePerformances request": { + "$ref": "./examples/GetImagePerformances.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/performance/images/count": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Gets the number of images tagged with the provided {tagIds} that have prediction results from\r\ntraining for the provided iteration {iterationId}.", + "description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetImagePerformanceCount", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id. Defaults to workspace.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images to count. Defaults to all tags when null.", + "required": false, + "type": "array", + "items": { + "type": "string", + "x-nullable": false + }, + "collectionFormat": "csv", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer", + "x-nullable": false + } + } + }, + "x-ms-examples": { + "Successful GetImagePerformanceCount request": { + "$ref": "./examples/GetImagePerformanceCount.json" + } + } + } + }, + "/projects": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get your projects.", + "operationId": "GetProjects", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Project" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetProjects request": { + "$ref": "./examples/GetProjects.json" + } + } + }, + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Create a project.", + "operationId": "CreateProject", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Name of the project.", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "name": "description", + "in": "query", + "description": "The description of the project.", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "domainId", + "in": "query", + "description": "The id of the domain to use for this project. Defaults to General.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "name": "classificationType", + "in": "query", + "description": "The type of classifier to create for this project.", + "required": false, + "type": "string", + "enum": [ + "Multiclass", + "Multilabel" + ], + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "x-ms-examples": { + "Successful CreateProject request": { + "$ref": "./examples/CreateProject.json" + } + } + } + }, + "/projects/{projectId}": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get a specific project.", + "operationId": "GetProject", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The id of the project to get.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "x-ms-examples": { + "Successful GetProject request": { + "$ref": "./examples/GetProject.json" + } + } + }, + "delete": { + "tags": [ + "ProjectApi" + ], + "summary": "Delete a specific project.", + "operationId": "DeleteProject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteProject request": { + "$ref": "./examples/DeleteProject.json" + } + } + }, + "patch": { + "tags": [ + "ProjectApi" + ], + "summary": "Update a specific project.", + "operationId": "UpdateProject", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The id of the project to update.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "updatedProject", + "in": "body", + "description": "The updated project model.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + } + }, + "x-ms-examples": { + "Successful UpdateProject request": { + "$ref": "./examples/UpdateProject.json" + } + } + } + }, + "/projects/{projectId}/iterations": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get iterations for the project.", + "operationId": "GetIterations", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Iteration" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetIterations request": { + "$ref": "./examples/GetIterations.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get a specific iteration.", + "operationId": "GetIteration", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The id of the project the iteration belongs to.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The id of the iteration to get.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "x-ms-examples": { + "Successful GetIteration request": { + "$ref": "./examples/GetIteration.json" + } + } + }, + "delete": { + "tags": [ + "ProjectApi" + ], + "summary": "Delete a specific iteration of a project.", + "operationId": "DeleteIteration", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteIteration request": { + "$ref": "./examples/DeleteIteration.json" + } + } + }, + "patch": { + "tags": [ + "ProjectApi" + ], + "summary": "Update a specific iteration.", + "operationId": "UpdateIteration", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "Iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "updatedIteration", + "in": "body", + "description": "The updated iteration model.", + "required": true, + "schema": { + "$ref": "#/definitions/Iteration" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "x-ms-examples": { + "Successful UpdateIteration request": { + "$ref": "./examples/UpdateIteration.json" + } + } + } + }, + "/projects/{projectId}/train": { + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Queues project for training.", + "operationId": "TrainProject", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + } + }, + "x-ms-examples": { + "Successful TrainProject request": { + "$ref": "./examples/TrainProject.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/export": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get the list of exports for a specific iteration.", + "operationId": "GetExports", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Export" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetExports request": { + "$ref": "./examples/GetExports.json" + } + } + }, + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Export a trained iteration.", + "operationId": "ExportIteration", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "platform", + "in": "query", + "description": "The target platform.", + "required": true, + "type": "string", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX" + ], + "x-nullable": true + }, + { + "name": "flavor", + "in": "query", + "description": "The flavor of the target platform.", + "required": false, + "type": "string", + "enum": [ + "Linux", + "Windows", + "ONNX10", + "ONNX12" + ], + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Export" + } + } + }, + "x-ms-examples": { + "Successful ExportIteration request": { + "$ref": "./examples/ExportIteration.json" + } + } + } + }, + "/projects/{projectId}/tags/{tagId}": { + "get": { + "tags": [ + "TagsApi" + ], + "summary": "Get information about a specific tag.", + "operationId": "GetTag", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project this tag belongs to.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagId", + "in": "path", + "description": "The tag id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration to retrieve this tag from. Optional, defaults to current training set.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "x-ms-examples": { + "Successful GetTag request": { + "$ref": "./examples/GetTag.json" + } + } + }, + "delete": { + "tags": [ + "TagsApi" + ], + "summary": "Delete a tag from the project.", + "operationId": "DeleteTag", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagId", + "in": "path", + "description": "Id of the tag to be deleted.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-examples": { + "Successful DeleteTag request": { + "$ref": "./examples/DeleteTag.json" + } + } + }, + "patch": { + "tags": [ + "TagsApi" + ], + "summary": "Update a tag.", + "operationId": "UpdateTag", + "consumes": [ + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagId", + "in": "path", + "description": "The id of the target tag.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "updatedTag", + "in": "body", + "description": "The updated tag model.", + "required": true, + "schema": { + "$ref": "#/definitions/Tag" + } + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "x-ms-examples": { + "Successful UpdateTag request": { + "$ref": "./examples/UpdateTag.json" + } + } + } + }, + "/projects/{projectId}/tags": { + "get": { + "tags": [ + "TagsApi" + ], + "summary": "Get the tags for a given project and iteration.", + "operationId": "GetTags", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + }, + "x-nullable": true + } + } + }, + "x-ms-examples": { + "Successful GetTags request": { + "$ref": "./examples/GetTags.json" + } + } + }, + "post": { + "tags": [ + "TagsApi" + ], + "summary": "Create a tag for the project.", + "operationId": "CreateTag", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "name", + "in": "query", + "description": "The tag name.", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "name": "description", + "in": "query", + "description": "Optional description for the tag.", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "type", + "in": "query", + "description": "Optional type for the tag.", + "required": false, + "type": "string", + "enum": [ + "Regular", + "Negative" + ], + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + } + }, + "x-ms-examples": { + "Successful CreateTag request": { + "$ref": "./examples/CreateTag.json" + } + } + } + } + }, + "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 + }, + "ImageTagCreateBatch": { + "description": "Batch of image tags.", + "type": "object", + "properties": { + "tags": { + "description": "Image Tag entries to include in this batch.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageTagCreateEntry": { + "description": "Entry associating a tag to an image.", + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "description": "Id of the image.", + "type": "string", + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "description": "Id of the tag.", + "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 + }, + "ImageRegionCreateEntry": { + "description": "Entry associating a region to an image.", + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "description": "Id of the image.", + "type": "string", + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "description": "Id of the tag associated with this region.", + "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", + "description": "Id of the tag associated with this region.", + "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 + }, + "Image": { + "description": "Image model to be sent as JSON.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Id of the image.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "description": "Date the image was created.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "width": { + "format": "int32", + "description": "Width of the image.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "height": { + "format": "int32", + "description": "Height of the image.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "resizedImageUri": { + "description": "The URI to the (resized) image used for training.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "thumbnailUri": { + "description": "The URI to the thumbnail of the original image.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "originalImageUri": { + "description": "The URI to the original uploaded image.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "tags": { + "description": "Tags associated with this image.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageTag" + }, + "readOnly": true, + "x-nullable": true + }, + "regions": { + "description": "Regions associated with this image.", + "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", + "description": "Id of the tag associated with this region.", + "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": { + "description": "True if all of the images in the batch were created successfully, otherwise false.", + "type": "boolean", + "readOnly": true, + "x-nullable": false + }, + "images": { + "description": "List of the image creation results.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageCreateResult" + }, + "readOnly": true, + "x-nullable": true + } + }, + "x-nullable": true + }, + "ImageCreateResult": { + "type": "object", + "properties": { + "sourceUrl": { + "description": "Source URL of the image.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "status": { + "description": "Status of the image creation.", + "enum": [ + "OK", + "OKDuplicate", + "ErrorSource", + "ErrorImageFormat", + "ErrorImageSize", + "ErrorStorage", + "ErrorLimitExceed", + "ErrorTagLimitExceed", + "ErrorRegionLimitExceed", + "ErrorUnknown", + "ErrorNegativeAndRegularTagOnSameImage" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ImageCreateStatus", + "modelAsString": true + } + }, + "image": { + "$ref": "#/definitions/Image", + "description": "The 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 + }, + "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", + "description": "Id of the tag associated with this region.", + "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 + }, + "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 + }, + "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 + }, + "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 + }, + "ImageUrl": { + "type": "object", + "properties": { + "url": { + "type": "string", + "x-nullable": true + } + }, + "x-nullable": true + }, + "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 + }, + "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 + }, + "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 + }, + "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": { + "resizedImageUri": { + "description": "The URI to the (resized) prediction image.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "thumbnailUri": { + "description": "The URI to the thumbnail of the original prediction image.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "originalImageUri": { + "description": "The URI to the original prediction image.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "domain": { + "format": "uuid", + "description": "Domain used for the prediction.", + "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 + }, + "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 modified.", + "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 + }, + "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 + }, + "Export": { + "type": "object", + "properties": { + "platform": { + "description": "Platform of the export.", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportPlatformModel", + "modelAsString": true + } + }, + "status": { + "description": "Status of the export.", + "enum": [ + "Exporting", + "Failed", + "Done" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportStatusModel", + "modelAsString": true + } + }, + "downloadUri": { + "description": "URI used to download the model.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "flavor": { + "description": "Flavor of the export.", + "enum": [ + "Linux", + "Windows", + "ONNX10", + "ONNX12" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "ExportFlavorModel", + "modelAsString": true + } + }, + "newerVersionAvailable": { + "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.", + "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 + }, + "type": { + "description": "Gets or sets the type of the tag.", + "enum": [ + "Regular", + "Negative" + ], + "type": "string", + "x-nullable": false, + "x-ms-enum": { + "name": "TagType", + "modelAsString": true + } + }, + "imageCount": { + "format": "int32", + "description": "Gets the number of images with this tag.", + "type": "integer", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + } + }, + "parameters": { + "ApiKey": { + "name": "Training-Key", + "in": "header", + "required": true, + "type": "string", + "x-ms-client-name": "ApiKey", + "x-ms-parameter-location": "client" + }, + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImageRegions.json new file mode 100644 index 000000000000..a0ef98e2a450 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImageRegions.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "batch": { + "regions" : [ + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "tagId" : "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "left": 0.25, + "top": 0.25, + "width": 0.25, + "height": 0.25 + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "created": [ ], + "duplicated": [], + "exceeded": [] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImageTags.json new file mode 100644 index 000000000000..91d3ba604a24 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImageTags.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "batch": { + "tags": [ + { + "imageId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "created": [ + { + "imageId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a" + } + ], + "duplicated": null, + "exceeded": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json new file mode 100644 index 000000000000..6cd0d804d59e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "tagIds": [ + "b607964f-7bd6-4a3b-a869-6791fb6aab87" + ], + "imageData": "multipart data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10.65Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + }, + { + "sourceUrl": "\"hemlock_6.jpg\"", + "status": "OK", + "image": { + "id": "f1855a92-b873-47e7-b513-f07a667ceda1", + "created": "2017-12-19T15:56:10.57Z", + "width": 900, + "height": 1531, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.5168568Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json new file mode 100644 index 000000000000..8313ef6d88e0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "batch": { + "images": [ + { + "name": "hemlock_10.jpg", + "contents": "{image contents}" + } + ], + "tagIds": [ + "b607964f-7bd6-4a3b-a869-6791fb6aab87" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10.65Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json new file mode 100644 index 000000000000..6fd3babcc699 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "batch": { + "images": [ + { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9" + } + ], + "tagIds": [ + "b607964f-7bd6-4a3b-a869-6791fb6aab87" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10.65Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json new file mode 100644 index 000000000000..9a183f787e8f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "batch": { + "images": [ + { + "url": "{url to image}" + } + ], + "tagIds": [ + "b607964f-7bd6-4a3b-a869-6791fb6aab87" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "sourceUrl": "{url to image}", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10.65Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09.6105895Z" + } + ] + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json new file mode 100644 index 000000000000..4bd5651525ad --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "name": "My New Project", + "description": "A test project", + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "My New Project", + "description": "A test project", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateTag.json new file mode 100644 index 000000000000..89f51202952f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateTag.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "Tag1", + "description": "Description of Tag1", + "body": "" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Tag1", + "description": "Description of Tag1", + "imageCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImageRegions.json new file mode 100644 index 000000000000..a35354da0478 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImageRegions.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "regionIds": [ "" ] + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImageTags.json new file mode 100644 index 000000000000..8de8d0ffd3b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImageTags.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "imageIds": [ + "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + ], + "tagIds": [ + "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + ] + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImages.json new file mode 100644 index 000000000000..ab086b435194 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteImages.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "imageIds": [ + "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + ] + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteIteration.json new file mode 100644 index 000000000000..bbada4036451 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteIteration.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeletePrediction.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeletePrediction.json new file mode 100644 index 000000000000..663540a9c7e2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeletePrediction.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "ids": [ + "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + ] + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteProject.json new file mode 100644 index 000000000000..2b60aa038b8c --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteProject.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteTag.json new file mode 100644 index 000000000000..e9df96b2c6e4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/DeleteTag.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01" + }, + "responses": { + "204": { + "headers": {}, + "body": "" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/ExportIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/ExportIteration.json new file mode 100644 index 000000000000..725769469fb9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/ExportIteration.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "platform": "TensorFlow" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "platform": "TensorFlow", + "status": "Exporting", + "downloadUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomain.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomain.json new file mode 100644 index 000000000000..55430c0b7feb --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomain.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "domainId": "b30a91ae-e3c1-4f73-a81e-c270bff27c39" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39", + "name": "Retail", + "exportable": false + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomains.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomains.json new file mode 100644 index 000000000000..03f339caa2b9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomains.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "name": "General", + "exportable": false + }, + { + "id": "c151d5b5-dd07-472a-acc8-15d29dea8518", + "name": "Food", + "exportable": false + }, + { + "id": "ca455789-012d-4b50-9fec-5bb63841c793", + "name": "Landmarks", + "exportable": false + }, + { + "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39", + "name": "Retail", + "exportable": false + }, + { + "id": "45badf75-3591-4f26-a705-45678d3e9f5f", + "name": "Adult", + "exportable": false + }, + { + "id": "0732100f-1a38-4e49-a514-c9b44c697ab5", + "name": "General (compact)", + "exportable": true + }, + { + "id": "b5cfd229-2ac7-4b2b-8d0a-2b0661344894", + "name": "Landmarks (compact)", + "exportable": true + }, + { + "id": "6b4faeda-8396-481b-9f8b-177b9fa3097f", + "name": "Retail (compact)", + "exportable": true + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetExports.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetExports.json new file mode 100644 index 000000000000..abd24cbc0c5d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetExports.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "platform": "TensorFlow", + "status": "Done", + "downloadUri": "{Download URI" + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformanceCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformanceCount.json new file mode 100644 index 000000000000..75a4c85e295b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformanceCount.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12", + "tagIds": [ "b5f7e6a2-a481-49a6-afec-a7cef1af3544" ] + }, + "responses": { + "200": { + "headers": {}, + "body": "1" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformances.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformances.json new file mode 100644 index 000000000000..2a0c67fb6dcb --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformances.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66", + "tagIds": [ + "" + ], + "orderBy": "Newest" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042", + "created": "2018-01-31T20:18:26.5806336Z", + "predictions": [ + { + "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "tagName": "Tag 1", + "probability": 1.0, + "boundingBox": { + "left": 0.25, + "top": 0.25, + "width": 0.25, + "height": 0.25 + } + } + ], + "width": 600, + "height": 1600, + "imageUri": "", + "thumbnailUri": "", + "tags" : [ ], + "regions": [ ] + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImageRegionProposals.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImageRegionProposals.json new file mode 100644 index 000000000000..ed9e828cd308 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImageRegionProposals.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "proposals": [ + { + "confidence": 0.25, + "boundingBox": { + "left": 0.25, + "top": 0.25, + "width": 0.25, + "height": 0.25 + } + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagesByIds.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagesByIds.json new file mode 100644 index 000000000000..98f4c880665a --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagesByIds.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json new file mode 100644 index 000000000000..13739c1ce237 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:47:02.9511889Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterationPerformance.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterationPerformance.json new file mode 100644 index 000000000000..8fea34b309d7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterationPerformance.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "threshold": 0.9 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "perTagPerformance": [ + { + "id": "e31ff107-5505-4753-be42-b369b21b026c", + "name": "Hemlock", + "precision": 1.0, + "precisionStdDeviation": 0.0, + "recall": 1.0, + "recallStdDeviation": 0.0 + }, + { + "id": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "name": "Japanese Cherry", + "precision": 1.0, + "precisionStdDeviation": 0.0, + "recall": 1.0, + "recallStdDeviation": 0.0 + } + ], + "precision": 1.0, + "precisionStdDeviation": 0.0, + "recall": 1.0, + "recallStdDeviation": 0.0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json new file mode 100644 index 000000000000..dbcb14405ef8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "name": "Iteration 1", + "isDefault": true, + "status": "Completed", + "created": "2017-12-18T22:40:29.7304213Z", + "lastModified": "2017-12-18T22:40:41.3173903Z", + "trainedAt": "2017-12-18T22:40:41.0058589Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:47:02.9511889Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + { + "id": "3adaf7b2-18fc-4376-9da4-b5ea160a7cf5", + "name": "Iteration 3", + "isDefault": false, + "status": "New", + "created": "2017-12-19T15:46:59.2533333Z", + "lastModified": "2017-12-19T15:46:59.2699369Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": null + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json new file mode 100644 index 000000000000..7335be561999 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "My New Project", + "description": "A test project", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json new file mode 100644 index 000000000000..4cff8a634be3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "My New Project", + "description": "", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTag.json new file mode 100644 index 000000000000..ccd76c898899 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTag.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Tag1", + "description": "Description of Tag1", + "imageCount": 0 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTaggedImageCount.json new file mode 100644 index 000000000000..89707bb70271 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTaggedImageCount.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": "10" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTaggedImages.json new file mode 100644 index 000000000000..98f4c880665a --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTaggedImages.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTags.json new file mode 100644 index 000000000000..8ba964999aea --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTags.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Tag1", + "description": "Description of Tag1", + "imageCount": 0 + } + ] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetUntaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetUntaggedImageCount.json new file mode 100644 index 000000000000..89707bb70271 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetUntaggedImageCount.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": "10" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetUntaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetUntaggedImages.json new file mode 100644 index 000000000000..98f4c880665a --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetUntaggedImages.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json new file mode 100644 index 000000000000..8a40a06e9408 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "query": { + "orderBy": "Newest", + "tags": [ + { + "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "minThreshold": 0.9 + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "results": [ + { + "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042", + "project": "8988643a-ae70-447d-9a22-15c4255e5ecb", + "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66", + "created": "2018-01-31T20:18:26.5806336Z", + "predictions": [ + { + "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "tagName": "Tag 1", + "probability": 1.0 + }, + { + "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3", + "tagName": "Tag 2", + "probability": 3.60627153E-12 + } + ], + "originalImageUri": "", + "thumbnailUri": "", + "resizedImageUri": "" + } + ], + "token": { + "session": "1:286613", + "continuation": null, + "maxCount": 0, + "orderBy": "Newest", + "tags": [ + { + "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "minThreshold": 0.9, + "maxThreshold": 1.0 + } + ], + "iterationId": null, + "startTime": null, + "endTime": null, + "application": null + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImage.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImage.json new file mode 100644 index 000000000000..439be44f9c31 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImage.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.00 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImageUrl.json new file mode 100644 index 000000000000..a72595efe23f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImageUrl.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.00 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json new file mode 100644 index 000000000000..9bdd8b39b79e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "isDefault": false, + "status": "Training", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:46:58.197323Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json new file mode 100644 index 000000000000..a48f0ef6843a --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "updatedIteration": { + "name": "Best Iteration" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Best Iteration", + "isDefault": false, + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:53:07.8782881Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json new file mode 100644 index 000000000000..59d801c0ed4b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "updatedProject": { + "name": "New Project Name", + "description": "A new Description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "New Project Name", + "description": "A new Description", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": null + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateTag.json new file mode 100644 index 000000000000..94cdd86f22a1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateTag.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "updatedTag": { + "name": "Better Tag Name", + "description": "Better description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Better Tag Name", + "description": "Better description", + "imageCount": 0 + } + } + } +} \ No newline at end of file From d148b66bc707f3bb01ee0aa0e1bfed18ba217455 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Wed, 6 Feb 2019 15:13:08 -0800 Subject: [PATCH 02/18] Add 3.0 version of swagger for Training and Prediction --- .../Prediction/stable/v3.0/Prediction.json | 572 +++++++++++-- .../Training/stable/v3.0/Training.json | 749 ++++++++++++++++-- 2 files changed, 1187 insertions(+), 134 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json index 21bf65009c37..41a2f9bae749 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json @@ -1,22 +1,22 @@ { "swagger": "2.0", "info": { - "version": "2.0", + "version": "3.0", "title": "Custom Vision Prediction Client" }, "host": "southcentralus.api.cognitive.microsoft.com", - "basePath": "/customvision/v2.0/Prediction", + "basePath": "/customvision/v3.0/prediction", "schemes": [ "https" ], "paths": { - "/{projectId}/url": { + "/{projectId}/classify/models/{name}/url": { "post": { "tags": [ "ImagePredictionApi" ], - "summary": "Predict an image url and saves the result", - "operationId": "PredictImageUrl", + "summary": "Classify an image url and saves the result.", + "operationId": "ClassifyImageUrl", "consumes": [ "application/json", "text/json", @@ -34,38 +34,112 @@ { "name": "projectId", "in": "path", - "description": "The project id", + "description": "The project id.", "required": true, "type": "string", "format": "uuid", "x-nullable": false }, + { + "name": "name", + "in": "path", + "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": true, + "type": "string", + "x-nullable": true + }, { "name": "imageUrl", "in": "body", - "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", "required": true, "schema": { "$ref": "#/definitions/ImageUrl" } }, { - "name": "iterationId", + "name": "application", "in": "query", - "description": "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", + "description": "Optional. Specifies the name of application using the endpoint.", "required": false, "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ClassifyImageUrl request": { + "$ref": "./examples/ClassifyImageUrl.json" + } + } + } + }, + "/{projectId}/classify/models/{name}/image": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Classify an image and saves the result.", + "operationId": "ClassifyImage", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", "format": "uuid", + "x-nullable": false + }, + { + "name": "name", + "in": "path", + "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": true, + "type": "string", "x-nullable": true }, { "name": "application", "in": "query", - "description": "Optional. Specifies the name of application using the endpoint", + "description": "Optional. Specifies the name of application using the endpoint.", "required": false, "type": "string", "x-nullable": true }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data.", + "required": true, + "type": "file" + }, { "$ref": "#/parameters/ApiKey" } @@ -76,25 +150,34 @@ "schema": { "$ref": "#/definitions/ImagePrediction" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { - "Successful PredictImageUrl request": { - "$ref": "./examples/PredictImageUrl.json" + "Successful ClassifyImage request": { + "$ref": "./examples/ClassifyImage.json" } } } }, - "/{projectId}/image": { + "/{projectId}/classify/models/{name}/url/nostore": { "post": { "tags": [ "ImagePredictionApi" ], - "summary": "Predict an image and saves the result", - "operationId": "PredictImage", + "summary": "Classify an image url without saving the result.", + "operationId": "ClassifyImageUrlWithNoStore", "consumes": [ - "multipart/form-data", - "application/octet-stream" + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" ], "produces": [ "application/json", @@ -106,25 +189,101 @@ { "name": "projectId", "in": "path", - "description": "The project id", + "description": "The project id.", "required": true, "type": "string", "format": "uuid", "x-nullable": false }, { - "name": "iterationId", + "name": "name", + "in": "path", + "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "name": "imageUrl", + "in": "body", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "application", "in": "query", - "description": "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", + "description": "Optional. Specifies the name of application using the endpoint.", "required": false, "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ClassifyImageUrlWithNoStore request": { + "$ref": "./examples/ClassifyImageUrlWithNoStore.json" + } + } + } + }, + "/{projectId}/classify/models/{name}/image/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Classify an image without saving the result.", + "operationId": "ClassifyImageWithNoStore", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", "format": "uuid", + "x-nullable": false + }, + { + "name": "name", + "in": "path", + "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": true, + "type": "string", "x-nullable": true }, { "name": "application", "in": "query", - "description": "Optional. Specifies the name of application using the endpoint", + "description": "Optional. Specifies the name of application using the endpoint.", "required": false, "type": "string", "x-nullable": true @@ -132,6 +291,7 @@ { "name": "imageData", "in": "formData", + "description": "Binary image data.", "required": true, "type": "file" }, @@ -145,22 +305,28 @@ "schema": { "$ref": "#/definitions/ImagePrediction" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { - "Successful PredictImage request": { - "$ref": "./examples/PredictImage.json" + "Successful ClassifyImageWithNoStore request": { + "$ref": "./examples/ClassifyImageWithNoStore.json" } } } }, - "/{projectId}/url/nostore": { + "/{projectId}/detect/models/{name}/url": { "post": { "tags": [ "ImagePredictionApi" ], - "summary": "Predict an image url without saving the result", - "operationId": "PredictImageUrlWithNoStore", + "summary": "Detect objects in an image url and saves the result.", + "operationId": "DetectImageUrl", "consumes": [ "application/json", "text/json", @@ -178,38 +344,112 @@ { "name": "projectId", "in": "path", - "description": "The project id", + "description": "The project id.", "required": true, "type": "string", "format": "uuid", "x-nullable": false }, + { + "name": "name", + "in": "path", + "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": true, + "type": "string", + "x-nullable": true + }, { "name": "imageUrl", "in": "body", - "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", "required": true, "schema": { "$ref": "#/definitions/ImageUrl" } }, { - "name": "iterationId", + "name": "application", "in": "query", - "description": "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", + "description": "Optional. Specifies the name of application using the endpoint.", "required": false, "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectImageUrl request": { + "$ref": "./examples/DetectImageUrl.json" + } + } + } + }, + "/{projectId}/detect/models/{name}/image": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Detect objects in an image and saves the result.", + "operationId": "DetectImage", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", "format": "uuid", + "x-nullable": false + }, + { + "name": "name", + "in": "path", + "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": true, + "type": "string", "x-nullable": true }, { "name": "application", "in": "query", - "description": "Optional. Specifies the name of application using the endpoint", + "description": "Optional. Specifies the name of application using the endpoint.", "required": false, "type": "string", "x-nullable": true }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data.", + "required": true, + "type": "file" + }, { "$ref": "#/parameters/ApiKey" } @@ -220,25 +460,34 @@ "schema": { "$ref": "#/definitions/ImagePrediction" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { - "Successful PredictImageUrlWithNoStore request": { - "$ref": "./examples/PredictImageUrlWithNoStore.json" + "Successful DetectImage request": { + "$ref": "./examples/DetectImage.json" } } } }, - "/{projectId}/image/nostore": { + "/{projectId}/detect/models/{name}/url/nostore": { "post": { "tags": [ "ImagePredictionApi" ], - "summary": "Predict an image without saving the result", - "operationId": "PredictImageWithNoStore", + "summary": "Detect objects in an image url without saving the result.", + "operationId": "DetectImageUrlWithNoStore", "consumes": [ - "multipart/form-data", - "application/octet-stream" + "application/json", + "text/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" ], "produces": [ "application/json", @@ -250,25 +499,101 @@ { "name": "projectId", "in": "path", - "description": "The project id", + "description": "The project id.", "required": true, "type": "string", "format": "uuid", "x-nullable": false }, { - "name": "iterationId", + "name": "name", + "in": "path", + "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "name": "imageUrl", + "in": "body", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "application", "in": "query", - "description": "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", + "description": "Optional. Specifies the name of application using the endpoint.", "required": false, "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectImageUrlWithNoStore request": { + "$ref": "./examples/DetectImageUrlWithNoStore.json" + } + } + } + }, + "/{projectId}/detect/models/{name}/image/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Detect objects in an image without saving the result.", + "operationId": "DetectImageWithNoStore", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", "format": "uuid", + "x-nullable": false + }, + { + "name": "name", + "in": "path", + "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": true, + "type": "string", "x-nullable": true }, { "name": "application", "in": "query", - "description": "Optional. Specifies the name of application using the endpoint", + "description": "Optional. Specifies the name of application using the endpoint.", "required": false, "type": "string", "x-nullable": true @@ -276,6 +601,7 @@ { "name": "imageData", "in": "formData", + "description": "Binary image data.", "required": true, "type": "file" }, @@ -289,11 +615,17 @@ "schema": { "$ref": "#/definitions/ImagePrediction" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { - "Successful PredictImageWithNoStore request": { - "$ref": "./examples/PredictImageWithNoStore.json" + "Successful DetectImageWithNoStore request": { + "$ref": "./examples/DetectImageWithNoStore.json" } } } @@ -301,9 +633,11 @@ }, "definitions": { "ImageUrl": { + "description": "Image url.", "type": "object", "properties": { "url": { + "description": "Url of the image.", "type": "string", "x-nullable": true } @@ -311,33 +645,39 @@ "x-nullable": true }, "ImagePrediction": { + "description": "Result of an image prediction request.", "type": "object", "properties": { "id": { "format": "uuid", + "description": "Prediction Id.", "type": "string", "readOnly": true, "x-nullable": false }, "project": { "format": "uuid", + "description": "Project Id.", "type": "string", "readOnly": true, "x-nullable": false }, "iteration": { "format": "uuid", + "description": "Iteration Id.", "type": "string", "readOnly": true, "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" @@ -349,63 +689,203 @@ "x-nullable": true }, "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, "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 }, "BoundingBox": { + "description": "Bounding box that defines a region of an image.", "type": "object", "properties": { "left": { "format": "float", + "description": "Coordinate of the left boundary.", "type": "number", "x-nullable": false }, "top": { "format": "float", + "description": "Coordinate of the top boundary.", "type": "number", "x-nullable": false }, "width": { "format": "float", + "description": "Width.", "type": "number", "x-nullable": false }, "height": { "format": "float", + "description": "Height.", "type": "number", "x-nullable": false } }, "x-nullable": true + }, + "CustomVisionError": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "enum": [ + "NoError", + "BadRequest", + "BadRequestExceededBatchSize", + "BadRequestNotSupported", + "BadRequestInvalidIds", + "BadRequestProjectName", + "BadRequestProjectNameNotUnique", + "BadRequestProjectDescription", + "BadRequestProjectUnknownDomain", + "BadRequestProjectUnknownClassification", + "BadRequestProjectUnsupportedDomainTypeChange", + "BadRequestIterationName", + "BadRequestIterationNameNotUnique", + "BadRequestIterationDescription", + "BadRequestIterationIsNotTrained", + "BadRequestWorkspaceCannotBeModified", + "BadRequestWorkspaceNotDeletable", + "BadRequestTagName", + "BadRequestTagNameNotUnique", + "BadRequestTagDescription", + "BadRequestTagType", + "BadRequestMultipleNegativeTag", + "BadRequestImageTags", + "BadRequestImageRegions", + "BadRequestNegativeAndRegularTagOnSameImage", + "BadRequestIterationIsPublished", + "BadRequestInvalidPublishName", + "BadRequestSubscriptionApi", + "BadRequestPublishFailed", + "BadRequestUnpublishFailed", + "BadRequestExceedProjectLimit", + "BadRequestExceedIterationPerProjectLimit", + "BadRequestExceedTagPerProjectLimit", + "BadRequestExceedTagPerImageLimit", + "BadRequestExceededQuota", + "BadRequestCannotMigrateProjectWithName", + "BadRequestNotLimitedTrial", + "BadRequestImageBatch", + "BadRequestImageStream", + "BadRequestImageUrl", + "BadRequestImageFormat", + "BadRequestImageSizeBytes", + "BadRequestImageExceededCount", + "BadRequestTrainingNotNeeded", + "BadRequestTrainingValidationFailed", + "BadRequestClassificationTrainingValidationFailed", + "BadRequestMultiClassClassificationTrainingValidationFailed", + "BadRequestMultiLabelClassificationTrainingValidationFailed", + "BadRequestDetectionTrainingValidationFailed", + "BadRequestTrainingAlreadyInProgress", + "BadRequestDetectionTrainingNotAllowNegativeTag", + "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-nullable": false, + "x-ms-enum": { + "name": "CustomVisionErrorCodes", + "modelAsString": true + } + }, + "message": { + "description": "A message explaining the error reported by the service.", + "type": "string" + } + } } }, "parameters": { "ApiKey": { "name": "Prediction-Key", "in": "header", + "description": "API key.", "required": true, "type": "string", "x-ms-client-name": "ApiKey", @@ -414,7 +894,7 @@ "Endpoint": { "name": "Endpoint", "in": "path", - "description": "Supported Cognitive Services endpoints", + "description": "Supported Cognitive Services endpoints.", "required": true, "type": "string", "x-ms-parameter-location": "client", @@ -430,4 +910,4 @@ } ] } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index 2056a6a71d06..a2577ca96c84 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -1,11 +1,11 @@ { "swagger": "2.0", "info": { - "version": "2.2", + "version": "3.0", "title": "Custom Vision Training Client" }, "host": "southcentralus.api.cognitive.microsoft.com", - "basePath": "/customvision/v2.2/Training", + "basePath": "/customvision/v3.0/training", "schemes": [ "https" ], @@ -39,6 +39,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -82,6 +88,12 @@ "schema": { "$ref": "#/definitions/Domain" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -150,6 +162,12 @@ "type": "integer", "x-nullable": false } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -205,6 +223,12 @@ "type": "integer", "x-nullable": false } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -263,6 +287,12 @@ "schema": { "$ref": "#/definitions/ImageTagCreateSummary" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -322,6 +352,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -381,6 +417,12 @@ "schema": { "$ref": "#/definitions/ImageRegionCreateSummary" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -427,6 +469,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -527,6 +575,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -614,6 +668,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -684,6 +744,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -751,6 +817,12 @@ "schema": { "$ref": "#/definitions/ImageCreateSummary" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -797,6 +869,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -856,6 +934,12 @@ "schema": { "$ref": "#/definitions/ImageCreateSummary" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -915,6 +999,12 @@ "schema": { "$ref": "#/definitions/ImageCreateSummary" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -974,6 +1064,12 @@ "schema": { "$ref": "#/definitions/ImageCreateSummary" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -983,7 +1079,7 @@ } } }, - "/{projectId}/images/{imageId}/regionproposals": { + "/projects/{projectId}/images/{imageId}/regionproposals": { "post": { "tags": [ "ImageRegionProposalApi" @@ -1025,6 +1121,12 @@ "schema": { "$ref": "#/definitions/ImageRegionProposal" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1073,6 +1175,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1140,6 +1248,12 @@ "schema": { "$ref": "#/definitions/ImagePrediction" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1202,6 +1316,12 @@ "schema": { "$ref": "#/definitions/ImagePrediction" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1260,6 +1380,12 @@ "schema": { "$ref": "#/definitions/PredictionQueryResult" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1328,6 +1454,12 @@ "schema": { "$ref": "#/definitions/IterationPerformance" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1428,6 +1560,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1496,6 +1634,12 @@ "type": "integer", "x-nullable": false } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1534,6 +1678,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1603,6 +1753,12 @@ "schema": { "$ref": "#/definitions/Project" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1646,6 +1802,12 @@ "schema": { "$ref": "#/definitions/Project" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1679,6 +1841,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1735,6 +1903,12 @@ "schema": { "$ref": "#/definitions/Project" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1782,6 +1956,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1834,6 +2014,12 @@ "schema": { "$ref": "#/definitions/Iteration" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1876,6 +2062,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1941,6 +2133,12 @@ "schema": { "$ref": "#/definitions/Iteration" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1974,6 +2172,43 @@ "format": "uuid", "x-nullable": false }, + { + "name": "trainingType", + "in": "query", + "description": "The type of training to use to train the project (default: Regular).", + "required": false, + "type": "string", + "enum": [ + "Regular", + "Advanced" + ], + "x-nullable": false + }, + { + "name": "reservedBudgetInHours", + "in": "query", + "description": "The number of hours reserved as budget for training (if applicable).", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "name": "forceTrain", + "in": "query", + "description": "Whether to force train even if dataset and configuration does not change (default: false).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "notificationEmailAddress", + "in": "query", + "description": "The email address to send notification to when training finishes (default: null).", + "required": false, + "type": "string", + "x-nullable": true + }, { "$ref": "#/parameters/ApiKey" } @@ -1984,6 +2219,12 @@ "schema": { "$ref": "#/definitions/Iteration" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -1993,6 +2234,130 @@ } } }, + "/projects/{projectId}/iterations/{iterationId}/publish": { + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Publish a specific iteration.", + "operationId": "PublishIteration", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "name", + "in": "query", + "description": "The updated iteration name.", + "required": true, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "boolean", + "x-nullable": false + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful PublishIteration request": { + "$ref": "./examples/PublishIteration.json" + } + } + }, + "delete": { + "tags": [ + "ProjectApi" + ], + "summary": "Unpublish a specific iteration.", + "operationId": "UnpublishIteration", + "consumes": [], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "boolean", + "x-nullable": false + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful UnpublishIteration request": { + "$ref": "./examples/UnpublishIteration.json" + } + } + } + }, "/projects/{projectId}/iterations/{iterationId}/export": { "get": { "tags": [ @@ -2040,6 +2405,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -2104,7 +2475,8 @@ "Linux", "Windows", "ONNX10", - "ONNX12" + "ONNX12", + "ARM" ], "x-nullable": true }, @@ -2118,6 +2490,12 @@ "schema": { "$ref": "#/definitions/Export" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -2179,6 +2557,12 @@ "schema": { "$ref": "#/definitions/Tag" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -2221,6 +2605,12 @@ "responses": { "204": { "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -2286,6 +2676,12 @@ "schema": { "$ref": "#/definitions/Tag" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -2342,6 +2738,12 @@ }, "x-nullable": true } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -2411,6 +2813,12 @@ "schema": { "$ref": "#/definitions/Tag" } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } } }, "x-ms-examples": { @@ -2555,21 +2963,25 @@ }, "left": { "format": "float", + "description": "Coordinate of the left boundary.", "type": "number", "x-nullable": false }, "top": { "format": "float", + "description": "Coordinate of the top boundary.", "type": "number", "x-nullable": false }, "width": { "format": "float", + "description": "Width.", "type": "number", "x-nullable": false }, "height": { "format": "float", + "description": "Height.", "type": "number", "x-nullable": false } @@ -2637,21 +3049,25 @@ }, "left": { "format": "float", + "description": "Coordinate of the left boundary.", "type": "number", "x-nullable": false }, "top": { "format": "float", + "description": "Coordinate of the top boundary.", "type": "number", "x-nullable": false }, "width": { "format": "float", + "description": "Width.", "type": "number", "x-nullable": false }, "height": { "format": "float", + "description": "Height.", "type": "number", "x-nullable": false } @@ -2780,21 +3196,25 @@ }, "left": { "format": "float", + "description": "Coordinate of the left boundary.", "type": "number", "x-nullable": false }, "top": { "format": "float", + "description": "Coordinate of the top boundary.", "type": "number", "x-nullable": false }, "width": { "format": "float", + "description": "Width.", "type": "number", "x-nullable": false }, "height": { "format": "float", + "description": "Height.", "type": "number", "x-nullable": false } @@ -2926,21 +3346,25 @@ }, "left": { "format": "float", + "description": "Coordinate of the left boundary.", "type": "number", "x-nullable": false }, "top": { "format": "float", + "description": "Coordinate of the top boundary.", "type": "number", "x-nullable": false }, "width": { "format": "float", + "description": "Width.", "type": "number", "x-nullable": false }, "height": { "format": "float", + "description": "Height.", "type": "number", "x-nullable": false } @@ -2973,6 +3397,7 @@ "type": "object", "properties": { "url": { + "description": "Url of the image.", "type": "string", "x-nullable": true }, @@ -3022,6 +3447,7 @@ "properties": { "id": { "format": "uuid", + "description": "Id of the image.", "type": "string", "x-nullable": false }, @@ -3087,25 +3513,30 @@ "x-nullable": true }, "BoundingBox": { + "description": "Bounding box that defines a region of an image.", "type": "object", "properties": { "left": { "format": "float", + "description": "Coordinate of the left boundary.", "type": "number", "x-nullable": false }, "top": { "format": "float", + "description": "Coordinate of the top boundary.", "type": "number", "x-nullable": false }, "width": { "format": "float", + "description": "Width.", "type": "number", "x-nullable": false }, "height": { "format": "float", + "description": "Height.", "type": "number", "x-nullable": false } @@ -3113,9 +3544,11 @@ "x-nullable": true }, "ImageUrl": { + "description": "Image url.", "type": "object", "properties": { "url": { + "description": "Url of the image.", "type": "string", "x-nullable": true } @@ -3123,33 +3556,39 @@ "x-nullable": true }, "ImagePrediction": { + "description": "Result of an image prediction request.", "type": "object", "properties": { "id": { "format": "uuid", + "description": "Prediction Id.", "type": "string", "readOnly": true, "x-nullable": false }, "project": { "format": "uuid", + "description": "Project Id.", "type": "string", "readOnly": true, "x-nullable": false }, "iteration": { "format": "uuid", + "description": "Iteration Id.", "type": "string", "readOnly": true, "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" @@ -3161,27 +3600,32 @@ "x-nullable": true }, "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, "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 } }, @@ -3318,29 +3762,34 @@ }, "id": { "format": "uuid", + "description": "Prediction Id.", "type": "string", "readOnly": true, "x-nullable": false }, "project": { "format": "uuid", + "description": "Project Id.", "type": "string", "readOnly": true, "x-nullable": false }, "iteration": { "format": "uuid", + "description": "Iteration Id.", "type": "string", "readOnly": true, "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" @@ -3520,13 +3969,78 @@ }, "x-nullable": true }, + "Export": { + "type": "object", + "properties": { + "platform": { + "description": "Platform of the export.", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportPlatformModel", + "modelAsString": true + } + }, + "status": { + "description": "Status of the export.", + "enum": [ + "Exporting", + "Failed", + "Done" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportStatusModel", + "modelAsString": true + } + }, + "downloadUri": { + "description": "URI used to download the model.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "flavor": { + "description": "Flavor of the export.", + "enum": [ + "Linux", + "Windows", + "ONNX10", + "ONNX12" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "ExportFlavorModel", + "modelAsString": true + } + }, + "newerVersionAvailable": { + "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.", + "type": "boolean", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + }, "Project": { "description": "Represents a project.", "type": "object", "properties": { "id": { "format": "uuid", - "description": "Gets The project id.", + "description": "Gets the project id.", "type": "string", "readOnly": true, "x-nullable": false @@ -3560,10 +4074,16 @@ "x-nullable": false }, "thumbnailUri": { - "description": "Gets the thumbnail url representing the project.", + "description": "Gets the thumbnail url representing the image.", "type": "string", "readOnly": true, "x-nullable": true + }, + "drModeEnabled": { + "description": "Gets if the DR mode is on.", + "type": "boolean", + "readOnly": true, + "x-nullable": false } }, "x-nullable": true @@ -3577,19 +4097,6 @@ "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 @@ -3610,11 +4117,6 @@ "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", @@ -3644,7 +4146,7 @@ }, "projectId": { "format": "uuid", - "description": "Gets The project id. of the iteration.", + "description": "Gets the project id of the iteration.", "type": "string", "readOnly": true, "x-nullable": false @@ -3675,71 +4177,12 @@ "name": "Classifier", "modelAsString": true } - } - }, - "x-nullable": true - }, - "Export": { - "type": "object", - "properties": { - "platform": { - "description": "Platform of the export.", - "enum": [ - "CoreML", - "TensorFlow", - "DockerFile", - "ONNX" - ], - "type": "string", - "readOnly": true, - "x-nullable": false, - "x-ms-enum": { - "name": "ExportPlatformModel", - "modelAsString": true - } }, - "status": { - "description": "Status of the export.", - "enum": [ - "Exporting", - "Failed", - "Done" - ], - "type": "string", - "readOnly": true, - "x-nullable": false, - "x-ms-enum": { - "name": "ExportStatusModel", - "modelAsString": true - } - }, - "downloadUri": { - "description": "URI used to download the model.", + "publishName": { + "description": "Name of the published model.", "type": "string", "readOnly": true, "x-nullable": true - }, - "flavor": { - "description": "Flavor of the export.", - "enum": [ - "Linux", - "Windows", - "ONNX10", - "ONNX12" - ], - "type": "string", - "readOnly": true, - "x-nullable": true, - "x-ms-enum": { - "name": "ExportFlavorModel", - "modelAsString": true - } - }, - "newerVersionAvailable": { - "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.", - "type": "boolean", - "readOnly": true, - "x-nullable": false } }, "x-nullable": true @@ -3787,12 +4230,142 @@ } }, "x-nullable": true + }, + "CustomVisionError": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "enum": [ + "NoError", + "BadRequest", + "BadRequestExceededBatchSize", + "BadRequestNotSupported", + "BadRequestInvalidIds", + "BadRequestProjectName", + "BadRequestProjectNameNotUnique", + "BadRequestProjectDescription", + "BadRequestProjectUnknownDomain", + "BadRequestProjectUnknownClassification", + "BadRequestProjectUnsupportedDomainTypeChange", + "BadRequestIterationName", + "BadRequestIterationNameNotUnique", + "BadRequestIterationDescription", + "BadRequestIterationIsNotTrained", + "BadRequestWorkspaceCannotBeModified", + "BadRequestWorkspaceNotDeletable", + "BadRequestTagName", + "BadRequestTagNameNotUnique", + "BadRequestTagDescription", + "BadRequestTagType", + "BadRequestMultipleNegativeTag", + "BadRequestImageTags", + "BadRequestImageRegions", + "BadRequestNegativeAndRegularTagOnSameImage", + "BadRequestIterationIsPublished", + "BadRequestInvalidPublishName", + "BadRequestSubscriptionApi", + "BadRequestPublishFailed", + "BadRequestUnpublishFailed", + "BadRequestExceedProjectLimit", + "BadRequestExceedIterationPerProjectLimit", + "BadRequestExceedTagPerProjectLimit", + "BadRequestExceedTagPerImageLimit", + "BadRequestExceededQuota", + "BadRequestCannotMigrateProjectWithName", + "BadRequestNotLimitedTrial", + "BadRequestImageBatch", + "BadRequestImageStream", + "BadRequestImageUrl", + "BadRequestImageFormat", + "BadRequestImageSizeBytes", + "BadRequestImageExceededCount", + "BadRequestTrainingNotNeeded", + "BadRequestTrainingValidationFailed", + "BadRequestClassificationTrainingValidationFailed", + "BadRequestMultiClassClassificationTrainingValidationFailed", + "BadRequestMultiLabelClassificationTrainingValidationFailed", + "BadRequestDetectionTrainingValidationFailed", + "BadRequestTrainingAlreadyInProgress", + "BadRequestDetectionTrainingNotAllowNegativeTag", + "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-nullable": false, + "x-ms-enum": { + "name": "CustomVisionErrorCodes", + "modelAsString": true + } + }, + "message": { + "description": "A message explaining the error reported by the service.", + "type": "string" + } + } } }, "parameters": { "ApiKey": { "name": "Training-Key", "in": "header", + "description": "API key.", "required": true, "type": "string", "x-ms-client-name": "ApiKey", @@ -3801,7 +4374,7 @@ "Endpoint": { "name": "Endpoint", "in": "path", - "description": "Supported Cognitive Services endpoints", + "description": "Supported Cognitive Services endpoints.", "required": true, "type": "string", "x-ms-parameter-location": "client", @@ -3817,4 +4390,4 @@ } ] } -} \ No newline at end of file +} From 903795df17a287d20e0cb657299d592aa2eb2483 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Thu, 31 Jan 2019 10:41:52 -0800 Subject: [PATCH 03/18] Add examples for v3.0 --- .../{PredictImage.json => ClassifyImage.json} | 2 +- ...ictImageUrl.json => ClassifyImageUrl.json} | 2 +- ....json => ClassifyImageUrlWithNoStore.json} | 2 +- ...ore.json => ClassifyImageWithNoStore.json} | 2 +- .../stable/v3.0/examples/DetectImage.json | 33 +++++++++++++++++ .../stable/v3.0/examples/DetectImageUrl.json | 35 +++++++++++++++++++ .../examples/DetectImageUrlWithNoStore.json | 35 +++++++++++++++++++ .../v3.0/examples/DetectImageWithNoStore.json | 33 +++++++++++++++++ .../stable/v3.0/examples/GetIteration.json | 1 - .../stable/v3.0/examples/GetIterations.json | 3 -- .../v3.0/examples/PublishIteration.json | 16 +++++++++ .../stable/v3.0/examples/TrainProject.json | 1 - .../v3.0/examples/UnpublishIteration.json | 15 ++++++++ .../stable/v3.0/examples/UpdateIteration.json | 1 - 14 files changed, 171 insertions(+), 10 deletions(-) rename specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/{PredictImage.json => ClassifyImage.json} (94%) rename specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/{PredictImageUrl.json => ClassifyImageUrl.json} (94%) rename specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/{PredictImageUrlWithNoStore.json => ClassifyImageUrlWithNoStore.json} (94%) rename specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/{PredictImageWithNoStore.json => ClassifyImageWithNoStore.json} (94%) create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UnpublishIteration.json diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json similarity index 94% rename from specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImage.json rename to specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json index 397ea4bc3c04..32d7ba8d777e 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImage.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "name": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json similarity index 94% rename from specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrl.json rename to specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json index 78a95d198ca5..a77ec714518a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrl.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "name": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json similarity index 94% rename from specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrlWithNoStore.json rename to specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json index 78a95d198ca5..a77ec714518a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageUrlWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "name": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json similarity index 94% rename from specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageWithNoStore.json rename to specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json index 397ea4bc3c04..32d7ba8d777e 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/PredictImageWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "name": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json new file mode 100644 index 000000000000..32d7ba8d777e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "name": "MyModel1", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json new file mode 100644 index 000000000000..a77ec714518a --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "name": "MyModel1", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json new file mode 100644 index 000000000000..a77ec714518a --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "name": "MyModel1", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json new file mode 100644 index 000000000000..32d7ba8d777e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "name": "MyModel1", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41.6789561Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json index 13739c1ce237..8e51d58da52b 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json @@ -12,7 +12,6 @@ "body": { "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Iteration 2", - "isDefault": false, "status": "Completed", "created": "2017-12-18T22:40:36.9066667Z", "lastModified": "2017-12-19T15:47:02.9511889Z", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json index dbcb14405ef8..70143e1b2b7d 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json @@ -12,7 +12,6 @@ { "id": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", "name": "Iteration 1", - "isDefault": true, "status": "Completed", "created": "2017-12-18T22:40:29.7304213Z", "lastModified": "2017-12-18T22:40:41.3173903Z", @@ -24,7 +23,6 @@ { "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Iteration 2", - "isDefault": false, "status": "Completed", "created": "2017-12-18T22:40:36.9066667Z", "lastModified": "2017-12-19T15:47:02.9511889Z", @@ -36,7 +34,6 @@ { "id": "3adaf7b2-18fc-4376-9da4-b5ea160a7cf5", "name": "Iteration 3", - "isDefault": false, "status": "New", "created": "2017-12-19T15:46:59.2533333Z", "lastModified": "2017-12-19T15:46:59.2699369Z", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json new file mode 100644 index 000000000000..003b7a5785d4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Model1" + }, + "responses": { + "200": { + "headers": {}, + "body": true + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json index 9bdd8b39b79e..c3ec2c3eb8ef 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json @@ -11,7 +11,6 @@ "body": { "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Iteration 2", - "isDefault": false, "status": "Training", "created": "2017-12-18T22:40:36.9066667Z", "lastModified": "2017-12-19T15:46:58.197323Z", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UnpublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UnpublishIteration.json new file mode 100644 index 000000000000..70d6a7c37624 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UnpublishIteration.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "200": { + "headers": {}, + "body": true + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json index a48f0ef6843a..967eba1fe21c 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json @@ -15,7 +15,6 @@ "body": { "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Best Iteration", - "isDefault": false, "status": "Completed", "created": "2017-12-18T22:40:36.9066667Z", "lastModified": "2017-12-19T15:53:07.8782881Z", From 41587bf6eb34ba784213dc3a6865ac648bd9abe7 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Wed, 30 Jan 2019 15:24:00 -0800 Subject: [PATCH 04/18] Update release to 3.0 --- .../data-plane/CustomVision/Prediction/readme.go.md | 9 +++++++++ .../data-plane/CustomVision/Prediction/readme.md | 11 +++++++++-- .../data-plane/CustomVision/Training/readme.go.md | 9 +++++++++ .../data-plane/CustomVision/Training/readme.md | 12 ++++++++++-- 4 files changed, 37 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md index f37ddd4038bc..116757a5a978 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md @@ -23,4 +23,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_3_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.0/customvision/$(namespace) ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md index 0d9677e06268..110f50ce71f7 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md @@ -4,11 +4,11 @@ Configuration for generating Custom Vision Prediction SDK. -The current release is `release_1_0`. +The current release is `release_3_0`. ``` yaml -tag: release_1_0 +tag: release_3_0 openapi-type: data-plane ``` # Releases @@ -20,6 +20,13 @@ These settings apply only when `--tag=release_1_0` is specified on the command l input-file: stable/v2.0/Prediction.json ``` +### Release 3.0 +These settings apply only when `--tag=release_3_0` is specified on the command line. + +``` yaml $(tag) == 'release_3_0' +input-file: stable/v3.0/Prediction.json +``` + # Validation ## Suppression diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md index bfa367502a3a..d17920f61028 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md @@ -43,4 +43,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_3_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.0/customvision/$(namespace) ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md index b53e3e43337b..6d87d84f471c 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md @@ -4,11 +4,11 @@ Configuration for generating Custom Vision Training SDK. -The current release is `release_2_2`. +The current release is `release_3_0`. ``` yaml -tag: release_2_2 +tag: release_3_0 openapi-type: data-plane ``` # Releases @@ -33,6 +33,14 @@ These settings apply only when `--tag=release_2_2` is specified on the command l ``` yaml $(tag) == 'release_2_2' input-file: stable/v2.2/Training.json ``` + +### Release 3.0 +These settings apply only when `--tag=release_3_0` is specified on the command line. + +``` yaml $(tag) == 'release_3_0' +input-file: stable/v3.0/Training.json +``` + # Validation ## Suppression From 364b4c3067ea89f180c89bdad422c15eb11811dd Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Mon, 4 Mar 2019 06:26:11 -0800 Subject: [PATCH 05/18] Update Training API --- .../Prediction/stable/v3.0/Prediction.json | 4 + .../Training/stable/v3.0/Training.json | 233 +++++++++++++----- 2 files changed, 171 insertions(+), 66 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json index 41a2f9bae749..165bbc5439de 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json @@ -772,6 +772,7 @@ "BadRequestProjectUnknownDomain", "BadRequestProjectUnknownClassification", "BadRequestProjectUnsupportedDomainTypeChange", + "BadRequestProjectUnsupportedExportPlatform", "BadRequestIterationName", "BadRequestIterationNameNotUnique", "BadRequestIterationDescription", @@ -805,6 +806,7 @@ "BadRequestImageSizeBytes", "BadRequestImageExceededCount", "BadRequestTrainingNotNeeded", + "BadRequestTrainingNotNeededButTrainingPipelineUpdated", "BadRequestTrainingValidationFailed", "BadRequestClassificationTrainingValidationFailed", "BadRequestMultiClassClassificationTrainingValidationFailed", @@ -812,6 +814,8 @@ "BadRequestDetectionTrainingValidationFailed", "BadRequestTrainingAlreadyInProgress", "BadRequestDetectionTrainingNotAllowNegativeTag", + "BadRequestInvalidEmailAddress", + "BadRequestBakingAlreadyInProgress", "BadRequestExportValidationFailed", "BadRequestExportAlreadyInProgress", "BadRequestPredictionIdsMissing", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index a2577ca96c84..fec8e07a5bb6 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -1743,6 +1743,26 @@ ], "x-nullable": false }, + { + "name": "targetExportPlatforms", + "in": "query", + "description": "List of platforms the trained model is intending exporting to.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ], + "x-nullable": false + }, + "collectionFormat": "multi", + "x-nullable": true + }, { "$ref": "#/parameters/ApiKey" } @@ -2275,6 +2295,14 @@ "type": "string", "x-nullable": true }, + { + "name": "predictionId", + "in": "query", + "description": "The id of the prediction resource to publish to.", + "required": true, + "type": "string", + "x-nullable": true + }, { "$ref": "#/parameters/ApiKey" } @@ -3969,71 +3997,6 @@ }, "x-nullable": true }, - "Export": { - "type": "object", - "properties": { - "platform": { - "description": "Platform of the export.", - "enum": [ - "CoreML", - "TensorFlow", - "DockerFile", - "ONNX" - ], - "type": "string", - "readOnly": true, - "x-nullable": false, - "x-ms-enum": { - "name": "ExportPlatformModel", - "modelAsString": true - } - }, - "status": { - "description": "Status of the export.", - "enum": [ - "Exporting", - "Failed", - "Done" - ], - "type": "string", - "readOnly": true, - "x-nullable": false, - "x-ms-enum": { - "name": "ExportStatusModel", - "modelAsString": true - } - }, - "downloadUri": { - "description": "URI used to download the model.", - "type": "string", - "readOnly": true, - "x-nullable": true - }, - "flavor": { - "description": "Flavor of the export.", - "enum": [ - "Linux", - "Windows", - "ONNX10", - "ONNX12" - ], - "type": "string", - "readOnly": true, - "x-nullable": true, - "x-ms-enum": { - "name": "ExportFlavorModel", - "modelAsString": true - } - }, - "newerVersionAvailable": { - "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.", - "type": "boolean", - "readOnly": true, - "x-nullable": false - } - }, - "x-nullable": true - }, "Project": { "description": "Represents a project.", "type": "object", @@ -4097,6 +4060,35 @@ "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 + } + }, + "targetExportPlatforms": { + "description": "A list of ExportPlatform that the trained model should be able to support.", + "type": "array", + "items": { + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ], + "type": "string", + "x-nullable": false + }, + "x-nullable": true } }, "x-nullable": true @@ -4157,6 +4149,23 @@ "readOnly": true, "x-nullable": false }, + "exportableTo": { + "description": "A set of platforms this iteration can export to.", + "type": "array", + "items": { + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ], + "type": "string", + "x-nullable": false + }, + "readOnly": true, + "x-nullable": true + }, "domainId": { "format": "uuid", "description": "Get or sets a guid of the domain the iteration has been trained on.", @@ -4178,6 +4187,27 @@ "modelAsString": true } }, + "trainingType": { + "description": "Gets the training type of the iteration.", + "enum": [ + "Regular", + "Advanced" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "TrainingType", + "modelAsString": true + } + }, + "reservedBudgetInHours": { + "format": "int32", + "description": "Gets the reserved baking budget for the iteration.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, "publishName": { "description": "Name of the published model.", "type": "string", @@ -4187,6 +4217,73 @@ }, "x-nullable": true }, + "Export": { + "type": "object", + "properties": { + "platform": { + "description": "Platform of the export.", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportPlatform", + "modelAsString": true + } + }, + "status": { + "description": "Status of the export.", + "enum": [ + "Exporting", + "Failed", + "Done" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportStatus", + "modelAsString": true + } + }, + "downloadUri": { + "description": "URI used to download the model.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "flavor": { + "description": "Flavor of the export.", + "enum": [ + "Linux", + "Windows", + "ONNX10", + "ONNX12", + "ARM" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "ExportFlavor", + "modelAsString": true + } + }, + "newerVersionAvailable": { + "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.", + "type": "boolean", + "readOnly": true, + "x-nullable": false + } + }, + "x-nullable": true + }, "Tag": { "description": "Represents a Tag.", "type": "object", @@ -4252,6 +4349,7 @@ "BadRequestProjectUnknownDomain", "BadRequestProjectUnknownClassification", "BadRequestProjectUnsupportedDomainTypeChange", + "BadRequestProjectUnsupportedExportPlatform", "BadRequestIterationName", "BadRequestIterationNameNotUnique", "BadRequestIterationDescription", @@ -4285,6 +4383,7 @@ "BadRequestImageSizeBytes", "BadRequestImageExceededCount", "BadRequestTrainingNotNeeded", + "BadRequestTrainingNotNeededButTrainingPipelineUpdated", "BadRequestTrainingValidationFailed", "BadRequestClassificationTrainingValidationFailed", "BadRequestMultiClassClassificationTrainingValidationFailed", @@ -4292,6 +4391,8 @@ "BadRequestDetectionTrainingValidationFailed", "BadRequestTrainingAlreadyInProgress", "BadRequestDetectionTrainingNotAllowNegativeTag", + "BadRequestInvalidEmailAddress", + "BadRequestBakingAlreadyInProgress", "BadRequestExportValidationFailed", "BadRequestExportAlreadyInProgress", "BadRequestPredictionIdsMissing", @@ -4390,4 +4491,4 @@ } ] } -} +} \ No newline at end of file From 370169abdf402f69926ea95090bfd7a16965be25 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Mon, 4 Mar 2019 06:15:54 -0800 Subject: [PATCH 06/18] Rename arg, update comment. --- .../Prediction/stable/v3.0/Prediction.json | 48 +++++++++---------- .../stable/v3.0/examples/ClassifyImage.json | 2 +- .../v3.0/examples/ClassifyImageUrl.json | 2 +- .../examples/ClassifyImageUrlWithNoStore.json | 2 +- .../examples/ClassifyImageWithNoStore.json | 2 +- .../stable/v3.0/examples/DetectImage.json | 2 +- .../stable/v3.0/examples/DetectImageUrl.json | 2 +- .../examples/DetectImageUrlWithNoStore.json | 2 +- .../v3.0/examples/DetectImageWithNoStore.json | 2 +- .../v3.0/examples/PublishIteration.json | 3 +- 10 files changed, 34 insertions(+), 33 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json index 165bbc5439de..21a00b2c341f 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json @@ -10,7 +10,7 @@ "https" ], "paths": { - "/{projectId}/classify/models/{name}/url": { + "/{projectId}/classify/models/{publishedModelName}/url": { "post": { "tags": [ "ImagePredictionApi" @@ -41,9 +41,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishedModelName", "in": "path", - "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "description": "Specifies the name of the model to evaluate against.", "required": true, "type": "string", "x-nullable": true @@ -90,7 +90,7 @@ } } }, - "/{projectId}/classify/models/{name}/image": { + "/{projectId}/classify/models/{publishedModelName}/image": { "post": { "tags": [ "ImagePredictionApi" @@ -118,9 +118,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishedModelName", "in": "path", - "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "description": "Specifies the name of the model to evaluate against.", "required": true, "type": "string", "x-nullable": true @@ -165,7 +165,7 @@ } } }, - "/{projectId}/classify/models/{name}/url/nostore": { + "/{projectId}/classify/models/{publishedModelName}/url/nostore": { "post": { "tags": [ "ImagePredictionApi" @@ -196,9 +196,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishedModelName", "in": "path", - "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "description": "Specifies the name of the model to evaluate against.", "required": true, "type": "string", "x-nullable": true @@ -245,7 +245,7 @@ } } }, - "/{projectId}/classify/models/{name}/image/nostore": { + "/{projectId}/classify/models/{publishedModelName}/image/nostore": { "post": { "tags": [ "ImagePredictionApi" @@ -273,9 +273,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishedModelName", "in": "path", - "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "description": "Specifies the name of the model to evaluate against.", "required": true, "type": "string", "x-nullable": true @@ -320,7 +320,7 @@ } } }, - "/{projectId}/detect/models/{name}/url": { + "/{projectId}/detect/models/{publishedModelName}/url": { "post": { "tags": [ "ImagePredictionApi" @@ -351,9 +351,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishedModelName", "in": "path", - "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "description": "Specifies the name of the model to evaluate against.", "required": true, "type": "string", "x-nullable": true @@ -400,7 +400,7 @@ } } }, - "/{projectId}/detect/models/{name}/image": { + "/{projectId}/detect/models/{publishedModelName}/image": { "post": { "tags": [ "ImagePredictionApi" @@ -428,9 +428,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishedModelName", "in": "path", - "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "description": "Specifies the name of the model to evaluate against.", "required": true, "type": "string", "x-nullable": true @@ -475,7 +475,7 @@ } } }, - "/{projectId}/detect/models/{name}/url/nostore": { + "/{projectId}/detect/models/{publishedModelName}/url/nostore": { "post": { "tags": [ "ImagePredictionApi" @@ -506,9 +506,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishedModelName", "in": "path", - "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "description": "Specifies the name of the model to evaluate against.", "required": true, "type": "string", "x-nullable": true @@ -555,7 +555,7 @@ } } }, - "/{projectId}/detect/models/{name}/image/nostore": { + "/{projectId}/detect/models/{publishedModelName}/image/nostore": { "post": { "tags": [ "ImagePredictionApi" @@ -583,9 +583,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishedModelName", "in": "path", - "description": "Specifies the name of the model to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "description": "Specifies the name of the model to evaluate against.", "required": true, "type": "string", "x-nullable": true diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json index 32d7ba8d777e..2e9642d710c1 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "name": "MyModel1", + "publishedModelName": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json index a77ec714518a..963700d22e5a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "name": "MyModel1", + "publishedModelName": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json index a77ec714518a..963700d22e5a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "name": "MyModel1", + "publishedModelName": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json index 32d7ba8d777e..2e9642d710c1 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "name": "MyModel1", + "publishedModelName": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json index 32d7ba8d777e..2e9642d710c1 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "name": "MyModel1", + "publishedModelName": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json index a77ec714518a..963700d22e5a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "name": "MyModel1", + "publishedModelName": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json index a77ec714518a..963700d22e5a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "name": "MyModel1", + "publishedModelName": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json index 32d7ba8d777e..2e9642d710c1 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "name": "MyModel1", + "publishedModelName": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json index 003b7a5785d4..73f8d548074b 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json @@ -5,7 +5,8 @@ "Training-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", - "name": "Model1" + "name": "Model1", + "predictionId": "/subscriptions/{subscription}/resourceGroups/{resource group name}/providers/Microsoft.CognitiveServices/accounts/{resource name}" }, "responses": { "200": { From d84a52ffd77b5c4bd9cc95d3173d0bf6deeab96e Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Wed, 6 Mar 2019 14:20:17 -0800 Subject: [PATCH 07/18] Update ruby readme --- .../CustomVision/Prediction/readme.ruby.md | 12 ++++++++++++ .../data-plane/CustomVision/Training/readme.ruby.md | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md index 411adce418c5..fdffabe43ab5 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md @@ -13,6 +13,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: - tag: release_1_0 + - tag: release_3_0 ``` ### Tag: release_1_0 and ruby @@ -25,3 +26,14 @@ namespace: "Azure::CognitiveServices::CustomVision::Prediction::V1_0" output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvision_prediction/lib title: "PredictionClient" ``` + +### Tag: release_3_0 and ruby + +These settings apply only when `--tag=release_3_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::CustomVision::Prediction::V3_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvision_prediction/lib +title: "PredictionClient" +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md index 6fcea51453d6..7e65a5709df0 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md @@ -13,6 +13,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: - tag: release_1_0 + - tag: release_3_0 ``` ### Tag: release_1_0 and ruby @@ -25,3 +26,14 @@ namespace: "Azure::CognitiveServices::CustomVision::Training::V1_0" output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvision_training/lib title: "TrainingClient" ``` + +### Tag: release_3_0 and ruby + +These settings apply only when `--tag=release_3_0 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_3_0' && $(ruby) +namespace: "Azure::CognitiveServices::CustomVision::Training::V3_0" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvision_training/lib +title: "TrainingClient" +``` From e76649e7cc068de1c170a8b4eec4292a9a5929a4 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Fri, 8 Mar 2019 12:27:32 -0800 Subject: [PATCH 08/18] Update comments and incorporate feedback. --- .../Prediction/stable/v3.0/Prediction.json | 48 ++-- .../Training/stable/v3.0/Training.json | 231 ++++++++++-------- 2 files changed, 155 insertions(+), 124 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json index 21a00b2c341f..3134e4e7bc6c 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json @@ -10,7 +10,7 @@ "https" ], "paths": { - "/{projectId}/classify/models/{publishedModelName}/url": { + "/{projectId}/classify/iterations/{publishedName}/url": { "post": { "tags": [ "ImagePredictionApi" @@ -41,7 +41,7 @@ "x-nullable": false }, { - "name": "publishedModelName", + "name": "publishedName", "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, @@ -51,7 +51,7 @@ { "name": "imageUrl", "in": "body", - "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", + "description": "An ImageUrl that contains the url of the image to be evaluated.", "required": true, "schema": { "$ref": "#/definitions/ImageUrl" @@ -90,7 +90,7 @@ } } }, - "/{projectId}/classify/models/{publishedModelName}/image": { + "/{projectId}/classify/iterations/{publishedName}/image": { "post": { "tags": [ "ImagePredictionApi" @@ -118,7 +118,7 @@ "x-nullable": false }, { - "name": "publishedModelName", + "name": "publishedName", "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, @@ -136,7 +136,7 @@ { "name": "imageData", "in": "formData", - "description": "Binary image data.", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.", "required": true, "type": "file" }, @@ -165,7 +165,7 @@ } } }, - "/{projectId}/classify/models/{publishedModelName}/url/nostore": { + "/{projectId}/classify/iterations/{publishedName}/url/nostore": { "post": { "tags": [ "ImagePredictionApi" @@ -196,7 +196,7 @@ "x-nullable": false }, { - "name": "publishedModelName", + "name": "publishedName", "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, @@ -245,7 +245,7 @@ } } }, - "/{projectId}/classify/models/{publishedModelName}/image/nostore": { + "/{projectId}/classify/iterations/{publishedName}/image/nostore": { "post": { "tags": [ "ImagePredictionApi" @@ -273,7 +273,7 @@ "x-nullable": false }, { - "name": "publishedModelName", + "name": "publishedName", "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, @@ -291,7 +291,7 @@ { "name": "imageData", "in": "formData", - "description": "Binary image data.", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 0MB.", "required": true, "type": "file" }, @@ -320,7 +320,7 @@ } } }, - "/{projectId}/detect/models/{publishedModelName}/url": { + "/{projectId}/detect/iterations/{publishedName}/url": { "post": { "tags": [ "ImagePredictionApi" @@ -351,7 +351,7 @@ "x-nullable": false }, { - "name": "publishedModelName", + "name": "publishedName", "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, @@ -361,7 +361,7 @@ { "name": "imageUrl", "in": "body", - "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", + "description": "An ImageUrl that contains the url of the image to be evaluated.", "required": true, "schema": { "$ref": "#/definitions/ImageUrl" @@ -400,7 +400,7 @@ } } }, - "/{projectId}/detect/models/{publishedModelName}/image": { + "/{projectId}/detect/iterations/{publishedName}/image": { "post": { "tags": [ "ImagePredictionApi" @@ -428,7 +428,7 @@ "x-nullable": false }, { - "name": "publishedModelName", + "name": "publishedName", "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, @@ -446,7 +446,7 @@ { "name": "imageData", "in": "formData", - "description": "Binary image data.", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.", "required": true, "type": "file" }, @@ -475,7 +475,7 @@ } } }, - "/{projectId}/detect/models/{publishedModelName}/url/nostore": { + "/{projectId}/detect/iterations/{publishedName}/url/nostore": { "post": { "tags": [ "ImagePredictionApi" @@ -506,7 +506,7 @@ "x-nullable": false }, { - "name": "publishedModelName", + "name": "publishedName", "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, @@ -555,7 +555,7 @@ } } }, - "/{projectId}/detect/models/{publishedModelName}/image/nostore": { + "/{projectId}/detect/iterations/{publishedName}/image/nostore": { "post": { "tags": [ "ImagePredictionApi" @@ -583,7 +583,7 @@ "x-nullable": false }, { - "name": "publishedModelName", + "name": "publishedName", "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, @@ -601,7 +601,7 @@ { "name": "imageData", "in": "formData", - "description": "Binary image data.", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 0MB.", "required": true, "type": "file" }, @@ -789,9 +789,9 @@ "BadRequestNegativeAndRegularTagOnSameImage", "BadRequestIterationIsPublished", "BadRequestInvalidPublishName", - "BadRequestSubscriptionApi", - "BadRequestPublishFailed", + "BadRequestInvalidPublishTarget", "BadRequestUnpublishFailed", + "BadRequestSubscriptionApi", "BadRequestExceedProjectLimit", "BadRequestExceedIterationPerProjectLimit", "BadRequestExceedTagPerProjectLimit", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index fec8e07a5bb6..7f7fd87e5860 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -330,6 +330,8 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 64, + "minItems": 0, "x-nullable": true }, { @@ -343,6 +345,8 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0, "x-nullable": true }, { @@ -460,6 +464,8 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 64, + "minItems": 0, "x-nullable": true }, { @@ -529,6 +535,8 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0, "x-nullable": true }, { @@ -550,7 +558,9 @@ "required": false, "type": "integer", "format": "int32", - "default": 50 + "default": 50, + "maximum": 256, + "minimum": 0 }, { "name": "skip", @@ -643,7 +653,9 @@ "required": false, "type": "integer", "format": "int32", - "default": 50 + "default": 50, + "maximum": 256, + "minimum": 0 }, { "name": "skip", @@ -719,6 +731,8 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 256, + "minItems": 0, "x-nullable": true }, { @@ -798,12 +812,14 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0, "x-nullable": true }, { "name": "imageData", "in": "formData", - "description": "Binary image data.", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.", "required": true, "type": "file" }, @@ -860,6 +876,8 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 256, + "minItems": 0, "x-nullable": true }, { @@ -1166,6 +1184,8 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 64, + "minItems": 0, "x-nullable": true }, { @@ -1223,7 +1243,7 @@ { "name": "imageUrl", "in": "body", - "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", + "description": "An ImageUrl that contains the url of the image to be evaluated.", "required": true, "schema": { "$ref": "#/definitions/ImageUrl" @@ -1302,7 +1322,7 @@ { "name": "imageData", "in": "formData", - "description": "Binary image data.", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.", "required": true, "type": "file" }, @@ -1514,6 +1534,8 @@ "x-nullable": false }, "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0, "x-nullable": true }, { @@ -1535,7 +1557,9 @@ "required": false, "type": "integer", "format": "int32", - "default": 50 + "default": 50, + "maximum": 256, + "minimum": 0 }, { "name": "skip", @@ -1760,7 +1784,7 @@ ], "x-nullable": false }, - "collectionFormat": "multi", + "collectionFormat": "csv", "x-nullable": true }, { @@ -1938,6 +1962,94 @@ } } }, + "/projects/{projectId}/train": { + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Queues project for training.", + "operationId": "TrainProject", + "consumes": [ + + ], + "produces": [ + "application/json", + "text/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "trainingType", + "in": "query", + "description": "The type of training to use to train the project (default: Regular).", + "required": false, + "type": "string", + "enum": [ + "Regular", + "Advanced" + ], + "x-nullable": false + }, + { + "name": "reservedBudgetInHours", + "in": "query", + "description": "The number of hours reserved as budget for training (if applicable).", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "name": "forceTrain", + "in": "query", + "description": "Whether to force train even if dataset and configuration does not change (default: false).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "notificationEmailAddress", + "in": "query", + "description": "The email address to send notification to when training finishes (default: null).", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "$ref": "#/parameters/ApiKey" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful TrainProject request": { + "$ref": "./examples/TrainProject.json" + } + } + } + }, "/projects/{projectId}/iterations": { "get": { "tags": [ @@ -1945,7 +2057,9 @@ ], "summary": "Get iterations for the project.", "operationId": "GetIterations", - "consumes": [], + "consumes": [ + + ], "produces": [ "application/json", "text/json", @@ -2168,92 +2282,6 @@ } } }, - "/projects/{projectId}/train": { - "post": { - "tags": [ - "ProjectApi" - ], - "summary": "Queues project for training.", - "operationId": "TrainProject", - "consumes": [], - "produces": [ - "application/json", - "text/json", - "application/xml", - "text/xml" - ], - "parameters": [ - { - "name": "projectId", - "in": "path", - "description": "The project id.", - "required": true, - "type": "string", - "format": "uuid", - "x-nullable": false - }, - { - "name": "trainingType", - "in": "query", - "description": "The type of training to use to train the project (default: Regular).", - "required": false, - "type": "string", - "enum": [ - "Regular", - "Advanced" - ], - "x-nullable": false - }, - { - "name": "reservedBudgetInHours", - "in": "query", - "description": "The number of hours reserved as budget for training (if applicable).", - "required": false, - "type": "integer", - "format": "int32", - "default": 0 - }, - { - "name": "forceTrain", - "in": "query", - "description": "Whether to force train even if dataset and configuration does not change (default: false).", - "required": false, - "type": "boolean", - "default": false - }, - { - "name": "notificationEmailAddress", - "in": "query", - "description": "The email address to send notification to when training finishes (default: null).", - "required": false, - "type": "string", - "x-nullable": true - }, - { - "$ref": "#/parameters/ApiKey" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/Iteration" - } - }, - "default": { - "description": "Error response", - "schema": { - "$ref": "#/definitions/CustomVisionError" - } - } - }, - "x-ms-examples": { - "Successful TrainProject request": { - "$ref": "./examples/TrainProject.json" - } - } - } - }, "/projects/{projectId}/iterations/{iterationId}/publish": { "post": { "tags": [ @@ -2261,7 +2289,9 @@ ], "summary": "Publish a specific iteration.", "operationId": "PublishIteration", - "consumes": [], + "consumes": [ + + ], "produces": [ "application/json", "text/json", @@ -2288,9 +2318,9 @@ "x-nullable": false }, { - "name": "name", + "name": "publishName", "in": "query", - "description": "The updated iteration name.", + "description": "The name to give the published iteration.", "required": true, "type": "string", "x-nullable": true @@ -2489,7 +2519,8 @@ "CoreML", "TensorFlow", "DockerFile", - "ONNX" + "ONNX", + "VAIDK" ], "x-nullable": true }, @@ -4366,9 +4397,9 @@ "BadRequestNegativeAndRegularTagOnSameImage", "BadRequestIterationIsPublished", "BadRequestInvalidPublishName", - "BadRequestSubscriptionApi", - "BadRequestPublishFailed", + "BadRequestInvalidPublishTarget", "BadRequestUnpublishFailed", + "BadRequestSubscriptionApi", "BadRequestExceedProjectLimit", "BadRequestExceedIterationPerProjectLimit", "BadRequestExceedTagPerProjectLimit", From 1569f403797a5e34f098a04d0d69c5d4678bbbac Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Fri, 8 Mar 2019 12:33:39 -0800 Subject: [PATCH 09/18] Remove text/json --- .../Prediction/stable/v3.0/Prediction.json | 12 ----- .../Training/stable/v3.0/Training.json | 48 +------------------ 2 files changed, 1 insertion(+), 59 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json index 3134e4e7bc6c..ad55c62790de 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json @@ -19,14 +19,12 @@ "operationId": "ClassifyImageUrl", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -103,7 +101,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -174,14 +171,12 @@ "operationId": "ClassifyImageUrlWithNoStore", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -258,7 +253,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -329,14 +323,12 @@ "operationId": "DetectImageUrl", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -413,7 +405,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -484,14 +475,12 @@ "operationId": "DetectImageUrlWithNoStore", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -568,7 +557,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index 7f7fd87e5860..67c00644f77d 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -20,7 +20,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -64,7 +63,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -114,7 +112,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -188,7 +185,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -247,14 +243,12 @@ "operationId": "CreateImageTags", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -381,14 +375,12 @@ "operationId": "CreateImageRegions", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -501,7 +493,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -611,7 +602,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -706,7 +696,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -787,7 +776,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -912,14 +900,12 @@ "operationId": "CreateImagesFromFiles", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -977,14 +963,12 @@ "operationId": "CreateImagesFromUrls", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1042,14 +1026,12 @@ "operationId": "CreateImagesFromPredictions", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1107,8 +1089,7 @@ "operationId": "GetImageRegionProposals", "consumes": [], "produces": [ - "application/json", - "text/json" + "application/json" ], "parameters": [ { @@ -1219,14 +1200,12 @@ "operationId": "QuickTestImageUrl", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1296,7 +1275,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1360,14 +1338,12 @@ "operationId": "QueryPredictions", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1425,7 +1401,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1500,7 +1475,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1610,7 +1584,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1683,7 +1656,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1725,7 +1697,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1822,7 +1793,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1907,14 +1877,12 @@ "operationId": "UpdateProject", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -1974,7 +1942,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2062,7 +2029,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2115,7 +2081,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2218,14 +2183,12 @@ "operationId": "UpdateIteration", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2294,7 +2257,6 @@ ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2367,7 +2329,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2426,7 +2387,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2486,7 +2446,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2574,7 +2533,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2686,14 +2644,12 @@ "operationId": "UpdateTag", "consumes": [ "application/json", - "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded" ], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2760,7 +2716,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], @@ -2820,7 +2775,6 @@ "consumes": [], "produces": [ "application/json", - "text/json", "application/xml", "text/xml" ], From 5a874832754b7eb77befdb2e49d2123478896da5 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Mon, 11 Mar 2019 11:09:32 -0700 Subject: [PATCH 10/18] Update required / x-nullable usage Fix Prediction and examples Fix Training API and examples --- .../Prediction/stable/v3.0/Prediction.json | 84 +- .../stable/v3.0/examples/ClassifyImage.json | 2 +- .../v3.0/examples/ClassifyImageUrl.json | 2 +- .../examples/ClassifyImageUrlWithNoStore.json | 2 +- .../examples/ClassifyImageWithNoStore.json | 2 +- .../stable/v3.0/examples/DetectImage.json | 2 +- .../stable/v3.0/examples/DetectImageUrl.json | 2 +- .../examples/DetectImageUrlWithNoStore.json | 2 +- .../v3.0/examples/DetectImageWithNoStore.json | 2 +- .../Training/stable/v3.0/Training.json | 746 ++++++++++-------- .../v3.0/examples/CreateImagesFromData.json | 6 +- .../v3.0/examples/CreateImagesFromFiles.json | 3 +- .../examples/CreateImagesFromPredictions.json | 3 +- .../v3.0/examples/CreateImagesFromUrls.json | 3 +- .../stable/v3.0/examples/CreateProject.json | 2 +- .../stable/v3.0/examples/CreateTag.json | 1 + .../stable/v3.0/examples/ExportIteration.json | 3 +- .../stable/v3.0/examples/GetDomain.json | 4 +- .../stable/v3.0/examples/GetDomains.json | 32 +- .../stable/v3.0/examples/GetExports.json | 3 +- .../stable/v3.0/examples/GetIteration.json | 6 +- .../stable/v3.0/examples/GetIterations.json | 18 +- .../stable/v3.0/examples/GetProject.json | 2 +- .../stable/v3.0/examples/GetProjects.json | 2 +- .../Training/stable/v3.0/examples/GetTag.json | 1 + .../stable/v3.0/examples/GetTags.json | 1 + .../v3.0/examples/PublishIteration.json | 2 +- .../v3.0/examples/QueryPredictions.json | 4 +- .../stable/v3.0/examples/TrainProject.json | 6 +- .../stable/v3.0/examples/UpdateIteration.json | 20 +- .../stable/v3.0/examples/UpdateProject.json | 13 +- .../stable/v3.0/examples/UpdateTag.json | 6 +- 32 files changed, 572 insertions(+), 415 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json index ad55c62790de..5add47544e32 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json @@ -43,8 +43,7 @@ "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "imageUrl", @@ -119,8 +118,7 @@ "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "application", @@ -195,8 +193,7 @@ "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "imageUrl", @@ -271,8 +268,7 @@ "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "application", @@ -347,8 +343,7 @@ "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "imageUrl", @@ -423,8 +418,7 @@ "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "application", @@ -499,8 +493,7 @@ "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "imageUrl", @@ -575,8 +568,7 @@ "in": "path", "description": "Specifies the name of the model to evaluate against.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "application", @@ -622,18 +614,27 @@ "definitions": { "ImageUrl": { "description": "Image url.", + "required": [ + "url" + ], "type": "object", "properties": { "url": { "description": "Url of the image.", "type": "string", - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImagePrediction": { "description": "Result of an image prediction request.", + "required": [ + "id", + "project", + "iteration", + "created", + "predictions" + ], "type": "object", "properties": { "id": { @@ -661,8 +662,7 @@ "format": "date-time", "description": "Date this prediction was created.", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "predictions": { "description": "List of predictions.", @@ -670,22 +670,23 @@ "items": { "$ref": "#/definitions/Prediction" }, - "readOnly": true, - "x-nullable": true + "readOnly": true } - }, - "x-nullable": true + } }, "Prediction": { "description": "Prediction result.", + "required": [ + "probability", + "tagId" + ], "type": "object", "properties": { "probability": { "format": "float", "description": "Probability of the tag.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "tagId": { "format": "uuid", @@ -703,41 +704,46 @@ "boundingBox": { "$ref": "#/definitions/BoundingBox", "description": "Bounding box of the prediction.", - "readOnly": true + "readOnly": true, + "x-nullable": true } - }, - "x-nullable": true + } }, "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", - "x-nullable": false + "readOnly": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "x-nullable": false + "readOnly": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "x-nullable": false + "readOnly": false } - }, - "x-nullable": true + } }, "CustomVisionError": { "required": [ @@ -775,6 +781,7 @@ "BadRequestImageTags", "BadRequestImageRegions", "BadRequestNegativeAndRegularTagOnSameImage", + "BadRequestRequiredParamIsNull", "BadRequestIterationIsPublished", "BadRequestInvalidPublishName", "BadRequestInvalidPublishTarget", @@ -803,7 +810,9 @@ "BadRequestTrainingAlreadyInProgress", "BadRequestDetectionTrainingNotAllowNegativeTag", "BadRequestInvalidEmailAddress", - "BadRequestBakingAlreadyInProgress", + "BadRequestDomainNotSupportedForAdvancedTraining", + "BadRequestExportPlatformNotSupportedForAdvancedTraining", + "BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining", "BadRequestExportValidationFailed", "BadRequestExportAlreadyInProgress", "BadRequestPredictionIdsMissing", @@ -860,7 +869,6 @@ "ErrorInvalid" ], "type": "string", - "x-nullable": false, "x-ms-enum": { "name": "CustomVisionErrorCodes", "modelAsString": true diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json index 2e9642d710c1..9c326e0c6d42 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "publishedModelName": "MyModel1", + "publishedName": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json index 963700d22e5a..d879781f2fab 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "publishedModelName": "MyModel1", + "publishedName": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json index 963700d22e5a..d879781f2fab 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "publishedModelName": "MyModel1", + "publishedName": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json index 2e9642d710c1..9c326e0c6d42 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "publishedModelName": "MyModel1", + "publishedName": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json index 2e9642d710c1..9c326e0c6d42 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "publishedModelName": "MyModel1", + "publishedName": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json index 963700d22e5a..d879781f2fab 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "publishedModelName": "MyModel1", + "publishedName": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json index 963700d22e5a..d879781f2fab 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "publishedModelName": "MyModel1", + "publishedName": "MyModel1", "imageUrl": { "url": "{Image URL}" } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json index 2e9642d710c1..9c326e0c6d42 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json @@ -4,7 +4,7 @@ "Content-Type": "application/json", "Prediction-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", - "publishedModelName": "MyModel1", + "publishedName": "MyModel1", "imageData": "multipart-form-data" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index 67c00644f77d..5c71762019d5 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -35,8 +35,7 @@ "type": "array", "items": { "$ref": "#/definitions/Domain" - }, - "x-nullable": true + } } }, "default": { @@ -142,10 +141,10 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, - "collectionFormat": "csv", - "x-nullable": true + "collectionFormat": "csv" }, { "$ref": "#/parameters/ApiKey" @@ -156,8 +155,7 @@ "description": "OK", "schema": { "format": "int32", - "type": "integer", - "x-nullable": false + "type": "integer" } }, "default": { @@ -216,8 +214,7 @@ "description": "OK", "schema": { "format": "int32", - "type": "integer", - "x-nullable": false + "type": "integer" } }, "default": { @@ -321,12 +318,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 64, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "name": "tagIds", @@ -336,12 +333,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 20, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "$ref": "#/parameters/ApiKey" @@ -453,12 +450,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 64, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "$ref": "#/parameters/ApiKey" @@ -523,12 +520,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 20, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "name": "orderBy", @@ -540,7 +537,7 @@ "Newest", "Oldest" ], - "x-nullable": false + "x-nullable": true }, { "name": "take", @@ -573,8 +570,7 @@ "type": "array", "items": { "$ref": "#/definitions/Image" - }, - "x-nullable": true + } } }, "default": { @@ -634,7 +630,7 @@ "Newest", "Oldest" ], - "x-nullable": false + "x-nullable": true }, { "name": "take", @@ -667,8 +663,7 @@ "type": "array", "items": { "$ref": "#/definitions/Image" - }, - "x-nullable": true + } } }, "default": { @@ -717,12 +712,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 256, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "name": "iterationId", @@ -744,8 +739,7 @@ "type": "array", "items": { "$ref": "#/definitions/Image" - }, - "x-nullable": true + } } }, "default": { @@ -797,12 +791,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 20, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "name": "imageData", @@ -861,12 +855,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 256, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "$ref": "#/parameters/ApiKey" @@ -1162,12 +1156,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 64, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "$ref": "#/parameters/ApiKey" @@ -1505,12 +1499,12 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, "collectionFormat": "csv", "maxItems": 20, - "minItems": 0, - "x-nullable": true + "minItems": 0 }, { "name": "orderBy", @@ -1522,7 +1516,7 @@ "Newest", "Oldest" ], - "x-nullable": false + "x-nullable": true }, { "name": "take", @@ -1555,8 +1549,7 @@ "type": "array", "items": { "$ref": "#/definitions/ImagePerformance" - }, - "x-nullable": true + } } }, "default": { @@ -1614,10 +1607,10 @@ "type": "array", "items": { "type": "string", + "format": "uuid", "x-nullable": false }, - "collectionFormat": "csv", - "x-nullable": true + "collectionFormat": "csv" }, { "$ref": "#/parameters/ApiKey" @@ -1628,8 +1621,7 @@ "description": "OK", "schema": { "format": "int32", - "type": "integer", - "x-nullable": false + "type": "integer" } }, "default": { @@ -1671,8 +1663,7 @@ "type": "array", "items": { "$ref": "#/definitions/Project" - }, - "x-nullable": true + } } }, "default": { @@ -1706,16 +1697,14 @@ "in": "query", "description": "Name of the project.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "description", "in": "query", "description": "The description of the project.", "required": false, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "domainId", @@ -1735,8 +1724,7 @@ "enum": [ "Multiclass", "Multilabel" - ], - "x-nullable": false + ] }, { "name": "targetExportPlatforms", @@ -1752,11 +1740,9 @@ "DockerFile", "ONNX", "VAIDK" - ], - "x-nullable": false + ] }, - "collectionFormat": "csv", - "x-nullable": true + "collectionFormat": "csv" }, { "$ref": "#/parameters/ApiKey" @@ -1964,8 +1950,7 @@ "enum": [ "Regular", "Advanced" - ], - "x-nullable": false + ] }, { "name": "reservedBudgetInHours", @@ -2053,8 +2038,7 @@ "type": "array", "items": { "$ref": "#/definitions/Iteration" - }, - "x-nullable": true + } } }, "default": { @@ -2284,16 +2268,14 @@ "in": "query", "description": "The name to give the published iteration.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "predictionId", "in": "query", "description": "The id of the prediction resource to publish to.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "$ref": "#/parameters/ApiKey" @@ -2303,8 +2285,7 @@ "200": { "description": "OK", "schema": { - "type": "boolean", - "x-nullable": false + "type": "boolean" } }, "default": { @@ -2359,8 +2340,7 @@ "200": { "description": "OK", "schema": { - "type": "boolean", - "x-nullable": false + "type": "boolean" } }, "default": { @@ -2420,8 +2400,7 @@ "type": "array", "items": { "$ref": "#/definitions/Export" - }, - "x-nullable": true + } } }, "default": { @@ -2713,7 +2692,9 @@ ], "summary": "Get the tags for a given project and iteration.", "operationId": "GetTags", - "consumes": [], + "consumes": [ + + ], "produces": [ "application/json", "application/xml", @@ -2749,8 +2730,7 @@ "type": "array", "items": { "$ref": "#/definitions/Tag" - }, - "x-nullable": true + } } }, "default": { @@ -2793,16 +2773,14 @@ "in": "query", "description": "The tag name.", "required": true, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "description", "in": "query", "description": "Optional description for the tag.", "required": false, - "type": "string", - "x-nullable": true + "type": "string" }, { "name": "type", @@ -2813,8 +2791,7 @@ "enum": [ "Regular", "Negative" - ], - "x-nullable": false + ] }, { "$ref": "#/parameters/ApiKey" @@ -2844,6 +2821,13 @@ }, "definitions": { "Domain": { + "required": [ + "id", + "name", + "type", + "exportable", + "enabled" + ], "type": "object", "properties": { "id": { @@ -2854,8 +2838,7 @@ }, "name": { "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "type": { "enum": [ @@ -2864,7 +2847,6 @@ ], "type": "string", "readOnly": true, - "x-nullable": false, "x-ms-enum": { "name": "DomainType", "modelAsString": true @@ -2872,16 +2854,13 @@ }, "exportable": { "type": "boolean", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "enabled": { "type": "boolean", - "readOnly": true, - "x-nullable": false + "readOnly": true } - }, - "x-nullable": true + } }, "ImageTagCreateBatch": { "description": "Batch of image tags.", @@ -2893,10 +2872,9 @@ "items": { "$ref": "#/definitions/ImageTagCreateEntry" }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImageTagCreateEntry": { "description": "Entry associating a tag to an image.", @@ -2906,16 +2884,17 @@ "format": "uuid", "description": "Id of the image.", "type": "string", + "readOnly": false, "x-nullable": false }, "tagId": { "format": "uuid", "description": "Id of the tag.", "type": "string", + "readOnly": false, "x-nullable": false } - }, - "x-nullable": true + } }, "ImageTagCreateSummary": { "type": "object", @@ -2925,6 +2904,7 @@ "items": { "$ref": "#/definitions/ImageTagCreateEntry" }, + "readOnly": false, "x-nullable": true }, "duplicated": { @@ -2932,6 +2912,7 @@ "items": { "$ref": "#/definitions/ImageTagCreateEntry" }, + "readOnly": false, "x-nullable": true }, "exceeded": { @@ -2939,10 +2920,10 @@ "items": { "$ref": "#/definitions/ImageTagCreateEntry" }, + "readOnly": false, "x-nullable": true } - }, - "x-nullable": true + } }, "ImageRegionCreateBatch": { "description": "Batch of image region information to create.", @@ -2953,53 +2934,61 @@ "items": { "$ref": "#/definitions/ImageRegionCreateEntry" }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImageRegionCreateEntry": { "description": "Entry associating a region to an image.", + "required": [ + "imageId", + "tagId", + "left", + "top", + "width", + "height" + ], "type": "object", "properties": { "imageId": { "format": "uuid", "description": "Id of the image.", "type": "string", + "readOnly": false, "x-nullable": false }, "tagId": { "format": "uuid", "description": "Id of the tag associated with this region.", "type": "string", + "readOnly": false, "x-nullable": false }, "left": { "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "x-nullable": false + "readOnly": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "x-nullable": false + "readOnly": false } - }, - "x-nullable": true + } }, "ImageRegionCreateSummary": { "type": "object", @@ -3009,6 +2998,7 @@ "items": { "$ref": "#/definitions/ImageRegionCreateResult" }, + "readOnly": false, "x-nullable": true }, "duplicated": { @@ -3016,6 +3006,7 @@ "items": { "$ref": "#/definitions/ImageRegionCreateEntry" }, + "readOnly": false, "x-nullable": true }, "exceeded": { @@ -3023,12 +3014,23 @@ "items": { "$ref": "#/definitions/ImageRegionCreateEntry" }, + "readOnly": false, "x-nullable": true } - }, - "x-nullable": true + } }, "ImageRegionCreateResult": { + "required": [ + "imageId", + "regionId", + "tagName", + "created", + "tagId", + "left", + "top", + "width", + "height" + ], "type": "object", "properties": { "imageId": { @@ -3045,50 +3047,57 @@ }, "tagName": { "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "created": { "format": "date-time", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "tagId": { "format": "uuid", "description": "Id of the tag associated with this region.", "type": "string", + "readOnly": false, "x-nullable": false }, "left": { "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "x-nullable": false + "readOnly": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "x-nullable": false + "readOnly": false } - }, - "x-nullable": true + } }, "Image": { "description": "Image model to be sent as JSON.", + "required": [ + "id", + "created", + "width", + "height", + "resizedImageUri", + "thumbnailUri", + "originalImageUri" + ], "type": "object", "properties": { "id": { @@ -3102,40 +3111,34 @@ "format": "date-time", "description": "Date the image was created.", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "width": { "format": "int32", "description": "Width of the image.", "type": "integer", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "height": { "format": "int32", "description": "Height of the image.", "type": "integer", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "resizedImageUri": { "description": "The URI to the (resized) image used for training.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "thumbnailUri": { "description": "The URI to the thumbnail of the original image.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "originalImageUri": { "description": "The URI to the original uploaded image.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "tags": { "description": "Tags associated with this image.", @@ -3155,10 +3158,14 @@ "readOnly": true, "x-nullable": true } - }, - "x-nullable": true + } }, "ImageTag": { + "required": [ + "tagId", + "tagName", + "created" + ], "type": "object", "properties": { "tagId": { @@ -3169,19 +3176,26 @@ }, "tagName": { "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "created": { "format": "date-time", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true } - }, - "x-nullable": true + } }, "ImageRegion": { + "required": [ + "regionId", + "tagName", + "created", + "tagId", + "left", + "top", + "width", + "height" + ], "type": "object", "properties": { "regionId": { @@ -3192,56 +3206,57 @@ }, "tagName": { "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "created": { "format": "date-time", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "tagId": { "format": "uuid", "description": "Id of the tag associated with this region.", "type": "string", + "readOnly": false, "x-nullable": false }, "left": { "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "x-nullable": false + "readOnly": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "x-nullable": false + "readOnly": false } - }, - "x-nullable": true + } }, "ImageCreateSummary": { + "required": [ + "isBatchSuccessful", + "images" + ], "type": "object", "properties": { "isBatchSuccessful": { "description": "True if all of the images in the batch were created successfully, otherwise false.", "type": "boolean", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "images": { "description": "List of the image creation results.", @@ -3249,20 +3264,22 @@ "items": { "$ref": "#/definitions/ImageCreateResult" }, - "readOnly": true, - "x-nullable": true + "readOnly": true } - }, - "x-nullable": true + } }, "ImageCreateResult": { + "required": [ + "sourceUrl", + "status", + "image" + ], "type": "object", "properties": { "sourceUrl": { "description": "Source URL of the image.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "status": { "description": "Status of the image creation.", @@ -3281,7 +3298,6 @@ ], "type": "string", "readOnly": true, - "x-nullable": false, "x-ms-enum": { "name": "ImageCreateStatus", "modelAsString": true @@ -3292,8 +3308,7 @@ "description": "The image.", "readOnly": true } - }, - "x-nullable": true + } }, "ImageFileCreateBatch": { "type": "object", @@ -3303,7 +3318,7 @@ "items": { "$ref": "#/definitions/ImageFileCreateEntry" }, - "x-nullable": true + "readOnly": false }, "tagIds": { "type": "array", @@ -3312,22 +3327,21 @@ "type": "string", "x-nullable": false }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImageFileCreateEntry": { "type": "object", "properties": { "name": { "type": "string", - "x-nullable": true + "readOnly": false }, "contents": { "format": "byte", "type": "string", - "x-nullable": true + "readOnly": false }, "tagIds": { "type": "array", @@ -3336,53 +3350,59 @@ "type": "string", "x-nullable": false }, - "x-nullable": true + "readOnly": false }, "regions": { "type": "array", "items": { "$ref": "#/definitions/Region" }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "Region": { + "required": [ + "tagId", + "left", + "top", + "width", + "height" + ], "type": "object", "properties": { "tagId": { "format": "uuid", "description": "Id of the tag associated with this region.", "type": "string", + "readOnly": false, "x-nullable": false }, "left": { "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "x-nullable": false + "readOnly": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "x-nullable": false + "readOnly": false } - }, - "x-nullable": true + } }, "ImageUrlCreateBatch": { "type": "object", @@ -3392,7 +3412,7 @@ "items": { "$ref": "#/definitions/ImageUrlCreateEntry" }, - "x-nullable": true + "readOnly": false }, "tagIds": { "type": "array", @@ -3401,18 +3421,20 @@ "type": "string", "x-nullable": false }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImageUrlCreateEntry": { + "required": [ + "url" + ], "type": "object", "properties": { "url": { "description": "Url of the image.", "type": "string", - "x-nullable": true + "readOnly": false }, "tagIds": { "type": "array", @@ -3421,17 +3443,16 @@ "type": "string", "x-nullable": false }, - "x-nullable": true + "readOnly": false }, "regions": { "type": "array", "items": { "$ref": "#/definitions/Region" }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImageIdCreateBatch": { "type": "object", @@ -3441,7 +3462,7 @@ "items": { "$ref": "#/definitions/ImageIdCreateEntry" }, - "x-nullable": true + "readOnly": false }, "tagIds": { "type": "array", @@ -3450,10 +3471,9 @@ "type": "string", "x-nullable": false }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImageIdCreateEntry": { "type": "object", @@ -3462,6 +3482,7 @@ "format": "uuid", "description": "Id of the image.", "type": "string", + "readOnly": false, "x-nullable": false }, "tagIds": { @@ -3471,19 +3492,23 @@ "type": "string", "x-nullable": false }, - "x-nullable": true + "readOnly": false }, "regions": { "type": "array", "items": { "$ref": "#/definitions/Region" }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImageRegionProposal": { + "required": [ + "projectId", + "imageId", + "proposals" + ], "type": "object", "properties": { "projectId": { @@ -3503,73 +3528,87 @@ "items": { "$ref": "#/definitions/RegionProposal" }, - "readOnly": true, - "x-nullable": true + "readOnly": true } - }, - "x-nullable": true + } }, "RegionProposal": { + "required": [ + "confidence", + "boundingBox" + ], "type": "object", "properties": { "confidence": { "format": "float", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "boundingBox": { "$ref": "#/definitions/BoundingBox", "readOnly": true } - }, - "x-nullable": true + } }, "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", - "x-nullable": false + "readOnly": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "x-nullable": false + "readOnly": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "x-nullable": false + "readOnly": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "x-nullable": false + "readOnly": false } - }, - "x-nullable": true + } }, "ImageUrl": { "description": "Image url.", + "required": [ + "url" + ], "type": "object", "properties": { "url": { "description": "Url of the image.", "type": "string", - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "ImagePrediction": { "description": "Result of an image prediction request.", + "required": [ + "id", + "project", + "iteration", + "created", + "predictions" + ], "type": "object", "properties": { "id": { @@ -3597,8 +3636,7 @@ "format": "date-time", "description": "Date this prediction was created.", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "predictions": { "description": "List of predictions.", @@ -3606,22 +3644,23 @@ "items": { "$ref": "#/definitions/Prediction" }, - "readOnly": true, - "x-nullable": true + "readOnly": true } - }, - "x-nullable": true + } }, "Prediction": { "description": "Prediction result.", + "required": [ + "probability", + "tagId" + ], "type": "object", "properties": { "probability": { "format": "float", "description": "Probability of the tag.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "tagId": { "format": "uuid", @@ -3639,26 +3678,26 @@ "boundingBox": { "$ref": "#/definitions/BoundingBox", "description": "Bounding box of the prediction.", - "readOnly": true + "readOnly": true, + "x-nullable": true } - }, - "x-nullable": true + } }, "PredictionQueryToken": { "type": "object", "properties": { "session": { "type": "string", - "x-nullable": true + "readOnly": false }, "continuation": { "type": "string", - "x-nullable": true + "readOnly": false }, "maxCount": { "format": "int32", "type": "integer", - "x-nullable": false + "readOnly": false }, "orderBy": { "enum": [ @@ -3667,7 +3706,7 @@ "Suggested" ], "type": "string", - "x-nullable": false, + "readOnly": false, "x-ms-enum": { "name": "OrderBy", "modelAsString": true @@ -3678,31 +3717,38 @@ "items": { "$ref": "#/definitions/PredictionQueryTag" }, - "x-nullable": true + "readOnly": false }, "iterationId": { "format": "uuid", "type": "string", + "readOnly": false, "x-nullable": true }, "startTime": { "format": "date-time", "type": "string", + "readOnly": false, "x-nullable": true }, "endTime": { "format": "date-time", "type": "string", + "readOnly": false, "x-nullable": true }, "application": { "type": "string", - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "PredictionQueryTag": { + "required": [ + "id", + "minThreshold", + "maxThreshold" + ], "type": "object", "properties": { "id": { @@ -3714,19 +3760,20 @@ "minThreshold": { "format": "float", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "maxThreshold": { "format": "float", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true } - }, - "x-nullable": true + } }, "PredictionQueryResult": { + "required": [ + "token", + "results" + ], "type": "object", "properties": { "token": { @@ -3738,33 +3785,39 @@ "items": { "$ref": "#/definitions/StoredImagePrediction" }, - "readOnly": true, - "x-nullable": true + "readOnly": true } - }, - "x-nullable": true + } }, "StoredImagePrediction": { "description": "result of an image classification request.", + "required": [ + "resizedImageUri", + "thumbnailUri", + "originalImageUri", + "domain", + "id", + "project", + "iteration", + "created", + "predictions" + ], "type": "object", "properties": { "resizedImageUri": { "description": "The URI to the (resized) prediction image.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "thumbnailUri": { "description": "The URI to the thumbnail of the original prediction image.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "originalImageUri": { "description": "The URI to the original prediction image.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "domain": { "format": "uuid", @@ -3798,8 +3851,7 @@ "format": "date-time", "description": "Date this prediction was created.", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "predictions": { "description": "List of predictions.", @@ -3807,14 +3859,19 @@ "items": { "$ref": "#/definitions/Prediction" }, - "readOnly": true, - "x-nullable": true + "readOnly": true } - }, - "x-nullable": true + } }, "IterationPerformance": { "description": "Represents the detailed performance data for a trained iteration.", + "required": [ + "perTagPerformance", + "precision", + "precisionStdDeviation", + "recall", + "recallStdDeviation" + ], "type": "object", "properties": { "perTagPerformance": { @@ -3823,36 +3880,31 @@ "items": { "$ref": "#/definitions/TagPerformance" }, - "readOnly": true, - "x-nullable": true + "readOnly": true }, "precision": { "format": "float", "description": "Gets the precision.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "precisionStdDeviation": { "format": "float", "description": "Gets the standard deviation for the precision.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "recall": { "format": "float", "description": "Gets the recall.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "recallStdDeviation": { "format": "float", "description": "Gets the standard deviation for the recall.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "averagePrecision": { "format": "float", @@ -3861,11 +3913,18 @@ "readOnly": true, "x-nullable": true } - }, - "x-nullable": true + } }, "TagPerformance": { "description": "Represents performance data for a particular tag in a trained iteration.", + "required": [ + "id", + "name", + "precision", + "precisionStdDeviation", + "recall", + "recallStdDeviation" + ], "type": "object", "properties": { "id": { @@ -3876,36 +3935,31 @@ }, "name": { "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "precision": { "format": "float", "description": "Gets the precision.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "precisionStdDeviation": { "format": "float", "description": "Gets the standard deviation for the precision.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "recall": { "format": "float", "description": "Gets the recall.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "recallStdDeviation": { "format": "float", "description": "Gets the standard deviation for the recall.", "type": "number", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "averagePrecision": { "format": "float", @@ -3914,11 +3968,18 @@ "readOnly": true, "x-nullable": true } - }, - "x-nullable": true + } }, "ImagePerformance": { "description": "Image performance model.", + "required": [ + "id", + "created", + "width", + "height", + "imageUri", + "thumbnailUri" + ], "type": "object", "properties": { "predictions": { @@ -3938,30 +3999,25 @@ "created": { "format": "date-time", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "width": { "format": "int32", "type": "integer", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "height": { "format": "int32", "type": "integer", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "imageUri": { "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "thumbnailUri": { "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "tags": { "type": "array", @@ -3979,11 +4035,19 @@ "readOnly": true, "x-nullable": true } - }, - "x-nullable": true + } }, "Project": { "description": "Represents a project.", + "required": [ + "id", + "name", + "description", + "settings", + "created", + "lastModified", + "thumbnailUri" + ], "type": "object", "properties": { "id": { @@ -3996,45 +4060,42 @@ "name": { "description": "Gets or sets the name of the project.", "type": "string", - "x-nullable": true + "readOnly": false }, "description": { "description": "Gets or sets the description of the project.", "type": "string", - "x-nullable": true + "readOnly": false }, "settings": { "$ref": "#/definitions/ProjectSettings", - "description": "Gets or sets the project settings." + "description": "Gets or sets the project settings.", + "readOnly": false }, "created": { "format": "date-time", "description": "Gets the date this project was created.", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "lastModified": { "format": "date-time", "description": "Gets the date this project was last modified.", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "thumbnailUri": { "description": "Gets the thumbnail url representing the image.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "drModeEnabled": { "description": "Gets if the DR mode is on.", "type": "boolean", "readOnly": true, - "x-nullable": false + "x-nullable": true } - }, - "x-nullable": true + } }, "ProjectSettings": { "description": "Represents settings associated with a project.", @@ -4044,6 +4105,7 @@ "format": "uuid", "description": "Gets or sets the id of the Domain to use with this project.", "type": "string", + "readOnly": false, "x-nullable": false }, "classificationType": { @@ -4053,6 +4115,7 @@ "Multilabel" ], "type": "string", + "readOnly": false, "x-nullable": true, "x-ms-enum": { "name": "Classifier", @@ -4070,16 +4133,27 @@ "ONNX", "VAIDK" ], - "type": "string", - "x-nullable": false + "type": "string" }, - "x-nullable": true + "readOnly": false } - }, - "x-nullable": true + } }, "Iteration": { "description": "Iteration model to be sent over JSON.", + "required": [ + "id", + "name", + "status", + "created", + "lastModified", + "projectId", + "exportable", + "exportableTo", + "trainingType", + "reservedBudgetInHours", + "publishName" + ], "type": "object", "properties": { "id": { @@ -4092,27 +4166,24 @@ "name": { "description": "Gets or sets the name of the iteration.", "type": "string", - "x-nullable": true + "readOnly": false }, "status": { "description": "Gets the current iteration status.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "created": { "format": "date-time", "description": "Gets the time this iteration was completed.", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "lastModified": { "format": "date-time", "description": "Gets the time this iteration was last modified.", "type": "string", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "trainedAt": { "format": "date-time", @@ -4131,8 +4202,7 @@ "exportable": { "description": "Whether the iteration can be exported to another format for download.", "type": "boolean", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "exportableTo": { "description": "A set of platforms this iteration can export to.", @@ -4145,11 +4215,9 @@ "ONNX", "VAIDK" ], - "type": "string", - "x-nullable": false + "type": "string" }, - "readOnly": true, - "x-nullable": true + "readOnly": true }, "domainId": { "format": "uuid", @@ -4180,7 +4248,6 @@ ], "type": "string", "readOnly": true, - "x-nullable": false, "x-ms-enum": { "name": "TrainingType", "modelAsString": true @@ -4188,21 +4255,24 @@ }, "reservedBudgetInHours": { "format": "int32", - "description": "Gets the reserved baking budget for the iteration.", + "description": "Gets the reserved advanced training budget for the iteration.", "type": "integer", - "readOnly": true, - "x-nullable": false + "readOnly": true }, "publishName": { "description": "Name of the published model.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true } - }, - "x-nullable": true + } }, "Export": { + "required": [ + "platform", + "status", + "downloadUri", + "newerVersionAvailable" + ], "type": "object", "properties": { "platform": { @@ -4216,7 +4286,6 @@ ], "type": "string", "readOnly": true, - "x-nullable": false, "x-ms-enum": { "name": "ExportPlatform", "modelAsString": true @@ -4231,7 +4300,6 @@ ], "type": "string", "readOnly": true, - "x-nullable": false, "x-ms-enum": { "name": "ExportStatus", "modelAsString": true @@ -4240,8 +4308,7 @@ "downloadUri": { "description": "URI used to download the model.", "type": "string", - "readOnly": true, - "x-nullable": true + "readOnly": true }, "flavor": { "description": "Flavor of the export.", @@ -4263,14 +4330,19 @@ "newerVersionAvailable": { "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.", "type": "boolean", - "readOnly": true, - "x-nullable": false + "readOnly": true } - }, - "x-nullable": true + } }, "Tag": { "description": "Represents a Tag.", + "required": [ + "id", + "name", + "description", + "type", + "imageCount" + ], "type": "object", "properties": { "id": { @@ -4283,12 +4355,12 @@ "name": { "description": "Gets or sets the name of the tag.", "type": "string", - "x-nullable": true + "readOnly": false }, "description": { "description": "Gets or sets the description of the tag.", "type": "string", - "x-nullable": true + "readOnly": false }, "type": { "description": "Gets or sets the type of the tag.", @@ -4297,7 +4369,7 @@ "Negative" ], "type": "string", - "x-nullable": false, + "readOnly": false, "x-ms-enum": { "name": "TagType", "modelAsString": true @@ -4307,11 +4379,9 @@ "format": "int32", "description": "Gets the number of images with this tag.", "type": "integer", - "readOnly": true, - "x-nullable": false + "readOnly": true } - }, - "x-nullable": true + } }, "CustomVisionError": { "required": [ @@ -4349,6 +4419,7 @@ "BadRequestImageTags", "BadRequestImageRegions", "BadRequestNegativeAndRegularTagOnSameImage", + "BadRequestRequiredParamIsNull", "BadRequestIterationIsPublished", "BadRequestInvalidPublishName", "BadRequestInvalidPublishTarget", @@ -4377,7 +4448,9 @@ "BadRequestTrainingAlreadyInProgress", "BadRequestDetectionTrainingNotAllowNegativeTag", "BadRequestInvalidEmailAddress", - "BadRequestBakingAlreadyInProgress", + "BadRequestDomainNotSupportedForAdvancedTraining", + "BadRequestExportPlatformNotSupportedForAdvancedTraining", + "BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining", "BadRequestExportValidationFailed", "BadRequestExportAlreadyInProgress", "BadRequestPredictionIdsMissing", @@ -4434,7 +4507,6 @@ "ErrorInvalid" ], "type": "string", - "x-nullable": false, "x-ms-enum": { "name": "CustomVisionErrorCodes", "modelAsString": true @@ -4476,4 +4548,4 @@ } ] } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json index 6cd0d804d59e..ab1f62de78fc 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json @@ -29,7 +29,8 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.6105895Z" + "created": "2017-12-19T15:56:09.6105895Z", + "tagName": "tag 1" } ] } @@ -48,7 +49,8 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.5168568Z" + "created": "2017-12-19T15:56:09.5168568Z", + "tagName": "tag 1" } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json index 8313ef6d88e0..851f3e53ea00 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json @@ -37,7 +37,8 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.6105895Z" + "created": "2017-12-19T15:56:09.6105895Z", + "tagName": "tag 1" } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json index 6fd3babcc699..612157ef3cf4 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json @@ -36,7 +36,8 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.6105895Z" + "created": "2017-12-19T15:56:09.6105895Z", + "tagName": "tag 1" } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json index 9a183f787e8f..d4e007860e79 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json @@ -36,7 +36,8 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.6105895Z" + "created": "2017-12-19T15:56:09.6105895Z", + "tagName": "tag name" } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json index 4bd5651525ad..ada2b58c5738 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json @@ -19,7 +19,7 @@ }, "created": "2017-12-18T05:43:18.08Z", "lastModified": "2017-12-18T05:43:18.0962423Z", - "thumbnailUri": null + "thumbnailUri": "" } } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateTag.json index 89f51202952f..aef1e14152d4 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateTag.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateTag.json @@ -15,6 +15,7 @@ "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", "name": "Tag1", "description": "Description of Tag1", + "type": "Regular", "imageCount": 0 } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/ExportIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/ExportIteration.json index 725769469fb9..6e9c04481fdf 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/ExportIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/ExportIteration.json @@ -13,7 +13,8 @@ "body": { "platform": "TensorFlow", "status": "Exporting", - "downloadUri": null + "downloadUri": "", + "newerVersionAvailable": false } } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomain.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomain.json index 55430c0b7feb..2c485a31b63f 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomain.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomain.json @@ -11,7 +11,9 @@ "body": { "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39", "name": "Retail", - "exportable": false + "type": "Classification", + "exportable": false, + "enabled": true } } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomains.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomains.json index 03f339caa2b9..72f0524a3960 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomains.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetDomains.json @@ -11,42 +11,58 @@ { "id": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", "name": "General", - "exportable": false + "type": "Classification", + "exportable": false, + "enabled": true }, { "id": "c151d5b5-dd07-472a-acc8-15d29dea8518", "name": "Food", - "exportable": false + "type": "Classification", + "exportable": false, + "enabled": true }, { "id": "ca455789-012d-4b50-9fec-5bb63841c793", "name": "Landmarks", - "exportable": false + "type": "Classification", + "exportable": false, + "enabled": true }, { "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39", "name": "Retail", - "exportable": false + "type": "Classification", + "exportable": false, + "enabled": true }, { "id": "45badf75-3591-4f26-a705-45678d3e9f5f", "name": "Adult", - "exportable": false + "type": "Classification", + "exportable": false, + "enabled": true }, { "id": "0732100f-1a38-4e49-a514-c9b44c697ab5", "name": "General (compact)", - "exportable": true + "type": "Classification", + "exportable": false, + "enabled": true }, { "id": "b5cfd229-2ac7-4b2b-8d0a-2b0661344894", "name": "Landmarks (compact)", - "exportable": true + "type": "Classification", + "exportable": false, + "enabled": true }, { "id": "6b4faeda-8396-481b-9f8b-177b9fa3097f", "name": "Retail (compact)", - "exportable": true + "type": "Classification", + "exportable": false, + "enabled": true } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetExports.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetExports.json index abd24cbc0c5d..3e6379ee2e7f 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetExports.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetExports.json @@ -13,7 +13,8 @@ { "platform": "TensorFlow", "status": "Done", - "downloadUri": "{Download URI" + "newerVersionAvailable": false, + "downloadUri": "{Download URI}" } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json index 8e51d58da52b..afb0aa3b2988 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json @@ -18,7 +18,11 @@ "trainedAt": "2017-12-19T15:47:02.9511889Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, - "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" } } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json index 70143e1b2b7d..0e3d883481a8 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json @@ -18,7 +18,11 @@ "trainedAt": "2017-12-18T22:40:41.0058589Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, - "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" }, { "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", @@ -29,7 +33,11 @@ "trainedAt": "2017-12-19T15:47:02.9511889Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, - "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], + "trainingType": "Regular", + "reservedBudgetInHours": 5, + "publishName": "model1" }, { "id": "3adaf7b2-18fc-4376-9da4-b5ea160a7cf5", @@ -39,7 +47,11 @@ "lastModified": "2017-12-19T15:46:59.2699369Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, - "domainId": null + "domainId": null, + "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json index 7335be561999..cb1e69ba8ca8 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json @@ -17,7 +17,7 @@ }, "created": "2017-12-18T05:43:18.08Z", "lastModified": "2017-12-18T05:43:18.0962423Z", - "thumbnailUri": null + "thumbnailUri": "" } } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json index 4cff8a634be3..b5cbbd335095 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json @@ -17,7 +17,7 @@ }, "created": "2017-12-18T05:43:18.08Z", "lastModified": "2017-12-18T05:43:18.0962423Z", - "thumbnailUri": null + "thumbnailUri": "" } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTag.json index ccd76c898899..7f3ec8654a99 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTag.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTag.json @@ -13,6 +13,7 @@ "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", "name": "Tag1", "description": "Description of Tag1", + "type": "Regular", "imageCount": 0 } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTags.json index 8ba964999aea..5d58993f24c8 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTags.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetTags.json @@ -13,6 +13,7 @@ "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", "name": "Tag1", "description": "Description of Tag1", + "type": "Regular", "imageCount": 0 } ] diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json index 73f8d548074b..7026e24e897c 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/PublishIteration.json @@ -5,7 +5,7 @@ "Training-Key": "{API Key}", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", - "name": "Model1", + "publishName": "Model1", "predictionId": "/subscriptions/{subscription}/resourceGroups/{resource group name}/providers/Microsoft.CognitiveServices/accounts/{resource name}" }, "responses": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json index 8a40a06e9408..c9091e74e0a1 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json @@ -9,6 +9,7 @@ "tags": [ { "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "maxThreshold": 1, "minThreshold": 0.9 } ] @@ -38,7 +39,8 @@ ], "originalImageUri": "", "thumbnailUri": "", - "resizedImageUri": "" + "resizedImageUri": "", + "domain": "b30a91ae-e3c1-4f73-a81e-c270bff27c39" } ], "token": { diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json index c3ec2c3eb8ef..fe1b7e9cd64f 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json @@ -16,7 +16,11 @@ "lastModified": "2017-12-19T15:46:58.197323Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, - "domainId": null + "domainId": null, + "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" } } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json index 967eba1fe21c..703b246005d7 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json @@ -6,7 +6,19 @@ "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "updatedIteration": { - "name": "Best Iteration" + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Best Iteration", + "status": "Completed", + "created": "2017-12-18T22:40:36.9066667Z", + "lastModified": "2017-12-19T15:53:07.8782881Z", + "trainedAt": "2017-12-19T15:47:02.9511889Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" } }, "responses": { @@ -21,7 +33,11 @@ "trainedAt": "2017-12-19T15:47:02.9511889Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, - "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" } } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json index 59d801c0ed4b..4917b8079bc0 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json @@ -5,8 +5,15 @@ "Training-Key": "{API Key}", "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", "updatedProject": { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", "name": "New Project Name", - "description": "A new Description" + "description": "A new Description", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18.08Z", + "lastModified": "2017-12-18T05:43:18.0962423Z", + "thumbnailUri": "" } }, "responses": { @@ -20,8 +27,8 @@ "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" }, "created": "2017-12-18T05:43:18.08Z", - "lastModified": "2017-12-18T05:43:18.0962423Z", - "thumbnailUri": null + "lastModified": "2017-12-18T05:43:19.0962423Z", + "thumbnailUri": "" } } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateTag.json index 94cdd86f22a1..c5e52e1ea3dd 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateTag.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateTag.json @@ -6,8 +6,11 @@ "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", "updatedTag": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", "name": "Better Tag Name", - "description": "Better description" + "type": "Regular", + "description": "Better description", + "imageCount": 0 } }, "responses": { @@ -17,6 +20,7 @@ "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", "name": "Better Tag Name", "description": "Better description", + "type": "Regular", "imageCount": 0 } } From 47d990ef0e304c8b3d7dd30987d1d7ef9e6e55c6 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Tue, 12 Mar 2019 11:28:53 -0700 Subject: [PATCH 11/18] Fix required/readonly --- .../Prediction/stable/v3.0/Prediction.json | 35 +- .../Training/stable/v3.0/Training.json | 453 +++++++++--------- .../v3.0/examples/QueryPredictions.json | 4 +- 3 files changed, 240 insertions(+), 252 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json index 5add47544e32..9de70630e269 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/Prediction.json @@ -622,19 +622,13 @@ "url": { "description": "Url of the image.", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, "ImagePrediction": { "description": "Result of an image prediction request.", - "required": [ - "id", - "project", - "iteration", - "created", - "predictions" - ], "type": "object", "properties": { "id": { @@ -662,13 +656,15 @@ "format": "date-time", "description": "Date this prediction was created.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "predictions": { "description": "List of predictions.", "type": "array", "items": { - "$ref": "#/definitions/Prediction" + "$ref": "#/definitions/Prediction", + "x-nullable": false }, "readOnly": true } @@ -676,17 +672,14 @@ }, "Prediction": { "description": "Prediction result.", - "required": [ - "probability", - "tagId" - ], "type": "object", "properties": { "probability": { "format": "float", "description": "Probability of the tag.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "tagId": { "format": "uuid", @@ -723,25 +716,29 @@ "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index 5c71762019d5..71897ca5df86 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -2821,13 +2821,6 @@ }, "definitions": { "Domain": { - "required": [ - "id", - "name", - "type", - "exportable", - "enabled" - ], "type": "object", "properties": { "id": { @@ -2838,7 +2831,8 @@ }, "name": { "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "type": { "enum": [ @@ -2847,6 +2841,7 @@ ], "type": "string", "readOnly": true, + "x-nullable": false, "x-ms-enum": { "name": "DomainType", "modelAsString": true @@ -2854,11 +2849,13 @@ }, "exportable": { "type": "boolean", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "enabled": { "type": "boolean", - "readOnly": true + "readOnly": true, + "x-nullable": false } } }, @@ -2870,7 +2867,8 @@ "description": "Image Tag entries to include in this batch.", "type": "array", "items": { - "$ref": "#/definitions/ImageTagCreateEntry" + "$ref": "#/definitions/ImageTagCreateEntry", + "x-nullable": false }, "readOnly": false } @@ -2932,7 +2930,8 @@ "regions": { "type": "array", "items": { - "$ref": "#/definitions/ImageRegionCreateEntry" + "$ref": "#/definitions/ImageRegionCreateEntry", + "x-nullable": false }, "readOnly": false } @@ -2968,25 +2967,29 @@ "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, @@ -3021,10 +3024,6 @@ }, "ImageRegionCreateResult": { "required": [ - "imageId", - "regionId", - "tagName", - "created", "tagId", "left", "top", @@ -3047,12 +3046,14 @@ }, "tagName": { "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "created": { "format": "date-time", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "tagId": { "format": "uuid", @@ -3065,39 +3066,34 @@ "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, "Image": { "description": "Image model to be sent as JSON.", - "required": [ - "id", - "created", - "width", - "height", - "resizedImageUri", - "thumbnailUri", - "originalImageUri" - ], "type": "object", "properties": { "id": { @@ -3111,34 +3107,40 @@ "format": "date-time", "description": "Date the image was created.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "width": { "format": "int32", "description": "Width of the image.", "type": "integer", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "height": { "format": "int32", "description": "Height of the image.", "type": "integer", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "resizedImageUri": { "description": "The URI to the (resized) image used for training.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "thumbnailUri": { "description": "The URI to the thumbnail of the original image.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "originalImageUri": { "description": "The URI to the original uploaded image.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "tags": { "description": "Tags associated with this image.", @@ -3161,11 +3163,6 @@ } }, "ImageTag": { - "required": [ - "tagId", - "tagName", - "created" - ], "type": "object", "properties": { "tagId": { @@ -3176,20 +3173,19 @@ }, "tagName": { "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "created": { "format": "date-time", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false } } }, "ImageRegion": { "required": [ - "regionId", - "tagName", - "created", "tagId", "left", "top", @@ -3206,12 +3202,14 @@ }, "tagName": { "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "created": { "format": "date-time", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "tagId": { "format": "uuid", @@ -3224,62 +3222,60 @@ "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, "ImageCreateSummary": { - "required": [ - "isBatchSuccessful", - "images" - ], "type": "object", "properties": { "isBatchSuccessful": { "description": "True if all of the images in the batch were created successfully, otherwise false.", "type": "boolean", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "images": { "description": "List of the image creation results.", "type": "array", "items": { - "$ref": "#/definitions/ImageCreateResult" + "$ref": "#/definitions/ImageCreateResult", + "x-nullable": false }, "readOnly": true } } }, "ImageCreateResult": { - "required": [ - "sourceUrl", - "status", - "image" - ], "type": "object", "properties": { "sourceUrl": { "description": "Source URL of the image.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "status": { "description": "Status of the image creation.", @@ -3298,6 +3294,7 @@ ], "type": "string", "readOnly": true, + "x-nullable": false, "x-ms-enum": { "name": "ImageCreateStatus", "modelAsString": true @@ -3306,7 +3303,8 @@ "image": { "$ref": "#/definitions/Image", "description": "The image.", - "readOnly": true + "readOnly": true, + "x-nullable": false } } }, @@ -3316,7 +3314,8 @@ "images": { "type": "array", "items": { - "$ref": "#/definitions/ImageFileCreateEntry" + "$ref": "#/definitions/ImageFileCreateEntry", + "x-nullable": false }, "readOnly": false }, @@ -3336,12 +3335,14 @@ "properties": { "name": { "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "contents": { "format": "byte", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "tagIds": { "type": "array", @@ -3355,7 +3356,8 @@ "regions": { "type": "array", "items": { - "$ref": "#/definitions/Region" + "$ref": "#/definitions/Region", + "x-nullable": false }, "readOnly": false } @@ -3382,25 +3384,29 @@ "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, @@ -3410,7 +3416,8 @@ "images": { "type": "array", "items": { - "$ref": "#/definitions/ImageUrlCreateEntry" + "$ref": "#/definitions/ImageUrlCreateEntry", + "x-nullable": false }, "readOnly": false }, @@ -3434,7 +3441,8 @@ "url": { "description": "Url of the image.", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "tagIds": { "type": "array", @@ -3448,7 +3456,8 @@ "regions": { "type": "array", "items": { - "$ref": "#/definitions/Region" + "$ref": "#/definitions/Region", + "x-nullable": false }, "readOnly": false } @@ -3460,7 +3469,8 @@ "images": { "type": "array", "items": { - "$ref": "#/definitions/ImageIdCreateEntry" + "$ref": "#/definitions/ImageIdCreateEntry", + "x-nullable": false }, "readOnly": false }, @@ -3497,18 +3507,14 @@ "regions": { "type": "array", "items": { - "$ref": "#/definitions/Region" + "$ref": "#/definitions/Region", + "x-nullable": false }, "readOnly": false } } }, "ImageRegionProposal": { - "required": [ - "projectId", - "imageId", - "proposals" - ], "type": "object", "properties": { "projectId": { @@ -3526,27 +3532,26 @@ "proposals": { "type": "array", "items": { - "$ref": "#/definitions/RegionProposal" + "$ref": "#/definitions/RegionProposal", + "x-nullable": false }, "readOnly": true } } }, "RegionProposal": { - "required": [ - "confidence", - "boundingBox" - ], "type": "object", "properties": { "confidence": { "format": "float", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "boundingBox": { "$ref": "#/definitions/BoundingBox", - "readOnly": true + "readOnly": true, + "x-nullable": false } } }, @@ -3564,25 +3569,29 @@ "format": "float", "description": "Coordinate of the left boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "top": { "format": "float", "description": "Coordinate of the top boundary.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "width": { "format": "float", "description": "Width.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "height": { "format": "float", "description": "Height.", "type": "number", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, @@ -3596,19 +3605,13 @@ "url": { "description": "Url of the image.", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, "ImagePrediction": { "description": "Result of an image prediction request.", - "required": [ - "id", - "project", - "iteration", - "created", - "predictions" - ], "type": "object", "properties": { "id": { @@ -3636,13 +3639,15 @@ "format": "date-time", "description": "Date this prediction was created.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "predictions": { "description": "List of predictions.", "type": "array", "items": { - "$ref": "#/definitions/Prediction" + "$ref": "#/definitions/Prediction", + "x-nullable": false }, "readOnly": true } @@ -3650,17 +3655,14 @@ }, "Prediction": { "description": "Prediction result.", - "required": [ - "probability", - "tagId" - ], "type": "object", "properties": { "probability": { "format": "float", "description": "Probability of the tag.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "tagId": { "format": "uuid", @@ -3688,16 +3690,19 @@ "properties": { "session": { "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "continuation": { "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "maxCount": { "format": "int32", "type": "integer", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "orderBy": { "enum": [ @@ -3707,6 +3712,7 @@ ], "type": "string", "readOnly": false, + "x-nullable": false, "x-ms-enum": { "name": "OrderBy", "modelAsString": true @@ -3715,7 +3721,8 @@ "tags": { "type": "array", "items": { - "$ref": "#/definitions/PredictionQueryTag" + "$ref": "#/definitions/PredictionQueryTag", + "x-nullable": false }, "readOnly": false }, @@ -3739,16 +3746,12 @@ }, "application": { "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false } } }, "PredictionQueryTag": { - "required": [ - "id", - "minThreshold", - "maxThreshold" - ], "type": "object", "properties": { "id": { @@ -3760,30 +3763,30 @@ "minThreshold": { "format": "float", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "maxThreshold": { "format": "float", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false } } }, "PredictionQueryResult": { - "required": [ - "token", - "results" - ], "type": "object", "properties": { "token": { "$ref": "#/definitions/PredictionQueryToken", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "results": { "type": "array", "items": { - "$ref": "#/definitions/StoredImagePrediction" + "$ref": "#/definitions/StoredImagePrediction", + "x-nullable": false }, "readOnly": true } @@ -3791,33 +3794,25 @@ }, "StoredImagePrediction": { "description": "result of an image classification request.", - "required": [ - "resizedImageUri", - "thumbnailUri", - "originalImageUri", - "domain", - "id", - "project", - "iteration", - "created", - "predictions" - ], "type": "object", "properties": { "resizedImageUri": { "description": "The URI to the (resized) prediction image.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "thumbnailUri": { "description": "The URI to the thumbnail of the original prediction image.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "originalImageUri": { "description": "The URI to the original prediction image.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "domain": { "format": "uuid", @@ -3851,13 +3846,15 @@ "format": "date-time", "description": "Date this prediction was created.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "predictions": { "description": "List of predictions.", "type": "array", "items": { - "$ref": "#/definitions/Prediction" + "$ref": "#/definitions/Prediction", + "x-nullable": false }, "readOnly": true } @@ -3865,20 +3862,14 @@ }, "IterationPerformance": { "description": "Represents the detailed performance data for a trained iteration.", - "required": [ - "perTagPerformance", - "precision", - "precisionStdDeviation", - "recall", - "recallStdDeviation" - ], "type": "object", "properties": { "perTagPerformance": { "description": "Gets the per-tag performance details for this iteration.", "type": "array", "items": { - "$ref": "#/definitions/TagPerformance" + "$ref": "#/definitions/TagPerformance", + "x-nullable": false }, "readOnly": true }, @@ -3886,25 +3877,29 @@ "format": "float", "description": "Gets the precision.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "precisionStdDeviation": { "format": "float", "description": "Gets the standard deviation for the precision.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "recall": { "format": "float", "description": "Gets the recall.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "recallStdDeviation": { "format": "float", "description": "Gets the standard deviation for the recall.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "averagePrecision": { "format": "float", @@ -3917,14 +3912,6 @@ }, "TagPerformance": { "description": "Represents performance data for a particular tag in a trained iteration.", - "required": [ - "id", - "name", - "precision", - "precisionStdDeviation", - "recall", - "recallStdDeviation" - ], "type": "object", "properties": { "id": { @@ -3935,31 +3922,36 @@ }, "name": { "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "precision": { "format": "float", "description": "Gets the precision.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "precisionStdDeviation": { "format": "float", "description": "Gets the standard deviation for the precision.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "recall": { "format": "float", "description": "Gets the recall.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "recallStdDeviation": { "format": "float", "description": "Gets the standard deviation for the recall.", "type": "number", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "averagePrecision": { "format": "float", @@ -3972,14 +3964,6 @@ }, "ImagePerformance": { "description": "Image performance model.", - "required": [ - "id", - "created", - "width", - "height", - "imageUri", - "thumbnailUri" - ], "type": "object", "properties": { "predictions": { @@ -3999,25 +3983,30 @@ "created": { "format": "date-time", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "width": { "format": "int32", "type": "integer", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "height": { "format": "int32", "type": "integer", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "imageUri": { "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "thumbnailUri": { "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "tags": { "type": "array", @@ -4040,13 +4029,9 @@ "Project": { "description": "Represents a project.", "required": [ - "id", "name", "description", - "settings", - "created", - "lastModified", - "thumbnailUri" + "settings" ], "type": "object", "properties": { @@ -4060,34 +4045,40 @@ "name": { "description": "Gets or sets the name of the project.", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "description": { "description": "Gets or sets the description of the project.", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "settings": { "$ref": "#/definitions/ProjectSettings", "description": "Gets or sets the project settings.", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "created": { "format": "date-time", "description": "Gets the date this project was created.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "lastModified": { "format": "date-time", "description": "Gets the date this project was last modified.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "thumbnailUri": { "description": "Gets the thumbnail url representing the image.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "drModeEnabled": { "description": "Gets if the DR mode is on.", @@ -4133,7 +4124,8 @@ "ONNX", "VAIDK" ], - "type": "string" + "type": "string", + "x-nullable": false }, "readOnly": false } @@ -4142,17 +4134,7 @@ "Iteration": { "description": "Iteration model to be sent over JSON.", "required": [ - "id", - "name", - "status", - "created", - "lastModified", - "projectId", - "exportable", - "exportableTo", - "trainingType", - "reservedBudgetInHours", - "publishName" + "name" ], "type": "object", "properties": { @@ -4166,24 +4148,28 @@ "name": { "description": "Gets or sets the name of the iteration.", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "status": { "description": "Gets the current iteration status.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "created": { "format": "date-time", "description": "Gets the time this iteration was completed.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "lastModified": { "format": "date-time", "description": "Gets the time this iteration was last modified.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "trainedAt": { "format": "date-time", @@ -4202,7 +4188,8 @@ "exportable": { "description": "Whether the iteration can be exported to another format for download.", "type": "boolean", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "exportableTo": { "description": "A set of platforms this iteration can export to.", @@ -4215,7 +4202,8 @@ "ONNX", "VAIDK" ], - "type": "string" + "type": "string", + "x-nullable": false }, "readOnly": true }, @@ -4248,6 +4236,7 @@ ], "type": "string", "readOnly": true, + "x-nullable": false, "x-ms-enum": { "name": "TrainingType", "modelAsString": true @@ -4257,22 +4246,18 @@ "format": "int32", "description": "Gets the reserved advanced training budget for the iteration.", "type": "integer", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "publishName": { "description": "Name of the published model.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false } } }, "Export": { - "required": [ - "platform", - "status", - "downloadUri", - "newerVersionAvailable" - ], "type": "object", "properties": { "platform": { @@ -4286,6 +4271,7 @@ ], "type": "string", "readOnly": true, + "x-nullable": false, "x-ms-enum": { "name": "ExportPlatform", "modelAsString": true @@ -4300,6 +4286,7 @@ ], "type": "string", "readOnly": true, + "x-nullable": false, "x-ms-enum": { "name": "ExportStatus", "modelAsString": true @@ -4308,7 +4295,8 @@ "downloadUri": { "description": "URI used to download the model.", "type": "string", - "readOnly": true + "readOnly": true, + "x-nullable": false }, "flavor": { "description": "Flavor of the export.", @@ -4330,18 +4318,17 @@ "newerVersionAvailable": { "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.", "type": "boolean", - "readOnly": true + "readOnly": true, + "x-nullable": false } } }, "Tag": { "description": "Represents a Tag.", "required": [ - "id", "name", "description", - "type", - "imageCount" + "type" ], "type": "object", "properties": { @@ -4355,12 +4342,14 @@ "name": { "description": "Gets or sets the name of the tag.", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "description": { "description": "Gets or sets the description of the tag.", "type": "string", - "readOnly": false + "readOnly": false, + "x-nullable": false }, "type": { "description": "Gets or sets the type of the tag.", @@ -4370,6 +4359,7 @@ ], "type": "string", "readOnly": false, + "x-nullable": false, "x-ms-enum": { "name": "TagType", "modelAsString": true @@ -4379,7 +4369,8 @@ "format": "int32", "description": "Gets the number of images with this tag.", "type": "integer", - "readOnly": true + "readOnly": true, + "x-nullable": false } } }, diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json index c9091e74e0a1..bfae1170adbf 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json @@ -45,7 +45,7 @@ ], "token": { "session": "1:286613", - "continuation": null, + "continuation": "", "maxCount": 0, "orderBy": "Newest", "tags": [ @@ -58,7 +58,7 @@ "iterationId": null, "startTime": null, "endTime": null, - "application": null + "application": "" } } } From 36a22093d4037ff1f8aa4325da8146be1d45d6ee Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Thu, 14 Mar 2019 09:03:42 -0700 Subject: [PATCH 12/18] Update examples --- .../stable/v3.0/examples/ClassifyImage.json | 2 +- .../v3.0/examples/ClassifyImageUrl.json | 2 +- .../examples/ClassifyImageUrlWithNoStore.json | 2 +- .../examples/ClassifyImageWithNoStore.json | 2 +- .../stable/v3.0/examples/DetectImage.json | 32 +++++++++++++------ .../stable/v3.0/examples/DetectImageUrl.json | 32 +++++++++++++------ .../examples/DetectImageUrlWithNoStore.json | 32 +++++++++++++------ .../v3.0/examples/DetectImageWithNoStore.json | 32 +++++++++++++------ .../v3.0/examples/CreateImagesFromData.json | 8 ++--- .../v3.0/examples/CreateImagesFromFiles.json | 4 +-- .../examples/CreateImagesFromPredictions.json | 4 +-- .../v3.0/examples/CreateImagesFromUrls.json | 4 +-- .../stable/v3.0/examples/CreateProject.json | 4 +-- .../v3.0/examples/GetImagePerformances.json | 2 +- .../stable/v3.0/examples/GetIteration.json | 6 ++-- .../stable/v3.0/examples/GetIterations.json | 16 +++++----- .../stable/v3.0/examples/GetProject.json | 4 +-- .../stable/v3.0/examples/GetProjects.json | 4 +-- .../v3.0/examples/QueryPredictions.json | 2 +- .../stable/v3.0/examples/QuickTestImage.json | 2 +- .../v3.0/examples/QuickTestImageUrl.json | 2 +- .../stable/v3.0/examples/TrainProject.json | 4 +-- .../stable/v3.0/examples/UpdateIteration.json | 12 +++---- .../stable/v3.0/examples/UpdateProject.json | 8 ++--- 24 files changed, 135 insertions(+), 87 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json index 9c326e0c6d42..bc978c8515ab 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImage.json @@ -14,7 +14,7 @@ "id": "951098b2-9b69-427b-bddb-d5cb618874e3", "project": "64b822c5-8082-4b36-a426-27225f4aa18c", "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "created": "2019-03-06T02:15:00Z", "predictions": [ { "tagId": "e31ff107-5505-4753-be42-b369b21b026c", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json index d879781f2fab..0a0e7b7a39e6 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrl.json @@ -16,7 +16,7 @@ "id": "951098b2-9b69-427b-bddb-d5cb618874e3", "project": "64b822c5-8082-4b36-a426-27225f4aa18c", "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "created": "2019-03-06T02:15:00Z", "predictions": [ { "tagId": "e31ff107-5505-4753-be42-b369b21b026c", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json index d879781f2fab..0a0e7b7a39e6 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageUrlWithNoStore.json @@ -16,7 +16,7 @@ "id": "951098b2-9b69-427b-bddb-d5cb618874e3", "project": "64b822c5-8082-4b36-a426-27225f4aa18c", "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "created": "2019-03-06T02:15:00Z", "predictions": [ { "tagId": "e31ff107-5505-4753-be42-b369b21b026c", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json index 9c326e0c6d42..bc978c8515ab 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/ClassifyImageWithNoStore.json @@ -14,7 +14,7 @@ "id": "951098b2-9b69-427b-bddb-d5cb618874e3", "project": "64b822c5-8082-4b36-a426-27225f4aa18c", "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "created": "2019-03-06T02:15:00Z", "predictions": [ { "tagId": "e31ff107-5505-4753-be42-b369b21b026c", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json index 9c326e0c6d42..2fa300983042 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImage.json @@ -11,20 +11,32 @@ "200": { "headers": {}, "body": { - "id": "951098b2-9b69-427b-bddb-d5cb618874e3", - "project": "64b822c5-8082-4b36-a426-27225f4aa18c", - "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1", + "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1", + "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957", + "created": "2019-03-10T06:10:28Z", "predictions": [ { - "tagId": "e31ff107-5505-4753-be42-b369b21b026c", - "tagName": "Hemlock", - "probability": 0.05149666 + "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75", + "tagName": "Tag 1", + "probability": 0.05149666, + "boundingBox": { + "left": 0.955476165, + "top": 0, + "width": 0.0412225723, + "height": 0.156851858 + } }, { - "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", - "tagName": "Japanese Cherry", - "probability": 0.000193528482 + "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8", + "tagName": "Tag 2", + "probability": 0.000193528482, + "boundingBox": { + "left": 0.062178582, + "top": 0, + "width": 0.9378114, + "height": 0.6830492 + } } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json index d879781f2fab..afafd238306c 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrl.json @@ -13,20 +13,32 @@ "200": { "headers": {}, "body": { - "id": "951098b2-9b69-427b-bddb-d5cb618874e3", - "project": "64b822c5-8082-4b36-a426-27225f4aa18c", - "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1", + "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1", + "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957", + "created": "2019-03-10T06:10:28Z", "predictions": [ { - "tagId": "e31ff107-5505-4753-be42-b369b21b026c", - "tagName": "Hemlock", - "probability": 0.05149666 + "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75", + "tagName": "Tag 1", + "probability": 0.05149666, + "boundingBox": { + "left": 0.955476165, + "top": 0, + "width": 0.0412225723, + "height": 0.156851858 + } }, { - "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", - "tagName": "Japanese Cherry", - "probability": 0.000193528482 + "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8", + "tagName": "Tag 2", + "probability": 0.000193528482, + "boundingBox": { + "left": 0.062178582, + "top": 0, + "width": 0.9378114, + "height": 0.6830492 + } } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json index d879781f2fab..afafd238306c 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageUrlWithNoStore.json @@ -13,20 +13,32 @@ "200": { "headers": {}, "body": { - "id": "951098b2-9b69-427b-bddb-d5cb618874e3", - "project": "64b822c5-8082-4b36-a426-27225f4aa18c", - "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1", + "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1", + "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957", + "created": "2019-03-10T06:10:28Z", "predictions": [ { - "tagId": "e31ff107-5505-4753-be42-b369b21b026c", - "tagName": "Hemlock", - "probability": 0.05149666 + "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75", + "tagName": "Tag 1", + "probability": 0.05149666, + "boundingBox": { + "left": 0.955476165, + "top": 0, + "width": 0.0412225723, + "height": 0.156851858 + } }, { - "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", - "tagName": "Japanese Cherry", - "probability": 0.000193528482 + "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8", + "tagName": "Tag 2", + "probability": 0.000193528482, + "boundingBox": { + "left": 0.062178582, + "top": 0, + "width": 0.9378114, + "height": 0.6830492 + } } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json index 9c326e0c6d42..2fa300983042 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.0/examples/DetectImageWithNoStore.json @@ -11,20 +11,32 @@ "200": { "headers": {}, "body": { - "id": "951098b2-9b69-427b-bddb-d5cb618874e3", - "project": "64b822c5-8082-4b36-a426-27225f4aa18c", - "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1", + "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1", + "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957", + "created": "2019-03-10T06:10:28Z", "predictions": [ { - "tagId": "e31ff107-5505-4753-be42-b369b21b026c", - "tagName": "Hemlock", - "probability": 0.05149666 + "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75", + "tagName": "Tag 1", + "probability": 0.05149666, + "boundingBox": { + "left": 0.955476165, + "top": 0, + "width": 0.0412225723, + "height": 0.156851858 + } }, { - "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", - "tagName": "Japanese Cherry", - "probability": 0.000193528482 + "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8", + "tagName": "Tag 2", + "probability": 0.000193528482, + "boundingBox": { + "left": 0.062178582, + "top": 0, + "width": 0.9378114, + "height": 0.6830492 + } } ] } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json index ab1f62de78fc..d52f05c8f334 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromData.json @@ -20,7 +20,7 @@ "status": "OK", "image": { "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", - "created": "2017-12-19T15:56:10.65Z", + "created": "2017-12-19T15:56:10Z", "width": 1095, "height": 900, "resizedImageUri": "{Resized Image Uri}", @@ -29,7 +29,7 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.6105895Z", + "created": "2017-12-19T15:56:09Z", "tagName": "tag 1" } ] @@ -40,7 +40,7 @@ "status": "OK", "image": { "id": "f1855a92-b873-47e7-b513-f07a667ceda1", - "created": "2017-12-19T15:56:10.57Z", + "created": "2017-12-19T15:56:10Z", "width": 900, "height": 1531, "resizedImageUri": "{Resized Image Uri}", @@ -49,7 +49,7 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.5168568Z", + "created": "2017-12-19T15:56:09Z", "tagName": "tag 1" } ] diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json index 851f3e53ea00..9a2ad2143d4d 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromFiles.json @@ -28,7 +28,7 @@ "status": "OK", "image": { "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", - "created": "2017-12-19T15:56:10.65Z", + "created": "2017-12-19T15:56:10Z", "width": 1095, "height": 900, "resizedImageUri": "{Resized Image Uri}", @@ -37,7 +37,7 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.6105895Z", + "created": "2017-12-19T15:56:09Z", "tagName": "tag 1" } ] diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json index 612157ef3cf4..8f09a114ba5e 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromPredictions.json @@ -27,7 +27,7 @@ "status": "OK", "image": { "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", - "created": "2017-12-19T15:56:10.65Z", + "created": "2017-12-19T15:56:10Z", "width": 1095, "height": 900, "resizedImageUri": "{Resized Image Uri}", @@ -36,7 +36,7 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.6105895Z", + "created": "2017-12-19T15:56:09Z", "tagName": "tag 1" } ] diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json index d4e007860e79..fafbdc118420 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateImagesFromUrls.json @@ -27,7 +27,7 @@ "status": "OK", "image": { "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", - "created": "2017-12-19T15:56:10.65Z", + "created": "2017-12-19T15:56:10Z", "width": 1095, "height": 900, "resizedImageUri": "{Resized Image Uri}", @@ -36,7 +36,7 @@ "tags": [ { "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", - "created": "2017-12-19T15:56:09.6105895Z", + "created": "2017-12-19T15:56:09Z", "tagName": "tag name" } ] diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json index ada2b58c5738..5f92bb5e24a6 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/CreateProject.json @@ -17,8 +17,8 @@ "settings": { "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" }, - "created": "2017-12-18T05:43:18.08Z", - "lastModified": "2017-12-18T05:43:18.0962423Z", + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:18Z", "thumbnailUri": "" } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformances.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformances.json index 2a0c67fb6dcb..15743496d81b 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformances.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetImagePerformances.json @@ -16,7 +16,7 @@ "body": [ { "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042", - "created": "2018-01-31T20:18:26.5806336Z", + "created": "2018-01-31T20:18:26Z", "predictions": [ { "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json index afb0aa3b2988..06a2655ba910 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIteration.json @@ -13,9 +13,9 @@ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Iteration 2", "status": "Completed", - "created": "2017-12-18T22:40:36.9066667Z", - "lastModified": "2017-12-19T15:47:02.9511889Z", - "trainedAt": "2017-12-19T15:47:02.9511889Z", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:47:02Z", + "trainedAt": "2017-12-19T15:47:02Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json index 0e3d883481a8..3d3d0f72b54a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetIterations.json @@ -13,9 +13,9 @@ "id": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", "name": "Iteration 1", "status": "Completed", - "created": "2017-12-18T22:40:29.7304213Z", - "lastModified": "2017-12-18T22:40:41.3173903Z", - "trainedAt": "2017-12-18T22:40:41.0058589Z", + "created": "2017-12-18T22:40:29Z", + "lastModified": "2017-12-18T22:40:41Z", + "trainedAt": "2017-12-18T22:40:41Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", @@ -28,9 +28,9 @@ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Iteration 2", "status": "Completed", - "created": "2017-12-18T22:40:36.9066667Z", - "lastModified": "2017-12-19T15:47:02.9511889Z", - "trainedAt": "2017-12-19T15:47:02.9511889Z", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:47:02Z", + "trainedAt": "2017-12-19T15:47:02Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", @@ -43,8 +43,8 @@ "id": "3adaf7b2-18fc-4376-9da4-b5ea160a7cf5", "name": "Iteration 3", "status": "New", - "created": "2017-12-19T15:46:59.2533333Z", - "lastModified": "2017-12-19T15:46:59.2699369Z", + "created": "2017-12-19T15:46:59Z", + "lastModified": "2017-12-19T15:46:59Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, "domainId": null, diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json index cb1e69ba8ca8..84e4dc4b5831 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProject.json @@ -15,8 +15,8 @@ "settings": { "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" }, - "created": "2017-12-18T05:43:18.08Z", - "lastModified": "2017-12-18T05:43:18.0962423Z", + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:18Z", "thumbnailUri": "" } } diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json index b5cbbd335095..d30ce59327a8 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/GetProjects.json @@ -15,8 +15,8 @@ "settings": { "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" }, - "created": "2017-12-18T05:43:18.08Z", - "lastModified": "2017-12-18T05:43:18.0962423Z", + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:18Z", "thumbnailUri": "" } ] diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json index bfae1170adbf..0bc765721364 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QueryPredictions.json @@ -24,7 +24,7 @@ "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042", "project": "8988643a-ae70-447d-9a22-15c4255e5ecb", "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66", - "created": "2018-01-31T20:18:26.5806336Z", + "created": "2018-01-31T20:18:26Z", "predictions": [ { "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImage.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImage.json index 439be44f9c31..27cb296211df 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImage.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImage.json @@ -14,7 +14,7 @@ "id": "951098b2-9b69-427b-bddb-d5cb618874e3", "project": "64b822c5-8082-4b36-a426-27225f4aa18c", "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "created": "2017-12-19T14:21:41Z", "predictions": [ { "tagId": "e31ff107-5505-4753-be42-b369b21b026c", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImageUrl.json index a72595efe23f..0aed543a0fd2 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImageUrl.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/QuickTestImageUrl.json @@ -16,7 +16,7 @@ "id": "951098b2-9b69-427b-bddb-d5cb618874e3", "project": "64b822c5-8082-4b36-a426-27225f4aa18c", "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", - "created": "2017-12-19T14:21:41.6789561Z", + "created": "2017-12-19T14:21:41Z", "predictions": [ { "tagId": "e31ff107-5505-4753-be42-b369b21b026c", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json index fe1b7e9cd64f..4b0484e0918a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/TrainProject.json @@ -12,8 +12,8 @@ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Iteration 2", "status": "Training", - "created": "2017-12-18T22:40:36.9066667Z", - "lastModified": "2017-12-19T15:46:58.197323Z", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:46:58Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, "domainId": null, diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json index 703b246005d7..9c0c74de536f 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateIteration.json @@ -9,9 +9,9 @@ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Best Iteration", "status": "Completed", - "created": "2017-12-18T22:40:36.9066667Z", - "lastModified": "2017-12-19T15:53:07.8782881Z", - "trainedAt": "2017-12-19T15:47:02.9511889Z", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:53:07Z", + "trainedAt": "2017-12-19T15:47:02Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], @@ -28,9 +28,9 @@ "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", "name": "Best Iteration", "status": "Completed", - "created": "2017-12-18T22:40:36.9066667Z", - "lastModified": "2017-12-19T15:53:07.8782881Z", - "trainedAt": "2017-12-19T15:47:02.9511889Z", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:53:07Z", + "trainedAt": "2017-12-19T15:47:02Z", "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", "exportable": false, "exportableTo": [ "ONNX", "DockerFile", "TensorFlow", "CoreML" ], diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json index 4917b8079bc0..81f30b39eac9 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UpdateProject.json @@ -11,8 +11,8 @@ "settings": { "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" }, - "created": "2017-12-18T05:43:18.08Z", - "lastModified": "2017-12-18T05:43:18.0962423Z", + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:18Z", "thumbnailUri": "" } }, @@ -26,8 +26,8 @@ "settings": { "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" }, - "created": "2017-12-18T05:43:18.08Z", - "lastModified": "2017-12-18T05:43:19.0962423Z", + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:19Z", "thumbnailUri": "" } } From 659b1059c7a89bca264c33e6fc8c175c9ae9053d Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Tue, 19 Mar 2019 08:47:55 -0700 Subject: [PATCH 13/18] remove nullable --- .../Training/stable/v3.0/Training.json | 48 +++++++------------ 1 file changed, 16 insertions(+), 32 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index 71897ca5df86..2d2dd37c16f9 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -130,8 +130,7 @@ "description": "The iteration id. Defaults to workspace.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "name": "tagIds", @@ -202,8 +201,7 @@ "description": "The iteration id. Defaults to workspace.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "$ref": "#/parameters/ApiKey" @@ -509,8 +507,7 @@ "description": "The iteration id. Defaults to workspace.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "name": "tagIds", @@ -536,8 +533,7 @@ "enum": [ "Newest", "Oldest" - ], - "x-nullable": true + ] }, { "name": "take", @@ -617,8 +613,7 @@ "description": "The iteration id. Defaults to workspace.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "name": "orderBy", @@ -629,8 +624,7 @@ "enum": [ "Newest", "Oldest" - ], - "x-nullable": true + ] }, { "name": "take", @@ -725,8 +719,7 @@ "description": "The iteration id. Defaults to workspace.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "$ref": "#/parameters/ApiKey" @@ -1228,8 +1221,7 @@ "description": "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.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "$ref": "#/parameters/ApiKey" @@ -1288,8 +1280,7 @@ "description": "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.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "name": "imageData", @@ -1515,8 +1506,7 @@ "enum": [ "Newest", "Oldest" - ], - "x-nullable": true + ] }, { "name": "take", @@ -1712,8 +1702,7 @@ "description": "The id of the domain to use for this project. Defaults to General.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "name": "classificationType", @@ -1974,8 +1963,7 @@ "in": "query", "description": "The email address to send notification to when training finishes (default: null).", "required": false, - "type": "string", - "x-nullable": true + "type": "string" }, { "$ref": "#/parameters/ApiKey" @@ -2459,8 +2447,7 @@ "DockerFile", "ONNX", "VAIDK" - ], - "x-nullable": true + ] }, { "name": "flavor", @@ -2474,8 +2461,7 @@ "ONNX10", "ONNX12", "ARM" - ], - "x-nullable": true + ] }, { "$ref": "#/parameters/ApiKey" @@ -2540,8 +2526,7 @@ "description": "The iteration to retrieve this tag from. Optional, defaults to current training set.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "$ref": "#/parameters/ApiKey" @@ -2716,8 +2701,7 @@ "description": "The iteration id. Defaults to workspace.", "required": false, "type": "string", - "format": "uuid", - "x-nullable": true + "format": "uuid" }, { "$ref": "#/parameters/ApiKey" From 5adc21c930bdad8bccc0fbb82ac7c049aae4b9b0 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Tue, 19 Mar 2019 21:49:21 -0700 Subject: [PATCH 14/18] Add missing field --- .../CustomVision/Training/stable/v3.0/Training.json | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index 2d2dd37c16f9..041cb32a12fb 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -4237,7 +4237,13 @@ "description": "Name of the published model.", "type": "string", "readOnly": true, - "x-nullable": false + "x-nullable": true + }, + "originalPublishResourceId": { + "description": "Resource Provider Id this iteration was originally published to.", + "type": "string", + "readOnly": true, + "x-nullable": true } } }, From 79d1c5ef4f2f3e560fb15ffe3f439e8a8fbf13bd Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Wed, 20 Mar 2019 06:58:51 -0700 Subject: [PATCH 15/18] Update HttpDelete operation to be consistent. --- .../CustomVision/Training/stable/v3.0/Training.json | 13 +++---------- .../stable/v3.0/examples/UnpublishIteration.json | 4 ++-- 2 files changed, 5 insertions(+), 12 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index 041cb32a12fb..c8fae1d83d89 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -2296,11 +2296,7 @@ "summary": "Unpublish a specific iteration.", "operationId": "UnpublishIteration", "consumes": [], - "produces": [ - "application/json", - "application/xml", - "text/xml" - ], + "produces": [], "parameters": [ { "name": "projectId", @@ -2325,11 +2321,8 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "type": "boolean" - } + "204": { + "description": "No Content" }, "default": { "description": "Error response", diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UnpublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UnpublishIteration.json index 70d6a7c37624..bbada4036451 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UnpublishIteration.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/examples/UnpublishIteration.json @@ -7,9 +7,9 @@ "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" }, "responses": { - "200": { + "204": { "headers": {}, - "body": true + "body": "" } } } \ No newline at end of file From 88b8b15c44d7c0f1fad2ba6d8bbad585ca4d8150 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Wed, 20 Mar 2019 14:34:54 -0700 Subject: [PATCH 16/18] Add missing error. --- .../data-plane/CustomVision/Training/stable/v3.0/Training.json | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json index c8fae1d83d89..e156ae3351c3 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.0/Training.json @@ -4398,6 +4398,7 @@ "BadRequestInvalidPublishName", "BadRequestInvalidPublishTarget", "BadRequestUnpublishFailed", + "BadRequestIterationNotPublished", "BadRequestSubscriptionApi", "BadRequestExceedProjectLimit", "BadRequestExceedIterationPerProjectLimit", From 76fe991307ce917a78127bc0b08cd5f8a4919848 Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Thu, 21 Mar 2019 13:25:00 -0700 Subject: [PATCH 17/18] Add ruby swagger-to-sdk parts --- .../data-plane/CustomVision/Prediction/readme.md | 3 +++ .../data-plane/CustomVision/Training/readme.md | 3 +++ 2 files changed, 6 insertions(+) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md index 110f50ce71f7..73a4dbe39b40 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md @@ -52,6 +52,9 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-js - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_customvision_prediction'] ``` ## CSharp Settings diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md index 6d87d84f471c..20ce2f8b6653 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md @@ -66,6 +66,9 @@ swagger-to-sdk: - repo: azure-sdk-for-java - repo: azure-sdk-for-js - repo: azure-sdk-for-node + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_cognitiveservices_customvision_training'] ``` ## CSharp Settings From 9ae6d3fc67753cc3b873097e46289a913a86357e Mon Sep 17 00:00:00 2001 From: Andrew Reddish Date: Thu, 21 Mar 2019 13:39:28 -0700 Subject: [PATCH 18/18] Update ruby.md --- .../data-plane/CustomVision/Prediction/readme.ruby.md | 4 ++-- .../data-plane/CustomVision/Training/readme.ruby.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md index fdffabe43ab5..3adbf19106d6 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md @@ -23,7 +23,7 @@ Please also specify `--ruby-sdks-folder=