Repository navigation
fix(nvidia, xai, upliftai): report the provider in metrics - #8473
anubhavlal07 wants to merge 1 commit into
Conversation
| def model(self) -> str: | ||
| return self._opts.model |
There was a problem hiding this comment.
🟡 Plugin metadata overrides lack documentation
The new model and provider overrides have no docstrings, despite the requirement to document new methods. Their plugin-specific values remain undocumented on these properties.
Learn more
The repository requires documentation for every newly written method. All five new property overrides lack docstrings: NVIDIA STT's model and provider, NVIDIA TTS's provider, Uplift AI TTS's provider, and xAI STT's provider. The base properties describe the general interface, but not the plugin-specific values of these overrides.
Example: A reader inspecting NVIDIA STT's model property sees no method documentation explaining that its value is the configured Riva model.
Recommended fix: Add concise docstrings to all five overrides identifying the value each exposes; document NVIDIA STT's model as the configured Riva model.
Was this helpful? React with 👍 or 👎 to provide feedback.
There was a problem hiding this comment.
These follow the existing overrides: 119 of the 123 provider overrides in livekit-plugins have no docstring, and the base STT.provider / TTS.provider docstrings already describe the property. Happy to add them if maintainers prefer.
Four plugin classes don't override the
providerproperty, so they fall back to the base class's"unknown": NVIDIASTTandTTS, Uplift AITTS, and xAISTT. NVIDIASTTdoesn't overridemodeleither. These are the values that metrics, telemetry spans and the fallback adapters report (#6690), so usage from these plugins shows up with no provider. Every other STT and TTS plugin sets them.Fix: add the properties, using the names these packages already use elsewhere:
STTandTTSreport"nvidia", asnvidia.realtimedoes.STT.modelreturns the configured Riva model.STTreports"xAI", as xAITTSdoes.TTSreports"UpliftAI".I didn't add
modelwhere the plugin has no model setting to report: NVIDIA TTS selects voices byfunction_id, and Uplift AI and xAI STT have no model option.Tests:
test_reports_model_and_providerintests/test_plugin_nvidia_stt.py;test_reports_providerintests/test_plugin_xai_stt.py;test_reports_providerin a newtests/test_plugin_upliftai_tts.py(plugin("upliftai")).All three fail on
mainand pass with the change (34 tests across the three files).ruff checkandruff format --checkare clean.This change was prepared with the help of an AI assistant (Claude), and I reviewed and tested it.