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.
Format - uuid. The project id.
Batch of image regions which include a tag and bounding box. Limited to 64.
{
"regions": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateBatch>
<regions>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
<ImageRegionCreateBatch>
<regions>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
OK
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
207
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The tags ids with which to tag each image. Limited to 20.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The batch of image files to add. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"name": "string",
"contents": "string",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageFileCreateBatch>
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageFileCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"id": "00000000-0000-0000-0000-000000000000",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageIdCreateBatch>
<images>
<id>00000000-0000-0000-0000-000000000000</id>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageIdCreateBatch>
<ImageIdCreateBatch>
<images>
<id>00000000-0000-0000-0000-000000000000</id>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageIdCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"url": "string",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageUrlCreateBatch>
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageUrlCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Associate a set of images with a set of tags.
Format - uuid. The project id.
Batch of image tags. Limited to 128 tags per batch.
{
"tags": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
]
}
<ImageTagCreateBatch>
<tags>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</tags>
</ImageTagCreateBatch>
<ImageTagCreateBatch>
<tags>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</tags>
</ImageTagCreateBatch>
OK
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
]
}
<ImageTagCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</exceeded>
</ImageTagCreateSummary>
<ImageTagCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</exceeded>
</ImageTagCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a project.
The description of the project.
Format - uuid. The id of the domain to use for this project. Defaults to General domain for image classification.
The type of classifier to create for this project.
List of platforms the trained model is intending exporting to.
Name of the project.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a tag for the project.
Format - uuid. The project id.
Optional description for the tag.
Optional type for the tag.
The tag name.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Delete a set of image regions.
Format - uuid. The project id.
Regions to delete. Limited to 64.
No Content
Error response
Delete images from the set of training images.
Format - uuid. The project id.
Ids of the images to be deleted. Limited to 256 images per batch.
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.
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.
Accepted
No Content
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Remove a set of tags from a set of images.
Format - uuid. The project id.
Image ids. Limited to 64 images.
Tags to be deleted from the specified images. Limited to 20 tags.
No Content
Error response
Delete a specific iteration of a project.
Format - uuid. The project id.
Format - uuid. The iteration id.
No Content
Error response
Delete a set of predicted images and their associated prediction results.
Format - uuid. The project id.
The prediction ids. Limited to 64.
No Content
Error response
Delete a specific project.
Format - uuid. The project id.
No Content
Error response
Delete a tag from the project.
Format - uuid. The project id.
Format - uuid. Id of the tag to be deleted.
No Content
Error response
Export a trained iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
The flavor of the target platform.
The target platform.
OK
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Exports a project.
Format - uuid. The project id of the project to export.
OK
{
"iterationCount": 0,
"imageCount": 0,
"tagCount": 0,
"regionCount": 0,
"estimatedImportTimeInMS": 0,
"token": "string"
}
<ProjectExport>
<iterationCount>0</iterationCount>
<imageCount>0</imageCount>
<tagCount>0</tagCount>
<regionCount>0</regionCount>
<estimatedImportTimeInMS>0</estimatedImportTimeInMS>
<token>string</token>
</ProjectExport>
<ProjectExport>
<iterationCount>0</iterationCount>
<imageCount>0</imageCount>
<tagCount>0</tagCount>
<regionCount>0</regionCount>
<estimatedImportTimeInMS>0</estimatedImportTimeInMS>
<token>string</token>
</ProjectExport>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get artifact content from blob storage, based on artifact relative path in the blob.
Format - uuid. The project id.
The relative path for artifact.
OK
Error response
Get information about a specific domain.
Format - uuid. The id of the domain to get information about.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
<Domain>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
<Domain>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a list of the available domains.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
]
<DomainArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
<DomainArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the list of exports for a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
OK
[
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
]
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.
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'.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdImagesCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesCountGet200TextXmlResponse>0</ProjectsProjectIdImagesCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200Applicatio-1>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200Applicatio-1>
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlRes>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlRes>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImagePerformanceArray>
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImagePerformanceArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The image id.
OK
{
"projectId": "00000000-0000-0000-0000-000000000000",
"imageId": "00000000-0000-0000-0000-000000000000",
"proposals": [
{
"confidence": 0.0,
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
<ImageRegionProposal>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<proposals>
<confidence>0</confidence>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</proposals>
</ImageRegionProposal>
<ImageRegionProposal>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<proposals>
<confidence>0</confidence>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</proposals>
</ImageRegionProposal>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.
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'.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The list of image ids to retrieve. Limited to 256.
Format - uuid. The iteration id. Defaults to workspace.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get detailed performance information about an iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
Format - float. The threshold used to determine true predictions.
Format - float. If applicable, the bounding box overlap threshold used to determine true predictions.
OK
{
"perTagPerformance": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
],
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
<IterationPerformance>
<perTagPerformance>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
<IterationPerformance>
<perTagPerformance>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get iterations for the project.
Format - uuid. The project id.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
]
<IterationArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
<IterationArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific project.
Format - uuid. The id of the project to get.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get your projects.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
]
<ProjectArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</ProjectArray>
<ProjectArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</ProjectArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get information about a specific tag.
Format - uuid. The project this tag belongs to.
Format - uuid. The tag id.
Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the tags for a given project and iteration.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
]
<TagArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
<TagArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
OK
0
<ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Imports a project.
Optional, name of the project to use instead of auto-generated name.
Token generated from the export project call.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Publish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
Whether to overwrite the published model with the given name (default: false).
The name to give the published iteration.
The id of the prediction resource to publish to.
OK
True
<ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>
<ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get images that were sent to your prediction endpoint.
Format - uuid. The project id.
Parameters used to query the predictions. Limited to combining 2 tags.
{
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "00000000-0000-0000-0000-000000000000",
"startTime": "string",
"endTime": "string",
"application": "string"
}
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
OK
{
"token": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "00000000-0000-0000-0000-000000000000",
"startTime": "string",
"endTime": "string",
"application": "string"
},
"results": [
{
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "00000000-0000-0000-0000-000000000000",
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
]
}
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</results>
</PredictionQueryResult>
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</results>
</PredictionQueryResult>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API takes in tagIds to get count of untagged images per suggested tags for a given threshold.
Format - uuid. The project id.
Model that contains tagIds, threshold and projectType to query by.
Format - uuid. IterationId to use for the suggested tags and regions.
{
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0
}
<TagFilter>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
</TagFilter>
<TagFilter>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
</TagFilter>
OK
{}
<ProjectsProjectIdImagesSuggestedCountPost200ApplicationXmlResponse />
<ProjectsProjectIdImagesSuggestedCountPost200TextXmlResponse />
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.
Format - uuid. The project id.
Contains properties we need to query suggested images.
Format - uuid. IterationId to use for the suggested tags and regions.
{
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0,
"session": "string",
"continuation": "string",
"maxCount": 0,
"sortBy": "UncertaintyAscending"
}
<SuggestedTagAndRegionQueryToken>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</SuggestedTagAndRegionQueryToken>
<SuggestedTagAndRegionQueryToken>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</SuggestedTagAndRegionQueryToken>
OK
{
"token": {
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0,
"session": "string",
"continuation": "string",
"maxCount": 0,
"sortBy": "UncertaintyAscending"
},
"results": [
{
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "00000000-0000-0000-0000-000000000000",
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"predictionUncertainty": 0.0
}
]
}
<SuggestedTagAndRegionQuery>
<token>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</token>
<results>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</results>
</SuggestedTagAndRegionQuery>
<SuggestedTagAndRegionQuery>
<token>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</token>
<results>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</results>
</SuggestedTagAndRegionQuery>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image.
Format - uuid. The project id.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image url.
Format - uuid. The project to evaluate against.
An ImageUrl that contains the url of the image to be evaluated.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.
{
"url": "string"
}
<ImageUrl>
<url>string</url>
</ImageUrl>
<ImageUrl>
<url>string</url>
</ImageUrl>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API will get suggested tags and regions for an array/batch of images along with confidences for the tags. It returns an empty array if no tags are found.
There is a limit of 64 images in the batch.
Format - uuid. The project id.
Format - uuid. IterationId to use for tag and region suggestion.
Array of image ids tag suggestion are needed for. Use GetImages API to get imageIds.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"predictionUncertainty": 0.0
}
]
<SuggestedTagAndRegionArray>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</SuggestedTagAndRegionArray>
<SuggestedTagAndRegionArray>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</SuggestedTagAndRegionArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Queues project for training.
Format - uuid. The project id.
Additional training parameters passed in to control how the project is trained.
The type of training to use to train the project (default: Regular).
Format - int32. The number of hours reserved as budget for training (if applicable).
Whether to force train even if dataset and configuration does not change (default: false).
The email address to send notification to when training finishes (default: null).
{
"selectedTags": [
"00000000-0000-0000-0000-000000000000"
]
}
<TrainingParameters>
<selectedTags>00000000-0000-0000-0000-000000000000</selectedTags>
</TrainingParameters>
<TrainingParameters>
<selectedTags>00000000-0000-0000-0000-000000000000</selectedTags>
</TrainingParameters>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Unpublish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
No Content
Error response
This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images.
Format - uuid. The project id.
The metadata to be updated to the specified images. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limied to 256.
The list of image ids to update. Limited to 64.
{}
<Metadata />
<Metadata />
OK
{
"isBatchSuccessful": true,
"images": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"status": "OK",
"metadata": {}
}
]
}
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"status": "OK",
"metadata": {}
}
]
}
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a specific iteration.
Format - uuid. Project id.
Format - uuid. Iteration id.
The updated iteration model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a specific project.
Format - uuid. The id of the project to update.
The updated project model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a tag.
Format - uuid. The project id.
Format - uuid. The id of the target tag.
The updated tag model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Batch of image regions which include a tag and bounding box. Limited to 64.
{
"regions": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateBatch>
<regions>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
<ImageRegionCreateBatch>
<regions>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
OK
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
207
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The tags ids with which to tag each image. Limited to 20.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The batch of image files to add. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"name": "string",
"contents": "string",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageFileCreateBatch>
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageFileCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"id": "00000000-0000-0000-0000-000000000000",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageIdCreateBatch>
<images>
<id>00000000-0000-0000-0000-000000000000</id>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageIdCreateBatch>
<ImageIdCreateBatch>
<images>
<id>00000000-0000-0000-0000-000000000000</id>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageIdCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"url": "string",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageUrlCreateBatch>
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageUrlCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Associate a set of images with a set of tags.
Format - uuid. The project id.
Batch of image tags. Limited to 128 tags per batch.
{
"tags": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
]
}
<ImageTagCreateBatch>
<tags>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</tags>
</ImageTagCreateBatch>
<ImageTagCreateBatch>
<tags>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</tags>
</ImageTagCreateBatch>
OK
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
]
}
<ImageTagCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</exceeded>
</ImageTagCreateSummary>
<ImageTagCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</exceeded>
</ImageTagCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a project.
The description of the project.
Format - uuid. The id of the domain to use for this project. Defaults to General domain for image classification.
The type of classifier to create for this project.
List of platforms the trained model is intending exporting to.
Name of the project.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a tag for the project.
Format - uuid. The project id.
Optional description for the tag.
Optional type for the tag.
The tag name.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Delete a set of image regions.
Format - uuid. The project id.
Regions to delete. Limited to 64.
No Content
Error response
Delete images from the set of training images.
Format - uuid. The project id.
Ids of the images to be deleted. Limited to 256 images per batch.
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.
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.
Accepted
No Content
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Remove a set of tags from a set of images.
Format - uuid. The project id.
Image ids. Limited to 64 images.
Tags to be deleted from the specified images. Limited to 20 tags.
No Content
Error response
Delete a specific iteration of a project.
Format - uuid. The project id.
Format - uuid. The iteration id.
No Content
Error response
Delete a set of predicted images and their associated prediction results.
Format - uuid. The project id.
The prediction ids. Limited to 64.
No Content
Error response
Delete a specific project.
Format - uuid. The project id.
No Content
Error response
Delete a tag from the project.
Format - uuid. The project id.
Format - uuid. Id of the tag to be deleted.
No Content
Error response
Export a trained iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
The flavor of the target platform.
The target platform.
OK
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Exports a project.
Format - uuid. The project id of the project to export.
OK
{
"iterationCount": 0,
"imageCount": 0,
"tagCount": 0,
"regionCount": 0,
"estimatedImportTimeInMS": 0,
"token": "string"
}
<ProjectExport>
<iterationCount>0</iterationCount>
<imageCount>0</imageCount>
<tagCount>0</tagCount>
<regionCount>0</regionCount>
<estimatedImportTimeInMS>0</estimatedImportTimeInMS>
<token>string</token>
</ProjectExport>
<ProjectExport>
<iterationCount>0</iterationCount>
<imageCount>0</imageCount>
<tagCount>0</tagCount>
<regionCount>0</regionCount>
<estimatedImportTimeInMS>0</estimatedImportTimeInMS>
<token>string</token>
</ProjectExport>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get artifact content from blob storage, based on artifact relative path in the blob.
Format - uuid. The project id.
The relative path for artifact.
OK
Error response
Get information about a specific domain.
Format - uuid. The id of the domain to get information about.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
<Domain>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
<Domain>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a list of the available domains.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
]
<DomainArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
<DomainArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the list of exports for a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
OK
[
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
]
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.
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'.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdImagesCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesCountGet200TextXmlResponse>0</ProjectsProjectIdImagesCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200Applicatio-1>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200Applicatio-1>
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlRes>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlRes>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImagePerformanceArray>
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImagePerformanceArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The image id.
OK
{
"projectId": "00000000-0000-0000-0000-000000000000",
"imageId": "00000000-0000-0000-0000-000000000000",
"proposals": [
{
"confidence": 0.0,
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
<ImageRegionProposal>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<proposals>
<confidence>0</confidence>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</proposals>
</ImageRegionProposal>
<ImageRegionProposal>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<proposals>
<confidence>0</confidence>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</proposals>
</ImageRegionProposal>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.
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'.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The list of image ids to retrieve. Limited to 256.
Format - uuid. The iteration id. Defaults to workspace.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get detailed performance information about an iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
Format - float. The threshold used to determine true predictions.
Format - float. If applicable, the bounding box overlap threshold used to determine true predictions.
OK
{
"perTagPerformance": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
],
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
<IterationPerformance>
<perTagPerformance>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
<IterationPerformance>
<perTagPerformance>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get iterations for the project.
Format - uuid. The project id.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
]
<IterationArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
<IterationArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific project.
Format - uuid. The id of the project to get.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get your projects.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
]
<ProjectArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</ProjectArray>
<ProjectArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</ProjectArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get information about a specific tag.
Format - uuid. The project this tag belongs to.
Format - uuid. The tag id.
Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the tags for a given project and iteration.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
]
<TagArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
<TagArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
OK
0
<ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Imports a project.
Optional, name of the project to use instead of auto-generated name.
Token generated from the export project call.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Publish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
Whether to overwrite the published model with the given name (default: false).
The name to give the published iteration.
The id of the prediction resource to publish to.
OK
True
<ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>
<ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get images that were sent to your prediction endpoint.
Format - uuid. The project id.
Parameters used to query the predictions. Limited to combining 2 tags.
{
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "00000000-0000-0000-0000-000000000000",
"startTime": "string",
"endTime": "string",
"application": "string"
}
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
OK
{
"token": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "00000000-0000-0000-0000-000000000000",
"startTime": "string",
"endTime": "string",
"application": "string"
},
"results": [
{
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "00000000-0000-0000-0000-000000000000",
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
]
}
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</results>
</PredictionQueryResult>
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</results>
</PredictionQueryResult>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API takes in tagIds to get count of untagged images per suggested tags for a given threshold.
Format - uuid. The project id.
Model that contains tagIds, threshold and projectType to query by.
Format - uuid. IterationId to use for the suggested tags and regions.
{
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0
}
<TagFilter>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
</TagFilter>
<TagFilter>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
</TagFilter>
OK
{}
<ProjectsProjectIdImagesSuggestedCountPost200ApplicationXmlResponse />
<ProjectsProjectIdImagesSuggestedCountPost200TextXmlResponse />
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.
Format - uuid. The project id.
Contains properties we need to query suggested images.
Format - uuid. IterationId to use for the suggested tags and regions.
{
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0,
"session": "string",
"continuation": "string",
"maxCount": 0,
"sortBy": "UncertaintyAscending"
}
<SuggestedTagAndRegionQueryToken>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</SuggestedTagAndRegionQueryToken>
<SuggestedTagAndRegionQueryToken>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</SuggestedTagAndRegionQueryToken>
OK
{
"token": {
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0,
"session": "string",
"continuation": "string",
"maxCount": 0,
"sortBy": "UncertaintyAscending"
},
"results": [
{
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "00000000-0000-0000-0000-000000000000",
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"predictionUncertainty": 0.0
}
]
}
<SuggestedTagAndRegionQuery>
<token>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</token>
<results>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</results>
</SuggestedTagAndRegionQuery>
<SuggestedTagAndRegionQuery>
<token>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</token>
<results>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</results>
</SuggestedTagAndRegionQuery>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image.
Format - uuid. The project id.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image url.
Format - uuid. The project to evaluate against.
An ImageUrl that contains the url of the image to be evaluated.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.
{
"url": "string"
}
<ImageUrl>
<url>string</url>
</ImageUrl>
<ImageUrl>
<url>string</url>
</ImageUrl>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API will get suggested tags and regions for an array/batch of images along with confidences for the tags. It returns an empty array if no tags are found.
There is a limit of 64 images in the batch.
Format - uuid. The project id.
Format - uuid. IterationId to use for tag and region suggestion.
Array of image ids tag suggestion are needed for. Use GetImages API to get imageIds.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"predictionUncertainty": 0.0
}
]
<SuggestedTagAndRegionArray>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</SuggestedTagAndRegionArray>
<SuggestedTagAndRegionArray>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</SuggestedTagAndRegionArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Queues project for training.
Format - uuid. The project id.
Additional training parameters passed in to control how the project is trained.
The type of training to use to train the project (default: Regular).
Format - int32. The number of hours reserved as budget for training (if applicable).
Whether to force train even if dataset and configuration does not change (default: false).
The email address to send notification to when training finishes (default: null).
{
"selectedTags": [
"00000000-0000-0000-0000-000000000000"
]
}
<TrainingParameters>
<selectedTags>00000000-0000-0000-0000-000000000000</selectedTags>
</TrainingParameters>
<TrainingParameters>
<selectedTags>00000000-0000-0000-0000-000000000000</selectedTags>
</TrainingParameters>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Unpublish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
No Content
Error response
This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images.
Format - uuid. The project id.
The metadata to be updated to the specified images. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limied to 256.
The list of image ids to update. Limited to 64.
{}
<Metadata />
<Metadata />
OK
{
"isBatchSuccessful": true,
"images": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"status": "OK",
"metadata": {}
}
]
}
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"status": "OK",
"metadata": {}
}
]
}
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a specific iteration.
Format - uuid. Project id.
Format - uuid. Iteration id.
The updated iteration model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a specific project.
Format - uuid. The id of the project to update.
The updated project model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a tag.
Format - uuid. The project id.
Format - uuid. The id of the target tag.
The updated tag model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Batch of image regions which include a tag and bounding box. Limited to 64.
{
"regions": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateBatch>
<regions>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
<ImageRegionCreateBatch>
<regions>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</ImageRegionCreateBatch>
OK
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
207
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
<ImageRegionCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</exceeded>
</ImageRegionCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The tags ids with which to tag each image. Limited to 20.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The batch of image files to add. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"name": "string",
"contents": "string",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageFileCreateBatch>
<ImageFileCreateBatch>
<images>
<name>string</name>
<contents>string</contents>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageFileCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"id": "00000000-0000-0000-0000-000000000000",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageIdCreateBatch>
<images>
<id>00000000-0000-0000-0000-000000000000</id>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageIdCreateBatch>
<ImageIdCreateBatch>
<images>
<id>00000000-0000-0000-0000-000000000000</id>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageIdCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.
{
"images": [
{
"url": "string",
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"regions": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
]
}
],
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"metadata": {}
}
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageUrlCreateBatch>
<ImageUrlCreateBatch>
<images>
<url>string</url>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<regions>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
</images>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<metadata />
</ImageUrlCreateBatch>
OK
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"sourceUrl": "string",
"status": "OK",
"image": {
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
}
]
}
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
<ImageCreateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<sourceUrl>string</sourceUrl>
<status>OK</status>
<image>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</image>
</images>
</ImageCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Associate a set of images with a set of tags.
Format - uuid. The project id.
Batch of image tags. Limited to 128 tags per batch.
{
"tags": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
]
}
<ImageTagCreateBatch>
<tags>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</tags>
</ImageTagCreateBatch>
<ImageTagCreateBatch>
<tags>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</tags>
</ImageTagCreateBatch>
OK
{
"created": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
],
"duplicated": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
],
"exceeded": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"tagId": "00000000-0000-0000-0000-000000000000"
}
]
}
<ImageTagCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</exceeded>
</ImageTagCreateSummary>
<ImageTagCreateSummary>
<created>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</created>
<duplicated>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</duplicated>
<exceeded>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
</exceeded>
</ImageTagCreateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a project.
The description of the project.
Format - uuid. The id of the domain to use for this project. Defaults to General domain for image classification.
The type of classifier to create for this project.
List of platforms the trained model is intending exporting to.
Name of the project.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Create a tag for the project.
Format - uuid. The project id.
Optional description for the tag.
Optional type for the tag.
The tag name.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Delete a set of image regions.
Format - uuid. The project id.
Regions to delete. Limited to 64.
No Content
Error response
Delete images from the set of training images.
Format - uuid. The project id.
Ids of the images to be deleted. Limited to 256 images per batch.
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.
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.
Accepted
No Content
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Remove a set of tags from a set of images.
Format - uuid. The project id.
Image ids. Limited to 64 images.
Tags to be deleted from the specified images. Limited to 20 tags.
No Content
Error response
Delete a specific iteration of a project.
Format - uuid. The project id.
Format - uuid. The iteration id.
No Content
Error response
Delete a set of predicted images and their associated prediction results.
Format - uuid. The project id.
The prediction ids. Limited to 64.
No Content
Error response
Delete a specific project.
Format - uuid. The project id.
No Content
Error response
Delete a tag from the project.
Format - uuid. The project id.
Format - uuid. Id of the tag to be deleted.
No Content
Error response
Export a trained iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
The flavor of the target platform.
The target platform.
OK
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
<Export>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</Export>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Exports a project.
Format - uuid. The project id of the project to export.
OK
{
"iterationCount": 0,
"imageCount": 0,
"tagCount": 0,
"regionCount": 0,
"estimatedImportTimeInMS": 0,
"token": "string"
}
<ProjectExport>
<iterationCount>0</iterationCount>
<imageCount>0</imageCount>
<tagCount>0</tagCount>
<regionCount>0</regionCount>
<estimatedImportTimeInMS>0</estimatedImportTimeInMS>
<token>string</token>
</ProjectExport>
<ProjectExport>
<iterationCount>0</iterationCount>
<imageCount>0</imageCount>
<tagCount>0</tagCount>
<regionCount>0</regionCount>
<estimatedImportTimeInMS>0</estimatedImportTimeInMS>
<token>string</token>
</ProjectExport>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get artifact content from blob storage, based on artifact relative path in the blob.
Format - uuid. The project id.
The relative path for artifact.
OK
Error response
Get information about a specific domain.
Format - uuid. The id of the domain to get information about.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
<Domain>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
<Domain>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</Domain>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a list of the available domains.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"type": "Classification",
"exportable": true,
"enabled": true
}
]
<DomainArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
<DomainArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<type>Classification</type>
<exportable>true</exportable>
<enabled>true</enabled>
</DomainArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the list of exports for a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
OK
[
{
"platform": "CoreML",
"status": "Exporting",
"downloadUri": "string",
"flavor": "Linux",
"newerVersionAvailable": true
}
]
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
<ExportArray>
<platform>CoreML</platform>
<status>Exporting</status>
<downloadUri>string</downloadUri>
<flavor>Linux</flavor>
<newerVersionAvailable>true</newerVersionAvailable>
</ExportArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.
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'.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdImagesCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesCountGet200TextXmlResponse>0</ProjectsProjectIdImagesCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200Applicatio-1>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200Applicatio-1>
<ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlRes>0</ProjectsProjectIdIterationsIterationIdPerformanceImagesCountGet200TextXmlRes>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImagePerformanceArray>
<ImagePerformanceArray>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImagePerformanceArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The image id.
OK
{
"projectId": "00000000-0000-0000-0000-000000000000",
"imageId": "00000000-0000-0000-0000-000000000000",
"proposals": [
{
"confidence": 0.0,
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
}
]
}
<ImageRegionProposal>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<proposals>
<confidence>0</confidence>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</proposals>
</ImageRegionProposal>
<ImageRegionProposal>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<proposals>
<confidence>0</confidence>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
</proposals>
</ImageRegionProposal>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.
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'.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
The list of image ids to retrieve. Limited to 256.
Format - uuid. The iteration id. Defaults to workspace.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get detailed performance information about an iteration.
Format - uuid. The id of the project the iteration belongs to.
Format - uuid. The id of the iteration to get.
Format - float. The threshold used to determine true predictions.
Format - float. If applicable, the bounding box overlap threshold used to determine true predictions.
OK
{
"perTagPerformance": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
],
"precision": 0.0,
"precisionStdDeviation": 0.0,
"recall": 0.0,
"recallStdDeviation": 0.0,
"averagePrecision": 0.0
}
<IterationPerformance>
<perTagPerformance>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
<IterationPerformance>
<perTagPerformance>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</perTagPerformance>
<precision>0</precision>
<precisionStdDeviation>0</precisionStdDeviation>
<recall>0</recall>
<recallStdDeviation>0</recallStdDeviation>
<averagePrecision>0</averagePrecision>
</IterationPerformance>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get iterations for the project.
Format - uuid. The project id.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
]
<IterationArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
<IterationArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</IterationArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get a specific project.
Format - uuid. The id of the project to get.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get your projects.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
]
<ProjectArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</ProjectArray>
<ProjectArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</ProjectArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get information about a specific tag.
Format - uuid. The project this tag belongs to.
Format - uuid. The tag id.
Format - uuid. The iteration to retrieve this tag from. Optional, defaults to current training set.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images to count. Defaults to all tags when null.
OK
0
<ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesTaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get the tags for a given project and iteration.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
]
<TagArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
<TagArray>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</TagArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
OK
0
<ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200ApplicationXmlResponse>
<ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>0</ProjectsProjectIdImagesUntaggedCountGet200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
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.
Format - uuid. The project id.
Format - uuid. The iteration id. Defaults to workspace.
The ordering. Defaults to newest.
Format - int32. Maximum number of images to return. Defaults to 50, limited to 256.
Format - int32. Number of images to skip before beginning the image batch. Defaults to 0.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"created": "string",
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"tags": [
{
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string"
}
],
"regions": [
{
"regionId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"created": "string",
"tagId": "00000000-0000-0000-0000-000000000000",
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
}
],
"metadata": {}
}
]
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
<ImageArray>
<id>00000000-0000-0000-0000-000000000000</id>
<created>string</created>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<tags>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<created>string</created>
</tags>
<regions>
<regionId>00000000-0000-0000-0000-000000000000</regionId>
<tagName>string</tagName>
<created>string</created>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</regions>
<metadata />
</ImageArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Imports a project.
Optional, name of the project to use instead of auto-generated name.
Token generated from the export project call.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Publish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
Whether to overwrite the published model with the given name (default: false).
The name to give the published iteration.
The id of the prediction resource to publish to.
OK
True
<ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200ApplicationXmlResponse>
<ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>true</ProjectsProjectIdIterationsIterationIdPublishPost200TextXmlResponse>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Get images that were sent to your prediction endpoint.
Format - uuid. The project id.
Parameters used to query the predictions. Limited to combining 2 tags.
{
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "00000000-0000-0000-0000-000000000000",
"startTime": "string",
"endTime": "string",
"application": "string"
}
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
<PredictionQueryToken>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</PredictionQueryToken>
OK
{
"token": {
"session": "string",
"continuation": "string",
"maxCount": 0,
"orderBy": "Newest",
"tags": [
{
"id": "00000000-0000-0000-0000-000000000000",
"minThreshold": 0.0,
"maxThreshold": 0.0
}
],
"iterationId": "00000000-0000-0000-0000-000000000000",
"startTime": "string",
"endTime": "string",
"application": "string"
},
"results": [
{
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "00000000-0000-0000-0000-000000000000",
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
]
}
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</results>
</PredictionQueryResult>
<PredictionQueryResult>
<token>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<orderBy>Newest</orderBy>
<tags>
<id>00000000-0000-0000-0000-000000000000</id>
<minThreshold>0</minThreshold>
<maxThreshold>0</maxThreshold>
</tags>
<iterationId>00000000-0000-0000-0000-000000000000</iterationId>
<startTime>string</startTime>
<endTime>string</endTime>
<application>string</application>
</token>
<results>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</results>
</PredictionQueryResult>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API takes in tagIds to get count of untagged images per suggested tags for a given threshold.
Format - uuid. The project id.
Model that contains tagIds, threshold and projectType to query by.
Format - uuid. IterationId to use for the suggested tags and regions.
{
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0
}
<TagFilter>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
</TagFilter>
<TagFilter>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
</TagFilter>
OK
{}
<ProjectsProjectIdImagesSuggestedCountPost200ApplicationXmlResponse />
<ProjectsProjectIdImagesSuggestedCountPost200TextXmlResponse />
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.
Format - uuid. The project id.
Contains properties we need to query suggested images.
Format - uuid. IterationId to use for the suggested tags and regions.
{
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0,
"session": "string",
"continuation": "string",
"maxCount": 0,
"sortBy": "UncertaintyAscending"
}
<SuggestedTagAndRegionQueryToken>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</SuggestedTagAndRegionQueryToken>
<SuggestedTagAndRegionQueryToken>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</SuggestedTagAndRegionQueryToken>
OK
{
"token": {
"tagIds": [
"00000000-0000-0000-0000-000000000000"
],
"threshold": 0.0,
"session": "string",
"continuation": "string",
"maxCount": 0,
"sortBy": "UncertaintyAscending"
},
"results": [
{
"width": 0,
"height": 0,
"resizedImageUri": "string",
"thumbnailUri": "string",
"originalImageUri": "string",
"domain": "00000000-0000-0000-0000-000000000000",
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"predictionUncertainty": 0.0
}
]
}
<SuggestedTagAndRegionQuery>
<token>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</token>
<results>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</results>
</SuggestedTagAndRegionQuery>
<SuggestedTagAndRegionQuery>
<token>
<tagIds>00000000-0000-0000-0000-000000000000</tagIds>
<threshold>0</threshold>
<session>string</session>
<continuation>string</continuation>
<maxCount>0</maxCount>
<sortBy>UncertaintyAscending</sortBy>
</token>
<results>
<width>0</width>
<height>0</height>
<resizedImageUri>string</resizedImageUri>
<thumbnailUri>string</thumbnailUri>
<originalImageUri>string</originalImageUri>
<domain>00000000-0000-0000-0000-000000000000</domain>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</results>
</SuggestedTagAndRegionQuery>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image.
Format - uuid. The project id.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.
Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Quick test an image url.
Format - uuid. The project to evaluate against.
An ImageUrl that contains the url of the image to be evaluated.
Format - uuid. Optional. Specifies the id of a particular iteration to evaluate against.
The default iteration for the project will be used when not specified.
Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.
{
"url": "string"
}
<ImageUrl>
<url>string</url>
</ImageUrl>
<ImageUrl>
<url>string</url>
</ImageUrl>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
]
}
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
<ImagePrediction>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
</ImagePrediction>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
This API will get suggested tags and regions for an array/batch of images along with confidences for the tags. It returns an empty array if no tags are found.
There is a limit of 64 images in the batch.
Format - uuid. The project id.
Format - uuid. IterationId to use for tag and region suggestion.
Array of image ids tag suggestion are needed for. Use GetImages API to get imageIds.
OK
[
{
"id": "00000000-0000-0000-0000-000000000000",
"project": "00000000-0000-0000-0000-000000000000",
"iteration": "00000000-0000-0000-0000-000000000000",
"created": "string",
"predictions": [
{
"probability": 0.0,
"tagId": "00000000-0000-0000-0000-000000000000",
"tagName": "string",
"boundingBox": {
"left": 0.0,
"top": 0.0,
"width": 0.0,
"height": 0.0
},
"tagType": "Regular"
}
],
"predictionUncertainty": 0.0
}
]
<SuggestedTagAndRegionArray>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</SuggestedTagAndRegionArray>
<SuggestedTagAndRegionArray>
<id>00000000-0000-0000-0000-000000000000</id>
<project>00000000-0000-0000-0000-000000000000</project>
<iteration>00000000-0000-0000-0000-000000000000</iteration>
<created>string</created>
<predictions>
<probability>0</probability>
<tagId>00000000-0000-0000-0000-000000000000</tagId>
<tagName>string</tagName>
<boundingBox>
<left>0</left>
<top>0</top>
<width>0</width>
<height>0</height>
</boundingBox>
<tagType>Regular</tagType>
</predictions>
<predictionUncertainty>0</predictionUncertainty>
</SuggestedTagAndRegionArray>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Queues project for training.
Format - uuid. The project id.
Additional training parameters passed in to control how the project is trained.
The type of training to use to train the project (default: Regular).
Format - int32. The number of hours reserved as budget for training (if applicable).
Whether to force train even if dataset and configuration does not change (default: false).
The email address to send notification to when training finishes (default: null).
{
"selectedTags": [
"00000000-0000-0000-0000-000000000000"
]
}
<TrainingParameters>
<selectedTags>00000000-0000-0000-0000-000000000000</selectedTags>
</TrainingParameters>
<TrainingParameters>
<selectedTags>00000000-0000-0000-0000-000000000000</selectedTags>
</TrainingParameters>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Unpublish a specific iteration.
Format - uuid. The project id.
Format - uuid. The iteration id.
No Content
Error response
This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images.
Format - uuid. The project id.
The metadata to be updated to the specified images. Limited to 10 key-value pairs per image. The length of key is limited to 128. The length of value is limied to 256.
The list of image ids to update. Limited to 64.
{}
<Metadata />
<Metadata />
OK
{
"isBatchSuccessful": true,
"images": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"status": "OK",
"metadata": {}
}
]
}
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
207
{
"isBatchSuccessful": true,
"images": [
{
"imageId": "00000000-0000-0000-0000-000000000000",
"status": "OK",
"metadata": {}
}
]
}
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
<ImageMetadataUpdateSummary>
<isBatchSuccessful>true</isBatchSuccessful>
<images>
<imageId>00000000-0000-0000-0000-000000000000</imageId>
<status>OK</status>
<metadata />
</images>
</ImageMetadataUpdateSummary>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a specific iteration.
Format - uuid. Project id.
Format - uuid. Iteration id.
The updated iteration model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"status": "string",
"created": "string",
"lastModified": "string",
"trainedAt": "string",
"projectId": "00000000-0000-0000-0000-000000000000",
"exportable": true,
"exportableTo": [
"CoreML"
],
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"trainingType": "Regular",
"reservedBudgetInHours": 0,
"trainingTimeInMinutes": 0,
"publishName": "string",
"originalPublishResourceId": "string"
}
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
<Iteration>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<status>string</status>
<created>string</created>
<lastModified>string</lastModified>
<trainedAt>string</trainedAt>
<projectId>00000000-0000-0000-0000-000000000000</projectId>
<exportable>true</exportable>
<exportableTo>CoreML</exportableTo>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<trainingType>Regular</trainingType>
<reservedBudgetInHours>0</reservedBudgetInHours>
<trainingTimeInMinutes>0</trainingTimeInMinutes>
<publishName>string</publishName>
<originalPublishResourceId>string</originalPublishResourceId>
</Iteration>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a specific project.
Format - uuid. The id of the project to update.
The updated project model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"settings": {
"domainId": "00000000-0000-0000-0000-000000000000",
"classificationType": "Multiclass",
"targetExportPlatforms": [
"CoreML"
],
"useNegativeSet": true,
"detectionParameters": "string",
"imageProcessingSettings": {
"augmentationMethods": {}
}
},
"created": "string",
"lastModified": "string",
"thumbnailUri": "string",
"drModeEnabled": true,
"status": "Succeeded"
}
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
<Project>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<settings>
<domainId>00000000-0000-0000-0000-000000000000</domainId>
<classificationType>Multiclass</classificationType>
<targetExportPlatforms>CoreML</targetExportPlatforms>
<useNegativeSet>true</useNegativeSet>
<detectionParameters>string</detectionParameters>
<imageProcessingSettings>
<augmentationMethods />
</imageProcessingSettings>
</settings>
<created>string</created>
<lastModified>string</lastModified>
<thumbnailUri>string</thumbnailUri>
<drModeEnabled>true</drModeEnabled>
<status>Succeeded</status>
</Project>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
Update a tag.
Format - uuid. The project id.
Format - uuid. The id of the target tag.
The updated tag model.
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
OK
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "string",
"description": "string",
"type": "Regular",
"imageCount": 0
}
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
<Tag>
<id>00000000-0000-0000-0000-000000000000</id>
<name>string</name>
<description>string</description>
<type>Regular</type>
<imageCount>0</imageCount>
</Tag>
Error response
{
"code": "NoError",
"message": "string"
}
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>
<CustomVisionError>
<code>NoError</code>
<message>string</message>
</CustomVisionError>