Install the Image Analysis SDK

Reference documentation | Package (NuGet) | Samples

This guide shows how to install the Image Analysis SDK for C#.

Platform requirements

The Image Analysis SDK for C# is compatible with Windows, Linux, and macOS.

• .NET installed. This installation also includes the .NET CLI.

Install the Image Analysis SDK for C#

The Image Analysis SDK for C# is available as a NuGet package and implements .NET Standard 2.0. For more information, see Azure.AI.Vision.ImageAnalysis.

Terminal

The Image Analysis SDK for C# can be installed from the .NET CLI. To add a package reference in your project file, run this command in the folder where your .csproj file is located:

dotnet add package  Azure.AI.Vision.ImageAnalysis --prerelease

PowerShell

The Image Analysis SDK for C# can be installed from the .NET CLI. To add a package reference in your project file, run this command in the folder where your .csproj file is located:

Install-Package Azure.AI.Vision.ImageAnalysis --prerelease

Visual Studio

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.

Reference documentation | Package (PyPi) | Samples

This guide shows how to install the Image Analysis SDK for Python.

Platform requirements

The Image Analysis SDK for Python is compatible with Windows, Linux, and macOS.

Install the Image Analysis SDK for Python

Before you install the Image Analysis SDK for Python, make sure to satisfy the platform requirements.

Choose your tool or IDE

Terminal

Install from terminal

To install the Image Analysis SDK for Python, run this command in a terminal.

pip install azure-ai-vision-imageanalysis

Upgrade to the latest Image Analysis SDK

To upgrade to the latest Image Analysis SDK, run this command in a terminal:

pip install --upgrade azure-ai-vision-imageanalysis

You can check which Image Analysis SDK for Python version is currently installed by running this command in a terminal:

pip list

VS Code

Install the Image Analysis SDK by using Visual Studio Code

To install the Image Analysis SDK for Python:

1. Download and install Visual Studio Code.

2. Run Visual Studio Code and install the Python extension:

   1. Select File > Preferences > Extensions.
   2. Search for Python, find the Python extension for Visual Studio Code published by Microsoft, and then select Install.

   

3. Select Terminal > New Terminal to open a terminal within Visual Studio Code.

4. At the terminal prompt, run the following command to install the Image Analysis SDK for Python package.

   pip install azure-ai-vision-imageanalysis
   

5. To upgrade to the latest Image Analysis SDK, run this command in a terminal:

   pip install --upgrade azure-ai-vision-imageanalysis
   

6. You can check which Image Analysis SDK for Python version is currently installed by running this command:

   pip list
   

For more information about Visual Studio Code and Python, see the Visual Studio Code documentation and the Visual Studio Code Python tutorial.

Reference documentation | Maven Package | Samples

This guide shows how to install the Image Analysis SDK for Java.

Platform requirements

The Image Analysis SDK for Java is compatible with Windows, Linux, and macOS.

• Java Development Kit (JDK) version 8 or above installed.

Windows

On Windows, you must use the 64-bit target architecture. Windows 10 or later is required.

The Java SDK uses native binaries. You must install the Microsoft Visual C++ Redistributable for Visual Studio 2015, 2017, 2019, and 2022 for your platform. Installing this package for the first time might require a restart.

Linux

The Image Analysis SDK for Java only supports Ubuntu 18.04/20.04/22.04 and Debian 9/10/11 on the x64 architecture when used with Linux.

Important

Use the most recent LTS release of the Linux distribution. For example, if you are using Ubuntu 20.04 LTS, use the latest release of Ubuntu 20.04.X.

The Image Analysis SDK depends on the following Linux system libraries:

• The shared libraries of the GNU C library, including the POSIX Threads Programming library, libpthreads
• The OpenSSL library (libssl) version 1.x

Important

The Image Analysis SDK does not yet support OpenSSL 3.0, which is the default in Ubuntu 22.04 and Debian 12.

To install OpenSSL 1.x from sources on Debian/Ubuntu based systems that don't have it, do:

wget -O - https://www.openssl.org/source/openssl-1.1.1u.tar.gz | tar zxf -
cd openssl-1.1.1u
./config --prefix=/usr/local
make -j $(nproc)
sudo make install_sw install_ssldirs
sudo ldconfig -v
export SSL_CERT_DIR=/etc/ssl/certs

Notes on installation:

• Check https://www.openssl.org/source/ for the latest OpenSSL 1.x version to use.
• The setting of SSL_CERT_DIR must be in effect systemwide or at least in the console where applications that use the Image Analysis SDK are launched from, otherwise OpenSSL 1.x installed in /usr/local may not find certificates.
• Ensure that the console output from ldconfig -v includes /usr/local/lib as it should on modern systems by default. If this isn't the case, set LD_LIBRARY_PATH (with the same scope as SSL_CERT_DIR) to add /usr/local/lib to the library path:

  export LD_LIBRARY_PATH=/usr/local/lib:$LD_LIBRARY_PATH
  

Ubuntu 18.04/20.04/22.04

sudo apt-get update
sudo apt-get install build-essential libssl-dev wget

Debian 9/10/11

To use the Image Analysis SDK in Alpine Linux, create a Debian chroot environment as documented in the Alpine Linux Wiki on running glibc programs. Then follow the Debian instructions here.

sudo apt-get update
sudo apt-get install build-essential libssl-dev wget

JAVA Development Kit

Java 8 or above is required.

Install a Java Development Kit (JDK) such as Azul Zulu OpenJDK, Microsoft Build of OpenJDK, Oracle Java, or your preferred JDK.

Run java -version from a command line to confirm successful installation and see the version. Make sure that the Java installation is native to the system architecture and not running through emulation.

Install the Image Analysis SDK for Java

The Image Analysis SDK for Java is available as a Maven package. For more information, see the package azure-ai-vision-imageanalysis in the Maven repository.

Maven

Follow these steps to install the Image Analysis SDK for Java using Apache Maven:

1. Install Apache Maven. On Linux, install from the distribution repositories if available.

2. Open a command prompt and run mvn -v to confirm successful installation.

3. Open a command prompt where you want to place the new project, and create a new pom.xml file.

4. Copy the following XML content into your pom.xml file:

   <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">
     <modelVersion>4.0.0</modelVersion>
     <groupId>azure.ai.vision.imageanalysis.samples</groupId>
     <artifactId>image-analysis-quickstart</artifactId>
     <version>0.0</version>
     <dependencies>
       <dependency>
         <groupId>com.azure</groupId>
         <artifactId>azure-ai-vision-imageanalysis</artifactId>
         <version>1.0.0-beta.1</version>
       </dependency>
       <dependency>
         <groupId>org.slf4j</groupId>
         <artifactId>slf4j-nop</artifactId>
         <version>1.7.36</version> 
       </dependency>
     </dependencies>
   </project>
   

5. Update the version value in <version>1.0.0-beta.1</version> based on the latest version you find in the Maven repository for the azure-ai-vision-imageanalysis package.

6. Run the following Maven command to install the Image Analysis SDK and dependencies.

   mvn clean dependency:copy-dependencies
   

7. Verify that the local folder path target\dependency was created, and it contains .jar files including three file named azure-ai-vision-*.jar

Gradle

1. Install Gradle.
2. In a command prompt run gradle -v to confirm successful installation.
3. Create your Java application using Gradle. See for example Building Java Applications Sample.
4. Update your build.gradle file by inserting 4 new dependencies:

   dependencies {
       implementation 'com.azure:azure-ai-vision-imageanalysis:1.0.0-beta.1'
       implementation 'org.slf4j:slf4j-nop:1.7.36'
   }
   

5. Update the version value in com.azure:azure-ai-vision-imageanalysis:1.0.0-beta.1 based on the latest version you find in the Maven repository for the azure-ai-vision-imageanalysis package.
6. Update your Java application to do Image Analysis using the Image Analysis SDK, compile and run your application.

Reference documentation | Package (npm) | Samples

This guide shows how to install the Image Analysis SDK for JavaScript.

Platform requirements

The Image Analysis SDK for JavaScript is compatible with Windows, Linux, and macOS.

Install the Image Analysis SDK for JavaScript

Install the Image Analysis client library for JavaScript with npm:

npm install @azure-rest/ai-vision-image-analysis

Next steps

Follow the Image Analysis quickstart to get started.