Computer Vision API (2022-10-12-preview)
Analyze
Analyze the input image. The request either contains image stream with any content type ['image/*', 'application/octet-stream'], or a JSON payload which includes an url property to be used to retrieve the image stream.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
The visual features requested: tags, objects, description, read, smartCrops, people.
The desired language for output generation. If this parameter is not specified, the default value is "en". See https://aka.ms/cv-languages for a list of supported languages.
A list of aspect ratios to use for smart cropping. Aspect ratios are calculated by dividing the target crop width by the height. Multiple values should be comma-separated.
Request headers
Request body
A JSON document with a URL pointing to the image that is to be analyzed.
{
"url": "string"
}
{
"description": "A JSON document with a URL pointing to the image that is to be analyzed.",
"required": [
"url"
],
"type": "object",
"properties": {
"url": {
"description": "Publicly reachable URL of an image.",
"type": "string"
}
}
}
[Binary image data]
Response 200
Success
Response 500
Error
{
"error": {
"code": "string",
"message": "string"
}
}
{
"description": "Response returned when an error occurs.",
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"description": "Detailed information about the error that occurred.",
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "Error code.\r\n- InvalidRequest: The request was malformed.\r\n- NotFound: The specified resource was not found.\r\n- ResourceModified: The resource has been modified and its ETag no longer matches the given value.\r\n- AlreadyExists: The resource cannot be created because another resource with the same name already exists.\r\n- ForbiddenByDRMode: The specified operation is currently unavailable.",
"type": "string"
},
"message": {
"description": "A message describing the error that occurred.",
"type": "string"
}
}
}
}
}
{
"error": {
"code": "string",
"message": "string"
}
}
{
"description": "Response returned when an error occurs.",
"required": [
"error"
],
"type": "object",
"properties": {
"error": {
"description": "Detailed information about the error that occurred.",
"required": [
"code",
"message"
],
"type": "object",
"properties": {
"code": {
"description": "Error code.\r\n- InvalidRequest: The request was malformed.\r\n- NotFound: The specified resource was not found.\r\n- ResourceModified: The resource has been modified and its ETag no longer matches the given value.\r\n- AlreadyExists: The resource cannot be created because another resource with the same name already exists.\r\n- ForbiddenByDRMode: The specified operation is currently unavailable.",
"type": "string"
},
"message": {
"description": "A message describing the error that occurred.",
"type": "string"
}
}
}
}
}
Code samples
@ECHO OFF
curl -v -X POST "https://switzerlandnorth.api.cognitive.microsoft.com/computervision/imageanalysis:analyze?api-version=2022-10-12-preview?features={string}&language=en&smartcrops-aspect-ratios={string}"
-H "Content-Type: application/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}");
// Request parameters
queryString["features"] = "{string}";
queryString["language"] = "en";
queryString["smartcrops-aspect-ratios"] = "{string}";
var uri = "https://switzerlandnorth.api.cognitive.microsoft.com/computervision/imageanalysis:analyze?api-version=2022-10-12-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.PostAsync(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://switzerlandnorth.api.cognitive.microsoft.com/computervision/imageanalysis:analyze?api-version=2022-10-12-preview");
builder.setParameter("features", "{string}");
builder.setParameter("language", "en");
builder.setParameter("smartcrops-aspect-ratios", "{string}");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/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
"features": "{string}",
"language": "en",
"smartcrops-aspect-ratios": "{string}",
};
$.ajax({
url: "https://switzerlandnorth.api.cognitive.microsoft.com/computervision/imageanalysis:analyze?api-version=2022-10-12-preview&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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://switzerlandnorth.api.cognitive.microsoft.com/computervision/imageanalysis:analyze?api-version=2022-10-12-preview";
NSArray* array = @[
// Request parameters
@"entities=true",
@"features={string}",
@"language=en",
@"smartcrops-aspect-ratios={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"application/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://switzerlandnorth.api.cognitive.microsoft.com/computervision/imageanalysis:analyze?api-version=2022-10-12-preview');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'features' => '{string}',
'language' => 'en',
'smartcrops-aspect-ratios' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'features': '{string}',
'language': 'en',
'smartcrops-aspect-ratios': '{string}',
})
try:
conn = httplib.HTTPSConnection('switzerlandnorth.api.cognitive.microsoft.com')
conn.request("POST", "/computervision/imageanalysis:analyze?api-version=2022-10-12-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',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'features': '{string}',
'language': 'en',
'smartcrops-aspect-ratios': '{string}',
})
try:
conn = http.client.HTTPSConnection('switzerlandnorth.api.cognitive.microsoft.com')
conn.request("POST", "/computervision/imageanalysis:analyze?api-version=2022-10-12-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://switzerlandnorth.api.cognitive.microsoft.com/computervision/imageanalysis:analyze?api-version=2022-10-12-preview')
query = URI.encode_www_form({
# Request parameters
'features' => '{string}',
'language' => 'en',
'smartcrops-aspect-ratios' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/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