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原始任務查詢響應。