Computer Vision API (2023-02-01-preview)

The Computer Vision API provides state-of-the-art algorithms to process images and return information. For example, it can be used to extract text using Read OCR, caption an image using descriptive natural language, detect objects, people, and more.

RegisterDataset

Register a new dataset.

Status codes returned:

  • 201: Operation completed successfully.
  • 400: The request was malformed.
  • 409: A dataset with the specified name already exists.

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

string

A name that can be used to uniquely identify the dataset after it has been registered.

Request headers

string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Properties for the dataset, such as the list of URIs to the annotation files.

{
  "annotationKind": "imageClassification",
  "annotationFileUris": [
    "string"
  ],
  "name": "string",
  "createdDateTime": "string",
  "updatedDateTime": "string",
  "eTag": "string",
  "authentication": {
    "kind": "none",
    "sasToken": "string"
  }
}
{
  "description": "Describes a dataset, which represents a set of images and annotations that can be used for training or testing a model.",
  "required": [
    "annotationKind",
    "createdDateTime",
    "eTag",
    "name",
    "updatedDateTime"
  ],
  "type": "object",
  "properties": {
    "annotationKind": {
      "description": "The kind of annotations contained in the annotation files.\r\nFor example, \"ImageClassification\" to specify that the annotation file contain object labels for training or testing a multiclass image classification model.",
      "enum": [
        "imageClassification",
        "imageObjectDetection"
      ],
      "type": "string"
    },
    "annotationFileUris": {
      "description": "List of absolute URIs to annotation files, each of which must be stored as a blob in an Azure Storage blob container.\r\nEach file must follow the COCO format for the specified AnnotationKind, with each image path being an absolute URI to a blob in a blob container.\r\nThe Computer Vision resource must have permission to read the annotation files and all referenced image files.\r\nThis can be done by turning on System managed identities for the Computer Vision resource, then assigning the identity to a role that has permission to read from the blob container containing the annotation and image files.",
      "maxItems": 10,
      "type": "array",
      "items": {
        "format": "uri",
        "type": "string"
      }
    },
    "name": {
      "description": "Read only. The name that is used to uniquely identify the dataset.",
      "maxLength": 255,
      "type": "string"
    },
    "createdDateTime": {
      "format": "date-time",
      "description": "Read only. The date and time when the dataset was first registered, in UTC.",
      "type": "string"
    },
    "updatedDateTime": {
      "format": "date-time",
      "description": "Read only. The date and time when the dataset was last updated, in UTC.",
      "type": "string"
    },
    "eTag": {
      "description": "Read only. The latest ETag for the dataset. May be used with the 'If-Match' header when updating or deleting a dataset.",
      "type": "string"
    },
    "authentication": {
      "description": "Describes the storage authentication settings.",
      "required": [
        "kind"
      ],
      "type": "object",
      "properties": {
        "kind": {
          "description": "The storage authentication kind.",
          "enum": [
            "none",
            "managedIdentity",
            "sas"
          ],
          "type": "string"
        },
        "sasToken": {
          "description": "Optional. The sas token to access container. Only needed when Kind = Sas.",
          "type": "string"
        }
      }
    }
  }
}

Response 201

Created

{
  "annotationKind": "imageClassification",
  "annotationFileUris": [
    "string"
  ],
  "name": "string",
  "createdDateTime": "string",
  "updatedDateTime": "string",
  "eTag": "string",
  "authentication": {
    "kind": "none",
    "sasToken": "string"
  }
}
{
  "description": "Describes a dataset, which represents a set of images and annotations that can be used for training or testing a model.",
  "required": [
    "annotationKind",
    "createdDateTime",
    "eTag",
    "name",
    "updatedDateTime"
  ],
  "type": "object",
  "properties": {
    "annotationKind": {
      "description": "The kind of annotations contained in the annotation files.\r\nFor example, \"ImageClassification\" to specify that the annotation file contain object labels for training or testing a multiclass image classification model.",
      "enum": [
        "imageClassification",
        "imageObjectDetection"
      ],
      "type": "string"
    },
    "annotationFileUris": {
      "description": "List of absolute URIs to annotation files, each of which must be stored as a blob in an Azure Storage blob container.\r\nEach file must follow the COCO format for the specified AnnotationKind, with each image path being an absolute URI to a blob in a blob container.\r\nThe Computer Vision resource must have permission to read the annotation files and all referenced image files.\r\nThis can be done by turning on System managed identities for the Computer Vision resource, then assigning the identity to a role that has permission to read from the blob container containing the annotation and image files.",
      "maxItems": 10,
      "type": "array",
      "items": {
        "format": "uri",
        "type": "string"
      }
    },
    "name": {
      "description": "Read only. The name that is used to uniquely identify the dataset.",
      "maxLength": 255,
      "type": "string"
    },
    "createdDateTime": {
      "format": "date-time",
      "description": "Read only. The date and time when the dataset was first registered, in UTC.",
      "type": "string"
    },
    "updatedDateTime": {
      "format": "date-time",
      "description": "Read only. The date and time when the dataset was last updated, in UTC.",
      "type": "string"
    },
    "eTag": {
      "description": "Read only. The latest ETag for the dataset. May be used with the 'If-Match' header when updating or deleting a dataset.",
      "type": "string"
    },
    "authentication": {
      "description": "Describes the storage authentication settings.",
      "required": [
        "kind"
      ],
      "type": "object",
      "properties": {
        "kind": {
          "description": "The storage authentication kind.",
          "enum": [
            "none",
            "managedIdentity",
            "sas"
          ],
          "type": "string"
        },
        "sasToken": {
          "description": "Optional. The sas token to access container. Only needed when Kind = Sas.",
          "type": "string"
        }
      }
    }
  }
}
{
  "annotationKind": "imageClassification",
  "annotationFileUris": [
    "string"
  ],
  "name": "string",
  "createdDateTime": "string",
  "updatedDateTime": "string",
  "eTag": "string",
  "authentication": {
    "kind": "none",
    "sasToken": "string"
  }
}
{
  "description": "Describes a dataset, which represents a set of images and annotations that can be used for training or testing a model.",
  "required": [
    "annotationKind",
    "createdDateTime",
    "eTag",
    "name",
    "updatedDateTime"
  ],
  "type": "object",
  "properties": {
    "annotationKind": {
      "description": "The kind of annotations contained in the annotation files.\r\nFor example, \"ImageClassification\" to specify that the annotation file contain object labels for training or testing a multiclass image classification model.",
      "enum": [
        "imageClassification",
        "imageObjectDetection"
      ],
      "type": "string"
    },
    "annotationFileUris": {
      "description": "List of absolute URIs to annotation files, each of which must be stored as a blob in an Azure Storage blob container.\r\nEach file must follow the COCO format for the specified AnnotationKind, with each image path being an absolute URI to a blob in a blob container.\r\nThe Computer Vision resource must have permission to read the annotation files and all referenced image files.\r\nThis can be done by turning on System managed identities for the Computer Vision resource, then assigning the identity to a role that has permission to read from the blob container containing the annotation and image files.",
      "maxItems": 10,
      "type": "array",
      "items": {
        "format": "uri",
        "type": "string"
      }
    },
    "name": {
      "description": "Read only. The name that is used to uniquely identify the dataset.",
      "maxLength": 255,
      "type": "string"
    },
    "createdDateTime": {
      "format": "date-time",
      "description": "Read only. The date and time when the dataset was first registered, in UTC.",
      "type": "string"
    },
    "updatedDateTime": {
      "format": "date-time",
      "description": "Read only. The date and time when the dataset was last updated, in UTC.",
      "type": "string"
    },
    "eTag": {
      "description": "Read only. The latest ETag for the dataset. May be used with the 'If-Match' header when updating or deleting a dataset.",
      "type": "string"
    },
    "authentication": {
      "description": "Describes the storage authentication settings.",
      "required": [
        "kind"
      ],
      "type": "object",
      "properties": {
        "kind": {
          "description": "The storage authentication kind.",
          "enum": [
            "none",
            "managedIdentity",
            "sas"
          ],
          "type": "string"
        },
        "sasToken": {
          "description": "Optional. The sas token to access container. Only needed when Kind = Sas.",
          "type": "string"
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X PUT "https://*.cognitiveservices.azure.com/computervision/datasets/{name}?api-version=2023-02-01-preview"
-H "Content-Type: application/json-patch+json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://*.cognitiveservices.azure.com/computervision/datasets/{name}?api-version=2023-02-01-preview&" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://*.cognitiveservices.azure.com/computervision/datasets/{name}?api-version=2023-02-01-preview");


            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://*.cognitiveservices.azure.com/computervision/datasets/{name}?api-version=2023-02-01-preview&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://*.cognitiveservices.azure.com/computervision/datasets/{name}?api-version=2023-02-01-preview";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // Request headers
    [_request setValue:@"application/json-patch+json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://*.cognitiveservices.azure.com/computervision/datasets/{name}?api-version=2023-02-01-preview');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PUT);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("PUT", "/computervision/datasets/{name}?api-version=2023-02-01-preview&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("PUT", "/computervision/datasets/{name}?api-version=2023-02-01-preview&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://*.cognitiveservices.azure.com/computervision/datasets/{name}?api-version=2023-02-01-preview')


request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json-patch+json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body