Merge pull request #250067 from dargilco/dargilco/8-31/updates-to-vision-setup-page

American-Dipper · web-flow · commit 0a623febfaa2 · 2023-09-12T19:45:29.000-07:00
[Azure AI svcs] Some updates to Vision SDK setup page
diff --git a/articles/ai-services/.openpublishing.redirection.cognitive-services.json b/articles/ai-services/.openpublishing.redirection.cognitive-services.json
@@ -6119,6 +6119,11 @@
             "source_path_from_root": "/articles/cognitive-services/Translator/quickstart-translator-sdk.md",
             "redirect_url": "/azure/ai-services/Translator/quickstart-text-sdk",
             "redirect_document_id": false
+        },
+        {
+            "source_path_from_root": "/articles/ai-services/computer-vision/how-to/install-sdk.md",
+            "redirect_url": "/articles/ai-services/computer-vision/sdk/install-sdk",
+            "redirect_document_id": false
         }
     ]
 }
diff --git a/articles/ai-services/computer-vision/includes/quickstarts-sdk/image-analysis-cpp-sdk-40.md b/articles/ai-services/computer-vision/includes/quickstarts-sdk/image-analysis-cpp-sdk-40.md
@@ -16,7 +16,7 @@ ms.author: pafarley
 
 Use the Image Analysis client SDK for C++ to analyze an image to read text and generate an image caption. This quickstart defines a function `AnalyzeImage()`, which uses the client object to analyze a remote image and print the results to the console.
 
-[Reference documentation](/cpp/cognitive-services/vision) | Packages (NuGet): [ImageAnalysis](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
+[Reference documentation](/cpp/cognitive-services/vision) | [Package (NuGet)](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
 
 > [!TIP]
 > The Analysis 4.0 API can do many different operations. See the [Analyze Image how-to guide](../../how-to/call-analyze-image-40.md) for examples that showcase all of the available features.
@@ -41,11 +41,11 @@ Open Visual Studio, and under **Get started** select **Create a new project**. S
 
 ### Install the client SDK 
 
-Once you've created a new project, install the client SDK by right-clicking on the project solution in the **Solution Explorer** and selecting **Manage NuGet Packages**. In the package manager that opens select **Browse**, check **Include prerelease**, and search for `Azure.AI.Vision.ImageAnalysis`. Select **Install**. For more information, see the [SDK installation guide](../../how-to/install-sdk.md).
+Once you've created a new project, install the client SDK by right-clicking on the project solution in the **Solution Explorer** and selecting **Manage NuGet Packages**. In the package manager that opens select **Browse**, check **Include prerelease**, and search for `Azure.AI.Vision.ImageAnalysis`. Select **Install**. For more information, see the [SDK installation guide](../../sdk/install-sdk.md?pivots=programming-language-cpp).
 
 #### [Linux](#tab/linux)
 
-Follow the [SDK installation guide](../../how-to/install-sdk.md) to install the Vision SDK for Linux.
+Follow the [SDK installation guide](../../sdk/install-sdk.md?pivots=programming-language-csharp) to install the Vision SDK for Linux.
 
 ---
 
diff --git a/articles/ai-services/computer-vision/includes/quickstarts-sdk/image-analysis-csharp-sdk-40.md b/articles/ai-services/computer-vision/includes/quickstarts-sdk/image-analysis-csharp-sdk-40.md
@@ -16,7 +16,7 @@ ms.author: pafarley
 
 Use the Image Analysis client SDK for C# to analyze an image to read text and generate an image caption. This quickstart defines a method `AnalyzeAsync()`, which uses the client object to analyze a remote image and print the results to the console. 
 
-[Reference documentation](/dotnet/api/azure.ai.vision.imageanalysis) | Packages (NuGet): [ImageAnalysis](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
+[Reference documentation](/dotnet/api/azure.ai.vision.imageanalysis) | [Packages (NuGet)](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
 
 > [!TIP]
 > The Analysis 4.0 API can do many different operations. See the [Analyze Image how-to guide](../../how-to/call-analyze-image-40.md) for examples that showcase all of the available features.
@@ -41,7 +41,7 @@ Open Visual Studio, and under **Get started** select **Create a new project**. S
 
 ### Install the client SDK 
 
-Once you've created a new project, install the client SDK by right-clicking on the project solution in the **Solution Explorer** and selecting **Manage NuGet Packages**. In the package manager that opens select **Browse**, check **Include prerelease**, and search for `Azure.AI.Vision.ImageAnalysis`. Select **Install**. For more information, see the [SDK installation guide](../../how-to/install-sdk.md).
+Once you've created a new project, install the client SDK by right-clicking on the project solution in the **Solution Explorer** and selecting **Manage NuGet Packages**. In the package manager that opens select **Browse**, check **Include prerelease**, and search for `Azure.AI.Vision.ImageAnalysis`. Select **Install**. For more information, see the [SDK installation guide](../../sdk/install-sdk.md?pivots=programming-language-csharp).
 
 #### [CLI](#tab/cli)
 
@@ -75,7 +75,7 @@ Within the application directory, install the Azure AI Vision client SDK for .NE
 dotnet add package  Azure.AI.Vision.ImageAnalysis --prerelease
 ```
 
-For more information, see the [SDK installation guide](../../how-to/install-sdk.md).
+For more information, see the [SDK installation guide](../../sdk/install-sdk.md?pivots=programming-language-csharp).
     
 ---
 
diff --git a/articles/ai-services/computer-vision/includes/quickstarts-sdk/image-analysis-python-sdk-40.md b/articles/ai-services/computer-vision/includes/quickstarts-sdk/image-analysis-python-sdk-40.md
@@ -44,7 +44,7 @@ Use the Image Analysis client SDK for Python to analyze a remote image to read t
     python -m pip install azure-ai-vision
     ```
 
-    For more information, see the [SDK installation guide](../../how-to/install-sdk.md).
+    For more information, see the [SDK installation guide](../../sdk/install-sdk.md?pivots=programming-language-python).
 
 1. Copy the following code into *quickstart.py*:
 
diff --git a/articles/ai-services/computer-vision/includes/setup-sdk/cpp-linux.md b/articles/ai-services/computer-vision/includes/setup-sdk/cpp-linux.md
@@ -10,8 +10,6 @@ Installing the Vision SDK package requires your device to support the APT/Debian
 
 ### Ubuntu 18.04, Ubuntu 20.04, Ubuntu 22.04, Debian 10 (Buster)
 
-1. **By installing the Azure AI Vision SDK package you acknowledge the [Azure AI Vision SDK license agreement](https://aka.ms/azai/vision/license)**.
-
 1. The Debian package is hosted on a Microsoft feed. To install the package, you first need to add the Microsoft feed to your device's package manager. To do that, run the following commands:
 
    * For Ubuntu 18.04 (Bionic Beaver)
@@ -53,25 +51,21 @@ Installing the Vision SDK package requires your device to support the APT/Debian
    * _azure-ai-vision-dev-common_
    * _azure-ai-vision-dev-image-analysis_
    * _azure-ai-vision-runtime-common_
-   * _azure-ai-vision-runtime-common-media_
    * _azure-ai-vision-runtime-image-analysis_
 
 ### Other Linux platforms
 
-1. **By installing the Azure AI Vision SDK package you acknowledge the [Azure AI Vision SDK license agreement](https://aka.ms/azai/vision/license)**.
-
 1. Directly download the following five packages to your device:
     ```sh
     wget https://packages.microsoft.com/repos/microsoft-ubuntu-bionic-prod/pool/main/a/azure-ai-vision-dev-common/azure-ai-vision-dev-common-0.13.0~beta.1-Linux.deb
     wget https://packages.microsoft.com/repos/microsoft-ubuntu-bionic-prod/pool/main/a/azure-ai-vision-dev-image-analysis/azure-ai-vision-dev-image-analysis-0.13.0~beta.1-Linux.deb
     wget https://packages.microsoft.com/repos/microsoft-ubuntu-bionic-prod/pool/main/a/azure-ai-vision-runtime-common/azure-ai-vision-runtime-common-0.13.0~beta.1-Linux.deb
-    wget https://packages.microsoft.com/repos/microsoft-ubuntu-bionic-prod/pool/main/a/azure-ai-vision-runtime-common-media/azure-ai-vision-runtime-common-media-0.13.0~beta.1-Linux.deb
     wget https://packages.microsoft.com/repos/microsoft-ubuntu-bionic-prod/pool/main/a/azure-ai-vision-runtime-image-analysis/azure-ai-vision-runtime-image-analysis-0.13.0~beta.1-Linux.deb
     ```
 1. Install the five packages:
     ```sh
     sudo apt update
-    sudo apt install ./azure-ai-vision-dev-common-0.13.0~beta.1-Linux.deb ./azure-ai-vision-dev-image-analysis-0.13.0~beta.1-Linux.deb ./azure-ai-vision-runtime-common-0.13.0~beta.1-Linux.deb ./azure-ai-vision-runtime-common-media-0.13.0~beta.1-Linux.deb ./azure-ai-vision-runtime-image-analysis-0.13.0~beta.1-Linux.deb
+    sudo apt install ./azure-ai-vision-dev-common-0.13.0~beta.1-Linux.deb ./azure-ai-vision-dev-image-analysis-0.13.0~beta.1-Linux.deb ./azure-ai-vision-runtime-common-0.13.0~beta.1-Linux.deb ./azure-ai-vision-runtime-image-analysis-0.13.0~beta.1-Linux.deb
     ```
 
 ### Verify installation
diff --git a/articles/ai-services/computer-vision/includes/setup-sdk/cpp.md b/articles/ai-services/computer-vision/includes/setup-sdk/cpp.md
@@ -6,9 +6,9 @@ ms.date: 08/01/2023
 ms.author: pafarley
 ---
 
-[Reference documentation](/cpp/cognitive-services/vision) | Packages (NuGet): [ImageAnalysis](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
+[Reference documentation](/cpp/cognitive-services/vision) | [Packages (NuGet)](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
 
-This guide shows how to install the Vision SDK for C++. 
+This guide shows how to install the Vision SDK for C++.
 
 ## Platform requirements
 
diff --git a/articles/ai-services/computer-vision/includes/setup-sdk/csharp.md b/articles/ai-services/computer-vision/includes/setup-sdk/csharp.md
@@ -6,7 +6,7 @@ ms.date: 08/01/2023
 ms.author: pafarley
 ---
 
-[Reference documentation](/dotnet/api/azure.ai.vision.imageanalysis) | Packages (NuGet): [ImageAnalysis](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
+[Reference documentation](/dotnet/api/azure.ai.vision.imageanalysis) | [Packages (NuGet)](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
 
 This guide shows how to install the Vision SDK for C#. 
 
@@ -21,15 +21,15 @@ The Vision SDK for C# is available as a NuGet package and implements .NET Standa
 
 # [Terminal](#tab/dotnetcli)
 
-The Vision SDK for C# can be installed from the [.NET CLI](https://dotnet.microsoft.com/download/dotnet/). To add a package reference in your project file, run this command in the folder where your .csproj` file is located:
+The Vision SDK for C# can be installed from the [.NET CLI](https://dotnet.microsoft.com/download/dotnet/). To add a package reference in your project file, run this command in the folder where your `.csproj` file is located:
 
 ```dotnetcli
 dotnet add package  Azure.AI.Vision.ImageAnalysis --prerelease
 ```
 
 # [PowerShell](#tab/powershell)
 
-The Vision SDK for C# can be installed from the [.NET CLI](https://dotnet.microsoft.com/download/dotnet/). To add a package reference in your project file, run this command in the folder where your .csproj` file is located:
+The Vision SDK for C# can be installed from the [.NET CLI](https://dotnet.microsoft.com/download/dotnet/). To add a package reference in your project file, run this command in the folder where your `.csproj` file is located:
 
 ```powershell
 Install-Package Azure.AI.Vision.ImageAnalysis --prerelease
diff --git a/articles/ai-services/computer-vision/includes/setup-sdk/license-notice-sdk.md b/articles/ai-services/computer-vision/includes/setup-sdk/license-notice-sdk.md
@@ -0,0 +1,17 @@
+---
+title: Vision SDK license terms
+titleSuffix: Azure AI services
+description: This page shows links to license terms and third-party notice.
+author: PatrickFarley
+ms.service: cognitive-services
+ms.subservice: computer-vision
+ms.topic: include
+ms.date: 12/04/2021
+ms.author: pafarley
+---
+
+> [!IMPORTANT]
+> By installing the Azure AI Vision SDK, you acknowledge its license. For more information, see:
+> - <a href="https://aka.ms/azai/vision/license" target="_blank">Microsoft software license terms for the Vision SDK <span class="docon docon-navigate-external x-hidden-focus"></span></a>
+> - <a href="https://aka.ms/azai/vision/TPN" target="_blank">Third-party software notices for the Vision SDK<span class="docon docon-navigate-external x-hidden-focus"></span></a>
+
diff --git a/articles/ai-services/computer-vision/includes/setup-sdk/python-requirements.md b/articles/ai-services/computer-vision/includes/setup-sdk/python-requirements.md
@@ -25,7 +25,7 @@ The Vision SDK for C# only supports **Ubuntu 18.04/20.04/22.04** and **Debian 9/
 
 ---
 
-Install a version of [Python from 3.7 or later](https://wiki.python.org/moin/BeginnersGuide/Download).
+Install a version of [Python from 3.8 or later](https://wiki.python.org/moin/BeginnersGuide/Download).
 
 To check your installation, open a terminal and run the command `python --version`. If it's installed properly, you'll get a response like "Python 3.8.10". If you're using Linux, you might need to run the command `python3 --version` instead. To enable use of `python` instead of `python3`, run `alias python='python3'` to set up an alias. The Vision SDK quickstart samples specify `python` usage. 
 
diff --git a/articles/ai-services/computer-vision/includes/setup-sdk/python.md b/articles/ai-services/computer-vision/includes/setup-sdk/python.md
@@ -8,7 +8,7 @@ ms.author: pafarley
 
 [Reference documentation](/python/api/azure-ai-vision) | [Package (PyPi)](https://pypi.org/project/azure-ai-vision/) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
 
-This guide shows how to install the Vision SDK for Python. 
+This guide shows how to install the Vision SDK for Python.
 
 ## Platform requirements
 
@@ -60,22 +60,19 @@ To install the Vision SDK for Python:
 
 1. Select **Terminal** > **New Terminal** to open a terminal within Visual Studio Code. 
 1. At the terminal prompt, run the following command to install the Vision SDK for Python package. 
-
     ```console
     python -m pip install azure-ai-vision
     ```
 
-To upgrade to the latest Vision SDK, run this command in a terminal:
-
-```console
-python -m pip install --upgrade azure-ai-vision
-```
-
-You can check which Vision SDK for Python version is currently installed by running this command:
+1. To upgrade to the latest Vision SDK, run this command in a terminal:
+    ```console
+    python -m pip install --upgrade azure-ai-vision
+    ```
 
-```console
-pip list
-```
+1. You can check which Vision SDK for Python version is currently installed by running this command:
+    ```console
+    pip list
+    ```
 
 For more information about Visual Studio Code and Python, see the [Visual Studio Code documentation](https://code.visualstudio.com/docs) and the [Visual Studio Code Python tutorial](https://code.visualstudio.com/docs/python/python-tutorial).
 
diff --git a/articles/ai-services/computer-vision/sdk/install-sdk.md b/articles/ai-services/computer-vision/sdk/install-sdk.md
@@ -1,7 +1,7 @@
 ---
 title: Install the Vision SDK
 titleSuffix: Azure AI services
-description: In this guide, you'll learn how to install the Vision SDK for your preferred programming language.
+description: In this guide, you learn how to install the Vision SDK for your preferred programming language.
 services: cognitive-services
 author: PatrickFarley
 manager: nitinme
@@ -10,12 +10,14 @@ ms.subservice: computer-vision
 ms.topic: quickstart
 ms.date: 08/01/2023
 ms.author: pafarley
-ms.custom: devx-track-python, devx-track-csharp
-zone_pivot_groups: programming-languages-vision-40-sdk
+ms.custom: devx-track-python, devx-track-csharp, devx-track-dotnet
+zone_pivot_groups: programming-languages-vision-40-sdk 
 ---
 
 # Install the Vision SDK
 
+[!INCLUDE [License Notice](../includes/setup-sdk/license-notice-sdk.md)]
+
 ::: zone pivot="programming-language-csharp"
 [!INCLUDE [C# include](../includes/setup-sdk/csharp.md)]
 ::: zone-end
@@ -25,7 +27,7 @@ zone_pivot_groups: programming-languages-vision-40-sdk
 ::: zone-end
 
 ::: zone pivot="programming-language-python"
-[!INCLUDE [Python include](./../includes/setup-sdk/python.md)]
+[!INCLUDE [Python include](../includes/setup-sdk/python.md)]
 ::: zone-end
 
 ## Next steps
diff --git a/articles/ai-services/computer-vision/sdk/overview-sdk.md b/articles/ai-services/computer-vision/sdk/overview-sdk.md
@@ -0,0 +1,60 @@
+---
+title: Vision SDK Overview
+titleSuffix: Azure AI services
+description: This page gives you an overview of the Azure AI Vision SDK for Image Analysis.
+services: cognitive-services
+author: PatrickFarley
+manager: nitinme
+ms.service: cognitive-services
+ms.subservice: computer-vision
+ms.topic: overview
+ms.date: 08/01/2023
+ms.author: pafarley
+ms.custom: devx-track-python, devx-track-csharp, devx-track-dotnet
+---
+
+# Vision SDK overview
+
+The Vision SDK (Preview) provides a convenient way to access the Image Analysis service using [version 4.0 of the REST APIs](https://aka.ms/vision-4-0-ref).
+
+[!INCLUDE [License Notice](../includes/setup-sdk/license-notice-sdk.md)]
+
+## Supported languages
+
+The Vision SDK supports the following languages and platforms:
+
+| Programming language | Quickstart | API Reference | Platform support |
+|----------------------|------------|-----------|------------------|
+| C# <sup>1</sup> | [quickstart](../quickstarts-sdk/image-analysis-client-library-40.md?pivots=programming-language-csharp)  | [reference](/dotnet/api/azure.ai.vision.imageanalysis) | Windows, UWP, Linux |
+| C++ <sup>2</sup> | [quickstart](../quickstarts-sdk/image-analysis-client-library-40.md?pivots=programming-language-cpp)  | [reference](/cpp/cognitive-services/vision) | Windows, Linux |
+| Python | [quickstart](../quickstarts-sdk/image-analysis-client-library-40.md?pivots=programming-language-python) | [reference](/python/api/azure-ai-vision) | Windows, Linux |
+
+<sup>1 The Vision SDK for C# is based on .NET Standard 2.0. See [.NET Standard](/dotnet/standard/net-standard?tabs=net-standard-2-0#net-implementation-support) documentation.</sup>
+
+<sup>2 ANSI-C isn't a supported programming language for the Vision SDK.</sup>
+
+## GitHub samples
+
+Numerous samples are available in the [Azure-Samples/azure-ai-vision-sdk](https://github.com/Azure-Samples/azure-ai-vision-sdk) repository on GitHub.
+
+## Getting help
+
+If you need assistance using the Vision SDK or would like to report a bug or suggest new features, open a [GitHub issue in the samples repository](https://github.com/Azure-Samples/azure-ai-vision-sdk/issues). The SDK development team monitors these issues.
+
+Before you create a new issue:
+* Make sure you first scan to see if a similar issue already exists.
+* Find the sample closest to your scenario and run it to see if you see the same issue in the sample code.
+
+## Release notes
+
+* **Vision SDK 0.13.0-beta.1** released July 2023. Image Analysis support was added for Universal Windows Platform (UWP) applications (C++, C#). Run-time package size reduction: Only the two native binaries
+`Azure-AI-Vision-Native.dll` and `Azure-AI-Vision-Extension-Image.dll` are now needed.
+* **Vision SDK 0.11.1-beta.1** released May 2023. Image Analysis APIs were updated to support [Background Removal](../how-to/background-removal.md).
+* **Vision SDK 0.10.0-beta.1** released April 2023. Image Analysis APIs were updated to support [Dense Captions](../concept-describe-images-40.md?tabs=dense).
+* **Vision SDK 0.9.0-beta.1** first released on March 2023, targeting Image Analysis applications on Windows and Linux platforms.
+
+
+## Next steps
+
+- [Install the SDK](./install-sdk.md)
+- [Try the Image Analysis Quickstart](../quickstarts-sdk/image-analysis-client-library-40.md)
diff --git a/articles/ai-services/computer-vision/toc.yml b/articles/ai-services/computer-vision/toc.yml
@@ -103,7 +103,11 @@ items:
   - name: Image Analysis overview
     href: overview-image-analysis.md
   - name: Vision SDK
-    href: how-to/install-sdk.md
+    items:
+    - name: Overview
+      href: sdk/overview-sdk.md
+    - name: Install the SDK
+      href: sdk/install-sdk.md
   - name: Quickstarts
     items:
     - name: Version 4.0 quickstart (preview)

Original file line number	Diff line number	Diff line change
`@@ -6119,6 +6119,11 @@`
`6119`	`6119`	`"source_path_from_root": "/articles/cognitive-services/Translator/quickstart-translator-sdk.md",`
`6120`	`6120`	`"redirect_url": "/azure/ai-services/Translator/quickstart-text-sdk",`
`6121`	`6121`	`"redirect_document_id": false`
	`6122`	`+ },`
	`6123`	`+ {`
	`6124`	`+ "source_path_from_root": "/articles/ai-services/computer-vision/how-to/install-sdk.md",`
	`6125`	`+ "redirect_url": "/articles/ai-services/computer-vision/sdk/install-sdk",`
	`6126`	`+ "redirect_document_id": false`
`6122`	`6127`	`}`
`6123`	`6128`	`]`
`6124`	`6129`	`}`