ImageAnalysisClient Class

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();

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

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

Parameters:

Returns:

 //
 // 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);
 

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

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

Parameters:

Returns:

 //
 // 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);
 

public 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. This is not commonly used.

Parameters:

Returns:

public 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:

Returns: