Install Alibaba Cloud Model Studio SDK - Alibaba Cloud Model Studio

Alibaba Cloud Model Studio provides SDKs for Python and Java (also called DashScope SDK), and is compatible with OpenAI SDK. This topic describes how to install Model Studio SDK (DashScope SDK) and OpenAI SDK.

Install the SDK

OpenAI SDK

Python

Prerequisites

Python 3.8 or a later version is installed.

Procedure

Install or update OpenAI SDK for Python

Run the following command:

pip install -U openai

If the installation fails, try replace pip with pip3. pip3 is used for Python 3 or higher versions.

Node.js

Procedure

Run the following command in the terminal:

npm install --save openai
# Or
yarn add openai

If the installation fails, configure the traffic mirror source and try again. For example:

npm config set registry https://registry.npmmirror.com/

After configuring the traffic mirror source, retry the installation command.

Supported models

For more information about the models that support the OpenAI SDK, see Compatiblity with OpenAI.

DashScope SDK

Python

Prerequisites

Python 3.8 or a later version is installed.

Procedure

Install or update the DashScope SDK

pip install -U dashscope

If the installation fails, try replace pip with pip3. pip3 is used for Python 3 or higher versions.

Java

Prerequisites

Java 8 or a later version is installed.

Procedure

XML

Open the pom.xml file of your Maven project.
Add the following dependency information into the <dependencies> section.

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>dashscope-sdk-java</artifactId>
    <!-- Replace 'the-latest-version' with the latest version number found at: https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java -->
    <version>the-latest-version</version>
</dependency>

Save the pom.xml file.
Execute Maven commands, such as mvn clean install or mvn compile, to refresh the dependencies of your project. This process automatically downloads the DashScope SDK for Java and incorporate it into your project.

Gradle

Open the build.gradle file of your Gradle project.

Add the following dependency information to the dependencies block.

dependencies {
    // Replace 'the-latest-version' with the latest version number found at: https://mvnrepository.com/artifact/com.alibaba/dashscope-sdk-java
    implementation group: 'com.alibaba', name: 'dashscope-sdk-java', version: 'the-latest-version'
}

Save the build.gradle file.
Open the command line, navigate to the root directory of your project, and run the following Gradle command to update your project dependencies. This process automatically downloads the DashScope SDK for Java and incorporates it into your project.
```
./gradlew build --refresh-dependencies
```
For Windows users, use this command instead:
```
gradlew build --refresh-dependencies
```

What to do next

Explore sample codes to call models with the OpenAI SDK or DashScope SDK.