Computer Vision API (2023-04-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.
PlanogramCompliance_Match
Run the planogram matching operation against a planogram and a product understanding result.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
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
Input to pass into the planogram matching operation.
{
"detectedProducts": {
"imageMetadata": {
"width": 0,
"height": 0
},
"products": [
{
"id": "string",
"boundingBox": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
},
"tags": [
{
"name": "string",
"confidence": 0.0
}
]
}
],
"gaps": [
{
"id": "string",
"boundingBox": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
},
"tags": [
{
"name": "string",
"confidence": 0.0
}
]
}
]
},
"planogram": {
"width": 0.0,
"height": 0.0,
"products": [
{
"id": "string",
"name": "string",
"w": 0.0,
"h": 0.0
}
],
"fixtures": [
{
"id": "string",
"w": 0.0,
"h": 0.0,
"x": 0.0,
"y": 0.0
}
],
"positions": [
{
"id": "string",
"productId": "string",
"fixtureId": "string",
"x": 0.0,
"y": 0.0
}
]
}
}{
"description": "Input to pass into the planogram matching operation.",
"required": [
"detectedProducts",
"planogram"
],
"type": "object",
"properties": {
"detectedProducts": {
"description": "Results from the product understanding operation.",
"required": [
"gaps",
"imageMetadata",
"products"
],
"type": "object",
"properties": {
"imageMetadata": {
"description": "The image metadata information such as height and width.",
"required": [
"height",
"width"
],
"type": "object",
"properties": {
"width": {
"format": "int32",
"description": "The width of the image in pixels.",
"minimum": 1,
"type": "integer"
},
"height": {
"format": "int32",
"description": "The height of the image in pixels.",
"minimum": 1,
"type": "integer"
}
}
},
"products": {
"description": "Products detected in the image.",
"type": "array",
"items": {
"description": "Describes a detected object in an image.",
"required": [
"boundingBox",
"tags"
],
"type": "object",
"properties": {
"id": {
"description": "Id of the detected object.",
"minLength": 1,
"type": "string"
},
"boundingBox": {
"description": "A bounding box for an area inside an image.",
"required": [
"h",
"w",
"x",
"y"
],
"type": "object",
"properties": {
"x": {
"format": "int32",
"description": "Left-coordinate of the top left point of the area, in pixels.",
"minimum": 0,
"type": "integer"
},
"y": {
"format": "int32",
"description": "Top-coordinate of the top left point of the area, in pixels.",
"minimum": 0,
"type": "integer"
},
"w": {
"format": "int32",
"description": "Width measured from the top-left point of the area, in pixels.",
"minimum": 1,
"type": "integer"
},
"h": {
"format": "int32",
"description": "Height measured from the top-left point of the area, in pixels.",
"minimum": 1,
"type": "integer"
}
}
},
"tags": {
"description": "Classification confidences of the detected object.",
"minItems": 1,
"type": "array",
"items": {
"description": "An entity observation in the image, along with the confidence score.",
"required": [
"confidence",
"name"
],
"type": "object",
"properties": {
"name": {
"description": "Name of the entity.",
"minLength": 1,
"type": "string"
},
"confidence": {
"format": "double",
"description": "The level of confidence that the entity was observed.",
"maximum": 1,
"minimum": 0,
"type": "number"
}
}
}
}
}
}
},
"gaps": {
"description": "Gaps detected in the image.",
"type": "array",
"items": {
"description": "Describes a detected object in an image.",
"required": [
"boundingBox",
"tags"
],
"type": "object",
"properties": {
"id": {
"description": "Id of the detected object.",
"minLength": 1,
"type": "string"
},
"boundingBox": {
"description": "A bounding box for an area inside an image.",
"required": [
"h",
"w",
"x",
"y"
],
"type": "object",
"properties": {
"x": {
"format": "int32",
"description": "Left-coordinate of the top left point of the area, in pixels.",
"minimum": 0,
"type": "integer"
},
"y": {
"format": "int32",
"description": "Top-coordinate of the top left point of the area, in pixels.",
"minimum": 0,
"type": "integer"
},
"w": {
"format": "int32",
"description": "Width measured from the top-left point of the area, in pixels.",
"minimum": 1,
"type": "integer"
},
"h": {
"format": "int32",
"description": "Height measured from the top-left point of the area, in pixels.",
"minimum": 1,
"type": "integer"
}
}
},
"tags": {
"description": "Classification confidences of the detected object.",
"minItems": 1,
"type": "array",
"items": {
"description": "An entity observation in the image, along with the confidence score.",
"required": [
"confidence",
"name"
],
"type": "object",
"properties": {
"name": {
"description": "Name of the entity.",
"minLength": 1,
"type": "string"
},
"confidence": {
"format": "double",
"description": "The level of confidence that the entity was observed.",
"maximum": 1,
"minimum": 0,
"type": "number"
}
}
}
}
}
}
}
}
},
"planogram": {
"description": "Describes the planogram for planogram matching operations.",
"required": [
"fixtures",
"height",
"positions",
"products",
"width"
],
"type": "object",
"properties": {
"width": {
"format": "double",
"description": "Width of the planogram.",
"type": "number"
},
"height": {
"format": "double",
"description": "Height of the planogram.",
"type": "number"
},
"products": {
"description": "List of products in the planogram.",
"minItems": 1,
"type": "array",
"items": {
"description": "Describes a product in the planogram.",
"required": [
"h",
"id",
"name",
"w"
],
"type": "object",
"properties": {
"id": {
"description": "Id of the product.",
"minLength": 1,
"type": "string"
},
"name": {
"description": "Name of the product.",
"maxLength": 255,
"minLength": 1,
"type": "string"
},
"w": {
"format": "double",
"description": "Width of the product.",
"type": "number"
},
"h": {
"format": "double",
"description": "Height of the fixture.",
"type": "number"
}
}
}
},
"fixtures": {
"description": "List of fixtures in the planogram.",
"minItems": 1,
"type": "array",
"items": {
"description": "Describes a fixture in a planogram.",
"required": [
"h",
"id",
"w",
"x",
"y"
],
"type": "object",
"properties": {
"id": {
"description": "Id of the fixture.",
"minLength": 1,
"type": "string"
},
"w": {
"format": "double",
"description": "Width of the fixture.",
"type": "number"
},
"h": {
"format": "double",
"description": "Height of the fixture.",
"type": "number"
},
"x": {
"format": "double",
"description": "Left offset from the origin, in unit of in inches or centimeters.",
"minimum": 0,
"type": "number"
},
"y": {
"format": "double",
"description": "Top offset from the origin, in unit of in inches or centimeters.",
"minimum": 0,
"type": "number"
}
}
}
},
"positions": {
"description": "List of positions in the planogram.",
"minItems": 1,
"type": "array",
"items": {
"description": "Describes a product position in a planogram.",
"required": [
"fixtureId",
"id",
"productId",
"x",
"y"
],
"type": "object",
"properties": {
"id": {
"description": "Id of the position.",
"minLength": 1,
"type": "string"
},
"productId": {
"description": "Id of the product.",
"minLength": 1,
"type": "string"
},
"fixtureId": {
"description": "Id of the fixture that the product is on.",
"minLength": 1,
"type": "string"
},
"x": {
"format": "double",
"description": "Left offset from the origin, in unit of in inches or centimeters.",
"minimum": 0,
"type": "number"
},
"y": {
"format": "double",
"description": "Top offset from the origin, in unit of in inches or centimeters.",
"minimum": 0,
"type": "number"
}
}
}
}
}
}
}
}Response 200
Success
{
"matchingResultPerPosition": [
{
"positionId": "string",
"detectedObject": {
"id": "string",
"boundingBox": {
"x": 0,
"y": 0,
"w": 0,
"h": 0
},
"tags": [
{
"name": "string",
"confidence": 0.0
}
]
}
}
]
}{
"description": "Results from the planogram matching operation.",
"required": [
"matchingResultPerPosition"
],
"type": "object",
"properties": {
"matchingResultPerPosition": {
"description": "The matched detected object information for each planogram position.",
"type": "array",
"items": {
"description": "Paired planogram position ID and corresponding detected object from product understanding result.",
"required": [
"detectedObject",
"positionId"
],
"type": "object",
"properties": {
"positionId": {
"description": "The position ID from the planogram matched to the corresponding detected object.",
"minLength": 1,
"type": "string"
},
"detectedObject": {
"description": "Describes a detected object in an image.",
"required": [
"boundingBox",
"tags"
],
"type": "object",
"properties": {
"id": {
"description": "Id of the detected object.",
"minLength": 1,
"type": "string"
},
"boundingBox": {
"description": "A bounding box for an area inside an image.",
"required": [
"h",
"w",
"x",
"y"
],
"type": "object",
"properties": {
"x": {
"format": "int32",
"description": "Left-coordinate of the top left point of the area, in pixels.",
"minimum": 0,
"type": "integer"
},
"y": {
"format": "int32",
"description": "Top-coordinate of the top left point of the area, in pixels.",
"minimum": 0,
"type": "integer"
},
"w": {
"format": "int32",
"description": "Width measured from the top-left point of the area, in pixels.",
"minimum": 1,
"type": "integer"
},
"h": {
"format": "int32",
"description": "Height measured from the top-left point of the area, in pixels.",
"minimum": 1,
"type": "integer"
}
}
},
"tags": {
"description": "Classification confidences of the detected object.",
"minItems": 1,
"type": "array",
"items": {
"description": "An entity observation in the image, along with the confidence score.",
"required": [
"confidence",
"name"
],
"type": "object",
"properties": {
"name": {
"description": "Name of the entity.",
"minLength": 1,
"type": "string"
},
"confidence": {
"format": "double",
"description": "The level of confidence that the entity was observed.",
"maximum": 1,
"minimum": 0,
"type": "number"
}
}
}
}
}
}
}
}
}
}
}Response 500
Error
Code samples
@ECHO OFF
curl -v -X POST "https://*.cognitiveservices.azure.us/computervision/planogramcompliance:match?api-version=2023-04-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.us/computervision/planogramcompliance:match?api-version=2023-04-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.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://*.cognitiveservices.azure.us/computervision/planogramcompliance:match?api-version=2023-04-01-preview");
URI uri = builder.build();
HttpPost request = new HttpPost(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.us/computervision/planogramcompliance:match?api-version=2023-04-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: "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://*.cognitiveservices.azure.us/computervision/planogramcompliance:match?api-version=2023-04-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:@"POST"];
// 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.us/computervision/planogramcompliance:match?api-version=2023-04-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_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-patch+json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.us')
conn.request("POST", "/computervision/planogramcompliance:match?api-version=2023-04-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.us')
conn.request("POST", "/computervision/planogramcompliance:match?api-version=2023-04-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.us/computervision/planogramcompliance:match?api-version=2023-04-01-preview')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Post.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