Skip to content

Commit e5a0534

Browse files
JamesJBarnettJamesJBarnett
authored
Merge pull request #246988 from PatrickFarley/comvis-updates
[ai svcs] import and update sdk install guide
2 parents 72da0fb + f6f4136 commit e5a0534

15 files changed

+463
-5
lines changed

‎articles/ai-services/computer-vision/how-to/install-sdk.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: Install the Vision SDK
3+
titleSuffix: Azure AI services
4+
description: In this guide, you'll learn how to install the Vision SDK for your preferred programming language.
5+
services: cognitive-services
6+
author: PatrickFarley
7+
manager: nitinme
8+
ms.service: cognitive-services
9+
ms.subservice: computer-vision
10+
ms.topic: quickstart
11+
ms.date: 08/01/2023
12+
ms.author: pafarley
13+
ms.custom: devx-track-python, devx-track-csharp, devx-track-dotnet
14+
zone_pivot_groups: programming-languages-vision-40-sdk
15+
---
16+
17+
# Install the Vision SDK
18+
19+
::: zone pivot="programming-language-csharp"
20+
[!INCLUDE [C# include](../includes/setup-sdk/csharp.md)]
21+
::: zone-end
22+
23+
::: zone pivot="programming-language-cpp"
24+
[!INCLUDE [C++ include](../includes/setup-sdk/cpp.md)]
25+
::: zone-end
26+
27+
::: zone pivot="programming-language-python"
28+
[!INCLUDE [Python include](./../includes/setup-sdk/python.md)]
29+
::: zone-end
30+
31+
## Next steps
32+
33+
Follow the [Image Analysis quickstart](../quickstarts-sdk/image-analysis-client-library-40.md) to get started.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,11 @@ Open Visual Studio, and under **Get started** select **Create a new project**. S
4141

4242
### Install the client SDK
4343

44-
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**.
44+
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).
4545

4646
#### [Linux](#tab/linux)
4747

48-
Follow [these instructions](https://github.com/Azure-Samples/azure-ai-vision-sdk/blob/main/samples/cpp/image-analysis/README-Linux.md#install-the-vision-sdk-package) to install the Vision SDK for Linux.
48+
Follow the [SDK installation guide](../../how-to/install-sdk.md) to install the Vision SDK for Linux.
4949

5050
---
5151

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,7 @@ ms.author: pafarley
1616

1717
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.
1818

19-
[Reference documentation](/dotnet/api/azure.ai.vision.imageanalysis
20-
) | Packages (NuGet): [ImageAnalysis](https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis) | [Samples](https://github.com/Azure-Samples/azure-ai-vision-sdk)
19+
[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)
2120

2221
> [!TIP]
2322
> 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.
@@ -42,7 +41,7 @@ Open Visual Studio, and under **Get started** select **Create a new project**. S
4241

4342
### Install the client SDK
4443

45-
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**.
44+
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).
4645

4746
#### [CLI](#tab/cli)
4847

@@ -75,6 +74,8 @@ Within the application directory, install the Azure AI Vision client SDK for .NE
7574
```dotnet
7675
dotnet add package Azure.AI.Vision.ImageAnalysis --prerelease
7776
```
77+
78+
For more information, see the [SDK installation guide](../../how-to/install-sdk.md).
7879

7980
---
8081

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Use the Image Analysis client SDK for Python to analyze a remote image to read t
4444
python -m pip install azure-ai-vision
4545
```
4646

47+
For more information, see the [SDK installation guide](../../how-to/install-sdk.md).
48+
4749
1. Copy the following code into *quickstart.py*:
4850

4951
> [!TIP]

‎articles/ai-services/computer-vision/includes/setup-sdk/cpp-linux.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
---
2+
author: PatrickFarley
3+
ms.service: cognitive-services
4+
ms.topic: include
5+
ms.date: 08/01/2023
6+
ms.author: pafarley
7+
---
8+
9+
Installing the Vision SDK package requires your device to support the APT/Debian package manager.
10+
11+
### Ubuntu 18.04, Ubuntu 20.04, Ubuntu 22.04, Debian 10 (Buster)
12+
13+
1. **By installing the Azure AI Vision SDK package you acknowledge the [Azure AI Vision SDK license agreement](https://aka.ms/azai/vision/license)**.
14+
15+
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:
16+
17+
* For Ubuntu 18.04 (Bionic Beaver)
18+
```sh
19+
sudo apt install wget dpkg
20+
wget "https://packages.microsoft.com/config/ubuntu/18.04/packages-microsoft-prod.deb"
21+
sudo dpkg -i packages-microsoft-prod.deb
22+
```
23+
24+
* For Ubuntu 20.04 (Focal Fossa)
25+
```sh
26+
sudo apt install wget dpkg
27+
wget "https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb"
28+
sudo dpkg -i packages-microsoft-prod.deb
29+
```
30+
31+
* For Ubuntu 22.04 (Jammy Jellyfish)
32+
```sh
33+
sudo apt install wget dpkg
34+
wget "https://packages.microsoft.com/config/ubuntu/22.04/packages-microsoft-prod.deb"
35+
sudo dpkg -i packages-microsoft-prod.deb
36+
```
37+
38+
* For Debian 10 (Buster)
39+
```sh
40+
sudo apt install wget dpkg
41+
wget "https://packages.microsoft.com/config/debian/10/packages-microsoft-prod.deb"
42+
sudo dpkg -i packages-microsoft-prod.deb
43+
```
44+
45+
1. Now install the Vision SDK Debian package required to build the sample:
46+
47+
```sh
48+
sudo apt update
49+
sudo apt install azure-ai-vision-dev-image-analysis
50+
```
51+
52+
1. Notice that the above package _azure-ai-vision-dev-image-analysis_ depends on other Vision SDK packages, which will be installed automatically. Run `apt list azure-ai-vision*` to see the list of installed Vision SDK packages:
53+
* _azure-ai-vision-dev-common_
54+
* _azure-ai-vision-dev-image-analysis_
55+
* _azure-ai-vision-runtime-common_
56+
* _azure-ai-vision-runtime-common-media_
57+
* _azure-ai-vision-runtime-image-analysis_
58+
59+
### Other Linux platforms
60+
61+
1. **By installing the Azure AI Vision SDK package you acknowledge the [Azure AI Vision SDK license agreement](https://aka.ms/azai/vision/license)**.
62+
63+
1. Directly download the following five packages to your device:
64+
```sh
65+
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
66+
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
67+
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
68+
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
69+
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
70+
```
71+
1. Install the five packages:
72+
```sh
73+
sudo apt update
74+
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
75+
```
76+
77+
### Verify installation
78+
79+
Verify installation succeeded by listing these folders:
80+
81+
```
82+
ls -la /usr/lib/azure-ai-vision
83+
ls -la /usr/include/azure-ai-vision
84+
ls -la /usr/share/doc/azure-ai-vision-*
85+
```
86+
87+
You should see shared object files named `libAzure-AI-Vision-*.so` and a few others in the first folder.
88+
89+
You should see header files named `vsion_api_cxx_*.hpp` and others in the second folder.
90+
91+
You should see package documents in the /usr/share/doc/azure-ai-vision-* folders (LICENSE.md, REDIST.txt, ThirdPartyNotices.txt).
92+
93+
## Cleanup
94+
95+
The Vision SDK Debian packages can be removed by running this single command:
96+
97+
```
98+
sudo apt-get purge azure-ai-vision-*
99+
```
100+
101+
## Required libraries for run-time distribution
102+
103+
The folder `/usr/lib/azure-ai-vision` contains several shared object libraries (`.so` files), needed to support different sets of Vision SDK APIs. For Image Analysis, only the following subset is needed when you distribute a run-time package of your application:
104+
105+
```
106+
libAzure-AI-Vision-Native.so
107+
libAzure-AI-Vision-Extension-Image.so
108+
```

‎articles/ai-services/computer-vision/includes/setup-sdk/cpp-requirements.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
author: PatrickFarley
3+
ms.service: cognitive-services
4+
ms.topic: include
5+
ms.date: 08/01/2023
6+
ms.author: pafarley
7+
---
8+
9+
The Vision SDK for C++ is compatible with Windows and Linux.
10+
11+
# [Windows](#tab/windows)
12+
13+
On Windows, you must use the 64-bit target architecture. Windows 10 or later is required.
14+
15+
You must install the [Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017, 2019, and 2022](/cpp/windows/latest-supported-vc-redist?view=msvc-170&preserve-view=true) for your platform. Installing this package for the first time might require a restart.
16+
17+
# [Linux](#tab/linux)
18+
19+
The Vision SDK for C# only supports **Ubuntu 18.04/20.04/22.04** and **Debian 9/10/11** on the x64 architecture when used with Linux.
20+
21+
[!INCLUDE [Linux distributions](linux-distributions.md)]
22+
23+
---

‎articles/ai-services/computer-vision/includes/setup-sdk/cpp-windows.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
author: PatrickFarley
3+
ms.service: cognitive-services
4+
ms.topic: include
5+
ms.date: 08/01/2023
6+
ms.author: pafarley
7+
---
8+
9+
10+
The Vision SDK for C++ is available as a NuGet package. For more information, see <a href="https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis" target="_blank">Azure.AI.Vision.ImageAnalysis</a>.
11+
12+
Open Visual Studio and create a new application project. Then 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**.
13+
14+
15+

‎articles/ai-services/computer-vision/includes/setup-sdk/cpp.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
author: PatrickFarley
3+
ms.service: cognitive-services
4+
ms.topic: include
5+
ms.date: 08/01/2023
6+
ms.author: pafarley
7+
---
8+
9+
[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)
10+
11+
This guide shows how to install the Vision SDK for C++.
12+
13+
## Platform requirements
14+
15+
[!INCLUDE [Requirements](cpp-requirements.md)]
16+
17+
## Install the Vision SDK for C++
18+
19+
# [Windows](#tab/windows)
20+
21+
[!INCLUDE [Requirements](cpp-windows.md)]
22+
23+
# [Linux](#tab/linux)
24+
25+
[!INCLUDE [Requirements](cpp-linux.md)]
26+
27+
---

‎articles/ai-services/computer-vision/includes/setup-sdk/csharp-requirements.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
author: PatrickFarley
3+
ms.service: cognitive-services
4+
ms.topic: include
5+
ms.date: 08/01/2023
6+
ms.author: pafarley
7+
---
8+
9+
The Vision SDK for C# is compatible with Windows and Linux.
10+
11+
# [Windows](#tab/windows)
12+
13+
On Windows, you must use the 64-bit target architecture. Windows 10 or later is required.
14+
15+
You must install the [Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017, 2019, and 2022](/cpp/windows/latest-supported-vc-redist?view=msvc-170&preserve-view=true) for your platform. Installing this package for the first time might require a restart.
16+
17+
# [Linux](#tab/linux)
18+
19+
The Vision SDK for C# only supports **Ubuntu 18.04/20.04/22.04** and **Debian 9/10/11** on the x64 architecture when used with Linux.
20+
21+
[!INCLUDE [Linux distributions](linux-distributions.md)]
22+
23+
---
24+

‎articles/ai-services/computer-vision/includes/setup-sdk/csharp.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
author: PatrickFarley
3+
ms.service: cognitive-services
4+
ms.topic: include
5+
ms.date: 08/01/2023
6+
ms.author: pafarley
7+
---
8+
9+
[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)
10+
11+
This guide shows how to install the Vision SDK for C#.
12+
13+
## Platform requirements
14+
15+
[!INCLUDE [Requirements](csharp-requirements.md)]
16+
17+
## Install the Vision SDK for C#
18+
19+
The Vision SDK for C# is available as a NuGet package and implements .NET Standard 2.0. For more information, see <a href="https://www.nuget.org/packages/Azure.AI.Vision.ImageAnalysis" target="_blank">Azure.AI.Vision.ImageAnalysis</a>.
20+
21+
22+
# [Terminal](#tab/dotnetcli)
23+
24+
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:
25+
26+
```dotnetcli
27+
dotnet add package Azure.AI.Vision.ImageAnalysis --prerelease
28+
```
29+
30+
# [PowerShell](#tab/powershell)
31+
32+
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:
33+
34+
```powershell
35+
Install-Package Azure.AI.Vision.ImageAnalysis --prerelease
36+
```
37+
38+
# [Visual Studio](#tab/vs)
39+
40+
Open Visual Studio and create a new application project. Then 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**.
41+
42+
43+
44+
---

0 commit comments

Comments
 (0)