Node.js SDK使用说明
更新时间:2025-04-21
安装Node.js SDK
选择以下任一种方式安装。
- 使用 npm 安装
# 使用 npm 安装
npm install @baiducloud/qianfan
- 使用 yarn 安装
# 使用 yarn 安装
yarn add @baiducloud/qianfan
SDK 调用方式说明
千帆ModelBuilder提供了使用安全认证AK/SK调用平台功能OpenAPI相关方式。
类别 | 支持使用安全认证AK/SK调用 |
---|---|
平台功能OpenAPI | ✓ |
使用安全认证AK/SK鉴权调用流程
步骤一,获取安全认证AK/SK
通过以下步骤获取Access Key(AK)/Secret Key(SK),更多介绍请参考如何获取AK/SK。
(1)登录千帆ModelBuilder控制台
登录千帆ModelBuilder控制台,点击“用户账号->安全认证”进入Access Key管理界面。
(2)查看安全认证Access Key/Secret Key
在安全认证/Access Key 页面,查看Access Key、Secret Key。注意:
- 初始化鉴权时,使用“安全认证/Access Key”中的Access Key和 Secret Key进行鉴权,更多鉴权认证机制请参考鉴权认证机制。
- 安全认证Access Key(AK)/Secret Key(SK),和使用的获取AcessToken的应用API Key(AK) 和 Secret Key(SK)不同。
步骤二,初始化
支持通过配置文件、环境变量、参数三种初始化方式。
- 方式一:通过配置文件初始化
在项目的根目录中创建一个名为 .env 的文件,并添加以下内容,SDK从当前目录的 .env 中读取配置。
# 在.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
const client = new ChatCompletion({ QIANFAN_ACCESS_KEY: 'your_access_key', QIANFAN_SECRET_KEY: 'your_secret_key' });
步骤三,调用SDK
调用对应的API,请参考各API文档调用示例。