ImageAnalysisResult Class

Reference

Definition

Namespace:: Azure.AI.Vision.ImageAnalysis

Assembly:: Azure.AI.Vision.ImageAnalysis.dll

Package:: Azure.AI.Vision.ImageAnalysis v1.0.0-beta.2

Source:: ImageAnalysisResult.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents the outcome of an Image Analysis operation.

public class ImageAnalysisResult : System.ClientModel.Primitives.IJsonModel<Azure.AI.Vision.ImageAnalysis.ImageAnalysisResult>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Vision.ImageAnalysis.ImageAnalysisResult>

type ImageAnalysisResult = class
    interface IJsonModel<ImageAnalysisResult>
    interface IPersistableModel<ImageAnalysisResult>

Public Class ImageAnalysisResult
Implements IJsonModel(Of ImageAnalysisResult), IPersistableModel(Of ImageAnalysisResult)

Inheritance: Object
ImageAnalysisResult

Implements: IJsonModel<ImageAnalysisResult> IPersistableModel<ImageAnalysisResult> IPersistableModel<T>

Remarks

Always start by checking the value of Reason property to determine if the analysis operation was successful or not. When an analysis operation is successful, applicable properties in this object will be populated based on the selected features (ImageAnalysisOptions.Features) or custom-trained model (ImageAnalysisOptions.ModelName). These results are parsed from the service JSON response. Other properties will be null. Call ImageAnalysisResultDetails.FromResult to get access to additional information about the result, such as the raw JSON response. When analysis operation failed, call ImageAnalysisErrorDetails.FromResult to get access to additional information about the error.

Properties

Caption	The generated phrase that describes the content of the analyzed image.
DenseCaptions	The up to 10 generated phrases, the first describing the content of the whole image, and the others describing the content of different regions of the image.
Metadata	Metadata associated with the analyzed image.
ModelVersion	The cloud AI model used for the analysis.
Objects	A list of detected physical objects in the analyzed image, and their location.
People	A list of detected people in the analyzed image, and their location.
Read	The extracted printed and hand-written text in the analyze image. Also knows as OCR.
SmartCrops	A list of crop regions at the desired as aspect ratios (if provided) that can be used as image thumbnails. These regions preserve as much content as possible from the analyzed image, with priority given to detected faces.
Tags	A list of content tags in the analyzed image.

Explicit Interface Implementations

IJsonModel<ImageAnalysisResult>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ImageAnalysisResult>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<ImageAnalysisResult>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<ImageAnalysisResult>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ImageAnalysisResult>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to