资讯 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

Node.js SDK调用平台功能API教程


本章节介绍了如何通过Node.js语言 SDK调用千帆平台的API能力。通过本章节,你将了解安装Node.js SDK,并通过SDK调用获取预置服务列表API能力。

前期准备

在开始本教程操作步骤之前,需要完成以下准备工作:

  • 确保已安装了 npm 或 yarn 包管理工具。
  • 确保已完成注册百度智能云账号。注意:为保障服务稳定运行,账户最好不处于欠费状态。
  • 确保已开通API调用权限。注意:针对付费服务,如果用户在使用过程中,操作了终止付费,则无法调用对应的API。如需重新开通,请在千帆大模型平台-在线服务页面,点击开通付费。

image.png

实现效果

例如,用户想要了解千帆大模型平台有哪些预置服务?

调用获取预置服务列表接口,可查看当前千帆大模型平台提供的预置服务。

步骤一:安装SDK

使用以下其中一种方式安装Node.js SDK。

  • 使用 npm 安装
npm install @baiducloud/qianfan
  • 使用 yarn 安装
yarn add @baiducloud/qianfan

步骤二:查看示例代码

本文以调用获取预置服务列表为例。

(1)点击查看获取预置服务列表,并点击复制示例代码。

注意:本文示例使用安全认证Access Key、Secret Key进行初始化认证信息。

示例代码如下:

  • consoleAction()方法需传递的参数:请求地址的后缀Query参数的ActionBody参数请参考预置服务列表API
import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";

// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');

async function main() {
  //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
  //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
  //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
  const res = await consoleAction({
      base_api_route: '/v2/service', action: 'DescribePresetServices', data: {
       "serviceIds": [ "svcp-7940ab471306"]
        }
  });    
    
  console.log(res);
}

main();

(2)复制代码到本地

将代码复制到本地环境,如下图所示。

image.png

步骤三:修改示例代码

(1)修改相关参数值

需修改Access Key、Secret Key、base_api_route、action、data值,如下所示:

image.png

参数名称
修改前的值
修改后的值
QIANFAN_ACCESS_KEY your_iam_ak · 示例:ALTAKRG****HTRtGVgO
· 如何获取该参数值:
百度智能云控制台-用户账户-安全认证页,查看Access Key、Secret Key。
image.png
QIANFAN_SECRET_KEY your_iam_sk · 示例:c05e36c**da79f8
· 如何获取该参数值:
百度智能云控制台-用户账户-安全认证页,查看Access Key、Secret Key。
image.png
base_api_route /v2/service 请求地址的后缀,本文示例无需修改此参数值
action DescribePresetServices Query参数的Action,本文示例无需修改此参数值
data "serviceIds": [ "svcp-7940ab471306"] Body参数,修改参数值为:"serviceIds": ["svcp-dfd7468a1315"],"serviceType": ["text2image"]

修改相关参数后,如下图所示。

image.png

步骤四:运行代码

运行代码,调用成功后返回执行结果。

上一篇
Go SDK调用平台功能API教程
下一篇
SDK安装及使用流程