口语评测（基础版）
视频服务与安全产品捉虫活动邀您参加！> HOT
文档中心>口语评测（基础版）>SDK 文档>服务端 SDK>Node.js SDK

Node.js SDK

最近更新时间：2024-07-25 11:17:31

我的收藏

本页目录：

安装依赖环境

NODEJS 10.0.0 版本及以上，nodejs 官网。

安装 SDK

使用 npm 安装 Node.js SDK，可以选择安装所有依赖或本产品相关依赖。更多信息前往 Github 仓库 或者 Gitee 仓库 。
所有依赖
相关依赖
npm install tencentcloud-sdk-nodejs --save
// 如使用此引入方式，代码中可将require("tencentcloud-sdk-nodejs")改为require("tencentcloud-sdk-nodejs-soe") 。
npm install tencentcloud-sdk-nodejs-common tencentcloud-sdk-nodejs-soe  tencentcloud-sdk-nodejs-sts --save

使用 SDK

可通过 控制台 生成代码进行调用或者参考下方示例，密钥获取可参考快速入门。

本地音频文件评测

发音数据传输附带初始化：直接调用 发音数据传输接口附带初始化过程 完成一次性评测。
const tencentcloud = require("tencentcloud-sdk-nodejs");


//导入对应产品模块的client models。
const SoeClient = tencentcloud.soe.v20180724.Client;

// 实例化一个认证对象，入参需要传入腾讯云账户 SecretId 和 SecretKey，此处还需注意密钥对的保密
// 代码泄露可能会导致 SecretId 和 SecretKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考，建议采用更安全的方式来使用密钥，请参见：https://cloud.tencent.com/document/product/1278/85305
// 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取
const clientConfig = {
  credential: {
    secretId: "SecretId",
    secretKey: "SecretKey",
  },
  region: "",
};


// 实例化soe的client对象
const client = new SoeClient(clientConfig);
const fs = require('fs');
let data = fs.readFileSync("SOEMUSIC/apple.mp3"); //本地音频文件
data = new Buffer.from(data).toString('base64');

var uuid = require('node-uuid');
let SessionId = uuid.v1();

const params = {
  "SeqId": 1,
  "IsEnd": 1,
  "VoiceFileType": 2,
  "VoiceEncodeType": 1,
  "UserVoiceData": data,
  "SessionId": SessionId,
  "RefText": "hello",
  "WorkMode": 0,
  "EvalMode": 0,
  "ScoreCoeff": 1
};
// 通过client对象调用TransmitOralProcessWithInit方法发起请求
client.TransmitOralProcessWithInit(params).then(
  (data) => {
    console.log(data);
  },
  (err) => {
    console.error("error", err);
  }
);


评测超时处理

如果本地文件过大，可能会导致评测超时。可以选用如下方案：
1. 流式分片传输：将发音数据进行分片处理，减少每次评测的时间。
2. 异步查询：使用异步功能将发音数据先上传，然后使用查询功能查询结构。
流式分片传输
异步查询
const tencentcloud = require("tencentcloud-sdk-nodejs");
const fs = require('fs');
const uuid = require('node-uuid');
//导入对应产品模块的client models。
const SoeClient = tencentcloud.soe.v20180724.Client;
const clientConfig = {
  // 为了保护密钥安全，建议将密钥设置在环境变量中或者配置文件中
  credential: {
      secretId: process.env.TENCENTCLOUD_SECRET_ID,// 用户的SecretId，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考https://cloud.tencent.com/document/product/598/37140
      secretKey: process.env.TENCENTCLOUD_SECRET_KEY,// 用户的SecretKey，建议使用子账号密钥，授权遵循最小权限指引，降低使用风险。子账号密钥获取可参考https://cloud.tencent.com/document/product/598/37140
  },
  region: "",
};
// 实例化要请求产品的client对象,clientProfile是可选的
const client = new SoeClient(clientConfig);
async function main(){
  // 获取base64数据
  const PKG_SIZE = 100 * 1024;
  const SessionId = uuid.v1();
  const data = fs.readFileSync('SOEMUSIC/apple.mp3');//本地音频文件
  console.log(typeof data);
  const pkgNum = Math.ceil(data.length / PKG_SIZE);
  for (let i = 1; i <= pkgNum; i++) {
    let lastIndex = i == pkgNum ? data.length : i * PKG_SIZE
    let IsEnd = i == pkgNum ? 1 : 0
    let buf = data.subarray((i - 1) * PKG_SIZE, lastIndex)
    base64_data = new Buffer.from(buf).toString('base64');
    const params = {
      "SeqId": i,
      "IsEnd": IsEnd,
      "VoiceFileType": 3,
      "VoiceEncodeType": 1,
      "UserVoiceData": base64_data,
      "SessionId": SessionId,
      "RefText": "hello",
      "WorkMode": 0,
      "EvalMode": 2,
      "ScoreCoeff": 1
    };
    try {
      const response = await client.TransmitOralProcessWithInit(params);
      console.log(response);
    } catch (err) {
      console.error('error', err);
    }



  }
}



main()











const tencentcloud = require("tencentcloud-sdk-nodejs");

//导入对应产品模块的client models。
const SoeClient = tencentcloud.soe.v20180724.Client;

// 实例化一个认证对象，入参需要传入腾讯云账户 SecretId 和 SecretKey，此处还需注意密钥对的保密
// 代码泄露可能会导致 SecretId 和 SecretKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考，建议采用更安全的方式来使用密钥，请参见：https://cloud.tencent.com/document/product/1278/85305
// 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取
const clientConfig = {
  credential: {
    secretId: "SecretId",
    secretKey: "SecretKey",
  },
  region: "",
};

// 实例化soe的client对象
const client = new SoeClient(clientConfig);
// 请求参数赋值
var uuid = require('node-uuid');
let SessionId = uuid.v1();
const fs = require('fs');
let data = fs.readFileSync("SOEMUSIC/para.mp3"); //本地音频文件
data = new Buffer.from(data).toString('base64');

const params = {
  "SessionId": SessionId,
  "RefText": "hello",
  "WorkMode": 1,
  "EvalMode": 2,
  "ScoreCoeff": 1,
  "IsAsync":1,
  "SeqId": 1,
  "IsEnd": 1,
  "VoiceFileType": 3,
  "VoiceEncodeType": 1,
  "UserVoiceData": data,
  "SessionId": SessionId,

};



// 请求查询
var t1 = setInterval(check,1000)

function check(){
    client.TransmitOralProcessWithInit(params).then(
        (data) => {
            console.log(data);
            // var obj = JSON.parse(data)
            var status = data.Status
            if (status == "Finished") {
                clearInterval(t1)
            }
            else {
              params["IsQuery"] = 1
            }
        },
        (err) => {
            console.error("error", err);
            clearInterval(t1)

        }
    );
}




使用方法说明

1. SessionID：使用 uuid 来作为 SessionID，用于区分不同的音频。
2. base64 转换：读取本地音频文件，转换成 base64 数据进行评测。
3. 流式分片 base64 转换：读取本地音频文件，将音频进行分片，转换成 base64 数据进行评测。
4. 异步轮询：使用 json 反序列化，获取评测结果，判断是否查询到最终结果。
SessionID
base64转换
流式分片
异步轮询
var uuid = require('node-uuid');
let SessionId = uuid.v1();
const fs = require('fs');
const path = require('path');
const mineType = require('mime-types');

// 获取base64数据
let filePath = path.resolve(''); //本地音频文件地址
let data = fs.readFileSync(filePath);
data = new Buffer.from(data).toString('base64');
let PKG_SIZE = 1 * 1024;
const fs = require('fs');
// 获取uuid
var uuid = require('node-uuid');
let SessionId = uuid.v1();
let data = fs.readFileSync('SOEMUSIC/apple.mp3');//本地音频文件
let pkgNum = Math.ceil(data.length / PKG_SIZE);
for (let i = 1; i <= pkgNum; i++) {
  let lastIndex = i == pkgNum ? data.length : i * PKG_SIZE
  let IsEnd = i == pkgNum ? 1 : 0
  let buf = data((i - 1) * PKG_SIZE, lastIndex)
  data = buf.toString('base64');
// 请求查询
var t1 = setInterval(check,1000)

function check(){
    client.TransmitOralProcessWithInit(params).then(
        (data) => {
            console.log(data);
            // var obj = JSON.parse(data)
            var status = data.Status
            if (status == "Finished") {
                clearInterval(t1)
            }
            else {
              params["IsQuery"] = 1
            }
        },
        (err) => {
            console.error("error", err);
            clearInterval(t1)

        }
    );
}

临时授权凭证

客户端 SDK 需要使用 获取联合身份临时访问凭证 生成临时密钥，保障密钥安全性。
/// Depends on tencentcloud-sdk-nodejs version 4.0.3 or higher
const tencentcloud = require("tencentcloud-sdk-nodejs");


const StsClient = tencentcloud.sts.v20180813.Client;

// 实例化一个认证对象，入参需要传入腾讯云账户 SecretId 和 SecretKey，此处还需注意密钥对的保密
// 代码泄露可能会导致 SecretId 和 SecretKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考，建议采用更安全的方式来使用密钥，请参见：https://cloud.tencent.com/document/product/1278/85305
// 密钥可前往官网控制台 https://console.cloud.tencent.com/cam/capi 进行获取
const clientConfig = {
  credential: {
    secretId: "SecretId",
    secretKey: "SecretKey",
  },
  region: "",
};



// 实例化要请求产品的client对象,clientProfile是可选的
const client = new StsClient(clientConfig);
const policy = {
  version: '2.0',
  statement: {
    effect: 'allow',
    action: ['soe:TransmitOralProcessWithInit'],
    resource: '*'
  }
};


const params = {
  "Name": "soe",
  "Policy": encodeURIComponent(JSON.stringify(policy))
};

client.GetFederationToken(params).then(
  (data) => {
    console.log(data);
  },
  (err) => {
    console.error("error", err);
  }
);


中国站
文档反馈
文档活动
message-icon联系我们
目录