Del via


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.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions
Power Automate Standard All Power Automate regions
Power Apps Standard All Power Apps regions
Contact
Name Microsoft
URL Microsoft LogicApps Support
Microsoft Power Automate Support
Microsoft Power Apps Support
Connector Metadata
Publisher Microsoft
Website https://azure.microsoft.com/services/cognitive-services/computer-vision/

To use this integration, you will need a Cognitive Service resource in the Azure portal. You will get an endpoint and a key for authenticating your applications. To make a connection, provide the Account key, site URL and select Create connection. For operation costs on your connection, learn more here.

You're now ready to start using this integration.

Known issues and limitations

Please note that operation results may be incomplete due to underlying Cognitive Service Api nature, which is based on machine learning and pattern recognition.

Connecting with Microsoft Entra ID

To create connections with Microsoft Entra ID, you must add the Cognitive Services User role to your account to access. To use this connection, you must input the unique subdomain associated wih your Cognitive Services resource into the supporting operations.

Operations not supported with Microsoft Entra ID authentication

When using Microsoft Entra ID authentication only V3 actions are supported. Deprecated actions will continue to work with Access Key authentication, but will fail if used with an Microsoft Entra ID connection.

Creating a connection

The connector supports the following authentication types:

Api Key ApiKey All regions Shareable
Default [DEPRECATED] This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility. All regions Not shareable

Api Key

Auth ID: keyBasedAuth

Applicable: All regions

ApiKey

This is shareable connection. If the power app is shared with another user, connection is shared as well. For more information, please see the Connectors overview for canvas apps - Power Apps | Microsoft Docs

Name Type Description Required
Account Key securestring Cognitive Services Account Key True
Site URL string Root site url (Example: https://westus.api.cognitive.microsoft.com)

Default [DEPRECATED]

Applicable: All regions

This option is only for older connections without an explicit authentication type, and is only provided for backward compatibility.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Account Key securestring Cognitive Services Account Key True
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'.

Throttling Limits

Name Calls Renewal Period
API calls per connection 1200 60 seconds

Actions

Analyze Image

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

Analyze Image (V3) (Preview)

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

Describe Image

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

Describe Image (V3) (Preview)

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

Describe Image Content

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

Describe Image Content (V3) (Preview)

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

Describe Image URL

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

Describe Image URL (V3) (Preview)

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

Detect Objects

Generates a list of deteced objects in the supplied image.

Detect Objects (V3) (Preview)

Generates a list of deteced objects in the supplied image.

Generate Thumbnail

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

Generate Thumbnail (V3) (Preview)

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

Get Area of Interest

Returns a bounding box around the most important area of the image.

Get Area of Interest (V3) (Preview)

Returns a bounding box around the most important area of the image.

Optical Character Recognition (OCR) to JSON

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

Optical Character Recognition (OCR) to JSON (V3) (Preview)

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

Optical Character Recognition (OCR) to Text

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

Optical Character Recognition (OCR) to Text (V3) (Preview)

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

Recognize Domain Specific Content

Recognize celebrities or landmarks in an image.

Recognize Domain Specific Content (V3) (Preview)

Recognize celebrities or landmarks in an image.

Tag Image

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

Tag Image (V3) (Preview)

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

Analyze Image

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

Parameters

Name Key Required Type Description
Language
language string

The service will return recognition results in specified language.

Image Source
format True string

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

Image
Image True dynamic

Returns

Analyze Image (V3) (Preview)

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

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Language
language string

The service will return recognition results in specified language.

Image Source
format True string

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

Image
Image True dynamic

Returns

Describe Image

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

Parameters

Name Key Required Type Description
Max Candidates
maxCandidates number

Maximum number of candidate descriptions to be returned.

Language
language string

The service will return recognition results in specified language.

Image Source
format True string

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

Image
Image True dynamic

Returns

Describe Image (V3) (Preview)

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

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Max Candidates
maxCandidates number

Maximum number of candidate descriptions to be returned.

Language
language string

The service will return recognition results in specified language.

Image Source
format True string

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

Image
Image True dynamic

Returns

Describe Image Content

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

Parameters

Name Key Required Type Description
Max Candidates
maxCandidates number

Maximum number of candidate descriptions to be returned.

Language
language string

The service will return recognition results in specified language.

Image Content
Image True binary

Source of the image reference in body.

Returns

Describe Image Content (V3) (Preview)

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

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Max Candidates
maxCandidates number

Maximum number of candidate descriptions to be returned.

Language
language string

The service will return recognition results in specified language.

Image Content
Image True binary

Source of the image reference in body.

Returns

Describe Image URL

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

Parameters

Name Key Required Type Description
Max Candidates
maxCandidates number

Maximum number of candidate descriptions to be returned.

Language
language string

The service will return recognition results in specified language.

Image URL
url url

Source of image reference by URL.

Returns

Describe Image URL (V3) (Preview)

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

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Max Candidates
maxCandidates number

Maximum number of candidate descriptions to be returned.

Language
language string

The service will return recognition results in specified language.

Image URL
url url

Source of image reference by URL.

Returns

Detect Objects

Generates a list of deteced objects in the supplied image.

Parameters

Name Key Required Type Description
Image Source
format True string

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

Image
Image True dynamic

Returns

Detect Objects (V3) (Preview)

Generates a list of deteced objects in the supplied image.

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Image Source
format True string

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

Image
Image True dynamic

Returns

Generate Thumbnail

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

Parameters

Name Key Required Type Description
Thumbnail Width
width True number

Width of the generated thumbnail - recommended is 50

Thumbnail Height
height True number

Height of the generated thumbnail - recommended is 50

Smart Cropping
smartCropping boolean

Boolean flag for enabling smart cropping

Image Source
format True string

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

Image
Image True dynamic

Returns

Generated thumbnail image

Thumbnail
binary

Generate Thumbnail (V3) (Preview)

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

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Thumbnail Width
width True number

Width of the generated thumbnail - recommended is 50

Thumbnail Height
height True number

Height of the generated thumbnail - recommended is 50

Smart Cropping
smartCropping boolean

Boolean flag for enabling smart cropping

Image Source
format True string

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

Image
Image True dynamic

Returns

Generated thumbnail image

Thumbnail
binary

Get Area of Interest

Returns a bounding box around the most important area of the image.

Parameters

Name Key Required Type Description
Image Source
format True string

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

Image
Image True dynamic

Returns

Get Area of Interest (V3) (Preview)

Returns a bounding box around the most important area of the image.

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Image Source
format True string

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

Image
Image True dynamic

Returns

Optical Character Recognition (OCR) to JSON

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

Parameters

Name Key Required Type Description
Image Source
format True string

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

Image
Image True dynamic

Returns

JSON Response
OCRJsonResponse

Optical Character Recognition (OCR) to JSON (V3) (Preview)

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

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Image Source
format True string

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

Image
Image True dynamic

Returns

JSON Response
OCRJsonResponse

Optical Character Recognition (OCR) to Text

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

Parameters

Name Key Required Type Description
Image Source
format True string

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

Image
Image True dynamic

Returns

Optical Character Recognition (OCR) to Text (V3) (Preview)

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

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Image Source
format True string

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

Image
Image True dynamic

Returns

Recognize Domain Specific Content

Recognize celebrities or landmarks in an image.

Parameters

Name Key Required Type Description
Domain Model
model True string

Supported domain-specific model to recognize in image.

Image Source
format True string

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

Image
Image True dynamic

Returns

Recognize Domain Specific Content (V3) (Preview)

Recognize celebrities or landmarks in an image.

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Domain Model
model True string

Supported domain-specific model to recognize in image.

Image Source
format True string

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

Image
Image True dynamic

Returns

Tag Image

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

Parameters

Name Key Required Type Description
Image Source
format True string

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

Image
Image True dynamic

Returns

Tag Image (V3) (Preview)

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

Parameters

Name Key Required Type Description
Resource Subdomain or Region
subdomainName True string

Azure subdomain or geographic region (e.g. westus)

Image Source
format True string

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

Image
Image True dynamic

Returns

Definitions

DomainModelResponse

Name Path Type Description
celebrities
result.celebrities array of object

Recognized celebrities in image

Celebrity Confidence
result.celebrities.confidence float

Confidence score that image is of celebrity

Celebrity Name
result.celebrities.name string

Name of the recognized celebrity

landmarks
result.landmarks array of object

Recognized landmarks in image

Landmark Confidence
result.landmarks.confidence float

Confidence score that image is of landmark

Landmark Name
result.landmarks.name string

Name of the identified landmark

TagResponse

Name Path Type Description
tags
tags array of object

Set of tags returned from the picture analysis.

Tag Confidence Score
tags.confidence float

Confidence score of the identified tag.

Tag Name
tags.name string

Name of the tag identified.

DetectResponse

Name Path Type Description
objects
objects array of object

Set of objects returned from the picture analysis.

Object confidence score
objects.confidence float

Confidence score of the identified object.

Object name
objects.object string

Name of the object identified.

AreaOfInterestResponse

OCRJsonResponse

Name Path Type Description
Text Language
language string

Detected language of the image text.

Regions Array
regions array of object

Text regions returned.

OCRTextResponse

Name Path Type Description
Detected Text
text string

Text detected in the image analyzed

AnalyzeResponse

Name Path Type Description
categories
categories array of object

Categories identified from the image

Category Name
categories.name string

Name of the category identified from the image

Category Confidence Score
categories.score float

Confidence Score for the image category

Captions
description.captions array of object

List of captions generated from the image

Caption Confidence Score
description.captions.confidence float

Confidence score of the image caption

Caption Text
description.captions.text string

Text caption generated from the image

Tag Names
description.tags array of string

Collection of tag names.

tags
tags array of object

Tags identified with confidence scores.

Tag Confidence Score
tags.confidence float

Confidence score for the identified tags.

Tag Name
tags.name string

Name of the tag identified.

DescribeResponse

Name Path Type Description
Captions
description.captions array of object

List of captions generated from the image

Caption Confidence Score
description.captions.confidence float

Confidence score of the image caption

Caption Text
description.captions.text string

Text caption generated from the image

Tag Names
description.tags array of string

Collection of tag names.

binary

This is the basic data type 'binary'.