ComputerVisionClientOperationsMixin class

Definition

Inheritance
builtins.object
ComputerVisionClientOperationsMixin

Methods

analyze_image(url, visual_features=None, details=None, language='en', description_exclude=None, custom_headers=None, raw=False, **operation_config)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyze_image_by_domain(model, url, language='en', custom_headers=None, raw=False, **operation_config)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyze_image_by_domain_in_stream(model, image, language='en', custom_headers=None, raw=False, callback=None, **operation_config)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyze_image_in_stream(image, visual_features=None, details=None, language='en', description_exclude=None, custom_headers=None, raw=False, callback=None, **operation_config)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

batch_read_file(url, custom_headers=None, raw=False, **operation_config)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadOperationResult' operation to access OCR results.​.

batch_read_file_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

Use this interface to get the result of a Read Document operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read Document interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'Get Read Result operation' to access OCR results.​.

describe_image(url, max_candidates=1, language='en', description_exclude=None, custom_headers=None, raw=False, **operation_config)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

describe_image_in_stream(image, max_candidates=1, language='en', description_exclude=None, custom_headers=None, raw=False, callback=None, **operation_config)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

detect_objects(url, custom_headers=None, raw=False, **operation_config)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

detect_objects_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

generate_thumbnail(width, height, url, smart_cropping=False, custom_headers=None, raw=False, callback=None, **operation_config)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

generate_thumbnail_in_stream(width, height, image, smart_cropping=False, custom_headers=None, raw=False, callback=None, **operation_config)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

get_area_of_interest(url, custom_headers=None, raw=False, **operation_config)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

get_area_of_interest_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

get_read_operation_result(operation_id, custom_headers=None, raw=False, **operation_config)

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Batch Read File interface.

get_text_operation_result(operation_id, custom_headers=None, raw=False, **operation_config)

This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface.

list_models(custom_headers=None, raw=False, **operation_config)

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

recognize_printed_text(url, detect_orientation=True, language='unk', custom_headers=None, raw=False, **operation_config)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

recognize_printed_text_in_stream(image, detect_orientation=True, language='unk', custom_headers=None, raw=False, callback=None, **operation_config)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

recognize_text(url, mode, custom_headers=None, raw=False, **operation_config)

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.

recognize_text_in_stream(image, mode, custom_headers=None, raw=False, callback=None, **operation_config)

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.

tag_image(url, language='en', custom_headers=None, raw=False, **operation_config)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

tag_image_in_stream(image, language='en', custom_headers=None, raw=False, callback=None, **operation_config)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyze_image(url, visual_features=None, details=None, language='en', description_exclude=None, custom_headers=None, raw=False, **operation_config)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyze_image(url, visual_features=None, details=None, language='en', description_exclude=None, custom_headers=None, raw=False, **operation_config)

Parameters

url
str

Publicly reachable URL of an image.

visual_features
list[str or VisualFeatureTypes]

A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act), or is gory (depicts extreme violence or blood). Sexually suggestive content (aka racy content) is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English.

default value: None
details
list[str or Details]

A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.

default value: None
language
str

The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

default value: en
description_exclude
list[str or DescriptionExclude]

Turn off specified domain models when generating the description.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ImageAnalysis or ClientRawResponse if raw=true

Return type

Exceptions

analyze_image_by_domain(model, url, language='en', custom_headers=None, raw=False, **operation_config)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyze_image_by_domain(model, url, language='en', custom_headers=None, raw=False, **operation_config)

Parameters

model
str

The domain-specific content to recognize.

url
str

Publicly reachable URL of an image.

language
str

The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

default value: en
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

DomainModelResults or ClientRawResponse if raw=true

Return type

Exceptions

analyze_image_by_domain_in_stream(model, image, language='en', custom_headers=None, raw=False, callback=None, **operation_config)

This operation recognizes content within an image by applying a domain-specific model. The list of domain-specific models that are supported by the Computer Vision API can be retrieved using the /models GET request. Currently, the API provides following domain-specific models: celebrities, landmarks. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyze_image_by_domain_in_stream(model, image, language='en', custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

model
str

The domain-specific content to recognize.

image
Generator

An image stream.

language
str

The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

default value: en
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

DomainModelResults or ClientRawResponse if raw=true

Return type

Exceptions

analyze_image_in_stream(image, visual_features=None, details=None, language='en', description_exclude=None, custom_headers=None, raw=False, callback=None, **operation_config)

This operation extracts a rich set of visual features based on the image content. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. Within your request, there is an optional parameter to allow you to choose which features to return. By default, image categories are returned in the response. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

analyze_image_in_stream(image, visual_features=None, details=None, language='en', description_exclude=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

image
Generator

An image stream.

visual_features
list[str or VisualFeatureTypes]

A string indicating what visual feature types to return. Multiple values should be comma-separated. Valid visual feature types include: Categories - categorizes image content according to a taxonomy defined in documentation. Tags - tags the image with a detailed list of words related to the image content. Description - describes the image content with a complete English sentence. Faces - detects if faces are present. If present, generate coordinates, gender and age. ImageType - detects if image is clipart or a line drawing. Color - determines the accent color, dominant color, and whether an image is black&white. Adult - detects if the image is pornographic in nature (depicts nudity or a sex act), or is gory (depicts extreme violence or blood). Sexually suggestive content (aka racy content) is also detected. Objects - detects various objects within an image, including the approximate location. The Objects argument is only available in English. Brands - detects various brands within an image, including the approximate location. The Brands argument is only available in English.

default value: None
details
list[str or Details]

A string indicating which domain-specific details to return. Multiple values should be comma-separated. Valid visual feature types include: Celebrities - identifies celebrities if detected in the image, Landmarks - identifies notable landmarks in the image.

default value: None
language
str

The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

default value: en
description_exclude
list[str or DescriptionExclude]

Turn off specified domain models when generating the description.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

ImageAnalysis or ClientRawResponse if raw=true

Return type

Exceptions

batch_read_file(url, custom_headers=None, raw=False, **operation_config)

Use this interface to get the result of a Read operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read File interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'GetReadOperationResult' operation to access OCR results.​.

batch_read_file(url, custom_headers=None, raw=False, **operation_config)

Parameters

url
str

Publicly reachable URL of an image.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

Exceptions

batch_read_file_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

Use this interface to get the result of a Read Document operation, employing the state-of-the-art Optical Character Recognition (OCR) algorithms optimized for text-heavy documents. When you use the Read Document interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your 'Get Read Result operation' to access OCR results.​.

batch_read_file_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

image
Generator

An image stream.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

Exceptions

describe_image(url, max_candidates=1, language='en', description_exclude=None, custom_headers=None, raw=False, **operation_config)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

describe_image(url, max_candidates=1, language='en', description_exclude=None, custom_headers=None, raw=False, **operation_config)

Parameters

url
str

Publicly reachable URL of an image.

max_candidates
int

Maximum number of candidate descriptions to be returned. The default is 1.

default value: 1
language
str

The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

default value: en
description_exclude
list[str or DescriptionExclude]

Turn off specified domain models when generating the description.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ImageDescription or ClientRawResponse if raw=true

Return type

Exceptions

describe_image_in_stream(image, max_candidates=1, language='en', description_exclude=None, custom_headers=None, raw=False, callback=None, **operation_config)

This operation generates a description of an image in human readable language with complete sentences. The description is based on a collection of content tags, which are also returned by the operation. More than one description can be generated for each image. Descriptions are ordered by their confidence score. Descriptions may include results from celebrity and landmark domain models, if applicable. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

describe_image_in_stream(image, max_candidates=1, language='en', description_exclude=None, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

image
Generator

An image stream.

max_candidates
int

Maximum number of candidate descriptions to be returned. The default is 1.

default value: 1
language
str

The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

default value: en
description_exclude
list[str or DescriptionExclude]

Turn off specified domain models when generating the description.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

ImageDescription or ClientRawResponse if raw=true

Return type

Exceptions

detect_objects(url, custom_headers=None, raw=False, **operation_config)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

detect_objects(url, custom_headers=None, raw=False, **operation_config)

Parameters

url
str

Publicly reachable URL of an image.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

DetectResult or ClientRawResponse if raw=true

Return type

Exceptions

detect_objects_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

Performs object detection on the specified image. Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

detect_objects_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

image
Generator

An image stream.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

DetectResult or ClientRawResponse if raw=true

Return type

Exceptions

generate_thumbnail(width, height, url, smart_cropping=False, custom_headers=None, raw=False, callback=None, **operation_config)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

generate_thumbnail(width, height, url, smart_cropping=False, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

width
int

Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.

height
int

Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.

url
str

Publicly reachable URL of an image.

smart_cropping
bool

Boolean flag for enabling smart cropping.

default value: False
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator

Exceptions

generate_thumbnail_in_stream(width, height, image, smart_cropping=False, custom_headers=None, raw=False, callback=None, **operation_config)

This operation generates a thumbnail image with the user-specified width and height. By default, the service analyzes the image, identifies the region of interest (ROI), and generates smart cropping coordinates based on the ROI. Smart cropping helps when you specify an aspect ratio that differs from that of the input image. A successful response contains the thumbnail image binary. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, InvalidThumbnailSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

generate_thumbnail_in_stream(width, height, image, smart_cropping=False, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

width
int

Width of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.

height
int

Height of the thumbnail, in pixels. It must be between 1 and 1024. Recommended minimum of 50.

image
Generator

An image stream.

smart_cropping
bool

Boolean flag for enabling smart cropping.

default value: False
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator

Exceptions

get_area_of_interest(url, custom_headers=None, raw=False, **operation_config)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

get_area_of_interest(url, custom_headers=None, raw=False, **operation_config)

Parameters

url
str

Publicly reachable URL of an image.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

AreaOfInterestResult or ClientRawResponse if raw=true

Return type

Exceptions

get_area_of_interest_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

This operation returns a bounding box around the most important area of the image. A successful response will be returned in JSON. If the request failed, the response contains an error code and a message to help determine what went wrong. Upon failure, the error code and an error message are returned. The error code could be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, FailedToProcess, Timeout, or InternalServerError.

get_area_of_interest_in_stream(image, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

image
Generator

An image stream.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

AreaOfInterestResult or ClientRawResponse if raw=true

Return type

Exceptions

get_read_operation_result(operation_id, custom_headers=None, raw=False, **operation_config)

This interface is used for getting OCR results of Read operation. The URL to this interface should be retrieved from 'Operation-Location' field returned from Batch Read File interface.

get_read_operation_result(operation_id, custom_headers=None, raw=False, **operation_config)

Parameters

operation_id
str

Id of read operation returned in the response of the 'Batch Read File' interface.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ReadOperationResult or ClientRawResponse if raw=true

Return type

Exceptions

get_text_operation_result(operation_id, custom_headers=None, raw=False, **operation_config)

This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface.

get_text_operation_result(operation_id, custom_headers=None, raw=False, **operation_config)

Parameters

operation_id
str

Id of the text operation returned in the response of the 'Recognize Text'

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

TextOperationResult or ClientRawResponse if raw=true

Return type

Exceptions

list_models(custom_headers=None, raw=False, **operation_config)

This operation returns the list of domain-specific models that are supported by the Computer Vision API. Currently, the API supports following domain-specific models: celebrity recognizer, landmark recognizer. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

list_models(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ListModelsResult or ClientRawResponse if raw=true

Return type

Exceptions

recognize_printed_text(url, detect_orientation=True, language='unk', custom_headers=None, raw=False, **operation_config)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

recognize_printed_text(url, detect_orientation=True, language='unk', custom_headers=None, raw=False, **operation_config)

Parameters

detect_orientation
bool

Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).

url
str

Publicly reachable URL of an image.

default value: True
language
str or OcrLanguages

The BCP-47 language code of the text to be detected in the image. The default value is 'unk'. Possible values include: 'unk', 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'

default value: unk
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

OcrResult or ClientRawResponse if raw=true

Return type

Exceptions

recognize_printed_text_in_stream(image, detect_orientation=True, language='unk', custom_headers=None, raw=False, callback=None, **operation_config)

Optical Character Recognition (OCR) detects text in an image and extracts the recognized characters into a machine-usable character stream. Upon success, the OCR results will be returned. Upon failure, the error code together with an error message will be returned. The error code can be one of InvalidImageUrl, InvalidImageFormat, InvalidImageSize, NotSupportedImage, NotSupportedLanguage, or InternalServerError.

recognize_printed_text_in_stream(image, detect_orientation=True, language='unk', custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

detect_orientation
bool

Whether detect the text orientation in the image. With detectOrientation=true the OCR service tries to detect the image orientation and correct it before further processing (e.g. if it's upside-down).

image
Generator

An image stream.

default value: True
language
str or OcrLanguages

The BCP-47 language code of the text to be detected in the image. The default value is 'unk'. Possible values include: 'unk', 'zh-Hans', 'zh-Hant', 'cs', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'nb', 'pl', 'pt', 'ru', 'es', 'sv', 'tr', 'ar', 'ro', 'sr-Cyrl', 'sr-Latn', 'sk'

default value: unk
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

OcrResult or ClientRawResponse if raw=true

Return type

Exceptions

recognize_text(url, mode, custom_headers=None, raw=False, **operation_config)

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.

recognize_text(url, mode, custom_headers=None, raw=False, **operation_config)

Parameters

mode
str or TextRecognitionMode

Type of text to recognize. Possible values include: 'Handwritten', 'Printed'

url
str

Publicly reachable URL of an image.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

Exceptions

recognize_text_in_stream(image, mode, custom_headers=None, raw=False, callback=None, **operation_config)

Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.

recognize_text_in_stream(image, mode, custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

image
Generator

An image stream.

mode
str or TextRecognitionMode

Type of text to recognize. Possible values include: 'Handwritten', 'Printed'

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

Exceptions

tag_image(url, language='en', custom_headers=None, raw=False, **operation_config)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

tag_image(url, language='en', custom_headers=None, raw=False, **operation_config)

Parameters

url
str

Publicly reachable URL of an image.

language
str

The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

default value: en
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

TagResult or ClientRawResponse if raw=true

Return type

Exceptions

tag_image_in_stream(image, language='en', custom_headers=None, raw=False, callback=None, **operation_config)

This operation generates a list of words, or tags, that are relevant to the content of the supplied image. The Computer Vision API can return tags based on objects, living beings, scenery or actions found in images. Unlike categories, tags are not organized according to a hierarchical classification system, but correspond to image content. Tags may contain hints to avoid ambiguity or provide context, for example the tag "ascomycete" may be accompanied by the hint "fungus". Two input methods are supported -- (1) Uploading an image or (2) specifying an image URL. A successful response will be returned in JSON. If the request failed, the response will contain an error code and a message to help understand what went wrong.

tag_image_in_stream(image, language='en', custom_headers=None, raw=False, callback=None, **operation_config)

Parameters

image
Generator

An image stream.

language
str

The desired language for output generation. If this parameter is not specified, the default value is "en".Supported languages:en - English, Default. es - Spanish, ja - Japanese, pt - Portuguese, zh - Simplified Chinese. Possible values include: 'en', 'es', 'ja', 'pt', 'zh'

default value: en
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
callback
Callable[Bytes, response=None]

When specified, will be called with each chunk of data that is streamed. The callback should take two arguments, the bytes of the current chunk of data and the response object. If the data is uploading, response will be None.

default value: None
operation_config

Operation configuration overrides.

Returns

TagResult or ClientRawResponse if raw=true

Return type

Exceptions