Partager via

ImageAnalysisClient Class

  • Reference

ImageAnalysisClient.

Inheritance
azure.ai.vision.imageanalysis._client.ImageAnalysisClient
ImageAnalysisClient

Constructor

ImageAnalysisClient(endpoint: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

Parameters

Name Description
endpoint
Required
str

Azure AI Computer Vision endpoint (protocol and hostname, for example: https://<resource-name>.cognitiveservices.azure.com). Required.
credential
Required
AzureKeyCredential or TokenCredential

Credential used to authenticate requests to the service. Is either a AzureKeyCredential type or a TokenCredential type. Required.

Keyword-Only Parameters

Name Description
api_version
str

The API version to use for this operation. Default value is "2023-10-01". Note that overriding this default value may result in unsupported behavior.

Methods

analyze

Performs a single Image Analysis operation.
analyze_from_url

Performs a single Image Analysis operation.
close
send_request

Runs the network request through the client's chained policies.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

analyze

Performs a single Image Analysis operation.

analyze(image_data: bytes, visual_features: List[VisualFeatures], *, language: str | None = None, gender_neutral_caption: bool | None = None, smart_crops_aspect_ratios: List[float] | None = None, model_version: str | None = None, **kwargs: Any) -> ImageAnalysisResult

Parameters

Name Description
image_data
Required
bytes

A buffer containing the whole image to be analyzed.
visual_features
Required
list[VisualFeatures]

A list of visual features to analyze. Required. Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People. At least one visual feature must be specified.

Keyword-Only Parameters

Name Description
language
str

The desired language for result generation (a two-letter language code). Defaults to 'en' (English). See https://aka.ms/cv-languages for a list of supported languages.
gender_neutral_caption
bool

Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features. Defaults to 'false'. Captions may contain gender terms (for example: 'man', 'woman', or 'boy', 'girl'). If you set this to 'true', those will be replaced with gender-neutral terms (for example: 'person' or 'child').
smart_crops_aspect_ratios
list[float]

A list of aspect ratios to use for smart cropping. Defaults to one crop region with an aspect ratio the service sees fit between 0.5 and 2.0 (inclusive). Aspect ratios are calculated by dividing the target crop width in pixels by the height in pixels. When set, supported values are between 0.75 and 1.8 (inclusive).
model_version
str

The version of cloud AI-model used for analysis. Defaults to 'latest', for the latest AI model with recent improvements. The format is the following: 'latest' or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model. If you would like to make sure analysis results do not change over time, set this value to a specific model version.

Returns

Type Description
ImageAnalysisResult

ImageAnalysisResult. The ImageAnalysisResult is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

analyze_from_url

Performs a single Image Analysis operation.

analyze_from_url(image_url: str, visual_features: List[VisualFeatures], *, language: str | None = None, gender_neutral_caption: bool | None = None, smart_crops_aspect_ratios: List[float] | None = None, model_version: str | None = None, **kwargs: Any) -> ImageAnalysisResult

Parameters

Name Description
image_url
Required
str

The publicly accessible URL of the image to analyze.
visual_features
Required
list[VisualFeatures]

A list of visual features to analyze. Required. Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People. At least one visual feature must be specified.

Keyword-Only Parameters

Name Description
language
str

The desired language for result generation (a two-letter language code). Defaults to 'en' (English). See https://aka.ms/cv-languages for a list of supported languages.
gender_neutral_caption
bool

Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features. Defaults to 'false'. Captions may contain gender terms (for example: 'man', 'woman', or 'boy', 'girl'). If you set this to 'true', those will be replaced with gender-neutral terms (for example: 'person' or 'child').
smart_crops_aspect_ratios
list[float]

A list of aspect ratios to use for smart cropping. Defaults to one crop region with an aspect ratio the service sees fit between 0.5 and 2.0 (inclusive). Aspect ratios are calculated by dividing the target crop width in pixels by the height in pixels. When set, supported values are between 0.75 and 1.8 (inclusive).
model_version
str

The version of cloud AI-model used for analysis. Defaults to 'latest', for the latest AI model with recent improvements. The format is the following: 'latest' or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model. If you would like to make sure analysis results do not change over time, set this value to a specific model version.

Returns

Type Description
ImageAnalysisResult

ImageAnalysisResult. The ImageAnalysisResult is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

close 

close() -> None

Keyword-Only Parameters

Name Description
language
str

The desired language for result generation (a two-letter language code). Defaults to 'en' (English). See https://aka.ms/cv-languages for a list of supported languages.
gender_neutral_caption
bool

Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features. Defaults to 'false'. Captions may contain gender terms (for example: 'man', 'woman', or 'boy', 'girl'). If you set this to 'true', those will be replaced with gender-neutral terms (for example: 'person' or 'child').
smart_crops_aspect_ratios
list[float]

A list of aspect ratios to use for smart cropping. Defaults to one crop region with an aspect ratio the service sees fit between 0.5 and 2.0 (inclusive). Aspect ratios are calculated by dividing the target crop width in pixels by the height in pixels. When set, supported values are between 0.75 and 1.8 (inclusive).
model_version
str

The version of cloud AI-model used for analysis. Defaults to 'latest', for the latest AI model with recent improvements. The format is the following: 'latest' or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model. If you would like to make sure analysis results do not change over time, set this value to a specific model version.

Exceptions

Type Description
HttpResponseError

send_request

Runs the network request through the client's chained policies.


>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse

Parameters

Name Description
request
Required
HttpRequest

The network request you want to make. Required.

Keyword-Only Parameters

Name Description
stream
bool

Whether the response payload will be streamed. Defaults to False.

Returns

Type Description
HttpResponse

The response of your network call. Does not do error handling on your response.

Exceptions

Type Description
HttpResponseError