Skip to content

feat(stt): add keyterms parameter in Elevenlabs STT plugin #4967

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidzhao merged 2 commits into from
Mar 2, 2026
+14 −0
Merged

feat(stt): add keyterms parameter in Elevenlabs STT plugin #4967

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aecb556
feat(stt): add keyterms option to bias transcription towards specific…
Arjun-AI-codes Feb 27, 2026
a00209a
Update docstring for elevenlabs keyterms
Arjun-AI-codes Feb 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions livekit-plugins/livekit-plugins-elevenlabs/livekit/plugins/elevenlabs/stt.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ class STTOptions:
include_timestamps: bool
sample_rate: STTRealtimeSampleRates
server_vad: NotGivenOr[VADOptions | None]
keyterms: NotGivenOr[list[str]]


class STT(stt.STT):
Expand All @@ -88,6 +89,7 @@ def __init__(
include_timestamps: bool = False,
http_session: aiohttp.ClientSession | None = None,
model_id: NotGivenOr[ElevenLabsSTTModels | str] = NOT_GIVEN,
keyterms: NotGivenOr[list[str]] = NOT_GIVEN,
) -> None:
"""
Create a new instance of ElevenLabs STT.
Expand All @@ -105,6 +107,10 @@ def __init__(
http_session (aiohttp.ClientSession | None): Custom HTTP session for API requests. Optional.
model_id (ElevenLabsSTTModels | str): ElevenLabs STT model to use. If not specified a default model will
be selected based on parameters provided.
keyterms (NotGivenOr[list[str]]): A list of keywords or phrases to bias the transcription towards.
Each keyterm can contain at most 5 words and must be less than 50 characters.
Maximum of 100 keyterms. Only supported for Scribe v2 batch recognition
(not realtime streaming). Usage incurs additional costs.
"""

if is_given(use_realtime):
Expand Down Expand Up @@ -149,6 +155,7 @@ def __init__(
server_vad=server_vad,
include_timestamps=include_timestamps,
model_id=model_id,
keyterms=keyterms,
)
self._session = http_session
self._streams = weakref.WeakSet[SpeechStream]()
Expand Down Expand Up @@ -184,6 +191,9 @@ async def _recognize_impl(
form.add_field("tag_audio_events", str(self._opts.tag_audio_events).lower())
if self._opts.language_code:
form.add_field("language_code", self._opts.language_code)
if is_given(self._opts.keyterms):
for keyterm in self._opts.keyterms:
form.add_field("keyterms", keyterm)

try:
async with self._ensure_session().post(
Expand Down Expand Up @@ -268,13 +278,17 @@ def update_options(
*,
tag_audio_events: NotGivenOr[bool] = NOT_GIVEN,
server_vad: NotGivenOr[VADOptions] = NOT_GIVEN,
keyterms: NotGivenOr[list[str]] = NOT_GIVEN,
) -> None:
if is_given(tag_audio_events):
self._opts.tag_audio_events = tag_audio_events

if is_given(server_vad):
self._opts.server_vad = server_vad

if is_given(keyterms):
self._opts.keyterms = keyterms

for stream in self._streams:
stream.update_options(server_vad=server_vad)

Expand Down