关键词提示 | ElevenLabs Documentation

操作指南 · 假设你已完成文本转语音快速入门。

概述

关键词提示适用于 Scribe v2、Scribe v2 Medical（批量）和 Scribe v2 Realtime，且需额外付费。详细价格请参阅 API 定价页面。

关键词提示功能可让你突出显示单词或短语，引导模型优先转录它们。这对转录音频中不常见的特定词语或句子非常有用，例如产品名称、人名或其他特定术语。关键词比其他模型提供的偏置关键词或自定义词汇表更强大，因为模型会依据上下文决定是否转录该术语。

	批量（Scribe v2 / Scribe v2 Medical）	实时（Scribe v2 Realtime）
最大关键词数量	1000	50
每个关键词最大字符数	50	20

例如，如果公司名称并非常见短语，或者拼写、发音比较独特，可以使用关键词提示确保模型正确转录。以下是一个音频示例：

不使用关键词提示时，模型可能会将以上内容转录为：

I work at eleven labs.

其中公司名称的写法不正确。使用关键词提示后，可确保模型以上述正确的拼写和格式进行转录：

I work at ElevenLabs.

上下文

模型可以利用上下文判断是否应转录某个术语。提供关键词 “ElevenLabs” 后，以上音频会按预期转录；同时，模型仍能根据上下文正确转录以下内容：

输出以下转录文本：

I've worked at many labs. In fact I've worked at eleven labs.

批量转录

通过向 convert 方法传入 keyterms 参数，即可在批量文本转语音 API 中使用关键词提示。

import os
from dotenv import load_dotenv
from io import BytesIO
import requests
from elevenlabs.client import ElevenLabs
load_dotenv()
elevenlabs = ElevenLabs(
    api_key=os.getenv("ELEVENLABS_API_KEY"),
)
audio_url = (
    "https://storage.googleapis.com/eleven-public-cdn/documentation_assets/audio/stt-keyterm-prompting.mp3"
)
response = requests.get(audio_url)
audio_data = BytesIO(response.content)
transcription = elevenlabs.speech_to_text.convert(
    file=audio_data,
    model_id="scribe_v2", # Model to use
    # Keyterms to prompt the model with.
    # Up to 1000 keyterms can be provided, with a maximum length of 50 characters each
    keyterms=["ElevenLabs"],
)
print(transcription)

实时流式传输

实时文本转语音 WebSocket API 也支持关键词提示。连接时传入 keyterms 参数。

connection = await elevenlabs.speech_to_text.realtime.connect(RealtimeUrlOptions(
    model_id="scribe_v2_realtime",
    keyterms=["ElevenLabs"],
))

直接使用 WebSocket API 时，请将关键词作为查询参数传入：

wss://api.elevenlabs.io/v1/speech-to-text/realtime?model_id=scribe_v2_realtime&keyterms=ElevenLabs&keyterms=AnotherTerm

后续步骤

API 参考文档

完整的文本转语音 API 参考文档和参数说明。

实体检测

自动检测并标记转录文本中的人名、日期和地点等实体。