speech-to-text

ElevenLabs 语音转文本

使用 Scribe v2 将音频转录为文本——支持 90 多种语言、说话人分离和词级时间戳。

**设置：**请参阅 安装指南。对于 JavaScript，请仅使用 @elevenlabs/* packages。

快速开始

Python

from elevenlabs import ElevenLabs

client = ElevenLabs()

with open("audio.mp3", "rb") as audio_file:
    result = client.speech_to_text.convert(file=audio_file, model_id="scribe_v2")

print(result.text)

JavaScript

import { ElevenLabsClient } from "@elevenlabs/elevenlabs-js";
import { createReadStream } from "fs";

const client = new ElevenLabsClient();
const result = await client.speechToText.convert({
  file: createReadStream("audio.mp3"),
  modelId: "scribe_v2",
});
console.log(result.text);

cURL

curl -X POST "https://api.elevenlabs.io/v1/speech-to-text" \
  -H "xi-api-key: $ELEVENLABS_API_KEY" -F "[email protected]" -F "model_id=scribe_v2"

模型

模型 ID	描述	适用场景
scribe_v2	业界领先的准确度，支持 90 多种语言	批量转录、字幕、长音频
scribe_v2_realtime	低延迟（约 150 ms）	实时转录、语音 Agent

带时间戳的转录

词级时间戳包含类型分类和说话人识别：

result = client.speech_to_text.convert(
    file=audio_file, model_id="scribe_v2", timestamps_granularity="word"
)

for word in result.words:
    print(f"{word.text}: {word.start}s - {word.end}s (type: {word.type})")

说话人分离

识别谁说了什么——模型会为每个词标注说话人 ID，适用于会议、访谈或任何包含多位说话人的音频：

result = client.speech_to_text.convert(
    file=audio_file,
    model_id="scribe_v2",
    diarize=True
)

for word in result.words:
    print(f"[{word.speaker_id}] {word.text}")

关键术语提示

帮助模型识别它可能误听的特定词语，例如产品名称、技术术语或不常见的拼写（最多 100 个术语）：

result = client.speech_to_text.convert(
    file=audio_file,
    model_id="scribe_v2",
    keyterms=["ElevenLabs", "Scribe", "API"]
)

语言检测

自动检测语言，也可选择提供语言提示：

result = client.speech_to_text.convert(
    file=audio_file,
    model_id="scribe_v2",
    language_code="eng"  # ISO 639-1 or ISO 639-3 code
)

print(f"Detected: {result.language_code} ({result.language_probability:.0%})")

支持的格式

**音频：**MP3、WAV、M4A、FLAC、OGG、WebM、AAC、AIFF、Opus **视频：**MP4、AVI、MKV、MOV、WMV、FLV、WebM、MPEG、3GPP

**限制：**文件大小最多 3 GB，时长最多 10 小时

响应格式

{
  "text": "The full transcription text",
  "language_code": "eng",
  "language_probability": 0.98,
  "words": [
    {"text": "The", "start": 0.0, "end": 0.15, "type": "word", "speaker_id": "speaker_0"},
    {"text": " ", "start": 0.15, "end": 0.16, "type": "spacing", "speaker_id": "speaker_0"}
  ]
}

词类型：

• word - 实际说出的词语
• spacing - 词语之间的空白（有助于精确计时）
• audio_event - 模型检测到的非语音声音（笑声、掌声、音乐等）

错误处理

try:
    result = client.speech_to_text.convert(file=audio_file, model_id="scribe_v2")
except Exception as e:
    print(f"Transcription failed: {e}")

常见错误：

• 401：API 密钥无效
• 422：参数无效
• 429：超出速率限制

跟踪费用

通过 request-id 响应标头监控用量：

response = client.speech_to_text.convert.with_raw_response(file=audio_file, model_id="scribe_v2")
result = response.parse()
print(f"Request ID: {response.headers.get('request-id')}")

实时流式传输

如需以超低延迟（约 150 ms）进行实时转录，请使用实时 API。实时 API 会生成两种转录结果：

• **部分转录结果：**音频处理期间频繁更新的临时结果——用于实时反馈（例如，在用户说话时显示文本）
• **已提交的转录结果：**在你执行“提交”后生成的最终稳定结果——将其用作应用的权威数据源

“提交”会告知模型完成当前片段的转录。你可以手动提交（例如，在用户暂停时），也可以使用语音活动检测（VAD）在静音时自动提交。

Python（服务端）

import asyncio
from elevenlabs import ElevenLabs

client = ElevenLabs()

async def transcribe_realtime():
    async with client.speech_to_text.realtime.connect(
        model_id="scribe_v2_realtime",
        include_timestamps=True,
    ) as connection:
        await connection.stream_url("https://example.com/audio.mp3")

        async for event in connection:
            if event.type == "partial_transcript":
                print(f"Partial: {event.text}")
            elif event.type == "committed_transcript":
                print(f"Final: {event.text}")

asyncio.run(transcribe_realtime())

JavaScript（客户端，使用 React）

import { useScribe, CommitStrategy } from "@elevenlabs/react";

function TranscriptionComponent() {
  const [transcript, setTranscript] = useState("");

  const scribe = useScribe({
    modelId: "scribe_v2_realtime",
    commitStrategy: CommitStrategy.VAD, // Auto-commit on silence for mic input
    onPartialTranscript: (data) => console.log("Partial:", data.text),
    onCommittedTranscript: (data) => setTranscript((prev) => prev + data.text),
  });

  const start = async () => {
    // Get token from your backend (never expose API key to client)
    const { token } = await fetch("/scribe-token").then((r) => r.json());

    await scribe.connect({
      token,
      microphone: { echoCancellation: true, noiseSuppression: true },
    });
  };

  return <button onClick={start}>Start Recording</button>;
}

提交策略

策略	描述
手动	准备就绪时调用 commit()——适用于文件处理或由你控制音频片段的场景
VAD	语音活动检测会在检测到静音时自动提交——适用于实时麦克风输入

// React: set commitStrategy on the hook (recommended for mic input)
import { useScribe, CommitStrategy } from "@elevenlabs/react";

const scribe = useScribe({
  modelId: "scribe_v2_realtime",
  commitStrategy: CommitStrategy.VAD,
  // Optional VAD tuning:
  vadSilenceThresholdSecs: 1.5,
  vadThreshold: 0.4,
});

// JavaScript client: pass vad config on connect
const connection = await client.speechToText.realtime.connect({
  modelId: "scribe_v2_realtime",
  vad: {
    silenceThresholdSecs: 1.5,
    threshold: 0.4,
  },
});

事件类型

事件	描述
partial_transcript	实时临时结果
committed_transcript	提交后的最终结果
committed_transcript_with_timestamps	包含词级时间信息的最终结果
error	发生错误

完整文档请参阅实时参考资料。

参考资料

• 安装指南
• 转录选项
• 客户端实时流式传输
• 服务端实时流式传输
• 提交策略
• 实时事件参考