Connectors Reference

Computer Vision API

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

 

Status: Preview

Tier: Standard

Version: 1.0.0

 

Actions:

Name

Summary

ListModels ()

List domain specific models

GetImageSchema (string format)

Get Request Body Parameters

RecognizeDomainSpecificContent (string model, string format, RecognizeDomainSpecificContentParameterImage Image)

Recognize Domain Specific Content

TagImage (string format, TagImageParameterImage Image)

Tag Image

OCR ([internal][Optional]string language, [internal][Optional]boolean detectOrientation, string format, OCRParameterImage Image)

Optical Character Recognition (OCR) to JSON

OCRText ([internal][Optional]string language, [internal][Optional]boolean detectOrientation, string format, OCRTextParameterImage Image)

Optical Character Recognition (OCR) to Text

AnalyzeImage ([advanced][Optional]string language, [internal][Optional]string visualFeatures, string format, AnalyzeImageParameterImage Image)

Analyze Image

GetThumbnail (number width, number height, [advanced][Optional]boolean smartCropping, string format, GetThumbnailParameterImage Image)

Generate Thumbnail

DescribeImage ([advanced][Optional]number maxCandidates, string format, DescribeImageParameterImage Image)

Describe Image

DescribeImageContent ([advanced][Optional]number maxCandidates, string Image)

Describe Image Content

DescribeImageURL ([advanced][Optional]number maxCandidates, ImageContentObject ImageURL)

Describe Image URL

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AnalyzeImageParameterImage

 

AnalyzeResponse

 

DescribeImageParameterImage

 

DescribeResponse

 

DomainModelResponse

 

GetImageSchemaResponse

 

GetThumbnailParameterImage

 

ImageContentObject

 

ListModelsResponse

 

ModelResponse

 

OCRJsonResponse

JSON Response

OCRParameterImage

 

OCRTextParameterImage

 

OCRTextResponse

 

RecognizeDomainSpecificContentParameterImage

 

TagImageParameterImage

 

TagResponse

 

 

Actions:

ListModels

Summary: List domain specific models

Description: List domain specific models.

 

Syntax:

ComputerVisionAPI.ListModels ()

 

Returns:

          Type:ListModelsResponse

 

GetImageSchema

Summary: Get Request Body Parameters

Description: Return the schema for the request body format desired.

 

Syntax:

ComputerVisionAPI.GetImageSchema (string format)

 

Parameters:

Name

Type

Summary

Required

Related Action

format

string

(Image Source)Values: [Image Content, Image URL]

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

True

 

Returns:

          Type:GetImageSchemaResponse

 

RecognizeDomainSpecificContent

Summary: Recognize Domain Specific Content

Description: Recognize celebrities or landmarks in an image.

 

Syntax:

ComputerVisionAPI.RecognizeDomainSpecificContent (string model, string format, RecognizeDomainSpecificContentParameterImage Image)

 

Parameters:

Name

Type

Summary

Required

Related Action

model

string

(Domain Model)Values: [Celebrities, Landmarks]

Supported domain-specific model to recognize in image.

True

format

string

(Image Source)Values: [Image Content, Image URL]

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

True

Image

RecognizeDomainSpecificContentParameterImage

 

 

True

 

Returns:

          Type:DomainModelResponse

 

TagImage

Summary: Tag Image

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

 

Syntax:

ComputerVisionAPI.TagImage (string format, TagImageParameterImage Image)

 

Parameters:

Name

Type

Summary

Required

Related Action

format

string

(Image Source)Values: [Image Content, Image URL]

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

True

Image

TagImageParameterImage

 

 

True

 

Returns:

          Type:TagResponse

 

OCR

Summary: Optical Character Recognition (OCR) to JSON

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

 

Syntax:

ComputerVisionAPI.OCR ([internal][Optional]string language, [internal][Optional]boolean detectOrientation, string format, OCRParameterImage Image)

 

Parameters:

Name

Type

Summary

Required

Related Action

language

string

(Language)

The language code of the text to be detected in the image.

False

detectOrientation

boolean

(Detect Orientation)

he BCP-47 language code of the text to be detected in the image.

False

format

string

(Image Source)Values: [Image Content, Image URL]

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

True

Image

OCRParameterImage

 

 

True

 

Returns:

          Type:OCRJsonResponse

          Summary: JSON Response

 

OCRText

Summary: Optical Character Recognition (OCR) to Text

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

 

Syntax:

ComputerVisionAPI.OCRText ([internal][Optional]string language, [internal][Optional]boolean detectOrientation, string format, OCRTextParameterImage Image)

 

Parameters:

Name

Type

Summary

Required

Related Action

language

string

(Language)

The language code of the text to be detected in the image.

False

detectOrientation

boolean

(Detect Orientation)

he BCP-47 language code of the text to be detected in the image.

False

format

string

(Image Source)Values: [Image Content, Image URL]

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

True

Image

OCRTextParameterImage

 

 

True

 

Returns:

          Type:OCRTextResponse

 

AnalyzeImage

Summary: Analyze Image

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

 

Syntax:

ComputerVisionAPI.AnalyzeImage ([advanced][Optional]string language, [internal][Optional]string visualFeatures, string format, AnalyzeImageParameterImage Image)

 

Parameters:

Name

Type

Summary

Required

Related Action

language

string

(Language)Values: [en, zh]

The service will return recognition results in specified language.

False

visualFeatures

string

(Visual Feature Options)

A string indicating what visual feature types to return. Multiple values should be comma-separated.

False

format

string

(Image Source)Values: [Image Content, Image URL]

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

True

Image

AnalyzeImageParameterImage

 

 

True

 

Returns:

          Type:AnalyzeResponse

 

GetThumbnail

Summary: Generate Thumbnail

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

 

Syntax:

ComputerVisionAPI.GetThumbnail (number width, number height, [advanced][Optional]boolean smartCropping, string format, GetThumbnailParameterImage Image)

 

Parameters:

Name

Type

Summary

Required

Related Action

width

number

(Thumbnail Width)

Width of the generated thumbnail - recommended is 50

True

height

number

(Thumbnail Height)

Height of the generated thumbnail - recommended is 50

True

smartCropping

boolean

(Smart Cropping)

Boolean flag for enabling smart cropping

False

format

string

(Image Source)Values: [Image Content, Image URL]

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

True

Image

GetThumbnailParameterImage

 

 

True

 

Returns:

          Type:string(binary)

          Summary: Thumbnail

          Description: Generated thumbnail image

 

DescribeImage

Summary: Describe Image

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

 

Syntax:

ComputerVisionAPI.DescribeImage ([advanced][Optional]number maxCandidates, string format, DescribeImageParameterImage Image)

 

Parameters:

Name

Type

Summary

Required

Related Action

maxCandidates

number

(Max Candidates)

Maximum number of candidate descriptions to be returned.

False

format

string

(Image Source)Values: [Image Content, Image URL]

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

True

Image

DescribeImageParameterImage

 

 

True

 

Returns:

          Type:DescribeResponse

 

DescribeImageContent

Summary: Describe Image Content

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

 

Syntax:

ComputerVisionAPI.DescribeImageContent ([advanced][Optional]number maxCandidates, string Image)

 

Parameters:

Name

Type

Summary

Required

Related Action

maxCandidates

number

(Max Candidates)

Maximum number of candidate descriptions to be returned.

False

Image

string(binary)

 

 

True

 

Returns:

          Type:DescribeResponse

 

DescribeImageURL

Summary: Describe Image URL

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

 

Syntax:

ComputerVisionAPI.DescribeImageURL ([advanced][Optional]number maxCandidates, ImageContentObject ImageURL)

 

Parameters:

Name

Type

Summary

Required

Related Action

maxCandidates

number

(Max Candidates)

Maximum number of candidate descriptions to be returned.

False

ImageURL

ImageContentObject

 

 

True

 

Returns:

          Type:DescribeResponse

 


 

AnalyzeImageParameterImage

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

AnalyzeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

categories

array of (CategoriesItem)

 

Categories identified from the image

description

Description

 

Properties to describe the image analyzed

tags

array of (TagsItem)

 

Tags identified with confidence scores.

 

CategoriesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Category Name

Name of the category identified from the image

score

number(float)

Category Confidence Score

Confidence Score for the image category

 

Description

Summary:

Description: Properties to describe the image analyzed

 

          Properties:

Name

Type

Summary

captions

array of (CaptionsItem)

Captions

List of captions generated from the image

tags

array of (string)

Tag Names

Collection of tag names.

 

CaptionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

confidence

number(float)

Caption Confidence Score

Confidence score of the image caption

text

string

Caption Text

Text caption generated from the image

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

confidence

number(float)

Tag Confidence Score

Confidence score for the identified tags.

name

string

Tag Name

Name of the tag identified.

 


 

DescribeImageParameterImage

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

DescribeResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

description

Description

 

Properties to describe the image analyzed

 

Description

Summary:

Description: Properties to describe the image analyzed

 

          Properties:

Name

Type

Summary

captions

array of (CaptionsItem)

Captions

List of captions generated from the image

tags

array of (string)

Tag Names

Collection of tag names.

 

CaptionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

confidence

number(float)

Caption Confidence Score

Confidence score of the image caption

text

string

Caption Text

Text caption generated from the image

 


 

DomainModelResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

result

Result

 

Computer Vision Result

 

Result

Summary:

Description: Computer Vision Result

 

          Properties:

Name

Type

Summary

celebrities

array of (CelebritiesItem)

 

Recognized celebrities in image

landmarks

array of (LandmarksItem)

 

Recognized landmarks in image

 

CelebritiesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

confidence

number(float)

Celebrity Confidence

Confidence score that image is of celebrity

name

string

Celebrity Name

Name of the recognized celebrity

 

LandmarksItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

confidence

number(float)

Landmark Confidence

Confidence score that image is of landmark

name

string

Landmark Name

Name of the identified landmark

 


 

GetImageSchemaResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

schema

Schema

 

 

 

Schema

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

GetThumbnailParameterImage

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

ImageContentObject

Summary:

Description:

 

          Properties:

Name

Type

Summary

url

string(url)

Image URL

Source of image reference by URL.


 

ListModelsResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

models

array of (ModelResponse)

Models

Models.


 

ModelResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Model name

Name.

categories

array of (string)

Model categories

Categories.


 

OCRJsonResponse

Summary: JSON Response

Description:

 

          Properties:

Name

Type

Summary

language

string

Text Language

Detected language of the image text.

regions

array of (RegionsItem)

Regions Array

Text regions returned.

 

RegionsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

OCRParameterImage

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OCRTextParameterImage

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

OCRTextResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

Detected Text

Text detected in the image analyzed


 

RecognizeDomainSpecificContentParameterImage

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TagImageParameterImage

Summary:

Description:

 

          Properties:

Name

Type

Summary


 

TagResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

tags

array of (TagsItem)

 

Set of tags returned from the picture analysis.

 

TagsItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

confidence

number(float)

Tag Confidence Score

Confidence score of the identified tag.

name

string

Tag Name

Name of the tag identified.