openapi: 3.2.0 info: title: Microsoft Azure Image API version: '1.0' description: 'Operations tagged ImageApi across 2 of this provider''s published API definitions: custom-vision-training-client-openapi-original.yml, trainingapi-openapi-original.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v2.1/Training tags: - name: Image API paths: /projects/{projectId}/images: get: tags: - Image API summary: Microsoft Azure Get Images For A Given Project Iteration Or Workspace description: 'This API supports batching and range selection. By default it will only return first 50 images matching images. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned' operationId: microsoftAzureGetimages parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: iterationId in: query description: The iteration id. Defaults to workspace. required: false schema: type: string format: uuid - 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 style: form explode: false schema: type: array items: type: string format: uuid maxItems: 20 minItems: 0 - name: taggingStatus in: query description: The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'. required: false schema: type: string enum: - All - Tagged - Untagged - name: $filter in: query description: 'An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response. The expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators. Here is an example, metadata=key1 eq ''value1'' and key2 ne ''value2''.' required: false schema: type: string - name: orderBy in: query description: The ordering. Defaults to newest. required: false schema: type: string enum: - Newest - Oldest - name: take in: query description: Maximum number of images to return. Defaults to 50, limited to 256. required: false schema: type: integer format: int32 default: 50 maximum: 256 minimum: 0 - name: skip in: query description: Number of images to skip before beginning the image batch. Defaults to 0. required: false schema: type: integer format: int32 default: 0 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Image' application/xml: schema: type: array items: $ref: '#/components/schemas/Image' text/xml: schema: type: array items: $ref: '#/components/schemas/Image' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful GetImages request: $ref: ./examples/GetImages.json security: - apim_key: [] post: tags: - Image API summary: Microsoft Azure 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 multiple image files can be sent at once, with a maximum of 64 files. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.' operationId: microsoftAzureCreateimagesfromdata parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: tagIds in: query description: The tags ids with which to tag each image. Limited to 20. required: false style: form explode: false schema: type: array items: type: string format: uuid maxItems: 20 minItems: 0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' '207': description: '207' content: application/json: schema: $ref: '#/components/schemas/ImageCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful CreateImagesFromData request: $ref: ./examples/CreateImagesFromData.json requestBody: content: multipart/form-data: schema: type: object properties: imageData: type: string description: Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB. format: binary required: - imageData application/octet-stream: schema: type: object properties: imageData: type: string description: Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB. format: binary required: - imageData security: - apim_key: [] delete: tags: - Image API summary: Microsoft Azure Delete Images From The Set Of Training Images operationId: microsoftAzureDeleteimages parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: imageIds in: query description: Ids of the images to be deleted. Limited to 256 images per batch. required: false style: form explode: false schema: type: array items: type: string format: uuid maxItems: 256 minItems: 0 - name: allImages in: query description: Flag to specify delete all images, specify this flag or a list of images. Using this flag will return a 202 response to indicate the images are being deleted. required: false schema: type: boolean - name: allIterations in: query description: Removes these images from all iterations, not just the current workspace. Using this flag will return a 202 response to indicate the images are being deleted. required: false schema: type: boolean responses: '202': description: Accepted '204': description: No Content default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful DeleteImages request: $ref: ./examples/DeleteImages.json description: Needs a more full description created. security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/count: get: tags: - Image API summary: Microsoft Azure Get The Number Of Images description: 'The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned' operationId: microsoftAzureGetimagecount parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: iterationId in: query description: The iteration id. Defaults to workspace. required: false schema: type: string format: uuid - name: taggingStatus in: query description: The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'. required: false schema: type: string enum: - All - Tagged - Untagged - name: $filter in: query description: 'An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response. The expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators. Here is an example, metadata=key1 eq ''value1'' and key2 ne ''value2''.' required: false schema: type: string - name: tagIds in: query description: A list of tags ids to filter the images to count. Defaults to all tags when null. required: false style: form explode: false schema: type: array items: type: string format: uuid responses: '200': description: OK content: application/json: schema: format: int32 type: integer application/xml: schema: format: int32 type: integer text/xml: schema: format: int32 type: integer default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful GetImageCount request: $ref: ./examples/GetImageCount.json security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/files: post: tags: - Image API summary: Microsoft Azure 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. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.' operationId: microsoftAzureCreateimagesfromfiles parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' '207': description: '207' content: application/json: schema: $ref: '#/components/schemas/ImageCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful CreateImagesFromFiles request: $ref: ./examples/CreateImagesFromFiles.json requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageFileCreateBatch' application/xml: schema: $ref: '#/components/schemas/ImageFileCreateBatch' text/xml: schema: $ref: '#/components/schemas/ImageFileCreateBatch' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImageFileCreateBatch' description: The batch of image files to add. Limited to 64 images and 20 tags per batch. required: true security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/id: get: tags: - Image API summary: Microsoft Azure 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 current workspace is used.' operationId: microsoftAzureGetimagesbyids parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: imageIds in: query description: The list of image ids to retrieve. Limited to 256. required: false style: form explode: false schema: type: array items: type: string format: uuid maxItems: 256 minItems: 0 - name: iterationId in: query description: The iteration id. Defaults to workspace. required: false schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Image' application/xml: schema: type: array items: $ref: '#/components/schemas/Image' text/xml: schema: type: array items: $ref: '#/components/schemas/Image' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful GetImagesByIds request: $ref: ./examples/GetImagesByIds.json security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/metadata: post: tags: - Image API summary: Microsoft Azure Update Metadata Of Images description: This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images. operationId: microsoftAzureUpdateimagemetadata parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: imageIds in: query description: The list of image ids to update. Limited to 64. required: true style: form explode: false schema: type: array items: type: string format: uuid maxItems: 256 minItems: 0 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageMetadataUpdateSummary' application/xml: schema: $ref: '#/components/schemas/ImageMetadataUpdateSummary' text/xml: schema: $ref: '#/components/schemas/ImageMetadataUpdateSummary' '207': description: '207' content: application/json: schema: $ref: '#/components/schemas/ImageMetadataUpdateSummary' application/xml: schema: $ref: '#/components/schemas/ImageMetadataUpdateSummary' text/xml: schema: $ref: '#/components/schemas/ImageMetadataUpdateSummary' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful UpdateImageMetadata request: $ref: ./examples/UpdateImageMetadata.json requestBody: content: application/json: schema: type: object additionalProperties: type: string application/xml: schema: type: object additionalProperties: type: string text/xml: schema: type: object additionalProperties: type: string application/x-www-form-urlencoded: schema: type: object additionalProperties: type: string description: The metadata to be updated to the specified images. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512. required: true security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/predictions: post: tags: - Image API summary: Microsoft Azure 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. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.' operationId: microsoftAzureCreateimagesfrompredictions parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' '207': description: '207' content: application/json: schema: $ref: '#/components/schemas/ImageCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful CreateImagesFromPredictions request: $ref: ./examples/CreateImagesFromPredictions.json requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageIdCreateBatch' application/xml: schema: $ref: '#/components/schemas/ImageIdCreateBatch' text/xml: schema: $ref: '#/components/schemas/ImageIdCreateBatch' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImageIdCreateBatch' description: Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch. required: true security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/regions: post: tags: - Image API summary: Microsoft Azure 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. There is a limit of 64 entries in the batch. If all regions are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each region will be listed in the response payload.' operationId: microsoftAzureCreateimageregions parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageRegionCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageRegionCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageRegionCreateSummary' '207': description: '207' content: application/json: schema: $ref: '#/components/schemas/ImageRegionCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageRegionCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageRegionCreateSummary' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful CreateImageRegions request: $ref: ./examples/CreateImageRegions.json requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageRegionCreateBatch' application/xml: schema: $ref: '#/components/schemas/ImageRegionCreateBatch' text/xml: schema: $ref: '#/components/schemas/ImageRegionCreateBatch' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImageRegionCreateBatch' description: Batch of image regions which include a tag and bounding box. Limited to 64. required: true security: - apim_key: [] delete: tags: - Image API summary: Microsoft Azure Delete A Set Of Image Regions operationId: microsoftAzureDeleteimageregions parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: regionIds in: query description: Regions to delete. Limited to 64. required: true style: form explode: false schema: type: array items: type: string format: uuid maxItems: 64 minItems: 0 responses: '204': description: No Content default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful DeleteImageRegions request: $ref: ./examples/DeleteImageRegions.json description: Needs a more full description created. security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/suggested: post: tags: - Image API summary: Microsoft Azure Get Untagged Images Whose Suggested Tags Match Given Tags… description: This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found. operationId: microsoftAzureQuerysuggestedimages parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: iterationId in: query description: IterationId to use for the suggested tags and regions. required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuggestedTagAndRegionQuery' application/xml: schema: $ref: '#/components/schemas/SuggestedTagAndRegionQuery' text/xml: schema: $ref: '#/components/schemas/SuggestedTagAndRegionQuery' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful QuerySuggestedImages request: $ref: ./examples/QuerySuggestedImages.json requestBody: content: application/json: schema: $ref: '#/components/schemas/SuggestedTagAndRegionQueryToken' application/xml: schema: $ref: '#/components/schemas/SuggestedTagAndRegionQueryToken' text/xml: schema: $ref: '#/components/schemas/SuggestedTagAndRegionQueryToken' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SuggestedTagAndRegionQueryToken' description: Contains properties we need to query suggested images. required: true security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/suggested/count: post: tags: - Image API summary: Microsoft Azure Get Count Of Images Whose Suggested Tags Match Given Tags And… description: This API takes in tagIds to get count of untagged images per suggested tags for a given threshold. operationId: microsoftAzureQuerysuggestedimagecount parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: iterationId in: query description: IterationId to use for the suggested tags and regions. required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: type: object additionalProperties: format: int32 type: integer application/xml: schema: type: object additionalProperties: format: int32 type: integer text/xml: schema: type: object additionalProperties: format: int32 type: integer default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful QuerySuggestedImageCount request: $ref: ./examples/QuerySuggestedImageCount.json requestBody: content: application/json: schema: $ref: '#/components/schemas/TagFilter' application/xml: schema: $ref: '#/components/schemas/TagFilter' text/xml: schema: $ref: '#/components/schemas/TagFilter' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/TagFilter' description: Model that contains tagIds, threshold and projectType to query by. required: true security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/tagged: get: tags: - Image API summary: Microsoft Azure 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. Use the {take} and {skip} parameters to control how many images to return in a given batch. The filtering is on an and/or relationship. For example, if the provided tag ids are for the "Dog" and "Cat" tags, then only images tagged with Dog and/or Cat will be returned' operationId: microsoftAzureGettaggedimages parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: iterationId in: query description: The iteration id. Defaults to workspace. required: false schema: type: string format: uuid - 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 style: form explode: false schema: type: array items: type: string format: uuid maxItems: 20 minItems: 0 - name: orderBy in: query description: The ordering. Defaults to newest. required: false schema: type: string enum: - Newest - Oldest - name: take in: query description: Maximum number of images to return. Defaults to 50, limited to 256. required: false schema: type: integer format: int32 default: 50 maximum: 256 minimum: 0 - name: skip in: query description: Number of images to skip before beginning the image batch. Defaults to 0. required: false schema: type: integer format: int32 default: 0 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Image' application/xml: schema: type: array items: $ref: '#/components/schemas/Image' text/xml: schema: type: array items: $ref: '#/components/schemas/Image' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful GetTaggedImages request: $ref: ./examples/GetTaggedImages.json security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/tagged/count: get: tags: - Image API summary: Microsoft Azure 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 "Cat" tags, then only images tagged with Dog and/or Cat will be returned' operationId: microsoftAzureGettaggedimagecount parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: iterationId in: query description: The iteration id. Defaults to workspace. required: false schema: type: string format: uuid - name: tagIds in: query description: A list of tags ids to filter the images to count. Defaults to all tags when null. required: false style: form explode: false schema: type: array items: type: string format: uuid responses: '200': description: OK content: application/json: schema: format: int32 type: integer application/xml: schema: format: int32 type: integer text/xml: schema: format: int32 type: integer default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful GetTaggedImageCount request: $ref: ./examples/GetTaggedImageCount.json security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/tags: post: tags: - Image API summary: Microsoft Azure Associate A Set Of Images With A Set Of Tags operationId: microsoftAzureCreateimagetags parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageTagCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageTagCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageTagCreateSummary' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful CreateImageTags request: $ref: ./examples/CreateImageTags.json description: Needs a more full description created. requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageTagCreateBatch' application/xml: schema: $ref: '#/components/schemas/ImageTagCreateBatch' text/xml: schema: $ref: '#/components/schemas/ImageTagCreateBatch' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImageTagCreateBatch' description: Batch of image tags. Limited to 128 tags per batch. required: true security: - apim_key: [] delete: tags: - Image API summary: Microsoft Azure Remove A Set Of Tags From A Set Of Images operationId: microsoftAzureDeleteimagetags parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: imageIds in: query description: Image ids. Limited to 64 images. required: true style: form explode: false schema: type: array items: type: string format: uuid maxItems: 64 minItems: 0 - name: tagIds in: query description: Tags to be deleted from the specified images. Limited to 20 tags. required: true style: form explode: false schema: type: array items: type: string format: uuid maxItems: 20 minItems: 0 responses: '204': description: No Content default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful DeleteImageTags request: $ref: ./examples/DeleteImageTags.json description: Needs a more full description created. security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/untagged: get: tags: - Image API summary: Microsoft Azure 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. Use the {take} and {skip} parameters to control how many images to return in a given batch.' operationId: microsoftAzureGetuntaggedimages parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: iterationId in: query description: The iteration id. Defaults to workspace. required: false schema: type: string format: uuid - name: orderBy in: query description: The ordering. Defaults to newest. required: false schema: type: string enum: - Newest - Oldest - name: take in: query description: Maximum number of images to return. Defaults to 50, limited to 256. required: false schema: type: integer format: int32 default: 50 maximum: 256 minimum: 0 - name: skip in: query description: Number of images to skip before beginning the image batch. Defaults to 0. required: false schema: type: integer format: int32 default: 0 responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Image' application/xml: schema: type: array items: $ref: '#/components/schemas/Image' text/xml: schema: type: array items: $ref: '#/components/schemas/Image' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful GetUntaggedImages request: $ref: ./examples/GetUntaggedImages.json security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/untagged/count: get: tags: - Image API summary: Microsoft Azure 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 current workspace is used.' operationId: microsoftAzureGetuntaggedimagecount parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid - name: iterationId in: query description: The iteration id. Defaults to workspace. required: false schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: format: int32 type: integer application/xml: schema: format: int32 type: integer text/xml: schema: format: int32 type: integer default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful GetUntaggedImageCount request: $ref: ./examples/GetUntaggedImageCount.json security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training /projects/{projectId}/images/urls: post: tags: - Image API summary: Microsoft Azure 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. If all images are successful created, 200(OK) status code will be returned. Otherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.' operationId: microsoftAzureCreateimagesfromurls parameters: - name: projectId in: path description: The project id. required: true schema: type: string format: uuid responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ImageCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' '207': description: '207' content: application/json: schema: $ref: '#/components/schemas/ImageCreateSummary' application/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' text/xml: schema: $ref: '#/components/schemas/ImageCreateSummary' default: description: Error response content: application/json: schema: $ref: '#/components/schemas/CustomVisionError' application/xml: schema: $ref: '#/components/schemas/CustomVisionError' text/xml: schema: $ref: '#/components/schemas/CustomVisionError' x-ms-examples: Successful CreateImagesFromUrls request: $ref: ./examples/CreateImagesFromUrls.json requestBody: content: application/json: schema: $ref: '#/components/schemas/ImageUrlCreateBatch' application/xml: schema: $ref: '#/components/schemas/ImageUrlCreateBatch' text/xml: schema: $ref: '#/components/schemas/ImageUrlCreateBatch' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ImageUrlCreateBatch' description: Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch. required: true security: - apim_key: [] servers: - url: https://southcentralus.api.cognitive.microsoft.com/customvision/v3.3/training components: schemas: ImageUrlCreateBatch: type: object properties: images: type: array items: $ref: '#/components/schemas/ImageUrlCreateEntry' readOnly: false tagIds: type: array items: format: uuid type: string readOnly: false metadata: description: The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512. type: - object - 'null' additionalProperties: type: string readOnly: false ImageRegionCreateResult: required: - tagId - left - top - width - height type: object properties: imageId: format: uuid type: string readOnly: true regionId: format: uuid type: string readOnly: true tagName: type: string readOnly: true created: format: date-time type: string readOnly: true tagId: format: uuid description: Id of the tag associated with this region. type: string readOnly: false left: format: float description: Coordinate of the left boundary. type: number readOnly: false top: format: float description: Coordinate of the top boundary. type: number readOnly: false width: format: float description: Width. type: number readOnly: false height: format: float description: Height. type: number readOnly: false ImageFileCreateEntry: type: object properties: name: type: string readOnly: false contents: format: byte type: string readOnly: false tagIds: type: array items: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 readOnly: false regions: type: array items: $ref: '#/components/schemas/Region' readOnly: false ImageIdCreateBatch: type: object properties: images: type: array items: $ref: '#/components/schemas/ImageIdCreateEntry' readOnly: false tagIds: type: array items: format: uuid type: string readOnly: false metadata: description: The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512. type: - object - 'null' additionalProperties: type: string readOnly: false ImageMetadataUpdateSummary: type: object properties: isBatchSuccessful: type: boolean readOnly: true images: type: array items: $ref: '#/components/schemas/ImageMetadataUpdateEntry' readOnly: true ImageTag: type: object properties: tagId: format: uuid type: string readOnly: true tagName: type: string readOnly: true created: format: date-time type: string readOnly: true ImageIdCreateEntry: type: object properties: id: format: uuid description: Id of the image. type: string readOnly: false tagIds: type: array items: format: uuid type: string readOnly: false regions: type: array items: $ref: '#/components/schemas/Region' readOnly: false Image: description: Image model to be sent as JSON. type: object properties: id: format: uuid description: Id of the image. type: string readOnly: true example: 00000000-0000-0000-0000-000000000000 created: format: date-time description: Date the image was created. type: string readOnly: true width: format: int32 description: Width of the image. type: integer readOnly: true height: format: int32 description: Height of the image. type: integer readOnly: true resizedImageUri: description: The URI to the (resized) image used for training. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. type: string readOnly: true thumbnailUri: description: The URI to the thumbnail of the original image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. type: string readOnly: true originalImageUri: description: The URI to the original uploaded image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. type: string readOnly: true tags: description: Tags associated with this image. type: - array - 'null' items: $ref: '#/components/schemas/ImageTag' readOnly: true regions: description: Regions associated with this image. type: - array - 'null' items: $ref: '#/components/schemas/ImageRegion' readOnly: true metadata: description: Metadata associated with this image. type: - object - 'null' additionalProperties: type: string readOnly: true SuggestedTagAndRegionQueryToken: description: 'Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null. Then on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results.' type: object properties: tagIds: description: Existing TagIds in project to filter suggested tags on. type: array items: format: uuid type: string readOnly: false threshold: format: double description: Confidence threshold to filter suggested tags on. type: number readOnly: false session: description: SessionId for database query. Initially set to null but later used to paginate. type: string readOnly: false continuation: description: Continuation Id for database pagination. Initially null but later used to paginate. type: string readOnly: false maxCount: format: int32 description: Maximum number of results you want to be returned in the response. type: integer readOnly: false sortBy: description: OrderBy. Ordering mechanism for your results. enum: - UncertaintyAscending - UncertaintyDescending type: string readOnly: false x-ms-enum: name: SortBy modelAsString: true ImageTagCreateBatch: description: Batch of image tags. type: object properties: tags: description: Image Tag entries to include in this batch. type: array items: $ref: '#/components/schemas/ImageTagCreateEntry' readOnly: false Prediction: description: Prediction result. type: object properties: probability: format: float description: Probability of the tag. type: number readOnly: true tagId: format: uuid description: Id of the predicted tag. type: string readOnly: true tagName: description: Name of the predicted tag. type: - string - 'null' readOnly: true boundingBox: $ref: '#/components/schemas/BoundingBox' description: Bounding box of the prediction. readOnly: true tagType: description: Type of the predicted tag. enum: - Regular - Negative - GeneralProduct type: - string - 'null' readOnly: true x-ms-enum: name: TagType modelAsString: true SuggestedTagAndRegionQuery: description: The array of result images and token containing session and continuation Ids for the next query. type: object properties: token: $ref: '#/components/schemas/SuggestedTagAndRegionQueryToken' description: Contains properties we need to fetch suggested tags for. readOnly: false results: description: Result of a suggested tags and regions request of the untagged image. type: array items: $ref: '#/components/schemas/StoredSuggestedTagAndRegion' readOnly: true ImageTagCreateEntry: description: Entry associating a tag to an image. type: object properties: imageId: format: uuid description: Id of the image. type: string readOnly: false tagId: format: uuid description: Id of the tag. type: string readOnly: false ImageRegionCreateSummary: type: object properties: created: type: - array - 'null' items: $ref: '#/components/schemas/ImageRegionCreateResult' readOnly: false duplicated: type: - array - 'null' items: $ref: '#/components/schemas/ImageRegionCreateEntry' readOnly: false exceeded: type: - array - 'null' items: $ref: '#/components/schemas/ImageRegionCreateEntry' readOnly: false StoredSuggestedTagAndRegion: description: Result of a suggested tags and regions request of the untagged image. type: object properties: width: format: int32 description: Width of the resized image. type: integer readOnly: true height: format: int32 description: Height of the resized image. type: integer readOnly: true resizedImageUri: description: The URI to the (resized) prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. type: string readOnly: true thumbnailUri: description: The URI to the thumbnail of the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. type: string readOnly: true originalImageUri: description: The URI to the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource. type: string readOnly: true domain: format: uuid description: Domain used for the prediction. type: string readOnly: true id: format: uuid description: Prediction Id. type: string readOnly: true project: format: uuid description: Project Id. type: string readOnly: true iteration: format: uuid description: Iteration Id. type: string readOnly: true created: format: date-time description: Date this prediction was created. type: string readOnly: true predictions: description: List of predictions. type: array items: $ref: '#/components/schemas/Prediction' readOnly: true predictionUncertainty: format: double description: Uncertainty (entropy) of suggested tags or regions per image. type: number readOnly: true ImageCreateResult: type: object properties: sourceUrl: description: Source URL of the image. type: string readOnly: 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-ms-enum: name: ImageCreateStatus modelAsString: true image: $ref: '#/components/schemas/Image' description: The image. readOnly: 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 - BadRequestProjectUnsupportedExportPlatform - BadRequestProjectImagePreprocessingSettings - BadRequestProjectDuplicated - BadRequestIterationName - BadRequestIterationNameNotUnique - BadRequestIterationDescription - BadRequestIterationIsNotTrained - BadRequestIterationValidationFailed - BadRequestWorkspaceCannotBeModified - BadRequestWorkspaceNotDeletable - BadRequestTagName - BadRequestTagNameNotUnique - BadRequestTagDescription - BadRequestTagType - BadRequestMultipleNegativeTag - BadRequestMultipleGeneralProductTag - BadRequestImageTags - BadRequestImageRegions - BadRequestNegativeAndRegularTagOnSameImage - BadRequestUnsupportedDomain - BadRequestRequiredParamIsNull - BadRequestIterationIsPublished - BadRequestInvalidPublishName - BadRequestInvalidPublishTarget - BadRequestUnpublishFailed - BadRequestIterationNotPublished - BadRequestSubscriptionApi - BadRequestExceedProjectLimit - BadRequestExceedIterationPerProjectLimit - BadRequestExceedTagPerProjectLimit - BadRequestExceedTagPerImageLimit - BadRequestExceededQuota - BadRequestCannotMigrateProjectWithName - BadRequestNotLimitedTrial - BadRequestImageBatch - BadRequestImageStream - BadRequestImageUrl - BadRequestImageFormat - BadRequestImageSizeBytes - BadRequestImageDimensions - BadRequestImageExceededCount - BadRequestTrainingNotNeeded - BadRequestTrainingNotNeededButTrainingPipelineUpdated - BadRequestTrainingValidationFailed - BadRequestClassificationTrainingValidationFailed - BadRequestMultiClassClassificationTrainingValidationFailed - BadRequestMultiLabelClassificationTrainingValidationFailed - BadRequestDetectionTrainingValidationFailed - BadRequestTrainingAlreadyInProgress - BadRequestDetectionTrainingNotAllowNegativeTag - BadRequestInvalidEmailAddress - BadRequestDomainNotSupportedForAdvancedTraining - BadRequestExportPlatformNotSupportedForAdvancedTraining - BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining - BadRequestExportValidationFailed - BadRequestExportAlreadyInProgress - BadRequestPredictionIdsMissing - BadRequestPredictionIdsExceededCount - BadRequestPredictionTagsExceededCount - BadRequestPredictionResultsExceededCount - BadRequestPredictionInvalidApplicationName - BadRequestPredictionInvalidQueryParameters - BadRequestInvalidImportToken - BadRequestExportWhileTraining - BadRequestImageMetadataKey - BadRequestImageMetadataValue - BadRequestOperationNotSupported - BadRequestInvalidArtifactUri - BadRequestCustomerManagedKeyRevoked - BadRequestInvalid - UnsupportedMediaType - Forbidden - ForbiddenUser - ForbiddenUserResource - ForbiddenUserSignupDisabled - ForbiddenUserSignupAllowanceExceeded - ForbiddenUserDoesNotExist - ForbiddenUserDisabled - ForbiddenUserInsufficientCapability - ForbiddenDRModeEnabled - ForbiddenInvalid - NotFound - NotFoundProject - NotFoundProjectDefaultIteration - NotFoundIteration - NotFoundIterationPerformance - NotFoundTag - NotFoundImage - NotFoundDomain - NotFoundApimSubscription - NotFoundInvalid - Conflict - ConflictInvalid - ErrorUnknown - ErrorIterationCopyFailed - ErrorPreparePerformanceMigrationFailed - ErrorProjectInvalidWorkspace - ErrorProjectInvalidPipelineConfiguration - ErrorProjectInvalidDomain - ErrorProjectTrainingRequestFailed - ErrorProjectImportRequestFailed - ErrorProjectExportRequestFailed - ErrorFeaturizationServiceUnavailable - ErrorFeaturizationQueueTimeout - ErrorFeaturizationInvalidFeaturizer - ErrorFeaturizationAugmentationUnavailable - ErrorFeaturizationUnrecognizedJob - ErrorFeaturizationAugmentationError - ErrorExporterInvalidPlatform - ErrorExporterInvalidFeaturizer - ErrorExporterInvalidClassifier - ErrorPredictionServiceUnavailable - ErrorPredictionModelNotFound - ErrorPredictionModelNotCached - ErrorPrediction - ErrorPredictionStorage - ErrorRegionProposal - ErrorUnknownBaseModel - ErrorInvalid type: string x-ms-enum: name: CustomVisionErrorCodes modelAsString: true message: description: A message explaining the error reported by the service. type: string ImageFileCreateBatch: type: object properties: images: type: array items: $ref: '#/components/schemas/ImageFileCreateEntry' readOnly: false tagIds: type: array items: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 readOnly: false metadata: description: The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512. type: - object - 'null' additionalProperties: type: string readOnly: false ImageRegionCreateBatch: description: Batch of image region information to create. type: object properties: regions: type: array items: $ref: '#/components/schemas/ImageRegionCreateEntry' readOnly: false BoundingBox: description: Bounding box that defines a region of an image. required: - left - top - width - height type: object properties: left: format: float description: Coordinate of the left boundary. type: number readOnly: false top: format: float description: Coordinate of the top boundary. type: number readOnly: false width: format: float description: Width. type: number readOnly: false height: format: float description: Height. type: number readOnly: false ImageUrlCreateEntry: required: - url type: object properties: url: description: Url of the image. type: string readOnly: false tagIds: type: array items: format: uuid type: string readOnly: false regions: type: array items: $ref: '#/components/schemas/Region' readOnly: false 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 tagId: format: uuid description: Id of the tag associated with this region. type: string readOnly: false left: format: float description: Coordinate of the left boundary. type: number readOnly: false top: format: float description: Coordinate of the top boundary. type: number readOnly: false width: format: float description: Width. type: number readOnly: false height: format: float description: Height. type: number readOnly: false ImageTagCreateSummary: type: object properties: created: type: - array - 'null' items: $ref: '#/components/schemas/ImageTagCreateEntry' readOnly: false duplicated: type: - array - 'null' items: $ref: '#/components/schemas/ImageTagCreateEntry' readOnly: false exceeded: type: - array - 'null' items: $ref: '#/components/schemas/ImageTagCreateEntry' readOnly: false ImageCreateSummary: type: object properties: isBatchSuccessful: description: True if all of the images in the batch were created successfully, otherwise false. type: boolean readOnly: true images: description: List of the image creation results. type: array items: $ref: '#/components/schemas/ImageCreateResult' readOnly: true TagFilter: description: Model that query for counting of images whose suggested tags match given tags and their probability are greater than or equal to the given threshold. type: object properties: tagIds: description: Existing TagIds in project to get suggested tags count for. type: array items: format: uuid type: string readOnly: false threshold: format: double description: Confidence threshold to filter suggested tags on. type: number readOnly: false ImageMetadataUpdateEntry: description: Entry associating a metadata to an image. type: object properties: imageId: format: uuid description: Id of the image. type: string readOnly: false status: description: Status of the metadata update. enum: - OK - ErrorImageNotFound - ErrorLimitExceed - ErrorUnknown type: string readOnly: false x-ms-enum: name: ImageMetadataUpdateStatus modelAsString: true metadata: description: Metadata of the image. type: - object - 'null' additionalProperties: type: string readOnly: false 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 left: format: float description: Coordinate of the left boundary. type: number readOnly: false top: format: float description: Coordinate of the top boundary. type: number readOnly: false width: format: float description: Width. type: number readOnly: false height: format: float description: Height. type: number readOnly: false ImageRegion: required: - tagId - left - top - width - height type: object properties: regionId: format: uuid type: string readOnly: true tagName: type: string readOnly: true created: format: date-time type: string readOnly: true tagId: format: uuid description: Id of the tag associated with this region. type: string readOnly: false left: format: float description: Coordinate of the left boundary. type: number readOnly: false top: format: float description: Coordinate of the top boundary. type: number readOnly: false width: format: float description: Width. type: number readOnly: false height: format: float description: Height. type: number readOnly: false ImageUrlCreateBatch_2: type: - object - 'null' properties: images: type: - array - 'null' items: $ref: '#/components/schemas/ImageUrlCreateEntry_2' tagIds: type: - array - 'null' items: format: uuid type: string ImageRegionCreateResult_2: type: - object - 'null' properties: imageId: format: uuid type: string readOnly: true regionId: format: uuid type: string readOnly: true tagName: type: - string - 'null' readOnly: true created: format: date-time type: string readOnly: true tagId: format: uuid type: string left: format: float type: number top: format: float type: number width: format: float type: number height: format: float type: number ImageFileCreateEntry_2: type: - object - 'null' properties: name: type: - string - 'null' contents: format: byte type: - string - 'null' tagIds: type: - array - 'null' items: format: uuid type: string regions: type: - array - 'null' items: $ref: '#/components/schemas/Region_2' ImageIdCreateBatch_2: type: - object - 'null' properties: images: type: - array - 'null' items: $ref: '#/components/schemas/ImageIdCreateEntry_2' tagIds: type: - array - 'null' items: format: uuid type: string ImageTag_2: type: - object - 'null' properties: tagId: format: uuid type: string readOnly: true tagName: type: - string - 'null' readOnly: true created: format: date-time type: string readOnly: true ImageIdCreateEntry_2: type: - object - 'null' properties: id: format: uuid type: string tagIds: type: - array - 'null' items: format: uuid type: string regions: type: - array - 'null' items: $ref: '#/components/schemas/Region_2' Image_2: description: Image model to be sent as JSON type: - object - 'null' properties: id: format: uuid type: string readOnly: true created: format: date-time type: string readOnly: true width: format: int32 type: integer readOnly: true height: format: int32 type: integer readOnly: true imageUri: type: - string - 'null' readOnly: true thumbnailUri: type: - string - 'null' readOnly: true tags: type: - array - 'null' items: $ref: '#/components/schemas/ImageTag_2' readOnly: true regions: type: - array - 'null' items: $ref: '#/components/schemas/ImageRegion_2' readOnly: true ImageTagCreateBatch_2: type: - object - 'null' properties: tags: type: - array - 'null' items: $ref: '#/components/schemas/ImageTagCreateEntry_2' ImageTagCreateEntry_2: type: - object - 'null' properties: imageId: format: uuid type: string tagId: format: uuid type: string ImageRegionCreateSummary_2: type: - object - 'null' properties: created: type: - array - 'null' items: $ref: '#/components/schemas/ImageRegionCreateResult_2' duplicated: type: - array - 'null' items: $ref: '#/components/schemas/ImageRegionCreateEntry_2' exceeded: type: - array - 'null' items: $ref: '#/components/schemas/ImageRegionCreateEntry_2' ImageCreateResult_2: type: - object - 'null' properties: sourceUrl: type: - string - 'null' readOnly: true status: enum: - OK - OKDuplicate - ErrorSource - ErrorImageFormat - ErrorImageSize - ErrorStorage - ErrorLimitExceed - ErrorTagLimitExceed - ErrorRegionLimitExceed - ErrorUnknown type: string readOnly: true x-ms-enum: name: ImageUploadStatus modelAsString: true image: $ref: '#/components/schemas/Image_2' readOnly: true ImageFileCreateBatch_2: type: - object - 'null' properties: images: type: - array - 'null' items: $ref: '#/components/schemas/ImageFileCreateEntry_2' tagIds: type: - array - 'null' items: format: uuid type: string ImageRegionCreateBatch_2: description: Batch of image region information to create. type: - object - 'null' properties: regions: type: - array - 'null' items: $ref: '#/components/schemas/ImageRegionCreateEntry_2' ImageUrlCreateEntry_2: type: - object - 'null' properties: url: type: - string - 'null' tagIds: type: - array - 'null' items: format: uuid type: string regions: type: - array - 'null' items: $ref: '#/components/schemas/Region_2' ImageRegionCreateEntry_2: type: - object - 'null' properties: imageId: format: uuid type: string tagId: format: uuid type: string left: format: float type: number top: format: float type: number width: format: float type: number height: format: float type: number ImageTagCreateSummary_2: type: - object - 'null' properties: created: type: - array - 'null' items: $ref: '#/components/schemas/ImageTagCreateEntry_2' duplicated: type: - array - 'null' items: $ref: '#/components/schemas/ImageTagCreateEntry_2' exceeded: type: - array - 'null' items: $ref: '#/components/schemas/ImageTagCreateEntry_2' ImageCreateSummary_2: type: - object - 'null' properties: isBatchSuccessful: type: boolean readOnly: true images: type: - array - 'null' items: $ref: '#/components/schemas/ImageCreateResult_2' readOnly: true Region_2: type: - object - 'null' properties: tagId: format: uuid type: string left: format: float type: number top: format: float type: number width: format: float type: number height: format: float type: number ImageRegion_2: type: - object - 'null' properties: regionId: format: uuid type: string readOnly: true tagName: type: - string - 'null' readOnly: true created: format: date-time type: string readOnly: true tagId: format: uuid type: string left: format: float type: number top: format: float type: number width: format: float type: number height: format: float type: number parameters: ApiKey: name: Training-Key in: header required: true x-ms-client-name: ApiKey x-ms-parameter-location: client schema: type: string securitySchemes: apim_key: type: apiKey name: Training-Key in: header x-refined-from: - custom-vision-training-client-openapi-original.yml - trainingapi-openapi-original.yml x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/components/parameters/Endpoint'