Partilhar via

ImageAnalysisClient Class

  • Reference
Package:
com.azure.ai.vision.imageanalysis
Maven Artifact:
com.azure:azure-ai-vision-imageanalysis:1.0.0
  • java.lang.Object
    • com.azure.ai.vision.imageanalysis.ImageAnalysisClient

public final class ImageAnalysisClient

Initializes a new instance of the synchronous ImageAnalysisClient type.

//
 // Create a synchronous Image Analysis client with API key authentication.
 //
 ImageAnalysisClient client = new ImageAnalysisClientBuilder()
     .endpoint(endpoint)
     .credential(new KeyCredential(key))
     .buildClient();

//
 // Create a synchronous Image Analysis client with Entra ID authentication.
 //
 ImageAnalysisClient client = new ImageAnalysisClientBuilder()
     .endpoint(endpoint)
     .credential(new DefaultAzureCredentialBuilder().build())
     .buildClient();

Method Summary

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

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

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

Performs a single Image Analysis operation on a given image URL, while allowing customization of the HTTP request and access to HTTP request and response details.
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 ImageAnalysisResult analyze(BinaryData imageData, List 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. 
 //
 // Synchronous 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");

 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 ImageAnalysisResult analyzeFromUrl(String imageUrl, List 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. 
 //
 // Synchronous 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");

 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 Response analyzeFromUrlWithResponse(String imageUrl, List visualFeatures, ImageAnalysisOptions imageAnalysisOptions, RequestOptions requestOptions)

Performs a single Image Analysis operation on a given 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.

analyzeWithResponse

public Response analyzeWithResponse(BinaryData imageData, List 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.

Applies to