安装Node.js SDK

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

• 使用 npm 安装

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

• 使用 yarn 安装

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

Node.js SDK使用流程简介

调用Node.js SDK前，需确保已完成SDK安装。千帆ModelBuilder提供了2种鉴权方式，开发者可以根据实际使用，选择合适的方式进行调用。

• 方式一，【推荐】使用安全认证AK/SK鉴权
• 方式二，【不推荐】使用应用AK/SK鉴权

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

【推荐】使用安全认证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，以对话Chat为例，调用如下
const client = new ChatCompletion({ QIANFAN_ACCESS_KEY: 'your_access_key', QIANFAN_SECRET_KEY: 'your_secret_key' });

步骤三，调用SDK

调用对应的API，请参考各API文档调用示例。

【不推荐】使用应用AK/SK鉴权调用流程

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

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

注意：应用AK、SK分别指应用的 API Key(即AK) 和 Secret Key(即SK)。

（1）登录千帆ModelBuilder控制台。

登录千帆ModelBuilder控制台。注意：为保障服务稳定运行，账户最好不处于欠费状态。

（2）创建应用。

如果已有千帆ModelBuilder应用，此步骤可跳过。如果无应用，进入控制台创建应用 ，如何创建应用也可以参考应用接入使用。

（3）在应用接入页，获取应用的API Key、Secret Key。

步骤二，初始化AK和SK

在调用 SDK 前，需要先初始化 应用API Key（即AK） 和 应用Secret Key（即SK），支持通过配置文件、环境变量、参数设置三种初始化方式，可以选择以下任一种方式初始化。

• 方式一：通过配置文件初始化

在项目的根目录中创建一个名为 .env 的文件，并添加以下内容，SDK从当前目录的 .env 中读取配置。

# 在.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' });

步骤三，调用SDK

调用对应的API，请参考各API文档调用示例。

使用教程

请查看Node.js SDK调用教程。