Skip to content

Add Custom vision 2.0 Swagger #3026

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anuchandy merged 7 commits into from
May 7, 2018
Merged

Add Custom vision 2.0 Swagger #3026

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4d15e2f
Add previous version into v2.0 for a base to diff changes off of.
areddish Apr 20, 2018
b12fad9
V2.0 of Custom Vision API
areddish Apr 13, 2018
699d8a5
Fix examples after re-working commits introduced unused examples.
areddish Apr 23, 2018
b1d5c72
Add descriptions
areddish Apr 25, 2018
2e4521b
Generate sync methods for all c# methods
areddish Apr 25, 2018
209e7a8
Sync to latest build
areddish Apr 25, 2018
ff5eeb4
Fix incorrect capitalization
areddish Apr 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Add previous version into v2.0 for a base to diff changes off of.
  • Loading branch information
@areddish
areddish committed May 7, 2018
commit 4d15e2fc1d7f25ab17d4fd79e3b13e296033bc1c
386 changes: 386 additions & 0 deletions ...fication/cognitiveservices/data-plane/CustomVision/Prediction/stable/v2.0/Prediction.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,386 @@
{
"swagger": "2.0",
"info": {
"version": "1.1",
"title": "PredictionEndpoint"
},
"host": "southcentralus.api.cognitive.microsoft.com",
"basePath": "/customvision/v1.1/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/ImagePredictionResultModel"
}
}
},
"x-ms-examples": {
"Successful Prediction with Url request": {
"$ref": "./examples/SuccessfulPredictionWithUrl.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/ImagePredictionResultModel"
}
}
},
"x-ms-examples": {
"Successful Prediction with Image request": {
"$ref": "./examples/SuccessfulPredictionWithImage.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/ImagePredictionResultModel"
}
}
},
"x-ms-examples": {
"Successful Prediction with Url request": {
"$ref": "./examples/SuccessfulPredictionWithUrl.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/ImagePredictionResultModel"
}
}
},
"x-ms-examples": {
"Successful Prediction with Image request": {
"$ref": "./examples/SuccessfulPredictionWithImage.json"
}
}
}
}
},
"definitions": {
"ImageUrl": {
"type": "object",
"properties": {
"Url": {
"type": "string",
"x-nullable": true
}
},
"x-nullable": true
},
"ImagePredictionResultModel": {
"description": "result of an image prediction request",
"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/ImageTagPredictionModel"
},
"readOnly": true,
"x-nullable": true
}
},
"x-nullable": true
},
"ImageTagPredictionModel": {
"type": "object",
"properties": {
"TagId": {
"format": "uuid",
"type": "string",
"readOnly": true,
"x-nullable": false
},
"Tag": {
"type": "string",
"readOnly": true,
"x-nullable": true
},
"Probability": {
"format": "float",
"type": "number",
"readOnly": true,
"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"
}
}
}
Loading