Merge pull request #265948 from dargilco/dargilco/02-09-2024-java-python-updates-for-image-analysis-beta2

Java & Python public docs updates for beta.2 release of Image Analysis SDK

Author: v-dirichards

articles/ai-services/computer-vision/includes/how-to-guides/analyze-image-40-java.md

@@ -34,27 +34,23 @@ You can select an image by providing a publicly accessible image URL, or by read
 
 ### Image URL
 
-Create a [URL](https://docs.oracle.com/javase/8/docs/api/java/net/URL.html) object for the image you want to analyze.
+Create an `imageUrl` string to hold the publicly accessible URL of the image you want to analyze.
 
 [!code-java[](~/cognitive-services-quickstart-code/java/ComputerVision/4-0/ImageAnalysisHowTo.java?name=snippet_url)]
 
-
 ### Image buffer
 
-Alternatively, you can pass in the image as a data array using a **BinaryData** object. For example, read from a local image file you want to analyze.
+Alternatively, you can pass in the image as memory buffer using a [BinaryData](/java/api/com.azure.core.util.binarydata) object. For example, read from a local image file you want to analyze.
 
 [!code-java[](~/cognitive-services-quickstart-code/java/ComputerVision/4-0/ImageAnalysisHowTo.java?name=snippet_file)]
 
 ## Select visual features
 
 The Analysis 4.0 API gives you access to all of the service's image analysis features. Choose which operations to do based on your own use case. See the [overview](/azure/ai-services/computer-vision/overview-image-analysis) for a description of each feature. The example in this section adds all of the [available visual features](/java/api/com.azure.ai.vision.imageanalysis.models.visualfeatures), but for practical usage you likely need fewer.
 
-
 > [!IMPORTANT]
 > The visual features [Captions](/java/api/com.azure.ai.vision.imageanalysis.models.visualfeatures#com-azure-ai-vision-imageanalysis-models-visualfeatures-caption) and [DenseCaptions](/java/api/com.azure.ai.vision.imageanalysis.models.visualfeatures#com-azure-ai-vision-imageanalysis-models-visualfeatures-dense-captions) are only supported in the following Azure regions: East US, France Central, Korea Central, North Europe, Southeast Asia, West Europe, West US.
 
-
-
 [!code-java[](~/cognitive-services-quickstart-code/java/ComputerVision/4-0/ImageAnalysisHowTo.java?name=snippet_features)]
 
 <!--
@@ -67,7 +63,6 @@ To use a custom model, create the [ImageAnalysisOptions](/java/api/com.azure.ai.
 [!code-java[](~/azure-ai-vision-sdk/docs/learn.microsoft.com/java/image-analysis/custom-model/ImageAnalysis.java?name=model_name)]
 -->
 
-
 ## Select analysis options
 
 Use an [ImageAnalysisOptions](/java/api/com.azure.ai.vision.imageanalysis.models.imageanalysisoptions) object to specify various options for the Analyze API call.
@@ -78,16 +73,13 @@ Use an [ImageAnalysisOptions](/java/api/com.azure.ai.vision.imageanalysis.models
 
 [!code-java[](~/cognitive-services-quickstart-code/java/ComputerVision/4-0/ImageAnalysisHowTo.java?name=snippet_options)]
 
+## Call the analyzeFromUrl method
 
+This section shows you how to make an analysis call to the service.
 
+Call the [analyzeFromUrl](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisclient#method-summary) method on the [ImageAnalysisClient](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisclient) object, as shown here. The call is synchronous, and will block until the service returns the results or an error occurred. Alternatively, you can use a [ImageAnalysisAsyncClient](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisasyncclient) object instead, and call its [analyzeFromUrl](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisasyncclient#method-summary) method which is non-blocking.
 
-## Call the Analyze API
-
-This section shows you how to make an analysis call to the service. 
-
-Call the [analyze](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisclient#method-summary) method on the [ImageAnalysisClient](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisclient) object, as shown here. The call is synchronous, and will block until the service returns the results or an error occurred. Alternatively, you can use a [ImageAnalysisAsyncClient](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisasyncclient) object instead, and call its [analyze](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisasyncclient#method-summary) method which is non-blocking.
-
-Use the input objects created in the above sections. To analyze from an image buffer instead of URL, replace `imageURL` in the method call with `imageData`.
+To analyze from an image buffer instead of URL, call the [analyze](/java/api/com.azure.ai.vision.imageanalysis.imageanalysisclient#method-summary) method instead, and pass in the `imageData` as the first argument.
 
 [!code-java[](~/cognitive-services-quickstart-code/java/ComputerVision/4-0/ImageAnalysisHowTo.java?name=snippet_call)]
 
@@ -104,7 +96,7 @@ The code is similar to the standard model case. The only difference is that resu
 
 ## Get results from the service
 
-The following code shows you how to parse the results of the various Analyze operations.
+The following code shows you how to parse the results from the **analyzeFromUrl** and **analyze** operations.
 
 [!code-java[](~/cognitive-services-quickstart-code/java/ComputerVision/4-0/ImageAnalysisHowTo.java?name=snippet_results)]
 

articles/ai-services/computer-vision/includes/how-to-guides/analyze-image-40-python.md

@@ -43,7 +43,7 @@ You can use the following sample image URL.
 
 ### Image buffer
 
-Alternatively, you can pass in the image as a data array. For example, read from a local image file you want to analyze.
+Alternatively, you can pass in the image as [bytes](https://docs.python.org/3/library/stdtypes.html#bytes-objects) object. For example, read from a local image file you want to analyze.
 
 [!code-python[](~/cognitive-services-quickstart-code/python/ComputerVision/4-0/how-to.py?name=snippet_file)]
 
@@ -63,9 +63,9 @@ To use a custom model, create the [ImageAnalysisOptions](/python/api/azure-ai-vi
 [!code-python[](~/azure-ai-vision-sdk/docs/learn.microsoft.com/python/image-analysis/custom-model/main.py?name=model_name)]
 -->
 
-## Call the Analyze API with options
+## Call the analyze_from_url method with options
 
-The following code calls the [Analyze API](/python/api/azure-ai-vision-imageanalysis/azure.ai.vision.imageanalysis.imageanalysisclient#azure-ai-vision-imageanalysis-imageanalysisclient-analyze) with the features you selected above and additional options, defined below. To analyze from an image buffer instead of URL, replace `image_url=image_url` in the method call with `image_data=image_data`.
+The following code calls the [analyze_from_url](/python/api/azure-ai-vision-imageanalysis/azure.ai.vision.imageanalysis.imageanalysisclient#azure-ai-vision-imageanalysis-imageanalysisclient-analyzefromurl) method on the client with the features you selected above and additional options, defined below. To analyze from an image buffer instead of URL, call the method [analyze](/python/api/azure-ai-vision-imageanalysis/azure.ai.vision.imageanalysis.imageanalysisclient#azure-ai-vision-imageanalysis-imageanalysisclient-analyze) instead, with `image_data=image_data` as the first argument.
 
 [!code-python[](~/cognitive-services-quickstart-code/python/ComputerVision/4-0/how-to.py?name=snippet_call)]
 
@@ -85,7 +85,7 @@ You can specify the language of the returned data. The language is optional, wit
 
 ## Get results from the service
 
-The following code shows you how to parse the results of the various **analyze** operations.
+The following code shows you how to parse the results from the **analyze_from_url** or **analyze** operations.
 
 [!code-python[](~/cognitive-services-quickstart-code/python/ComputerVision/4-0/how-to.py?name=snippet_result)]
 

articles/ai-services/computer-vision/includes/quickstarts-sdk/image-analysis-java-sdk-40.md

@@ -35,31 +35,37 @@ Use the Image Analysis client SDK for Java to analyze an image to read text and
 Open a console window and create a new folder for your quickstart application.
 
 1. Open a text editor and copy the following content to a new file. Save the file as `pom.xml` in your project directory
-    <!-- [!INCLUDE][](https://raw.githubusercontent.com/Azure-Samples/azure-ai-vision-sdk/main/docs/learn.microsoft.com/java/image-analysis/quick-start/pom.xml)] -->
+    <!-- [!INCLUDE][](https://raw.githubusercontent.com/Azure-Samples/cognitive-services-quickstart-code/master/java/ComputerVision/4-0/pom.xml)] -->
     ```xml
     <project xmlns="http://maven.apache.org/POM/4.0.0"
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
       <modelVersion>4.0.0</modelVersion>
-      <groupId>azure.ai.vision.imageanalysis.samples</groupId>
-      <artifactId>image-analysis-quickstart</artifactId>
-      <version>0.0</version>
+      <groupId>com.example</groupId>
+      <artifactId>my-application-name</artifactId>
+      <version>1.0.0</version>
       <dependencies>
+        <!-- https://mvnrepository.com/artifact/com.azure/azure-ai-vision-imageanalysis -->
         <dependency>
           <groupId>com.azure</groupId>
           <artifactId>azure-ai-vision-imageanalysis</artifactId>
-          <version>1.0.0-beta.1</version>
+          <version>1.0.0-beta.2</version>
         </dependency>
+        <!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-nop -->
+        <!-- Optional: provide a slf4j implementation. Here we use a no-op implementation
+        just to make the slf4j console spew warning go away. We can still use the internal
+        logger in azure.core library. See
+        https://github.com/Azure/azure-sdk-for-java/tree/main/sdk/vision/azure-ai-vision-imageanalysis#enable-http-requestresponse-logging -->
         <dependency>
           <groupId>org.slf4j</groupId>
           <artifactId>slf4j-nop</artifactId>
-          <version>1.7.36</version> 
+          <version>1.7.36</version>
         </dependency>
       </dependencies>
     </project>
     ```
 
-1. Update the version value (`1.0.0-beta.1`) based on the latest available version of the [azure-ai-vision-imageanalysis](https://aka.ms/azsdk/image-analysis/package/maven) package in the Maven repository. 
+1. Update the version value (`1.0.0-beta.2`) based on the latest available version of the [azure-ai-vision-imageanalysis](https://aka.ms/azsdk/image-analysis/package/maven) package in the Maven repository.
 1. Install the SDK and dependencies by running the following in the project directory:
     ```console
     mvn clean dependency:copy-dependencies