SDK安装及使用

本文介绍了如何通过

支持语言

• Python SDK
• Go SDK
• Java SDK
• Node.js SDK

SDK 使用流程简介

千帆ModelBuilder提供了2种调用方式。API不同，调用方式可能不同。开发者可以根据实际使用，选择合适的方式进行调用。

Python SDK

安装Python SDK

pip install qianfan

注意：目前支持 Python >= 3.7版本。

（推荐）使用安全认证AK/SK调用流程

（1）步骤一，获取安全认证AK/SK

在百度智能云千帆控制台-用户账号-安全认证-Access Key页面，查看Access Key（即安全认证AK）、Secret Key（即安全认证SK）。

（2）步骤二，初始化安全认证AK/SK

通过SDK调用API，SDK会获取安全认证AK和SK初始化信息，并自动完成鉴权相关步骤。

支持通过环境变量或参数初始化方式，优先级由低到高为：环境变量初始化<参数初始化。

# 通过环境变量传递（作用于全局，优先级最低）
import os
os.environ["QIANFAN_ACCESS_KEY"] = "..."
os.environ["QIANFAN_SECRET_KEY"] = "..."

#注意：不推荐使用此方式，后续功能更新可能出现不兼容问题，建议通过方式一环境变量初始化。
# 通过内置函数传递（作用于全局，优先级大于环境变量）
import qianfan
qianfan.AccessKey("...")
qianfan.SecretKey("...")

（3）步骤三，调用API

调用相关API，请参考各API文档调用示例。

（不推荐）使用应用AK/SK调用流程

说明：使用此方式进行鉴权，后续可能出现新功能不兼容的情况，不推荐使用。

（1）步骤一，获取应用的AK和SK

在百度智能云千帆控制台-应用列表 页面，查看应用的API Key、Secret Key。

注意：

• 为保障服务稳定运行，账户最好不处于欠费状态。
• 平台已不支持新建此类应用，如果之前未创建过应用，请使用安全认证AK/SK调用SDK。

（2）步骤二，初始化应用AK和SK

支持通过参数初始化、内置函数初始化、环境变量初始化三种方式进行初始化。

 chat_completion = qianfan.ChatCompletion(ak="应用API Key", sk="应用Secret Key")

 import qianfan
 qianfan.AK("应用API Key")
 qianfan.SK("应用Secret Key")

import os

os.environ["QIANFAN_AK"] = "应用API Key"
os.environ["QIANFAN_SK"] = "应用Secret Key"
 

（3）步骤三，调用API

调用相关API，请参考各API文档调用示例。

Go SDK

安装Go SDK

go get github.com/baidubce/bce-qianfan-sdk/go/qianfan

注意：目前支持 Golang >= 1.18 版本。

使用安全认证AK/SK调用流程

（1）步骤一，获取安全认证AK/SK

在百度智能云千帆控制台-用户账号-安全认证-Access Key页面，查看Access Key（即安全认证AK）、Secret Key（即安全认证SK）。

（2）步骤二，初始化安全认证AK/SK

通过SDK调用API，SDK会获取安全认证AK和SK初始化信息，并自动完成鉴权相关步骤。

支持通过环境变量、参数设置两种初始化方式，请选择任一种方式进行初始化。

// 通过环境变量初始化
import (
    "os"
)

// 替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_access_key")
os.Setenv("QIANFAN_SECRET_KEY", "your_secret_key")

import (
	"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)

// 替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
qianfan.GetConfig().AccessKey = "your_access_key"
qianfan.GetConfig().SecretKey = "your_secret_key"

（3）步骤三，调用API

调用相关API，请参考各API文档调用示例。

Java SDK

安装Java SDK

• Maven 在pom.xml的dependencies中添加依赖

<dependency>
    <groupId>com.baidubce</groupId>
    <artifactId>qianfan</artifactId>
    <version>0.1.6</version>
</dependency>

• Gradle 对于Kotlin DSL，在build.gradle.kts的dependencies中添加依赖

implementation("com.baidubce:qianfan:0.1.6")

对于Groovy DSL，在build.gradle的dependencies中添加依赖

implementation 'com.baidubce:qianfan:0.1.6'

注意：目前支持 Java版本 >= 8版本。

（推荐）使用安全认证AK/SK调用流程

（1）步骤一，获取安全认证AK/SK

在百度智能云千帆控制台-用户账号-安全认证-Access Key页面，查看Access Key（即安全认证AK）、Secret Key（即安全认证SK）。

（2）步骤二，初始化安全认证AK/SK

通过SDK调用API，SDK会获取安全认证AK和SK初始化信息，并自动完成鉴权相关步骤。

支持通过参数设置、环境变量两种初始化方式，请选择任一种方式进行初始化。

Qianfan qianfan = new Qianfan("your_access_key", "your_secret_key");

//SDK 支持从环境变量 QIANFAN_ACCESS_KEY 和 QIANFAN_SECRET_KEY 获取配置，这一步骤会在使用 SDK 时自动完成

export QIANFAN_ACCESS_KEY=your_access_key
export QIANFAN_SECRET_KEY=your_secret_key

（3）步骤三，调用API

调用相关API，请参考各API文档调用示例。

（不推荐）使用应用AK/SK调用流程

说明：使用此方式进行鉴权，后续可能出现新功能不兼容的情况，不推荐使用。

（1）步骤一，获取应用的AK和SK

在百度智能云千帆控制台-应用列表 页面，查看应用的API Key、Secret Key。

注意：

• 为保障服务稳定运行，账户最好不处于欠费状态。
  
• 平台已不支持新建此类应用，如果之前未创建过应用，请使用安全认证AK/SK调用SDK。

（2）步骤二，初始化应用AK和SK

• Java 初始化 支持通过参数初始化、环境变量初始化两种方式进行初始化。

Qianfan qianfan = new Qianfan(Auth.TYPE_OAUTH, "your_ak", "your_sk");

export QIANFAN_AK=your_ak
export QIANFAN_SK=your_sk

（3）步骤三，调用API

调用相关API，请参考各API文档调用示例。

Node.js SDK

安装Node.js SDK

选择以下任一种方式安装。

• 使用 npm 安装

# 使用 npm 安装
npm install @baiducloud/qianfan

• 使用 yarn 安装

# 使用 yarn 安装
yarn add @baiducloud/qianfan

（推荐）使用安全认证AK/SK调用流程

（1）步骤一，获取安全认证AK/SK

在百度智能云千帆控制台-用户账号-安全认证-Access Key页面，查看Access Key（即安全认证AK）、Secret Key（即安全认证SK）。

（2）步骤二，初始化安全认证AK/SK

通过SDK调用API，SDK会获取安全认证AK和SK初始化信息，并自动完成鉴权相关步骤。

支持通过配置文件、环境变量、参数三种初始化方式，请选择任一种方式进行初始化。

# 在.env文件中，设置以下内容，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
QIANFAN_ACCESS_KEY=your_access_key
QIANFAN_SECRET_KEY=your_secret_key

import {setEnvVariable} from "@baiducloud/qianfan";

setEnvVariable('QIANFAN_ACCESS_KEY','your_access_key');
setEnvVariable('QIANFAN_SECRET_KEY','your_secret_key');

import {ChatCompletion} from "@baiducloud/qianfan";

// 通过参数初始化，设置安全认证ACCESS_KEY/SECRET_KEY，以对话Chat为例，调用如下
const client = new ChatCompletion({ QIANFAN_ACCESS_KEY: 'your_access_key', QIANFAN_SECRET_KEY: 'your_secret_key' });

（3）步骤三，调用API

调用相关API，请参考各API文档调用示例。

（不推荐）使用应用AK/SK调用流程

说明：使用此方式进行鉴权，后续可能出现新功能不兼容的情况，不推荐使用。

（1）步骤一，获取应用的AK和SK

在百度智能云千帆控制台-应用列表 页面，查看应用的API Key、Secret Key。

注意：

• 为保障服务稳定运行，账户最好不处于欠费状态。
  
• 平台已不支持新建此类应用，如果之前未创建过应用，请使用安全认证AK/SK调用SDK。

（2）步骤二，初始化应用AK和SK

• Node.js 初始化

支持通过配置文件、环境变量、参数设置三种初始化方式，可以选择以下任一种方式初始化。

# 在.env文件中，设置以下内容，应用API Key替换your_api_key，应用Secret Key替换your_secret_key
QIANFAN_AK=your_api_key
QIANFAN_SK=your_secret_key

import {setEnvVariable} from "@baiducloud/qianfan";

setEnvVariable('QIANFAN_AK','your_api_key');
setEnvVariable('QIANFAN_SK','your_secret_key');

import {ChatCompletion} from "@baiducloud/qianfan";

// 通过参数初始化，应用API Key替换your_api_key，应用Secret Key替换your_secret_key，以对话Chat为例，调用如下
const client = new ChatCompletion({ QIANFAN_AK: 'your_api_key', QIANFAN_SK: 'your_secret_key' });

（3）步骤三，调用API

调用相关API，请参考各API文档调用示例。

使用教程

• Python SDK 请查看Python SDK调用教程。
• Go SDK 请查看Go SDK使用教程。
• Java SDK 请查看Java SDK调用教程。
• Node.js SDK 请查看Node.js SDK调用教程。