{
"opencollection": "1.0.0",
"info": {
"name": "Microsoft Azure AccessControlClient AccessConnector Models API",
"version": "2020-08-01-preview"
},
"items": [
{
"info": {
"name": "Models",
"type": "folder"
},
"items": [
{
"info": {
"name": "Microsoft Azure List Available Models",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.CognitiveServices/models",
"params": [
{
"name": "subscriptionId",
"value": "",
"type": "path",
"description": "The ID of the target subscription."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The API version to use for this operation."
}
]
},
"docs": "List available models for the subscription."
},
{
"info": {
"name": "Microsoft Azure Get Models",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/models",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
},
{
"name": "max-items-per-page",
"value": ""
}
],
"params": [
{
"name": "dependenciesFor",
"value": "",
"type": "query",
"description": "If specified, only return the set of the specified models along with their dependencies. If omitted, all models are retrieved."
},
{
"name": "includeModelDefinition",
"value": "",
"type": "query",
"description": "When true the model definition will be returned as part of the result."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Retrieves model metadata and, optionally, model definitions.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.
* 404 Not Found
* ModelNotFound - The model was not found."
},
{
"info": {
"name": "Microsoft Azure Post Models",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/models",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Uploads one or more models. When any error occurs, no models are uploaded.
Status codes:
* 201 Created
* 400 Bad Request
* DTDLParserError - The models provided are not valid DTDL.
* InvalidArgument - The model id is invalid.
* LimitExceeded - The maximum number of model ids allowed in 'dependenciesFor' has been reached.
* ModelVersionNotSupported - The version of DTDL used is not supported.
* 409 Conflict
* ModelAlreadyExists - The model provided already exi"
},
{
"info": {
"name": "Microsoft Azure Get Models Id",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/models/:id",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id for the model. The id is globally unique and case sensitive."
},
{
"name": "includeModelDefinition",
"value": "",
"type": "query",
"description": "When true the model definition will be returned as part of the result."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Retrieves model metadata and optionally the model definition.
Status codes:
* 200 OK
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* MissingArgument - The model id was not provided.
* 404 Not Found
* ModelNotFound - The model was not found."
},
{
"info": {
"name": "Microsoft Azure Patch Models Id",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/models/:id",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id for the model. The id is globally unique and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Updates the metadata for a model.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* JsonPatchInvalid - The JSON Patch provided is invalid.
* MissingArgument - The model id was not provided.
* 404 Not Found
* ModelNotFound - The model was not found.
* 409 Conflict
* ModelReferencesNotDecommissioned - The model refers to models that are not decommissioned."
},
{
"info": {
"name": "Microsoft Azure Delete Models Id",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/models/:id",
"headers": [
{
"name": "traceparent",
"value": ""
},
{
"name": "tracestate",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The id for the model. The id is globally unique and case sensitive."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Deletes a model. A model can only be deleted if no other models reference it.
Status codes:
* 204 No Content
* 400 Bad Request
* InvalidArgument - The model id is invalid.
* MissingArgument - The model id was not provided.
* 404 Not Found
* ModelNotFound - The model was not found.
* 409 Conflict
* ModelReferencesNotDeleted - The model refers to models that are not deleted."
},
{
"info": {
"name": "Microsoft Azure Gets Details For The Model Specified By The Given Modelid",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/models/:model_id",
"params": [
{
"name": "model_id",
"value": "",
"type": "path",
"description": "The identifier of the model."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Gets Details For The Model Specified By The Given Modelid",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/models/:model-id",
"params": [
{
"name": "model-id",
"value": "",
"type": "path",
"description": "The identifier of the model."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "The requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Post Models Model Analyze",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/models/:model/analyze",
"params": [
{
"name": "model",
"value": "",
"type": "path",
"description": "The domain-specific content to recognize."
},
{
"name": "language",
"value": "",
"type": "query",
"description": "The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese."
}
]
},
"docs": "This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API only provides a single domain-specific model: celebrities. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code an"
},
{
"info": {
"name": "Microsoft Azure Get Information About A Specific Model \r\n \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/models/:name",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the model to get."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Start Training A Custom Model \r\n \r\nstatus Codes Returned:\r\n 201: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 409: A Model With The Specified Name Already Exists",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/models/:name",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "A name that can be used to uniquely identify the model after it has been created."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Delete A Custom Model A Model Can Be Deleted If It Is In One Of The Succeeded , Failed , Or Canceled States \r\nif A Model Is In The Notstarted Or Training State, Cancel Training And Wait For Cancellation To Finish Before Deleting The Model \r\n \r\nstatus Codes Returned:\r\n 204: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/models/:name",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the model to delete."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Cancel Model Training \r\n \r\nstatus Codes Returned:\r\n 202: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model With The Specified Name Was Not Found",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/models/:name:cancel",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the model to cancel training."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Get Information About A Specific Model Evaluation \r\n \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model Evaluation With The Specified Name Was Not Found",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/models/:name/evaluations/:evaluationName",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the model to get the evaluation for."
},
{
"name": "evaluationName",
"value": "",
"type": "path",
"description": "The name of the model evaluation to get."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Evaluate An Existing Model \r\n \r\nstatus Codes Returned:\r\n 201: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 409: An Evaluation With The Specified Name Already Exists",
"type": "http"
},
"http": {
"method": "PUT",
"url": "{{baseUrl}}/models/:name/evaluations/:evaluationName",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the model to evaluate."
},
{
"name": "evaluationName",
"value": "",
"type": "path",
"description": "A name that can be used to uniquely identify the evaluation after it has been created."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Delete A Model Evaluation A Model Evaluation Can Be Deleted If It Is In The Succeeded Or Failed States \r\n \r\nstatus Codes Returned:\r\n 204: Operation Completed Successfully \r\n 400: The Request Was Malformed \r\n 404: A Model Evaluation With The Specified Name Was Not Found",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/models/:name/evaluations/:evaluationName",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the model to delete the evaluation for."
},
{
"name": "evaluationName",
"value": "",
"type": "path",
"description": "The name of the model evaluation to delete."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Requested API version."
}
]
},
"docs": "Needs a more full description created."
},
{
"info": {
"name": "Microsoft Azure Get A List Of The Available Evaluations For A Model \r\n \r\nstatus Codes Returned:\r\n 200: Operation Completed Successfully \r\n 400: The Request Was Malformed",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/models/:name/evaluations",
"params": [
{
"name": "name",
"value": "",
"type": "path",
"description": "The name of the model to get evaluations for."
},
{
"name": "skip",
"value": "",
"type": "query",
"description": "Number of evaluations to be skipped."
},
{
"name": "top",
"value": "",
"type": "query",
"description": "Number of evaluations to be returned after skipping. The maximum allowed value is 30."
},
{
"name": "api-version",
"value": "",
"type": "query",
"description": "Requested API version."
}
]
},
"docs": "Needs a more full description created."
}
]
}
],
"bundled": true
}