xunfeisdk

科大讯飞 Web API 的 TypeScript 版封装，可以方便的用于NodeJS环境下。

特点

• TypeScript 源代码, 带 .d.ts 类型定义。 可方便的用于 TS 或者 NodeJS项目中。
• Promise 型方法，支持 async / await 语句访问。

安装

npm install xunfeisdk

or

git clone https://github.com/breakstring/xunfeisdk.git
cd xunfeisdk
npm install

官方 WebAPI 接口

http://doc.xfyun.cn/rest_api/

测试

cd test
cp config_template.ts config.ts
# 修改你的 AppID 和各个 AppKey
# 别忘了去加你的IP地址到控制台的白名单
npm run test

已知问题

由于讯飞更改了其官方接口，不再支持新的WebAPI请求方式的应用，新应用只是支持流式API。如果您之前没有申请过TTS和IAT的API Key可能会导致测试无法通过。故临时更改了测试脚本只是保留了ISE（即语音评测部分）

使用

// 如果用在Nodejs环境中请使用 const xunfeisdk = require("xunfeisdk");的方式来引入包，或者使用ts-node之类的来直接执行ts
import * as Xunfei from "xunfeisdk";
import { IATAueType, IATEngineType, ISEAueType, ISECategoryType, ISELanguageType, ISEResultLevelType, TTSAueType, TTSAufType, TTSEngineType, TTSVoiceName } from "xunfeisdk";

const client = new Xunfei.Client("Your AppID");
// 语音评测服务（根据基准文字给语音朗读打分）
client.ISEAppKey = "语音评测的 AppKey";
const audio = fs.readFileSync(path.join(__dirname, "评测文件.wav"));
try {
    const result = await client.ISE(audio, "基准文字", ISEAueType.RAW, ISELanguageType.EN, ISECategoryType.SENTENCE, ISEResultLevelType.COMPLETE);

} catch (error) {
    // Oops...
}

// 语音听写(即语音转换为文字)
client.IATAppKey = “语音听写服务的 AppKey”;
const audio = fs.readFileSync(path.join(__dirname, "要转换为文字的音频.wav"));
try{
    const result = await client.IAT(audio, IATEngineType.SMS16K_English, IATAueType.RAW);
} catch (error) {
    // Oops...
}

// 语音合成 (即根据文字来生成音频)
client.TTSAppKey = "语音合成服务的 AppKey";
try {
    const result = await client.TTS("科大讯飞的接口文档写的太烂了", TTSAufType.L16_8K, TTSAueType.LAME, TTSVoiceName.XiaoYan);
    const mp3 = path.join(__dirname, "要存成的文件.mp3");
    fs.writeFileSync(mp3, result.audio, "binary");
} catch (error) {
    // Oops...
}