ImageAnalysisClient.Analyze Method

Definition

Namespace:

Azure.AI.Vision.ImageAnalysis

Assembly:

Azure.AI.Vision.ImageAnalysis.dll

Package:

Azure.AI.Vision.ImageAnalysis v1.0.0

Overloads

Analyze(BinaryData, VisualFeatures, ImageAnalysisOptions, CancellationToken)	Performs a single Image Analysis operation.
Analyze(Uri, VisualFeatures, ImageAnalysisOptions, CancellationToken)	Performs a single Image Analysis operation.

Analyze(BinaryData, VisualFeatures, ImageAnalysisOptions, CancellationToken)

Source:

ImageAnalysisClient.cs

Performs a single Image Analysis operation.

public virtual Azure.Response<Azure.AI.Vision.ImageAnalysis.ImageAnalysisResult> Analyze (BinaryData imageData, Azure.AI.Vision.ImageAnalysis.VisualFeatures visualFeatures, Azure.AI.Vision.ImageAnalysis.ImageAnalysisOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Analyze : BinaryData * Azure.AI.Vision.ImageAnalysis.VisualFeatures * Azure.AI.Vision.ImageAnalysis.ImageAnalysisOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.ImageAnalysis.ImageAnalysisResult>
override this.Analyze : BinaryData * Azure.AI.Vision.ImageAnalysis.VisualFeatures * Azure.AI.Vision.ImageAnalysis.ImageAnalysisOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.ImageAnalysis.ImageAnalysisResult>

Public Overridable Function Analyze (imageData As BinaryData, visualFeatures As VisualFeatures, Optional options As ImageAnalysisOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ImageAnalysisResult)

Parameters

imageData

BinaryData

The image to be analyzed.

visualFeatures

VisualFeatures

A flags enumeration indicating what visual feature types to return. Valid visual feature types include: Tags, Caption, DenseCaptions, Objects, Read, SmartCrops, People. At least one visual feature must be specified for Image Analysis.

options

ImageAnalysisOptions

A structure containing the per call analysis options.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<ImageAnalysisResult>

Exceptions

ArgumentNullException

imageData is null.

Analyze(Uri, VisualFeatures, ImageAnalysisOptions, CancellationToken)

Source:

ImageAnalysisClient.cs

Performs a single Image Analysis operation.

public virtual Azure.Response<Azure.AI.Vision.ImageAnalysis.ImageAnalysisResult> Analyze (Uri imageUri, Azure.AI.Vision.ImageAnalysis.VisualFeatures visualFeatures, Azure.AI.Vision.ImageAnalysis.ImageAnalysisOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member Analyze : Uri * Azure.AI.Vision.ImageAnalysis.VisualFeatures * Azure.AI.Vision.ImageAnalysis.ImageAnalysisOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.ImageAnalysis.ImageAnalysisResult>
override this.Analyze : Uri * Azure.AI.Vision.ImageAnalysis.VisualFeatures * Azure.AI.Vision.ImageAnalysis.ImageAnalysisOptions * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.ImageAnalysis.ImageAnalysisResult>

Public Overridable Function Analyze (imageUri As Uri, visualFeatures As VisualFeatures, Optional options As ImageAnalysisOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Response(Of ImageAnalysisResult)

Parameters

imageUri

Uri

The image to be analyzed.

visualFeatures

VisualFeatures

A flags enumeration indicating what visual feature types to return. Valid visual feature types include: Tags, Caption, DenseCaptions, Objects, Read, SmartCrops, People. At least one visual feature must be specified for Image Analysis.

options

ImageAnalysisOptions

A structure containing the per call analysis options.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Response<ImageAnalysisResult>

Exceptions

ArgumentNullException

imageUri is null.