elevenlabs: deprecate STT model_id in favor of model

Author: u9g

examples/other/elevenlab_scribe_v2.py

@@ -25,7 +25,7 @@ async def entrypoint(ctx: JobContext) -> None:
             "min_speech_duration_ms": 100,
             "min_silence_duration_ms": 300,
         },
-        model_id="scribe_v2_realtime",
+        model="scribe_v2_realtime",
     )
 
     session: AgentSession = AgentSession(

livekit-plugins/livekit-plugins-elevenlabs/livekit/plugins/elevenlabs/stt.py

@@ -91,7 +91,8 @@ def __init__(
         server_vad: NotGivenOr[VADOptions] = NOT_GIVEN,
         include_timestamps: bool = False,
         http_session: aiohttp.ClientSession | None = None,
-        model_id: NotGivenOr[ElevenLabsSTTModels | str] = NOT_GIVEN,
+        model: NotGivenOr[ElevenLabsSTTModels | str] = NOT_GIVEN,
+        model_id: NotGivenOr[ElevenLabsSTTModels | str] = NOT_GIVEN,  # Deprecated
         keyterms: NotGivenOr[list[str]] = NOT_GIVEN,
         no_verbatim: NotGivenOr[bool] = NOT_GIVEN,
         enable_logging: bool = True,
@@ -110,8 +111,9 @@ def __init__(
             sample_rate (STTRealtimeSampleRates): Audio sample rate in Hz. Default is 16000.
             server_vad (NotGivenOr[VADOptions]): Server-side VAD options, only supported for Scribe v2 realtime model.
             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
+            model (ElevenLabsSTTModels | str): ElevenLabs STT model to use. If not specified a default model will
                 be selected based on parameters provided.
+            model_id (ElevenLabsSTTModels | str): Deprecated alias for `model`. Use `model` instead.
             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
@@ -123,20 +125,29 @@ def __init__(
                 mode will be used. Defaults to True.
         """
 
+        if is_given(model_id):
+            if is_given(model):
+                logger.warning(
+                    "both `model` and `model_id` parameters are provided. `model_id` will be ignored."
+                )
+            else:
+                logger.warning("`model_id` parameter is deprecated, use `model` instead.")
+                model = model_id
+
         if is_given(use_realtime):
-            if is_given(model_id):
+            if is_given(model):
                 logger.warning(
-                    "both `use_realtime` and `model_id` parameters are provided. `use_realtime` will be ignored."
+                    "both `use_realtime` and `model` parameters are provided. `use_realtime` will be ignored."
                 )
             else:
                 logger.warning(
                     "`use_realtime` parameter is deprecated. "
-                    "Specify a realtime model_id to enable streaming. "
-                    "Defaulting model_id to one based on use_realtime parameter. "
+                    "Specify a realtime model to enable streaming. "
+                    "Defaulting model to one based on use_realtime parameter. "
                 )
-                model_id = "scribe_v2_realtime" if use_realtime else "scribe_v1"
-        model_id = model_id if is_given(model_id) else "scribe_v1"
-        use_realtime = model_id == "scribe_v2_realtime"
+                model = "scribe_v2_realtime" if use_realtime else "scribe_v1"
+        model = model if is_given(model) else "scribe_v1"
+        use_realtime = model == "scribe_v2_realtime"
 
         if not use_realtime and is_given(server_vad):
             logger.warning("Server-side VAD is only supported for Scribe v2 realtime model")
@@ -164,7 +175,7 @@ def __init__(
             sample_rate=sample_rate,
             server_vad=server_vad,
             include_timestamps=include_timestamps,
-            model_id=model_id,
+            model_id=model,
             keyterms=keyterms,
             no_verbatim=no_verbatim if is_given(no_verbatim) else False,
             enable_logging=enable_logging,

tests/test_plugin_elevenlabs_stt.py

@@ -85,7 +85,21 @@ def test_manual_commit_still_waits_for_empty_commit() -> None:
 
 
 def _stt(**kwargs: object) -> elevenlabs_stt.STT:
-    return elevenlabs_stt.STT(api_key="test-key", model_id="scribe_v2_realtime", **kwargs)
+    return elevenlabs_stt.STT(api_key="test-key", model="scribe_v2_realtime", **kwargs)
+
+
+def test_model_sets_model() -> None:
+    assert _stt()._opts.model_id == "scribe_v2_realtime"
+
+
+def test_deprecated_model_id_still_sets_model() -> None:
+    instance = elevenlabs_stt.STT(api_key="test-key", model_id="scribe_v2_realtime")
+    assert instance._opts.model_id == "scribe_v2_realtime"
+
+
+def test_model_takes_precedence_over_model_id() -> None:
+    instance = elevenlabs_stt.STT(api_key="test-key", model="scribe_v1", model_id="scribe_v2")
+    assert instance._opts.model_id == "scribe_v1"
 
 
 def test_no_verbatim_defaults_to_false() -> None: