| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602 |
- #!/usr/bin/env python3
- """Speech-to-text transcription used by the gateway for voice messages.
- Built-in providers: local (faster-whisper, default/free), local_command, groq, openai
- (also serves the managed ``nous`` selection), mistral, xai, elevenlabs, deepinfra; plus
- user-declared command providers and plugin providers. ``transcribe_audio(path)`` returns
- ``{"success", "transcript", "error"?, "provider"?}``. This module owns provider resolution,
- the dispatcher and the cached local model + idle-unload state; backends live in
- ``transcription_{common,audio,local,cloud,command}``.
- """
- import contextvars
- import logging
- import os
- import shutil
- import threading
- import time
- import importlib.util as _ilu
- from contextlib import ExitStack
- from pathlib import Path
- from tempfile import TemporaryDirectory
- from typing import Optional, Dict, Any
- from utils import is_truthy_value
- from tools.transcription_common import (
- BUILTIN_STT_PROVIDERS, CLOUD_STT_PROVIDERS, DEFAULT_ELEVENLABS_STT_MODEL,
- DEFAULT_GROQ_STT_MODEL, DEFAULT_LOCAL_MODEL, DEFAULT_MISTRAL_STT_MODEL, DEFAULT_PROVIDER,
- DEFAULT_STT_MODEL, LOCAL_STT_COMMAND_ENV, LOCAL_STT_LANGUAGE_ENV,
- normalize_xai_stt_model, _error_result, _get_stt_section, _ok_result)
- from tools.transcription_audio import (
- _convert_caf_to_wav, _prepare_audio_for_transcription, _trim_silence_for_cloud_stt,
- _validate_audio_file, _validate_audio_source_file)
- from tools.transcription_chunking import exceeds_upload_limit, transcribe_oversized, upload_limit
- from tools.transcription_local import (
- _get_idle_unload_seconds, _has_local_command, _join_confident_segments,
- _load_local_whisper_model, _looks_like_cuda_lib_error, _normalize_local_model,
- _normalize_local_stt_language, _transcribe_local_command, _try_lazy_install_stt,
- build_local_transcribe_kwargs)
- # The ``_transcribe_<provider>`` handlers are looked up in this module's globals by _dispatch_stt_provider.
- from tools.transcription_cloud import (
- _has_xai_stt_credentials, _resolve_openai_audio_client_config, _transcribe_deepinfra,
- _transcribe_elevenlabs, _transcribe_groq, _transcribe_mistral, _transcribe_openai,
- _transcribe_xai)
- from tools.transcription_command import (
- _apply_pre_transcription_hook, _dispatch_to_plugin_provider, _enforce_prompt_length_limit,
- _resolve_command_stt_provider_config, _transcribe_command_stt, _unregistered_stt_provider_error)
- logger = logging.getLogger(__name__)
- def _resolve_provider_key(env_var: str, provider_id: str) -> str:
- """STT API key via the shared voice-key resolver (config > env/.env > credential pool); resolved per call."""
- from tools.tool_backend_helpers import resolve_provider_secret
- return resolve_provider_secret(env_var, provider_id)
- def _safe_find_spec(module_name: str) -> bool:
- try:
- return _ilu.find_spec(module_name) is not None
- except (ImportError, ValueError):
- return module_name in globals() or module_name in os.sys.modules
- _HAS_FASTER_WHISPER, _HAS_OPENAI, _HAS_MISTRAL, _HAS_PILK = map(
- _safe_find_spec, ("faster_whisper", "openai", "mistralai", "pilk"))
- # Local model singleton; the lock guards check-then-load against concurrent voice messages.
- _local_model: Optional[object] = None
- _local_model_name: Optional[str] = None
- # See #24767.
- _local_model_lock = threading.Lock()
- # Idle unload: one daemon thread releases the model (hundreds of MB of RAM/VRAM) after a
- # configurable idle period, then exits; the next voice message reloads and restarts it.
- # _idle_unload_mgmt_lock serializes the start check so no duplicate watchers spawn.
- _last_transcription_time: float = 0.0
- _idle_unload_thread: Optional[threading.Thread] = None
- _idle_unload_stop = threading.Event()
- _idle_unload_mgmt_lock = threading.Lock()
- # (context, fallback timeout) of the last caller that loaded or used the model: whose profile's
- # stt.local.unload_after_idle_seconds the watcher applies. Guarded by _idle_unload_mgmt_lock.
- _idle_unload_policy: tuple[contextvars.Context, int] = (contextvars.copy_context(), 0)
- _IDLE_UNLOAD_CHECK_INTERVAL = 30 # seconds between idle checks
- # ---- Config helpers -----------------------------------------------------
- def _load_stt_config() -> dict:
- """Load the ``stt`` section from user config, falling back to defaults."""
- try:
- from hermes_cli.config import load_config
- return load_config().get("stt") or {}
- except Exception:
- return {}
- def is_stt_enabled(stt_config: Optional[dict] = None) -> bool:
- cfg = _load_stt_config() if stt_config is None else stt_config
- return is_truthy_value(cfg.get("enabled", True), default=True)
- def _resolve_stt_language(
- provider_key: str, stt_config: Optional[dict[str, Any]] = None, *, extra_keys: tuple = ()
- ) -> Optional[str]:
- """Language hint for an STT provider, first non-empty wins (never ""): ``stt.<provider>.language``
- (plus *extra_keys* aliases, e.g. ``language_code``) > ``stt.language`` > ``HERMES_LOCAL_STT_LANGUAGE``
- env > None (provider auto-detects)."""
- if stt_config is None:
- stt_config = _load_stt_config()
- provider_cfg = _get_stt_section(stt_config, provider_key)
- candidates = [provider_cfg.get(key) for key in ("language", *extra_keys)]
- if isinstance(stt_config, dict):
- candidates.append(stt_config.get("language"))
- candidates.append(os.getenv(LOCAL_STT_LANGUAGE_ENV))
- return next((c.strip() for c in candidates if isinstance(c, str) and c.strip()), None)
- def _openai_audio_unavailable_reason() -> Optional[str]:
- """None when OpenAI audio has usable credentials (config, env, or managed gateway); else the reason."""
- try:
- # Resolve directly instead of via the boolean probe: the probe flattens
- # _resolve_openai_audio_client_config's selection-specific ValueError into False, so a managed
- # openai-audio gateway outage would be logged as a generic "no API key" hint (#93045).
- _resolve_openai_audio_client_config()
- return None
- except ValueError as exc:
- return str(exc)
- def _has_openai_audio_backend() -> bool:
- return _openai_audio_unavailable_reason() is None
- def _is_local_stt_provider(provider: str, stt_config: dict[str, Any]) -> bool:
- """Whether *provider* is exempt from Hermes's remote upload cap."""
- return (provider or "").lower().strip() in {"local", "local_command"}
- # ---- Provider resolution ------------------------------------------------
- def _has_key(env_var: str, provider: str, *, needs_openai: bool = False, needs_mistral: bool = False):
- """Availability probe factory: optional SDK flag AND a resolvable API key."""
- def probe() -> bool:
- sdk_ok = (not needs_openai or _HAS_OPENAI) and (not needs_mistral or _HAS_MISTRAL)
- return sdk_ok and bool(_resolve_provider_key(env_var, provider))
- return probe
- def _has_xai_stt_credentials_quietly() -> bool:
- try:
- return _has_xai_stt_credentials()
- except Exception:
- return False
- def _resolve_explicit_openai() -> str:
- if not _HAS_OPENAI:
- logger.warning("STT provider 'openai' configured but no API key available")
- return "none"
- # Resolved directly so a managed openai-audio gateway outage is logged with its real reason.
- reason = _openai_audio_unavailable_reason()
- if reason is None:
- return "openai"
- logger.warning("STT provider 'openai' configured but unavailable: %s", reason)
- return "none"
- def _detect_local_backend() -> Optional[str]:
- """faster-whisper > local whisper CLI; None when no local backend is installed.
- Resolution only — it must never install. Asking a status probe to resolve the provider used
- to run a full dependency sync here (``_try_lazy_install_stt`` → ``pm.ensure_import``) under
- the per-install lock, so ``wake.status`` and ``/voice status`` could hold a sibling profile's
- backend off its port for the length of a venv rebuild. A missing faster-whisper now reports
- unavailable; the install happens on first transcription, in ``_transcribe_local``."""
- if _HAS_FASTER_WHISPER:
- return "local"
- return "local_command" if _has_local_command() else None
- def _resolve_explicit_local() -> str:
- backend = _detect_local_backend()
- if not backend:
- logger.warning("STT provider 'local' configured but unavailable "
- "(install faster-whisper or set HERMES_LOCAL_STT_COMMAND)")
- return backend or "none"
- def _resolve_explicit_local_command() -> str:
- if _has_local_command():
- return "local_command"
- if _HAS_FASTER_WHISPER:
- logger.info("Local STT command unavailable, using local faster-whisper")
- return "local"
- logger.warning("STT provider 'local_command' configured but unavailable")
- return "none"
- _has_groq_key = _has_key("GROQ_API_KEY", "groq", needs_openai=True)
- _has_mistral_key = _has_key("MISTRAL_API_KEY", "mistral", needs_mistral=True)
- _has_elevenlabs_key = _has_key("ELEVENLABS_API_KEY", "elevenlabs")
- _has_deepinfra_key = _has_key("DEEPINFRA_API_KEY", "deepinfra", needs_openai=True)
- # Cloud providers in AUTO-DETECT priority order:
- # name -> (explicit-selection probe, auto-detect probe, explicit warning, auto-detect log)
- # The probes differ only for openai (explicit has its own resolver in _EXPLICIT_RESOLVERS;
- # auto-detect also requires the SDK) and xai (auto-detect must never raise). DeepInfra is
- # LAST so a DEEPINFRA_API_KEY set for chat never displaces an xAI/ElevenLabs auto-selection.
- # Mistral only auto-selects when the SDK is present — no lazy-install during passive
- # auto-detection (explicit ``provider: mistral`` installs on first use).
- _CLOUD_PROVIDER_SPECS = {
- "groq": (_has_groq_key, _has_groq_key,
- "STT provider 'groq' configured but GROQ_API_KEY not set",
- "No local STT available, using Groq Whisper API"),
- "openai": (None, lambda: _HAS_OPENAI and _has_openai_audio_backend(),
- None,
- "No local STT available, using OpenAI Whisper API"),
- "mistral": (_has_mistral_key, _has_mistral_key,
- "STT provider 'mistral' configured but mistralai package not installed or MISTRAL_API_KEY not set",
- "No local STT available, using Mistral Voxtral Transcribe API"),
- "xai": (_has_xai_stt_credentials, _has_xai_stt_credentials_quietly,
- "STT provider 'xai' configured but no xAI credentials are available",
- "No local STT available, using xAI Grok STT API"),
- "elevenlabs": (_has_elevenlabs_key, _has_elevenlabs_key,
- "STT provider 'elevenlabs' configured but ELEVENLABS_API_KEY not set",
- "No local STT available, using ElevenLabs Scribe STT API"),
- "deepinfra": (_has_deepinfra_key, _has_deepinfra_key,
- "STT provider 'deepinfra' configured but DEEPINFRA_API_KEY not set (or openai package missing)",
- "No local STT available, using DeepInfra Whisper API")}
- # Explicit selections whose resolution is more than a probe + warning.
- _EXPLICIT_RESOLVERS = {
- "local": _resolve_explicit_local,
- "local_command": _resolve_explicit_local_command,
- "openai": _resolve_explicit_openai}
- def _resolve_explicit_provider(provider: str) -> str:
- """Explicit ``stt.provider`` -> usable name or ``"none"``; unknown names pass through untouched
- so the dispatcher fails with the provider-not-registered message."""
- resolver = _EXPLICIT_RESOLVERS.get(provider)
- if resolver is not None:
- return resolver()
- spec = _CLOUD_PROVIDER_SPECS.get(provider)
- if spec is None or spec[0]():
- return provider
- logger.warning(spec[2])
- return "none"
- def _get_provider(stt_config: dict) -> str:
- """Which STT provider to use: an explicit ``stt.provider`` is honoured (no silent cloud
- fallback); otherwise auto-detect local > groq > openai > mistral > xai > elevenlabs > deepinfra."""
- if not is_stt_enabled(stt_config):
- return "none"
- explicit = "provider" in stt_config
- provider = stt_config.get("provider", DEFAULT_PROVIDER)
- # The managed "Nous Subscription" selection is the OpenAI backend routed via the managed gateway.
- if isinstance(provider, str) and provider.strip().lower() == "nous":
- provider = "openai"
- if explicit and provider == "local":
- # Legacy DEFAULT_CONFIG seeded ``stt.provider: local`` on every install, so only a
- # raw config.yaml selection counts as explicit; otherwise autodetect (local-first anyway).
- try:
- from tools.tool_backend_helpers import read_selection
- if read_selection("stt") is None:
- explicit = False
- except Exception: # pragma: no cover — helpers are in-repo
- pass
- if explicit:
- return _resolve_explicit_provider(provider)
- backend = _detect_local_backend()
- if backend:
- return backend
- for name, (_probe, available, _warning, message) in _CLOUD_PROVIDER_SPECS.items():
- if available():
- logger.info(message)
- return name
- return "none"
- # ---- Provider: local (faster-whisper) -----------------------------------
- def _unload_local_model() -> None:
- """Release the cached local whisper model. Thread-safe via the model lock."""
- global _local_model, _local_model_name
- with _local_model_lock:
- if _local_model is not None:
- logger.info("Unloading local whisper model '%s' after idle timeout", _local_model_name or "unknown")
- _local_model = None
- _local_model_name = None
- def _configured_idle_unload_seconds() -> int:
- return _get_idle_unload_seconds(_load_stt_config().get("local") or {})
- def _start_idle_unload_watcher(timeout_seconds: int) -> None:
- """Ensure the single idle-unload watcher thread is running, governed by the caller's profile.
- One process can serve several profiles, each with its own
- ``stt.local.unload_after_idle_seconds``, and they share the one cached model. The policy that
- governs it is the one of whoever last loaded or used it: every call records the caller's
- context (profile scope included) and the loop re-reads the setting inside that context each
- cycle, so config edits still apply within one interval and a watcher started under profile A
- stops applying A's policy once profile B warms or transcribes. ``timeout_seconds`` is the
- fallback when that read fails. Exits after unloading, when the timeout becomes 0, or when the
- model is gone."""
- global _idle_unload_thread, _idle_unload_policy
- with _idle_unload_mgmt_lock:
- _idle_unload_policy = (contextvars.copy_context(), timeout_seconds)
- if _idle_unload_thread is not None and _idle_unload_thread.is_alive():
- return
- def _watch():
- while not _idle_unload_stop.wait(_IDLE_UNLOAD_CHECK_INTERVAL) and _local_model is not None:
- with _idle_unload_mgmt_lock:
- owner_context, fallback = _idle_unload_policy
- try:
- # A copy: a Context can't be entered twice at once, and the owner's own
- # request may still be running in the original.
- timeout = owner_context.copy().run(_configured_idle_unload_seconds)
- except Exception:
- timeout = fallback
- if timeout <= 0:
- break # unload disabled mid-flight — stand down
- if time.monotonic() - _last_transcription_time >= timeout:
- _unload_local_model()
- break
- _idle_unload_stop.clear()
- _idle_unload_thread = threading.Thread(target=_watch, name="hermes-stt-idle-unload", daemon=True)
- _idle_unload_thread.start()
- def _touch_transcription_time() -> None:
- """Record transcription activity (resets the idle timer)."""
- global _last_transcription_time
- _last_transcription_time = time.monotonic()
- def _get_or_load_local_model(model_name: str, local_cfg: dict[str, Any]):
- """Cached faster-whisper model, (re)loaded under a double-checked lock when needed. The returned
- strong reference stays valid even if the idle watcher nulls the global mid-transcription."""
- global _local_model, _local_model_name
- model = _local_model
- # Lazy-load the model (downloads on first use, ~150 MB for 'base'). Double-checked lock: concurrent
- # voice messages must not both download/load the model (#24767). ``model`` is a strong local reference
- # bound under the lock: the idle watcher may null the module global at any time, but this transcription
- # keeps using the instance it grabbed.
- if model is None or _local_model_name != model_name:
- with _local_model_lock:
- if _local_model is None or _local_model_name != model_name:
- logger.info("Loading faster-whisper model '%s' (first load downloads the model)...", model_name)
- # stt.local.device / compute_type pin a configuration where ``auto`` mis-detects.
- _local_model = _load_local_whisper_model(model_name, device=local_cfg.get("device", "auto"),
- compute_type=local_cfg.get("compute_type", "auto"))
- _local_model_name = model_name
- model = _local_model
- return model
- def _replace_cached_model_on_cpu(model_name: str):
- """Load *model_name* on CPU/int8 and make it the cached singleton."""
- global _local_model, _local_model_name
- model = _load_local_whisper_model(model_name, device="cpu", compute_type="int8")
- with _local_model_lock:
- _local_model, _local_model_name = model, model_name
- return model
- def _transcribe_local(
- file_path: str, model_name: str, *, language: Optional[str] = None, prompt: Optional[str] = None
- ) -> dict[str, Any]:
- """Transcribe using faster-whisper (local, free)."""
- if not _HAS_FASTER_WHISPER and not _try_lazy_install_stt():
- return _error_result("faster-whisper not installed")
- try:
- stt_config = _load_stt_config()
- local_cfg = stt_config.get("local") or {}
- # Reset the idle timer BEFORE loading so a long in-flight transcription isn't counted as idle.
- _touch_transcription_time()
- model = _get_or_load_local_model(model_name, local_cfg)
- if model is None: # defensive: load failed without raising
- return _error_result("Local whisper model failed to load")
- # pre_transcription hook overrides win over config-resolved values.
- transcribe_kwargs = build_local_transcribe_kwargs(stt_config)
- effective_language = language if language is not None else transcribe_kwargs.get("language")
- normalized_language = _normalize_local_stt_language(
- effective_language, getattr(model, "supported_languages", None))
- if normalized_language:
- transcribe_kwargs["language"] = normalized_language
- else:
- transcribe_kwargs.pop("language", None)
- if prompt:
- transcribe_kwargs["initial_prompt"] = prompt
- try:
- segments, info = model.transcribe(file_path, **transcribe_kwargs)
- # faster-whisper's transcribe() is lazy: the decode (and with it the
- # dlopen-on-first-use of the CUDA runtime on Windows) happens while
- # ITERATING segments, after this call has already returned (#103793).
- # Consume inside the guard so a first-use cuBLAS/cuDNN load failure
- # retries on CPU exactly like a load-time failure does.
- segments = list(segments)
- except Exception as exc:
- # CUDA libs can fail at dlopen-on-first-use, AFTER loading: evict the poisoned
- # cached model, reload on CPU and retry once, else every later message fails.
- if not _looks_like_cuda_lib_error(exc):
- raise
- logger.warning("faster-whisper CUDA runtime failed mid-transcribe (%s) — "
- "evicting cached model and retrying on CPU (int8).", exc)
- model = _replace_cached_model_on_cpu(model_name)
- segments, info = model.transcribe(file_path, **transcribe_kwargs)
- segments = list(segments)
- transcript = _join_confident_segments(segments, local_cfg)
- logger.info("Transcribed %s via local whisper (%s, lang=%s, %.1fs audio)",
- Path(file_path).name, model_name, info.language, info.duration)
- _touch_transcription_time()
- idle_timeout = _get_idle_unload_seconds(local_cfg)
- if idle_timeout > 0:
- _start_idle_unload_watcher(idle_timeout)
- return _ok_result(transcript, "local")
- except Exception as e:
- logger.error("Local transcription failed: %s", e, exc_info=True)
- return _error_result(f"Local transcription failed: {e}")
- # ---- Public API ---------------------------------------------------------
- def _read_block_error(file_path: str) -> Optional[dict[str, Any]]:
- """Refuse to ship a credential store (auth.json, .env, OAuth tokens) to an STT provider.
- Mirrors the image-gen / video-gen read guards."""
- from agent.file_safety import get_read_block_error
- blocked = get_read_block_error(file_path)
- return _error_result(blocked) if blocked else None
- def _transcribe_prepared_audio(
- file_path: str, model: Optional[str] = None, source: Optional[str] = None) -> dict[str, Any]:
- """Transcribe a validated audio file with the configured STT provider. ``model`` overrides the
- config default; ``source`` is a caller-surface label (``"gateway"``, ``"voice_mode"``) forwarded
- to the ``pre_transcription`` hook only."""
- # Validate before provider resolution so invalid files can't trigger provider setup
- # or lazy installation; the remote-upload size cap applies to non-local only.
- error = _read_block_error(file_path) or _validate_audio_file(file_path, enforce_size_limit=False)
- if error:
- return error
- stt_config = _load_stt_config()
- if not is_stt_enabled(stt_config):
- return _error_result("STT is disabled in config.yaml (stt.enabled: false).")
- provider = _get_provider(stt_config)
- remote = not _is_local_stt_provider(provider, stt_config)
- with ExitStack() as cleanup:
- # Never overwrite a neighboring WAV or leave converted voice notes behind.
- if remote and Path(file_path).suffix.lower() == ".caf":
- work_dir = cleanup.enter_context(TemporaryDirectory(prefix="hermes-caf-", ignore_cleanup_errors=True))
- file_path = _convert_caf_to_wav(file_path, work_dir)
- if not file_path:
- return _error_result("CAF audio could not be converted to WAV.")
- # Best-effort pre-upload silence trim for built-in cloud providers.
- if provider in CLOUD_STT_PROVIDERS:
- trimmed = _trim_silence_for_cloud_stt(file_path, stt_config)
- if trimmed:
- file_path = trimmed
- cleanup.callback(shutil.rmtree, os.path.dirname(trimmed), ignore_errors=True)
- if remote:
- limit = upload_limit(provider, _limit_model_name(provider, stt_config, model))
- if exceeds_upload_limit(file_path, limit):
- # Hints are resolved once for the whole recording, not once per segment.
- hints = _resolve_dispatch_hints(file_path, provider, stt_config, model, source)
- return transcribe_oversized(
- file_path, limit, lambda part: _route_stt_provider(part, provider, stt_config, *hints))
- return _dispatch_stt_provider(file_path, provider, stt_config, model, source)
- def _limit_model_name(provider: str, stt_config: dict[str, Any], model: Optional[str]) -> Optional[str]:
- """Model whose duration cap applies to an upload (built-ins resolve config/defaults)."""
- return _builtin_model_name(provider, stt_config, model) if provider in _BUILTIN_MODEL_KEYS else model
- # Built-in provider -> (stt section, config key, default, treat-empty-as-missing). "local_command"
- # shares ``stt.local``; deepinfra uses the live catalog when empty.
- _BUILTIN_MODEL_KEYS = {
- "local": ("local", "model", DEFAULT_LOCAL_MODEL, False),
- "local_command": ("local", "model", DEFAULT_LOCAL_MODEL, False),
- "groq": ("groq", "model", DEFAULT_GROQ_STT_MODEL, True),
- "openai": ("openai", "model", DEFAULT_STT_MODEL, False),
- "mistral": ("mistral", "model", DEFAULT_MISTRAL_STT_MODEL, False),
- "xai": ("xai", "model", "", True), # blank -> normalize_xai_stt_model resolves env/default
- "elevenlabs": ("elevenlabs", "model_id", DEFAULT_ELEVENLABS_STT_MODEL, False),
- "deepinfra": ("deepinfra", "model", "", True)}
- def _builtin_model_name(provider: str, stt_config: dict[str, Any], model: Optional[str]) -> str:
- """Resolve the model for a built-in provider: caller override > ``stt.<provider>`` config > default."""
- if model:
- return model
- section, key, default, empty_is_missing = _BUILTIN_MODEL_KEYS[provider]
- cfg = _get_stt_section(stt_config, section)
- resolved = (cfg.get(key) or default) if empty_is_missing else cfg.get(key, default)
- return normalize_xai_stt_model(resolved) if provider == "xai" else resolved
- def _resolve_dispatch_hints(
- file_path: str, provider: str, stt_config: dict[str, Any], model: Optional[str], source: Optional[str],
- ) -> tuple[Optional[str], Optional[str], Optional[str]]:
- """``(model, language, prompt)`` for one recording: static ``stt.prompt`` plus ``pre_transcription`` hooks."""
- # Static ``stt.prompt`` is the base; hook results mutate on top (last hook to set a field wins).
- prompt = stt_config.get("prompt")
- prompt = prompt if isinstance(prompt, str) and prompt.strip() else None
- # Fires after provider resolution and BEFORE any backend; ``language`` stays None unless a hook sets it.
- model, language, prompt = _apply_pre_transcription_hook(
- file_path=file_path, provider=provider, model=model,
- language=_get_stt_section(stt_config, provider).get("language"), prompt=prompt, source=source,
- )
- return model, language, _enforce_prompt_length_limit(prompt, provider)
- def _dispatch_stt_provider(
- file_path: str, provider: str, stt_config: dict[str, Any], model: Optional[str] = None,
- source: Optional[str] = None) -> dict[str, Any]:
- """Route *file_path* to the handler for *provider* (built-in > command > plugin)."""
- return _route_stt_provider(
- file_path, provider, stt_config, *_resolve_dispatch_hints(file_path, provider, stt_config, model, source))
- def _route_stt_provider(
- file_path: str, provider: str, stt_config: dict[str, Any], model: Optional[str],
- language: Optional[str], prompt: Optional[str]) -> dict[str, Any]:
- if provider in BUILTIN_STT_PROVIDERS:
- # Looked up in this module at call time so tests may patch ``_transcribe_*``.
- handler = globals()[f"_transcribe_{provider}"]
- model_name = _builtin_model_name(provider, stt_config, model)
- if provider in ("local", "local_command"):
- model_name = _normalize_local_model(model_name)
- return handler(file_path, model_name, language=language, prompt=prompt)
- # Command providers: after built-ins (``stt.providers.openai.command`` can't override the
- # real handler) and BEFORE plugins, since config is more local than a plugin install.
- # User-declared command-type provider (``stt.providers.<name>: type: command``). See #17843.
- command_provider_config = _resolve_command_stt_provider_config(provider, stt_config)
- if command_provider_config is not None:
- return _transcribe_command_stt(file_path, provider, command_provider_config, stt_config,
- model_override=model, language_override=language, prompt=prompt)
- # Plugin backend: reads ``stt.<provider>`` like built-ins; the ``model`` argument overrides it.
- plugin_result = _dispatch_to_plugin_provider(
- file_path, provider, stt_config, model=model or _get_stt_section(stt_config, provider).get("model"),
- language=language or _resolve_stt_language(provider, stt_config), prompt=prompt)
- return plugin_result if plugin_result is not None else _no_provider_error(provider, stt_config)
- def _no_provider_error(provider: str, stt_config: dict[str, Any]) -> dict[str, Any]:
- """Error envelope when nothing claimed *provider*: unregistered name > openai selection reason > generic hint."""
- provider_key = str(provider or "").strip().lower()
- if "provider" in stt_config and provider_key and provider_key not in BUILTIN_STT_PROVIDERS and provider_key != "none":
- return _unregistered_stt_provider_error(provider_key)
- # An explicit openai selection flattened to "none" has a specific reason (e.g. managed gateway down).
- # Surface it — with its `hermes tools` remediation — instead of the all-provider setup hint (#93045).
- if provider_key == "none" and str(stt_config.get("provider") or "") == "openai" and _HAS_OPENAI:
- reason = _openai_audio_unavailable_reason()
- if reason is not None:
- return _error_result(reason)
- return _error_result(
- "No STT provider available. Install faster-whisper for free local "
- f"transcription, configure {LOCAL_STT_COMMAND_ENV} or install a local whisper CLI, "
- "set GROQ_API_KEY for free Groq Whisper, set MISTRAL_API_KEY for Mistral "
- "Voxtral Transcribe, configure xAI OAuth or set XAI_API_KEY for xAI Grok STT, "
- "set ELEVENLABS_API_KEY for ElevenLabs Scribe, or set VOICE_TOOLS_OPENAI_KEY "
- "or OPENAI_API_KEY for the OpenAI Whisper API.")
- def transcribe_audio(
- file_path: str, model: Optional[str] = None, source: Optional[str] = None) -> dict[str, Any]:
- """Validate, preprocess supported inputs, and dispatch transcription. ``source`` is a caller-surface
- label (``"gateway"``, ``"voice_mode"``) forwarded to the ``pre_transcription`` hook only."""
- # Secret-store refusal runs before ANY validation so the error names the real reason.
- blocked = _read_block_error(file_path)
- if blocked:
- return blocked
- # Cap .silk sources before the decoder runs; for other inputs the upload cap is
- # provider-scoped in _transcribe_prepared_audio so local whisper can take big files.
- is_silk = Path(file_path).suffix.lower() == ".silk"
- source_error = _validate_audio_source_file(file_path, enforce_size_limit=is_silk)
- if source_error:
- return source_error
- prepared_path, cleanup_dir, prep_error = _prepare_audio_for_transcription(file_path)
- if prep_error or prepared_path is None:
- return prep_error or _error_result("Audio preprocessing did not produce a file for transcription.")
- try:
- return (_validate_audio_file(prepared_path, enforce_size_limit=False)
- or _transcribe_prepared_audio(prepared_path, model, source))
- finally:
- if cleanup_dir:
- shutil.rmtree(cleanup_dir, ignore_errors=True)
- def transcribe_audio_local_fallback(file_path: str, model: Optional[str] = None) -> dict[str, Any]:
- """Try an already-installed local STT backend without changing config: passive inbound-media
- recovery after the configured provider failed — never lazy-installs or falls through to cloud."""
- error = _validate_audio_file(file_path, enforce_size_limit=False)
- if error:
- return error
- local_model = model or (_load_stt_config().get("local") or {}).get("model", DEFAULT_LOCAL_MODEL)
- if _HAS_FASTER_WHISPER:
- return _transcribe_local(file_path, _normalize_local_model(local_model))
- if _has_local_command():
- return _transcribe_local_command(file_path, _normalize_local_model(local_model))
- return _error_result("No installed local STT backend is available.", provider="local")
|