Computer Vision API (Preview)

Extract rich information from images to categorize and process visual data—and protect your users from unwanted content with this Azure Cognitive Service.

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	1200	60 seconds

Creating a connection

To connect your account, you will need the following information:

Account Key: securestring

Cognitive Services Account Key

Site URL: string

Root site url (Example: https://westus.api.cognitive.microsoft.com ).If not specified site url will be defaulted to 'https://westus.api.cognitive.microsoft.com'.

Actions

Analyze Image

Operation ID:: AnalyzeImage

This operation extracts a rich set of visual features based on the image content.

Required Parameters

Image Source: string

Source of the image - either included or by reference url.

Key:: format

Image: dynamic

Key:: Image

Optional Parameters

Language: string

The service will return recognition results in specified language.

Key:: language

Returns

Body: AnalyzeResponse

Describe Image

Operation ID:: DescribeImage

This operation generates a description of an image in human readable language with complete sentences.

Required Parameters

Image Source: string

Source of the image - either included or by reference url.

Key:: format

Image: dynamic

Key:: Image

Optional Parameters

Max Candidates: number

Maximum number of candidate descriptions to be returned.

Key:: maxCandidates

Returns

Body: DescribeResponse

Describe Image Content

Operation ID:: DescribeImageContent

This operation generates a description of image content in human readable language with complete sentences.

Required Parameters

Image Content: binary

Source of the image reference in body.

Key:: Image

Optional Parameters

Max Candidates: number

Maximum number of candidate descriptions to be returned.

Key:: maxCandidates

Returns

Body: DescribeResponse

Describe Image URL

Operation ID:: DescribeImageURL

This operation generates a description of an image URL in human readable language with complete sentences.

Optional Parameters

Max Candidates: number

Maximum number of candidate descriptions to be returned.

Key:: maxCandidates

Image URL: url

Source of image reference by URL.

Key:: url

Returns

Body: DescribeResponse

Generate Thumbnail

Operation ID:: GetThumbnail

This operation generates a thumbnail image with the user-specified width and height.

Required Parameters

Thumbnail Width: number

Width of the generated thumbnail - recommended is 50

Key:: width

Thumbnail Height: number

Height of the generated thumbnail - recommended is 50

Key:: height

Image Source: string

Source of the image - either included or by reference url.

Key:: format

Image: dynamic

Key:: Image

Optional Parameters

Smart Cropping: boolean

Boolean flag for enabling smart cropping

Key:: smartCropping

Returns

Thumbnail: binary

Generated thumbnail image

Optical Character Recognition (OCR) to JSON

Operation ID:: OCR

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable JSON stream.

Required Parameters

Image Source: string

Source of the image - either included or by reference url.

Key:: format

Image: dynamic

Key:: Image

Returns

JSON Response: OCRJsonResponse

Optical Character Recognition (OCR) to Text

Operation ID:: OCRText

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a text file.

Required Parameters

Image Source: string

Source of the image - either included or by reference url.

Key:: format

Image: dynamic

Key:: Image

Returns

Body: OCRTextResponse

Recognize Domain Specific Content

Operation ID:: RecognizeDomainSpecificContent

Recognize celebrities or landmarks in an image.

Required Parameters

Domain Model: string

Supported domain-specific model to recognize in image.

Key:: model

Image Source: string

Source of the image - either included or by reference url.

Key:: format

Image: dynamic

Key:: Image

Returns

Body: DomainModelResponse

Tag Image

Operation ID:: TagImage

Generates a list of words, or tags, that are relevant to the content of the supplied image.

Required Parameters

Image Source: string

Source of the image - either included or by reference url.

Key:: format

Image: dynamic

Key:: Image

Returns

Body: TagResponse

Definitions

DomainModelResponse

Celebrity Confidence: float

Confidence score that image is of celebrity

Path:: result.celebrities.confidence

Celebrity Name: string

Name of the recognized celebrity

Path:: result.celebrities.name

Landmark Confidence: float

Confidence score that image is of landmark

Path:: result.landmarks.confidence

Landmark Name: string

Name of the identified landmark

Path:: result.landmarks.name

celebrities: array of object

Recognized celebrities in image

Path:: result.celebrities

landmarks: array of object

Recognized landmarks in image

Path:: result.landmarks

TagResponse

Tag Confidence Score: float

Confidence score of the identified tag.

Path:: tags.confidence

Tag Name: string

Name of the tag identified.

Path:: tags.name

tags: array of object

Set of tags returned from the picture analysis.

Path:: tags

OCRJsonResponse

Regions Array: array of object

Text regions returned.

Path:: regions

Text Language: string

Detected language of the image text.

Path:: language

OCRTextResponse

Detected Text: string

Text detected in the image analyzed

Path:: text

AnalyzeResponse

Caption Confidence Score: float

Confidence score of the image caption

Path:: description.captions.confidence

Caption Text: string

Text caption generated from the image

Path:: description.captions.text

Captions: array of object

List of captions generated from the image

Path:: description.captions

Category Confidence Score: float

Confidence Score for the image category

Path:: categories.score

Category Name: string

Name of the category identified from the image

Path:: categories.name

Tag Confidence Score: float

Confidence score for the identified tags.

Path:: tags.confidence

Tag Name: string

Name of the tag identified.

Path:: tags.name

Tag Names: array of string

Collection of tag names.

Path:: description.tags

categories: array of object

Categories identified from the image

Path:: categories

tags: array of object

Tags identified with confidence scores.

Path:: tags

DescribeResponse

Caption Confidence Score: float

Confidence score of the image caption

Path:: description.captions.confidence

Caption Text: string

Text caption generated from the image

Path:: description.captions.text

Captions: array of object

List of captions generated from the image

Path:: description.captions

Tag Names: array of string

Collection of tag names.

Path:: description.tags