Share via

ImageAnalysisAsyncClient Class

Package:
com.azure.ai.vision.imageanalysis
Maven Artifact:
com.azure:azure-ai-vision-imageanalysis:1.0.2
  • java.lang.Object
    • com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient

public final class ImageAnalysisAsyncClient

Initializes a new instance of the asynchronous ImageAnalysisClient type.

//
 // Create an asynchronous Image Analysis client with API key authentication.
 //
 ImageAnalysisAsyncClient client = new ImageAnalysisClientBuilder()
     .endpoint(endpoint)
     .credential(new KeyCredential(key))
     .buildAsyncClient();

//
 // Create an asynchronous Image Analysis client with Entra ID authentication.
 //
 ImageAnalysisAsyncClient client = new ImageAnalysisClientBuilder()
     .endpoint(endpoint)
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildAsyncClient();

Method Summary

Modifier and Type Method and Description
Mono<ImageAnalysisResult> analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)

Performs a single Image Analysis operation on a given image buffer.
Mono<ImageAnalysisResult> analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)

Performs a single Image Analysis operation on a give image URL.
Mono<Response<ImageAnalysisResult>> analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)

Performs a single Image Analysis operation on a give image URL, while allowing customization of the HTTP request and access to HTTP request and response details.
Mono<Response<ImageAnalysisResult>> analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)

Performs a single Image Analysis operation on a given image buffer, while allowing customization of the HTTP request and access to HTTP request and response details.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

analyze

public Mono<ImageAnalysisResult> analyze(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)

Performs a single Image Analysis operation on a given image buffer.

Parameters:

imageData - The image to analyze.
visualFeatures - 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.
options - Additional image analysis options.

Returns:

represents the outcome of an Image Analysis operation on successful completion of Mono. 
 //
 // Asynchronous analysis of an image file (sample.jpg), using all visual features,
 // with all options set. You will likely need fewer visual features and only
 // some (or no) options set.
 //
 ImageAnalysisOptions options = new ImageAnalysisOptions()
     .setLanguage("en")
     .setGenderNeutralCaption(true)
     .setSmartCropsAspectRatios(Arrays.asList(0.9, 1.33))
     .setModelVersion("latest");

 Mono<ImageAnalysisResult> result = client.analyze(
     BinaryData.fromFile(new File("sample.jpg").toPath()),
     Arrays.asList(
         VisualFeatures.SMART_CROPS,
         VisualFeatures.CAPTION,
         VisualFeatures.DENSE_CAPTIONS,
         VisualFeatures.OBJECTS,
         VisualFeatures.PEOPLE,
         VisualFeatures.READ,
         VisualFeatures.TAGS),
     options);

analyzeFromUrl

public Mono<ImageAnalysisResult> analyzeFromUrl(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions options)

Performs a single Image Analysis operation on a give image URL.

Parameters:

imageUrl - The publicly accessible URL of the image to analyze.
visualFeatures - 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.
options - Additional image analysis options.

Returns:

represents the outcome of an Image Analysis operation on successful completion of Mono. 
 //
 // Asynchronous analysis of an image file (https://aka.ms/azsdk/image-analysis/sample.jpg),
 // using all visual features, with all options set. You will likely need fewer visual features
 // and only some (or no) options set.
 //
 ImageAnalysisOptions options = new ImageAnalysisOptions()
     .setLanguage("en")
     .setGenderNeutralCaption(true)
     .setSmartCropsAspectRatios(Arrays.asList(0.9, 1.33))
     .setModelVersion("latest");

 Mono<ImageAnalysisResult> result = client.analyzeFromUrl(
     "https://aka.ms/azsdk/image-analysis/sample.jpg",
     Arrays.asList(
         VisualFeatures.SMART_CROPS,
         VisualFeatures.CAPTION,
         VisualFeatures.DENSE_CAPTIONS,
         VisualFeatures.OBJECTS,
         VisualFeatures.PEOPLE,
         VisualFeatures.READ,
         VisualFeatures.TAGS),
     options);

analyzeFromUrlWithResponse

public Mono<Response<ImageAnalysisResult>> analyzeFromUrlWithResponse(String imageUrl, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)

Performs a single Image Analysis operation on a give image URL, while allowing customization of the HTTP request and access to HTTP request and response details. This is not commonly used.

Parameters:

imageUrl - The publicly accessible URL of the image to analyze.
visualFeatures - 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.
imageAnalysisOptions - Additional image analysis options.
requestOptions - The options to configure the HTTP request before the HTTP client sends it.

Returns:

represents the outcome of an Image Analysis operation along with Response, on successful completion of Mono.

analyzeWithResponse

public Mono<Response<ImageAnalysisResult>> analyzeWithResponse(BinaryData imageData, List<VisualFeatures> visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)

Performs a single Image Analysis operation on a given image buffer, while allowing customization of the HTTP request and access to HTTP request and response details. This is not commonly used.

Parameters:

imageData - The image to analyze.
visualFeatures - 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.
imageAnalysisOptions - Additional image analysis options.
requestOptions - The options to configure the HTTP request before the HTTP client sends it.

Returns:

represents the outcome of an Image Analysis operation along with Response, on successful completion of Mono.

Applies to