Skip to main content

Qwen-Audio-ASR-Filetrans Node.js SDK

通过语音 Node.js SDK 调用 Qwen-Audio-ASR-Filetrans,提交录音文件 URL、查询异步任务并下载转写结果。

安装 SDK

需要 Node.js 18 或以上版本。下载 SDK 0.1.0 安装包后,在项目目录运行:
npm install ./dashscope-sdk-nodejs-0.1.0.tgz

快速开始

在控制台获取 API Key,并配置为环境变量 DASHSCOPE_API_KEY。 将以下示例保存为 example.mjs,运行 node example.mjs。
import { TranscriptionClient } from 'dashscope-sdk-nodejs/asr'

const client = new TranscriptionClient({
  apiKey: process.env.DASHSCOPE_API_KEY,
  workspaceId: process.env.DASHSCOPE_WORKSPACE_ID,
  baseUrl: 'dashscope-intl.aliyuncs.com',
  model: 'qwen-audio-3.1-asr-flash-filetrans',
})
const job = await client.transcribe(
  'https://dashscope.oss-cn-beijing.aliyuncs.com/audios/welcome.mp3',
)
for (const result of job.results) {
  if (result.subtaskStatus === 'SUCCEEDED') {
    console.log('Transcript:', result.text)
  } else {
    console.error(result.code, result.message)
    process.exitCode = 1
  }
}

接口参考

构造参数

TranscriptionClient 的构造参数如下。
参数类型必填说明
apiKeystring否API Key。默认读取 DASHSCOPE_API_KEY。
workspaceIdstring否业务空间 ID。默认读取 DASHSCOPE_WORKSPACE_ID。
baseUrlstring否服务域名,设置为 dashscope-intl.aliyuncs.com(新加坡)。
modelstring否模型 ID,默认 qwen-audio-3.1-asr-flash-filetrans。
pollIntervalMsnumber否查询间隔,默认 3000 ms。
pollTimeoutMsnumber否轮询超时(ms),默认 600000。
requestTimeoutMsnumber否单次 HTTP 请求超时(ms),默认 30000;0 表示不限制单次请求。

转写参数

transcribe() 和 submitTask() 的第二个参数为 parameters,第三个参数可传入 context。模型参数的完整说明见 HTTP API。
参数类型必填说明
fileUrlsstring | string[]是公网可访问的音频 URL;每次提交一个文件。
parameters.keep_dialectboolean否保留方言表达,默认 false。
parameters.vocabulary_idstring否预编译热词列表 ID。
parameters.vocabularyRecord<string, number>否即时热词:键为词,值为权重 [1,5] 或 50。
parameters.channel_idnumber[]否音轨索引,默认 [0]。
parameters.special_word_filterstring | Record<string, unknown>否敏感词过滤配置,可传 JSON 字符串或对象。
parameters.diarization_enabledboolean否单声道音频的说话人分离,默认 false。
parameters.speaker_countnumber否说话人数量参考值,范围 [2,100],需启用说话人分离。
parameters.language_hintsstring[]否识别语言提示,最多使用前 4 个值;未设置时自动识别。
callOpts.context / submitOpts.contextAsrContextMessage[]否识别上下文。消息格式为 { role, content: [{ type: "input_text", text }] },role 为 user 或 assistant;每种角色最多 5 条,文本共少于 400 字符,按对话轮次排列。
callOpts.onProgress(status: string, response: QueryTaskResponse) => void否查询进度回调,接收 status 和原始响应 response。

主要方法

方法返回值说明
transcribe(fileUrls: string | string[], parameters?: TranscriptionParameters, callOpts?: TranscribeCallOptions)Promise<TranscriptionJobResult>提交音频、轮询并下载结果;callOpts 可设置上下文和进度回调。
submitTask(fileUrls: string | string[], parameters?: TranscriptionParameters, submitOpts?: TranscriptionSubmitOptions)Promise<{ taskId: string; taskStatus: string }>提交任务并返回任务 ID、初始状态;submitOpts.context 设置识别上下文。
fetchTask(taskId: string, requestTimeoutMs?: number)Promise<QueryTaskResponse>查询一次任务,返回状态和结果下载链接。

返回结果

字段类型说明
taskIdstring任务 ID。
taskStatusstring任务状态。
resultsFileTranscriptionResult[]文件结果列表,包含 subtaskStatus、text、transcription;失败项含 code、message。
usageRecognitionUsage | undefined服务端返回的用量统计。
rawQueryTaskResponse原始任务查询响应。