Image Analysis SDK - Add missing @ServiceMethod tags; Move ImageAnaly…

…sisOptions to models pacakge (Azure#38292) * Add missing @ServiceMethod tags * Move ImageAnalysisOptions class to the `models` pacakge
azure-sdk · Jan 11, 2024 · 7322035 · 7322035
1 parent be30f37
commit 7322035
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 10 deletions.
diff --git a/sdk/vision/azure-ai-vision-imageanalysis/README.md b/sdk/vision/azure-ai-vision-imageanalysis/README.md
@@ -140,7 +140,7 @@ Notes:
 * Caption is only supported in English at the moment.
 
 ```java imports-caption-file-snippet
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.util.BinaryData;
@@ -167,7 +167,7 @@ To generate captions for additional images, simply call `analyze` multiple times
 This example is similar to the above, except it calls the `analyze` method and provides a [publicly accessible image URL](https://aka.ms/azsdk/image-analysis/sample.jpg) instead of a file name.
 
 ```java imports-caption-url-snippet
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import java.net.URL;

diff --git a/sdk/vision/azure-ai-vision-imageanalysis/src/customizations/customizations.md b/sdk/vision/azure-ai-vision-imageanalysis/src/customizations/customizations.md
@@ -62,6 +62,7 @@ import java.net.URL;
      * 
      * @return represents the outcome of an Image Analysis operation.
      */
+    @ServiceMethod(returns = ReturnType.SINGLE)
     public ImageAnalysisResult analyze(URL imageUrl, List<VisualFeatures> visualFeatures,
         ImageAnalysisOptions options) {
         if (options == null) {
@@ -90,6 +91,7 @@ import java.net.URL;
      * 
      * @return represents the outcome of an Image Analysis operation.
      */
+    @ServiceMethod(returns = ReturnType.SINGLE)
     public ImageAnalysisResult analyze(BinaryData imageData, List<VisualFeatures> visualFeatures,
         ImageAnalysisOptions options) {
         if (options == null) {
@@ -126,6 +128,7 @@ import java.net.URL;
      * 
      * @return represents the outcome of an Image Analysis operation on successful completion of {@link Mono}.
      */
+    @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<ImageAnalysisResult> analyze(URL imageUrl, List<VisualFeatures> visualFeatures,
         ImageAnalysisOptions options) {
         if (options == null) {
@@ -154,6 +157,7 @@ import java.net.URL;
      * 
      * @return represents the outcome of an Image Analysis operation on successful completion of {@link Mono}.
      */
+    @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<ImageAnalysisResult> analyze(BinaryData imageData, List<VisualFeatures> visualFeatures,
         ImageAnalysisOptions options) {
         if (options == null) {

diff --git a/...ageanalysis/src/main/java/com/azure/ai/vision/imageanalysis/ImageAnalysisAsyncClient.java b/...ageanalysis/src/main/java/com/azure/ai/vision/imageanalysis/ImageAnalysisAsyncClient.java
@@ -5,6 +5,7 @@
 
 import com.azure.ai.vision.imageanalysis.implementation.ImageAnalysisClientImpl;
 import com.azure.ai.vision.imageanalysis.implementation.models.ImageUrl;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.annotation.Generated;
@@ -572,6 +573,7 @@ Mono<ImageAnalysisResult> analyzeFromUrl(List<VisualFeatures> visualFeatures, Im
      * 
      * @return represents the outcome of an Image Analysis operation on successful completion of {@link Mono}.
      */
+    @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<ImageAnalysisResult> analyze(URL imageUrl, List<VisualFeatures> visualFeatures,
         ImageAnalysisOptions options) {
         if (options == null) {
@@ -600,6 +602,7 @@ public Mono<ImageAnalysisResult> analyze(URL imageUrl, List<VisualFeatures> visu
      * 
      * @return represents the outcome of an Image Analysis operation on successful completion of {@link Mono}.
      */
+    @ServiceMethod(returns = ReturnType.SINGLE)
     public Mono<ImageAnalysisResult> analyze(BinaryData imageData, List<VisualFeatures> visualFeatures,
         ImageAnalysisOptions options) {
         if (options == null) {

diff --git a/...on-imageanalysis/src/main/java/com/azure/ai/vision/imageanalysis/ImageAnalysisClient.java b/...on-imageanalysis/src/main/java/com/azure/ai/vision/imageanalysis/ImageAnalysisClient.java
@@ -5,6 +5,7 @@
 
 import com.azure.ai.vision.imageanalysis.implementation.ImageAnalysisClientImpl;
 import com.azure.ai.vision.imageanalysis.implementation.models.ImageUrl;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.annotation.Generated;
@@ -564,6 +565,7 @@ ImageAnalysisResult analyzeFromUrl(List<VisualFeatures> visualFeatures, ImageUrl
      * 
      * @return represents the outcome of an Image Analysis operation.
      */
+    @ServiceMethod(returns = ReturnType.SINGLE)
     public ImageAnalysisResult analyze(URL imageUrl, List<VisualFeatures> visualFeatures,
         ImageAnalysisOptions options) {
         if (options == null) {
@@ -592,6 +594,7 @@ public ImageAnalysisResult analyze(URL imageUrl, List<VisualFeatures> visualFeat
      * 
      * @return represents the outcome of an Image Analysis operation.
      */
+    @ServiceMethod(returns = ReturnType.SINGLE)
     public ImageAnalysisResult analyze(BinaryData imageData, List<VisualFeatures> visualFeatures,
         ImageAnalysisOptions options) {
         if (options == null) {

diff --git a/...n/imageanalysis/ImageAnalysisOptions.java → ...analysis/models/ImageAnalysisOptions.java b/...n/imageanalysis/ImageAnalysisOptions.java → ...analysis/models/ImageAnalysisOptions.java
@@ -1,6 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License.
-package com.azure.ai.vision.imageanalysis;
+package com.azure.ai.vision.imageanalysis.models;
 
 import java.util.List;
 

diff --git a/...nalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleAnalyzeAllImageFile.java b/...nalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleAnalyzeAllImageFile.java
@@ -31,14 +31,14 @@
 
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClient;
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder;
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.CropRegion;
 import com.azure.ai.vision.imageanalysis.models.DenseCaption;
 import com.azure.ai.vision.imageanalysis.models.DetectedObject;
 import com.azure.ai.vision.imageanalysis.models.DetectedPerson;
 import com.azure.ai.vision.imageanalysis.models.DetectedTag;
 import com.azure.ai.vision.imageanalysis.models.DetectedTextLine;
 import com.azure.ai.vision.imageanalysis.models.DetectedTextWord;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.credential.KeyCredential;

diff --git a/...geanalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleCaptionImageFile.java b/...geanalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleCaptionImageFile.java
@@ -34,7 +34,7 @@
 // END: imports-for-create-client-snippet
 
 // BEGIN: imports-caption-file-snippet
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.util.BinaryData;

diff --git a/...lysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleCaptionImageFileAsync.java b/...lysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleCaptionImageFileAsync.java
@@ -29,7 +29,7 @@
 
 import com.azure.ai.vision.imageanalysis.ImageAnalysisAsyncClient;
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder;
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.credential.KeyCredential;

diff --git a/...ageanalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleCaptionImageUrl.java b/...ageanalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleCaptionImageUrl.java
@@ -33,7 +33,7 @@
 import java.net.MalformedURLException;
 
 // BEGIN: imports-caption-url-snippet
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import java.net.URL;

diff --git a/...ysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleDenseCaptionsImageFile.java b/...ysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleDenseCaptionsImageFile.java
@@ -33,8 +33,8 @@
 
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClient;
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder;
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.DenseCaption;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.credential.KeyCredential;

diff --git a/...nalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleSmartCropsImageFile.java b/...nalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleSmartCropsImageFile.java
@@ -34,8 +34,8 @@
 
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClient;
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder;
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.CropRegion;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.credential.KeyCredential;

diff --git a/...imageanalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleTagsImageFile.java b/...imageanalysis/src/samples/java/com/azure/ai/vision/imageanalysis/SampleTagsImageFile.java
@@ -28,8 +28,8 @@
 
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClient;
 import com.azure.ai.vision.imageanalysis.ImageAnalysisClientBuilder;
-import com.azure.ai.vision.imageanalysis.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.DetectedTag;
+import com.azure.ai.vision.imageanalysis.models.ImageAnalysisOptions;
 import com.azure.ai.vision.imageanalysis.models.ImageAnalysisResult;
 import com.azure.ai.vision.imageanalysis.models.VisualFeatures;
 import com.azure.core.credential.KeyCredential;