Namespace Azure::AI::Vision::ImageAnalysis

Summary

Members	Descriptions
enum ImageAnalysisErrorReason	A categorical representation of error classes that can cause an Image Analysis request to fail.
enum ImageAnalysisFeature	Defines the supported visual features to detect in an image.
enum ImageSegmentationMode	Defines the segmentation mode supported by the Image Analysis service.
enum ImageAnalysisResultReason	Represents the reasons why an Image Analysis operation concluded.
class ImageAnalysis::ContentCaption	Represents a generated phrase that describes the content of the whole image or a region in the image.
class ImageAnalysis::ContentTag	Represent an image tag. A tag can be a recognizable object, living being, scenery, or actions that appear in the image.
class ImageAnalysis::ContentTags	Represents a list of image tags.
class ImageAnalysis::CropSuggestion	Represents a suggested image cropping that preserves much of the image content.
class ImageAnalysis::CropSuggestions	Represents a list of image crop suggestions that preserve most of the image content.
class ImageAnalysis::DenseCaptions	Represents a list of up to 10 captions for different regions of the image.
class ImageAnalysis::DetectedObject	Represents a physical object detected in an image.
class ImageAnalysis::DetectedObjects	Represents a list of physical object detected in an image.
class ImageAnalysis::DetectedPeople	Represents people detected in an image.
class ImageAnalysis::DetectedPerson	Represents a person detected in an image.
class ImageAnalysis::DetectedText	Represents the text lines detected in an image.
class ImageAnalysis::DetectedTextLine	Represents a single, contiguous line of text as detected within an image.
class ImageAnalysis::DetectedTextWord	Represents a single word that was detected in an image.
class ImageAnalysis::ImageAnalysisErrorDetails	A representation of an error associated with an image analysis result.
class ImageAnalysis::ImageAnalysisEventArgs	Represents an asynchronous Image Analysis result payload as an event argument.
class ImageAnalysis::ImageAnalysisOptions	Represents the configuration options that control the function of the ImageAnalyzer.
class ImageAnalysis::ImageAnalysisResult	Represents the outcome of an Image Analysis operation.
class ImageAnalysis::ImageAnalysisResultDetails	Represents additional information related to an image analysis result.
class ImageAnalysis::ImageAnalysisResultProperties	Represents the collection of properties on a given Image Analysis result object.
class ImageAnalysis::ImageAnalyzer	An object that facilitates Image Analysis operations with the Computer Vision service.
class ImageAnalysis::ImageAnalyzerProperties	Represents the properties that can be dynamically updated on a given ImageAnalyzer instance.
class ImageAnalysis::Rectangle	Represents a rectangular area inside an image.
class ImageAnalysis::SegmentationResult	Holds a single segmentation result image of PNG format and associated metadata.

Members

enum ImageAnalysisErrorReason

Values	Descriptions
AuthenticationFailure	Indicates an authentication error. An authentication error occurs if subscription key or authorization token is invalid, expired, or does not match the region being used.
BadRequest	Indicates that one or more image analysis parameters are invalid or the image format is not supported.
TooManyRequests	Indicates that the number of parallel requests exceeded the number of allowed concurrent analysis operations for the subscription.
Forbidden	Indicates that the free subscription used by the request ran out of quota.
ConnectionFailure	Indicates a connection error.
ServiceTimeout	Indicates a timeout when waiting for a response from the Computer Vision service.
ServiceError	Indicates an internal service error.
ServiceUnavailable	Indicates that the service is currently unavailable.
RuntimeError	Indicates any other service errors.

A categorical representation of error classes that can cause an Image Analysis request to fail.

enum ImageAnalysisFeature

Values	Descriptions
Tags	Tags the image with a detailed list of recognizable objects, living beings, scenery, and actions that appear in the image. The language of the tags can be specified by setting the property ImageAnalysisOptions::SetLanguage.
Caption	Generates a human-readable phrase that describes the image content, in one of the supported languages.
DenseCaptions	Dense Captions provides more details than ImageAnalysisFeature::Caption, by generating one sentence descriptions of up to 10 regions of the image in addition to describing the whole image.
Objects	Detects various objects within an image, including their approximate location. Object names are only available in English at the moment.
People	Detects people in the image, including their approximate location.
Text	Also known as Read or OCR. Performs Optical Character Recognition (OCR) and returns the text detected in the image, including the approximate location of every text line and word.
CropSuggestions	Also known as SmartCrops. Returns recommendations for image crop operations that preserve content (for example for thumbnail generation)

Defines the supported visual features to detect in an image.

enum ImageSegmentationMode

Values	Descriptions
None	The default value. No segmentation is performed.
BackgroundRemoval	Background removal. Segmentation results in a PNG image of the detected foreground object with a transparent background.
ForegroundMatting	Foreground matting. Segmentation results in a grayscale alpha matte PNG image showing the opacity of the detected foreground object.

Defines the segmentation mode supported by the Image Analysis service.

enum ImageAnalysisResultReason

Values	Descriptions
Error	Indicates that a result was generated due to an error during Image Analysis.
Analyzed	Indicates that Image Analysis was successful and results are available.

Represents the reasons why an Image Analysis operation concluded.