azure.cognitiveservices.vision.computervision.operations module

class azure.cognitiveservices.vision.computervision.operations.ComputerVisionClientOperationsMixin

Bases: object

analyze_image(url, visual_features=None, details=None, language='en', description_exclude=None, model_version='latest', 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.

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.

• 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.

• 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’

• description_exclude (list[str or DescriptionExclude]) – Turn off specified domain models when generating the description.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ImageAnalysis or ClientRawResponse if raw=true

Return type

ImageAnalysis or ClientRawResponse

Raises

ComputerVisionErrorResponseException

analyze_image_by_domain(model, url, language='en', model_version='latest', 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.

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’

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DomainModelResults or ClientRawResponse if raw=true

Return type

DomainModelResults or ClientRawResponse

Raises

ComputerVisionErrorResponseException

analyze_image_by_domain_in_stream(model, image, language='en', model_version='latest', 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.

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’

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

DomainModelResults or ClientRawResponse if raw=true

Return type

DomainModelResults or ClientRawResponse

Raises

ComputerVisionErrorResponseException

analyze_image_in_stream(image, visual_features=None, details=None, language='en', description_exclude=None, model_version='latest', 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.

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.

• 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.

• 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’

• description_exclude (list[str or DescriptionExclude]) – Turn off specified domain models when generating the description.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

ImageAnalysis or ClientRawResponse if raw=true

Return type

ImageAnalysis or ClientRawResponse

Raises

ComputerVisionErrorResponseException

describe_image(url, max_candidates=1, language='en', description_exclude=None, model_version='latest', 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.

Parameters

• url (str) – Publicly reachable URL of an image.

• max_candidates (int) – Maximum number of candidate descriptions to be returned. The default is 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’

• description_exclude (list[str or DescriptionExclude]) – Turn off specified domain models when generating the description.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ImageDescription or ClientRawResponse if raw=true

Return type

ImageDescription or ClientRawResponse

Raises

ComputerVisionErrorResponseException

describe_image_in_stream(image, max_candidates=1, language='en', description_exclude=None, model_version='latest', 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.

Parameters

• image (Generator) – An image stream.

• max_candidates (int) – Maximum number of candidate descriptions to be returned. The default is 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’

• description_exclude (list[str or DescriptionExclude]) – Turn off specified domain models when generating the description.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

ImageDescription or ClientRawResponse if raw=true

Return type

ImageDescription or ClientRawResponse

Raises

ComputerVisionErrorResponseException

detect_objects(url, model_version='latest', 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.

Parameters

• url (str) – Publicly reachable URL of an image.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

DetectResult or ClientRawResponse if raw=true

Return type

DetectResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException

detect_objects_in_stream(image, model_version='latest', 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.

Parameters

• image (Generator) – An image stream.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

DetectResult or ClientRawResponse if raw=true

Return type

DetectResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException

generate_thumbnail(width, height, url, smart_cropping=False, model_version='latest', 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.

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.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

HttpOperationError

generate_thumbnail_in_stream(width, height, image, smart_cropping=False, model_version='latest', 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.

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.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

object or ClientRawResponse if raw=true

Return type

Generator or ClientRawResponse

Raises

HttpOperationError

get_area_of_interest(url, model_version='latest', 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.

Parameters

• url (str) – Publicly reachable URL of an image.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

AreaOfInterestResult or ClientRawResponse if raw=true

Return type

AreaOfInterestResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException

get_area_of_interest_in_stream(image, model_version='latest', 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.

Parameters

• image (Generator) – An image stream.

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

AreaOfInterestResult or ClientRawResponse if raw=true

Return type

AreaOfInterestResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException

get_read_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 Read interface.

Parameters

• operation_id (str) – Id of read operation returned in the response of the ‘Read’ interface.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ReadOperationResult or ClientRawResponse if raw=true

Return type

ReadOperationResult or ClientRawResponse

Raises

ComputerVisionOcrErrorException

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.

Parameters

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

ListModelsResult or ClientRawResponse if raw=true

Return type

ListModelsResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException

read(url, language=None, pages=None, model_version='latest', reading_order='basic', 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 interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your ‘GetReadResult’ operation to access OCR results.​.

Parameters

• url (str) – Publicly reachable URL of an image.

• language (str or OcrDetectionLanguage) – The BCP-47 language code of the text in the document. Read supports auto language identification and multi-language documents, so only provide a language code if you would like to force the document to be processed in that specific language. See https://aka.ms/ocr-languages for list of supported languages. Possible values include: ‘af’, ‘ast’, ‘bi’, ‘br’, ‘ca’, ‘ceb’, ‘ch’, ‘co’, ‘crh’, ‘cs’, ‘csb’, ‘da’, ‘de’, ‘en’, ‘es’, ‘et’, ‘eu’, ‘fi’, ‘fil’, ‘fj’, ‘fr’, ‘fur’, ‘fy’, ‘ga’, ‘gd’, ‘gil’, ‘gl’, ‘gv’, ‘hni’, ‘hsb’, ‘ht’, ‘hu’, ‘ia’, ‘id’, ‘it’, ‘iu’, ‘ja’, ‘jv’, ‘kaa’, ‘kac’, ‘kea’, ‘kha’, ‘kl’, ‘ko’, ‘ku’, ‘kw’, ‘lb’, ‘ms’, ‘mww’, ‘nap’, ‘nl’, ‘no’, ‘oc’, ‘pl’, ‘pt’, ‘quc’, ‘rm’, ‘sco’, ‘sl’, ‘sq’, ‘sv’, ‘sw’, ‘tet’, ‘tr’, ‘tt’, ‘uz’, ‘vo’, ‘wae’, ‘yua’, ‘za’, ‘zh-Hans’, ‘zh-Hant’, ‘zu’

• pages (list[str]) – Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages, use a hyphen. Separate each page or range with a comma.

• model_version (str) – Optional parameter to specify the version of the OCR model used for text extraction. Accepted values are: “latest”, “latest-preview”, “2021-04-12”. Defaults to “latest”.

• reading_order (str) – Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either ‘basic’ or ‘natural’. Will default to ‘basic’ if not specified

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ComputerVisionOcrErrorException

read_in_stream(image, language=None, pages=None, model_version='latest', reading_order='basic', custom_headers=None, raw=False, callback=None, **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 interface, the response contains a field called ‘Operation-Location’. The ‘Operation-Location’ field contains the URL that you must use for your ‘GetReadResult’ operation to access OCR results.​.

Parameters

• image (Generator) – An image stream.

• language (str or OcrDetectionLanguage) – The BCP-47 language code of the text in the document. Read supports auto language identification and multi-language documents, so only provide a language code if you would like to force the document to be processed in that specific language. See https://aka.ms/ocr-languages for list of supported languages. Possible values include: ‘af’, ‘ast’, ‘bi’, ‘br’, ‘ca’, ‘ceb’, ‘ch’, ‘co’, ‘crh’, ‘cs’, ‘csb’, ‘da’, ‘de’, ‘en’, ‘es’, ‘et’, ‘eu’, ‘fi’, ‘fil’, ‘fj’, ‘fr’, ‘fur’, ‘fy’, ‘ga’, ‘gd’, ‘gil’, ‘gl’, ‘gv’, ‘hni’, ‘hsb’, ‘ht’, ‘hu’, ‘ia’, ‘id’, ‘it’, ‘iu’, ‘ja’, ‘jv’, ‘kaa’, ‘kac’, ‘kea’, ‘kha’, ‘kl’, ‘ko’, ‘ku’, ‘kw’, ‘lb’, ‘ms’, ‘mww’, ‘nap’, ‘nl’, ‘no’, ‘oc’, ‘pl’, ‘pt’, ‘quc’, ‘rm’, ‘sco’, ‘sl’, ‘sq’, ‘sv’, ‘sw’, ‘tet’, ‘tr’, ‘tt’, ‘uz’, ‘vo’, ‘wae’, ‘yua’, ‘za’, ‘zh-Hans’, ‘zh-Hant’, ‘zu’

• pages (list[str]) – Custom page numbers for multi-page documents(PDF/TIFF), input the number of the pages you want to get OCR result. For a range of pages, use a hyphen. Separate each page or range with a comma.

• model_version (str) – Optional parameter to specify the version of the OCR model used for text extraction. Accepted values are: “latest”, “latest-preview”, “2021-04-12”. Defaults to “latest”.

• reading_order (str) – Optional parameter to specify which reading order algorithm should be applied when ordering the extract text elements. Can be either ‘basic’ or ‘natural’. Will default to ‘basic’ if not specified

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

None or ClientRawResponse

Raises

ComputerVisionOcrErrorException

recognize_printed_text(url, detect_orientation=True, language='unk', model_version='latest', 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.

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.

• 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’

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

OcrResult or ClientRawResponse if raw=true

Return type

OcrResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException

recognize_printed_text_in_stream(image, detect_orientation=True, language='unk', model_version='latest', 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.

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.

• 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’

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

OcrResult or ClientRawResponse if raw=true

Return type

OcrResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException

tag_image(url, language='en', model_version='latest', 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.

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’

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• operation_config – Operation configuration overrides.

Returns

TagResult or ClientRawResponse if raw=true

Return type

TagResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException

tag_image_in_stream(image, language='en', model_version='latest', 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.

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’

• model_version (str) – Optional parameter to specify the version of the AI model. Accepted values are: “latest”, “2021-04-01”. Defaults to “latest”.

• custom_headers (dict) – headers that will be added to the request

• raw (bool) – returns the direct response alongside the deserialized response

• 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.

• operation_config – Operation configuration overrides.

Returns

TagResult or ClientRawResponse if raw=true

Return type

TagResult or ClientRawResponse

Raises

ComputerVisionErrorResponseException