analyze_from_image_datas
Creates, updates, deletes, gets or lists an analyze_from_image_datas resource.
Overview
| Name | analyze_from_image_datas |
| Type | Resource |
| Id | azure.ai_vision_image_analysis.analyze_from_image_datas |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
analyze_from_image_data | exec | features, endpoint | language, gender-neutral-caption, smartcrops-aspect-ratios, model-version | Performs a single Image Analysis operation. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endpoint | string | The service endpoint host (no scheme), e.g. myaccount.table.cosmos.azure.com:443 - value of the client endpoint parameter. (default: ) |
features | array | A list of visual features to analyze. Seven visual features are supported: Caption, DenseCaptions, Read (OCR), Tags, Objects, SmartCrops, and People. At least one visual feature must be specified. Required. |
gender-neutral-caption | boolean | Boolean flag for enabling gender-neutral captioning for Caption and Dense Captions features. By default 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'). Default value is None. |
language | string | The desired language for result generation (a two-letter language code). If this option is not specified, the default value 'en' is used (English). See https://aka.ms/cv-languages for a list of supported languages. Default value is None. |
model-version | string | The version of cloud AI-model used for analysis. The format is the following: 'latest' (default value) or 'YYYY-MM-DD' or 'YYYY-MM-DD-preview', where 'YYYY', 'MM', 'DD' are the year, month and day associated with the model. This is not commonly set, as the default always gives the latest AI model with recent improvements. If however you would like to make sure analysis results do not change over time, set this value to a specific model version. Default value is None. |
smartcrops-aspect-ratios | array | A list of aspect ratios to use for smart cropping. Aspect ratios are calculated by dividing the target crop width in pixels by the height in pixels. Supported values are between 0.75 and 1.8 (inclusive). If this parameter is not specified, the service will return one crop region with an aspect ratio it sees fit between 0.5 and 2.0 (inclusive). Default value is None. |
Lifecycle Methods
- analyze_from_image_data
Performs a single Image Analysis operation.
EXEC azure.ai_vision_image_analysis.analyze_from_image_datas.analyze_from_image_data
@features='{{ features }}' --required,
@endpoint='{{ endpoint }}' --required,
@language='{{ language }}',
@gender-neutral-caption={{ gender-neutral-caption }},
@smartcrops-aspect-ratios='{{ smartcrops-aspect-ratios }}',
@model-version='{{ model-version }}'
;