feat: add Smallest AI STT service integration (#4162)
Add SmallestSTTService using the Pulse WebSocket API for real-time transcription. Includes SmallestSTTSettings dataclass, 32-language support with resolve_language fallback, VAD-driven finalize signal, and SMALLEST_TTFS_P99 latency constant. Also adds X-Source and X-Pipecat-Version headers to Smallest STT and TTS WebSocket connections.
This commit is contained in:
@@ -21,9 +21,10 @@ from pipecat.processors.aggregators.llm_response_universal import (
|
|||||||
)
|
)
|
||||||
from pipecat.runner.types import RunnerArguments
|
from pipecat.runner.types import RunnerArguments
|
||||||
from pipecat.runner.utils import create_transport
|
from pipecat.runner.utils import create_transport
|
||||||
from pipecat.services.deepgram.stt import DeepgramSTTService
|
|
||||||
from pipecat.services.openai.llm import OpenAILLMService
|
from pipecat.services.openai.llm import OpenAILLMService
|
||||||
|
from pipecat.services.smallest.stt import SmallestSTTService
|
||||||
from pipecat.services.smallest.tts import SmallestTTSService
|
from pipecat.services.smallest.tts import SmallestTTSService
|
||||||
|
from pipecat.transcriptions.language import Language
|
||||||
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
from pipecat.transports.base_transport import BaseTransport, TransportParams
|
||||||
from pipecat.transports.daily.transport import DailyParams
|
from pipecat.transports.daily.transport import DailyParams
|
||||||
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams
|
from pipecat.transports.websocket.fastapi import FastAPIWebsocketParams
|
||||||
@@ -50,8 +51,11 @@ transport_params = {
|
|||||||
async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
|
async def run_bot(transport: BaseTransport, runner_args: RunnerArguments):
|
||||||
logger.info(f"Starting bot")
|
logger.info(f"Starting bot")
|
||||||
|
|
||||||
stt = DeepgramSTTService(
|
stt = SmallestSTTService(
|
||||||
api_key=os.getenv("DEEPGRAM_API_KEY"),
|
api_key=os.getenv("SMALLEST_API_KEY"),
|
||||||
|
settings=SmallestSTTService.Settings(
|
||||||
|
language=Language.EN,
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
tts = SmallestTTSService(
|
tts = SmallestTTSService(
|
||||||
|
|||||||
412
src/pipecat/services/smallest/stt.py
Normal file
412
src/pipecat/services/smallest/stt.py
Normal file
@@ -0,0 +1,412 @@
|
|||||||
|
#
|
||||||
|
# Copyright (c) 2024-2026, Daily
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: BSD 2-Clause License
|
||||||
|
#
|
||||||
|
|
||||||
|
"""Smallest AI speech-to-text service implementation.
|
||||||
|
|
||||||
|
This module provides a STT service using Smallest AI's Waves API:
|
||||||
|
|
||||||
|
- ``SmallestSTTService``: WebSocket-based real-time STT. Streams audio
|
||||||
|
continuously and receives interim/final transcripts with low latency.
|
||||||
|
"""
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
import json
|
||||||
|
from dataclasses import dataclass, field
|
||||||
|
from enum import Enum
|
||||||
|
from typing import Any, AsyncGenerator, Optional
|
||||||
|
from urllib.parse import urlencode
|
||||||
|
|
||||||
|
from loguru import logger
|
||||||
|
|
||||||
|
from pipecat import version as pipecat_version
|
||||||
|
from pipecat.frames.frames import (
|
||||||
|
CancelFrame,
|
||||||
|
EndFrame,
|
||||||
|
ErrorFrame,
|
||||||
|
Frame,
|
||||||
|
InterimTranscriptionFrame,
|
||||||
|
StartFrame,
|
||||||
|
TranscriptionFrame,
|
||||||
|
VADUserStartedSpeakingFrame,
|
||||||
|
VADUserStoppedSpeakingFrame,
|
||||||
|
)
|
||||||
|
from pipecat.processors.frame_processor import FrameDirection
|
||||||
|
from pipecat.services.settings import NOT_GIVEN, STTSettings, _NotGiven
|
||||||
|
from pipecat.services.stt_latency import SMALLEST_TTFS_P99
|
||||||
|
from pipecat.services.stt_service import WebsocketSTTService
|
||||||
|
from pipecat.transcriptions.language import Language, resolve_language
|
||||||
|
from pipecat.utils.time import time_now_iso8601
|
||||||
|
from pipecat.utils.tracing.service_decorators import traced_stt
|
||||||
|
|
||||||
|
try:
|
||||||
|
from websockets.asyncio.client import connect as websocket_connect
|
||||||
|
from websockets.protocol import State
|
||||||
|
except ModuleNotFoundError as e:
|
||||||
|
logger.error(f"Exception: {e}")
|
||||||
|
logger.error("In order to use Smallest, you need to `pip install pipecat-ai[smallest]`.")
|
||||||
|
raise Exception(f"Missing module: {e}")
|
||||||
|
|
||||||
|
|
||||||
|
def language_to_smallest_stt_language(language: Language) -> str:
|
||||||
|
"""Convert a Language enum to Smallest STT language code.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
language: The Language enum value to convert.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
The Smallest language code string.
|
||||||
|
"""
|
||||||
|
LANGUAGE_MAP = {
|
||||||
|
Language.BG: "bg",
|
||||||
|
Language.BN: "bn",
|
||||||
|
Language.CS: "cs",
|
||||||
|
Language.DA: "da",
|
||||||
|
Language.DE: "de",
|
||||||
|
Language.EN: "en",
|
||||||
|
Language.ES: "es",
|
||||||
|
Language.ET: "et",
|
||||||
|
Language.FI: "fi",
|
||||||
|
Language.FR: "fr",
|
||||||
|
Language.GU: "gu",
|
||||||
|
Language.HI: "hi",
|
||||||
|
Language.HU: "hu",
|
||||||
|
Language.IT: "it",
|
||||||
|
Language.KN: "kn",
|
||||||
|
Language.LT: "lt",
|
||||||
|
Language.LV: "lv",
|
||||||
|
Language.ML: "ml",
|
||||||
|
Language.MR: "mr",
|
||||||
|
Language.MT: "mt",
|
||||||
|
Language.NL: "nl",
|
||||||
|
Language.OR: "or",
|
||||||
|
Language.PA: "pa",
|
||||||
|
Language.PL: "pl",
|
||||||
|
Language.PT: "pt",
|
||||||
|
Language.RO: "ro",
|
||||||
|
Language.RU: "ru",
|
||||||
|
Language.SK: "sk",
|
||||||
|
Language.SV: "sv",
|
||||||
|
Language.TA: "ta",
|
||||||
|
Language.TE: "te",
|
||||||
|
Language.UK: "uk",
|
||||||
|
}
|
||||||
|
|
||||||
|
return resolve_language(language, LANGUAGE_MAP)
|
||||||
|
|
||||||
|
|
||||||
|
class SmallestSTTModel(str, Enum):
|
||||||
|
"""Available Smallest AI STT models."""
|
||||||
|
|
||||||
|
PULSE = "pulse"
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class SmallestSTTSettings(STTSettings):
|
||||||
|
"""Settings for SmallestSTTService.
|
||||||
|
|
||||||
|
Parameters:
|
||||||
|
word_timestamps: Include word-level timestamps.
|
||||||
|
full_transcript: Include cumulative transcript.
|
||||||
|
sentence_timestamps: Include sentence-level timestamps.
|
||||||
|
redact_pii: Redact personally identifiable information.
|
||||||
|
redact_pci: Redact payment card information.
|
||||||
|
numerals: Convert spoken numerals to digits.
|
||||||
|
diarize: Enable speaker diarization.
|
||||||
|
"""
|
||||||
|
|
||||||
|
word_timestamps: bool | _NotGiven = field(default_factory=lambda: NOT_GIVEN)
|
||||||
|
full_transcript: bool | _NotGiven = field(default_factory=lambda: NOT_GIVEN)
|
||||||
|
sentence_timestamps: bool | _NotGiven = field(default_factory=lambda: NOT_GIVEN)
|
||||||
|
redact_pii: bool | _NotGiven = field(default_factory=lambda: NOT_GIVEN)
|
||||||
|
redact_pci: bool | _NotGiven = field(default_factory=lambda: NOT_GIVEN)
|
||||||
|
numerals: str | _NotGiven = field(default_factory=lambda: NOT_GIVEN)
|
||||||
|
diarize: bool | _NotGiven = field(default_factory=lambda: NOT_GIVEN)
|
||||||
|
|
||||||
|
|
||||||
|
class SmallestSTTService(WebsocketSTTService):
|
||||||
|
"""Smallest AI real-time speech-to-text service using the Pulse WebSocket API.
|
||||||
|
|
||||||
|
Streams audio continuously over a WebSocket connection and receives
|
||||||
|
interim and final transcription results with low latency. Best suited
|
||||||
|
for real-time voice applications where immediate feedback is needed.
|
||||||
|
|
||||||
|
Uses Pipecat's VAD to detect when the user stops speaking and sends
|
||||||
|
a finalize message to flush the final transcript.
|
||||||
|
|
||||||
|
Example::
|
||||||
|
|
||||||
|
stt = SmallestSTTService(
|
||||||
|
api_key="your-api-key",
|
||||||
|
settings=SmallestSTTService.Settings(
|
||||||
|
language=Language.EN,
|
||||||
|
word_timestamps=True,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
"""
|
||||||
|
|
||||||
|
Settings = SmallestSTTSettings
|
||||||
|
_settings: Settings
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
*,
|
||||||
|
api_key: str,
|
||||||
|
base_url: str = "wss://api.smallest.ai",
|
||||||
|
encoding: str = "linear16",
|
||||||
|
sample_rate: Optional[int] = None,
|
||||||
|
settings: Optional[Settings] = None,
|
||||||
|
ttfs_p99_latency: Optional[float] = SMALLEST_TTFS_P99,
|
||||||
|
**kwargs,
|
||||||
|
):
|
||||||
|
"""Initialize the Smallest AI STT service.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
api_key: Smallest AI API key for authentication.
|
||||||
|
base_url: Base WebSocket URL for the Smallest API.
|
||||||
|
encoding: Audio encoding format. Defaults to "linear16".
|
||||||
|
sample_rate: Audio sample rate in Hz. If None, uses the pipeline's rate.
|
||||||
|
settings: Runtime-updatable settings for the STT service.
|
||||||
|
ttfs_p99_latency: P99 latency from speech end to final transcript in seconds.
|
||||||
|
**kwargs: Additional arguments passed to WebsocketSTTService.
|
||||||
|
"""
|
||||||
|
default_settings = self.Settings(
|
||||||
|
model=SmallestSTTModel.PULSE.value,
|
||||||
|
language=Language.EN,
|
||||||
|
word_timestamps=False,
|
||||||
|
full_transcript=False,
|
||||||
|
sentence_timestamps=False,
|
||||||
|
redact_pii=False,
|
||||||
|
redact_pci=False,
|
||||||
|
numerals="auto",
|
||||||
|
diarize=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
if settings is not None:
|
||||||
|
default_settings.apply_update(settings)
|
||||||
|
|
||||||
|
super().__init__(
|
||||||
|
sample_rate=sample_rate,
|
||||||
|
ttfs_p99_latency=ttfs_p99_latency,
|
||||||
|
keepalive_timeout=10,
|
||||||
|
keepalive_interval=5,
|
||||||
|
settings=default_settings,
|
||||||
|
**kwargs,
|
||||||
|
)
|
||||||
|
|
||||||
|
self._api_key = api_key
|
||||||
|
self._base_url = base_url.rstrip("/")
|
||||||
|
self._encoding = encoding
|
||||||
|
self._receive_task = None
|
||||||
|
self._connected_event = asyncio.Event()
|
||||||
|
self._connected_event.set()
|
||||||
|
|
||||||
|
def can_generate_metrics(self) -> bool:
|
||||||
|
"""Check if this service can generate processing metrics."""
|
||||||
|
return True
|
||||||
|
|
||||||
|
def language_to_service_language(self, language: Language) -> Optional[str]:
|
||||||
|
"""Convert a Language enum to Smallest service language format.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
language: The language to convert.
|
||||||
|
|
||||||
|
Returns:
|
||||||
|
The Smallest-specific language code, or None if not supported.
|
||||||
|
"""
|
||||||
|
return language_to_smallest_stt_language(language)
|
||||||
|
|
||||||
|
async def start(self, frame: StartFrame):
|
||||||
|
"""Start the service and connect to the WebSocket."""
|
||||||
|
await super().start(frame)
|
||||||
|
await self._connect()
|
||||||
|
|
||||||
|
async def stop(self, frame: EndFrame):
|
||||||
|
"""Stop the service and disconnect from the WebSocket."""
|
||||||
|
await super().stop(frame)
|
||||||
|
await self._disconnect()
|
||||||
|
|
||||||
|
async def cancel(self, frame: CancelFrame):
|
||||||
|
"""Cancel the service and disconnect from the WebSocket."""
|
||||||
|
await super().cancel(frame)
|
||||||
|
await self._disconnect()
|
||||||
|
|
||||||
|
async def process_frame(self, frame: Frame, direction: FrameDirection):
|
||||||
|
"""Process frames, handling VAD events for finalization."""
|
||||||
|
await super().process_frame(frame, direction)
|
||||||
|
|
||||||
|
if isinstance(frame, VADUserStartedSpeakingFrame):
|
||||||
|
await self.start_processing_metrics()
|
||||||
|
elif isinstance(frame, VADUserStoppedSpeakingFrame):
|
||||||
|
if self._websocket and self._websocket.state is State.OPEN:
|
||||||
|
try:
|
||||||
|
await self._websocket.send(json.dumps({"type": "finalize"}))
|
||||||
|
except Exception as e:
|
||||||
|
logger.warning(f"{self} failed to send finalize: {e}")
|
||||||
|
|
||||||
|
async def run_stt(self, audio: bytes) -> AsyncGenerator[Frame, None]:
|
||||||
|
"""Send audio to the Smallest Pulse WebSocket for transcription.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
audio: Raw PCM audio bytes.
|
||||||
|
|
||||||
|
Yields:
|
||||||
|
None -- transcription results arrive via WebSocket messages.
|
||||||
|
"""
|
||||||
|
await self._connected_event.wait()
|
||||||
|
|
||||||
|
if not self._websocket or self._websocket.state is State.CLOSED:
|
||||||
|
await self._connect()
|
||||||
|
|
||||||
|
if self._websocket and self._websocket.state is State.OPEN:
|
||||||
|
try:
|
||||||
|
await self._websocket.send(audio)
|
||||||
|
except Exception as e:
|
||||||
|
yield ErrorFrame(error=f"Smallest STT error: {e}")
|
||||||
|
return
|
||||||
|
|
||||||
|
yield None
|
||||||
|
|
||||||
|
async def _update_settings(self, delta: STTSettings) -> dict[str, Any]:
|
||||||
|
"""Apply a settings delta and reconnect if anything changed."""
|
||||||
|
changed = await super()._update_settings(delta)
|
||||||
|
|
||||||
|
if changed:
|
||||||
|
await self._disconnect()
|
||||||
|
await self._connect()
|
||||||
|
|
||||||
|
return changed
|
||||||
|
|
||||||
|
async def _connect(self):
|
||||||
|
self._connected_event.clear()
|
||||||
|
try:
|
||||||
|
await self._connect_websocket()
|
||||||
|
await super()._connect()
|
||||||
|
|
||||||
|
if self._websocket and not self._receive_task:
|
||||||
|
self._receive_task = self.create_task(
|
||||||
|
self._receive_task_handler(self._report_error)
|
||||||
|
)
|
||||||
|
finally:
|
||||||
|
self._connected_event.set()
|
||||||
|
|
||||||
|
async def _disconnect(self):
|
||||||
|
await super()._disconnect()
|
||||||
|
|
||||||
|
if self._receive_task:
|
||||||
|
await self.cancel_task(self._receive_task)
|
||||||
|
self._receive_task = None
|
||||||
|
|
||||||
|
await self._disconnect_websocket()
|
||||||
|
|
||||||
|
async def _connect_websocket(self):
|
||||||
|
"""Establish WebSocket connection to the Smallest Pulse STT API."""
|
||||||
|
try:
|
||||||
|
if self._websocket and self._websocket.state is State.OPEN:
|
||||||
|
return
|
||||||
|
|
||||||
|
logger.debug("Connecting to Smallest STT")
|
||||||
|
|
||||||
|
query_params = {
|
||||||
|
"language": self._settings.language,
|
||||||
|
"encoding": self._encoding,
|
||||||
|
"sample_rate": str(self.sample_rate),
|
||||||
|
"word_timestamps": str(self._settings.word_timestamps).lower(),
|
||||||
|
"full_transcript": str(self._settings.full_transcript).lower(),
|
||||||
|
"sentence_timestamps": str(self._settings.sentence_timestamps).lower(),
|
||||||
|
"redact_pii": str(self._settings.redact_pii).lower(),
|
||||||
|
"redact_pci": str(self._settings.redact_pci).lower(),
|
||||||
|
"numerals": self._settings.numerals,
|
||||||
|
"diarize": str(self._settings.diarize).lower(),
|
||||||
|
}
|
||||||
|
|
||||||
|
ws_url = f"{self._base_url}/waves/v1/pulse/get_text?{urlencode(query_params)}"
|
||||||
|
|
||||||
|
self._websocket = await websocket_connect(
|
||||||
|
ws_url,
|
||||||
|
additional_headers={
|
||||||
|
"Authorization": f"Bearer {self._api_key}",
|
||||||
|
"X-Source": "pipecat",
|
||||||
|
"X-Pipecat-Version": pipecat_version(),
|
||||||
|
},
|
||||||
|
)
|
||||||
|
await self._call_event_handler("on_connected")
|
||||||
|
logger.debug("Connected to Smallest STT")
|
||||||
|
except Exception as e:
|
||||||
|
await self.push_error(error_msg=f"Smallest STT connection error: {e}", exception=e)
|
||||||
|
self._websocket = None
|
||||||
|
await self._call_event_handler("on_connection_error", f"{e}")
|
||||||
|
|
||||||
|
async def _disconnect_websocket(self):
|
||||||
|
"""Close the WebSocket connection."""
|
||||||
|
try:
|
||||||
|
if self._websocket and self._websocket.state is State.OPEN:
|
||||||
|
logger.debug("Disconnecting from Smallest STT")
|
||||||
|
await self._websocket.close()
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"{self} error closing websocket: {e}")
|
||||||
|
finally:
|
||||||
|
self._websocket = None
|
||||||
|
await self._call_event_handler("on_disconnected")
|
||||||
|
|
||||||
|
def _get_websocket(self):
|
||||||
|
if self._websocket:
|
||||||
|
return self._websocket
|
||||||
|
raise Exception("Websocket not connected")
|
||||||
|
|
||||||
|
async def _receive_messages(self):
|
||||||
|
"""Receive and process messages from the Smallest Pulse WebSocket."""
|
||||||
|
async for message in self._get_websocket():
|
||||||
|
try:
|
||||||
|
data = json.loads(message)
|
||||||
|
await self._process_response(data)
|
||||||
|
except json.JSONDecodeError:
|
||||||
|
logger.warning(f"{self} received non-JSON message: {message}")
|
||||||
|
except Exception as e:
|
||||||
|
logger.error(f"{self} error processing message: {e}")
|
||||||
|
|
||||||
|
async def _process_response(self, data: dict):
|
||||||
|
"""Process a transcription response from the Pulse API.
|
||||||
|
|
||||||
|
Args:
|
||||||
|
data: Parsed JSON response containing transcript data.
|
||||||
|
"""
|
||||||
|
is_final = data.get("is_final", False)
|
||||||
|
text = data.get("transcript", "").strip()
|
||||||
|
|
||||||
|
if not text:
|
||||||
|
return
|
||||||
|
|
||||||
|
if is_final:
|
||||||
|
await self.stop_processing_metrics()
|
||||||
|
logger.debug(f"Smallest final transcript: [{text}]")
|
||||||
|
await self._handle_transcription(text, True, data.get("language"))
|
||||||
|
await self.push_frame(
|
||||||
|
TranscriptionFrame(
|
||||||
|
text,
|
||||||
|
self._user_id,
|
||||||
|
time_now_iso8601(),
|
||||||
|
data.get("language"),
|
||||||
|
result=data,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
logger.trace(f"Smallest interim transcript: [{text}]")
|
||||||
|
await self.push_frame(
|
||||||
|
InterimTranscriptionFrame(
|
||||||
|
text,
|
||||||
|
self._user_id,
|
||||||
|
time_now_iso8601(),
|
||||||
|
data.get("language"),
|
||||||
|
result=data,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
@traced_stt
|
||||||
|
async def _handle_transcription(
|
||||||
|
self, transcript: str, is_final: bool, language: Optional[str] = None
|
||||||
|
):
|
||||||
|
"""Handle a transcription result with tracing."""
|
||||||
|
pass
|
||||||
@@ -19,6 +19,7 @@ from typing import Any, AsyncGenerator, Optional
|
|||||||
|
|
||||||
from loguru import logger
|
from loguru import logger
|
||||||
|
|
||||||
|
from pipecat import version as pipecat_version
|
||||||
from pipecat.frames.frames import (
|
from pipecat.frames.frames import (
|
||||||
CancelFrame,
|
CancelFrame,
|
||||||
EndFrame,
|
EndFrame,
|
||||||
@@ -298,7 +299,11 @@ class SmallestTTSService(InterruptibleTTSService):
|
|||||||
|
|
||||||
self._websocket = await websocket_connect(
|
self._websocket = await websocket_connect(
|
||||||
self._build_websocket_url(),
|
self._build_websocket_url(),
|
||||||
additional_headers={"Authorization": f"Bearer {self._api_key}"},
|
additional_headers={
|
||||||
|
"Authorization": f"Bearer {self._api_key}",
|
||||||
|
"X-Source": "pipecat",
|
||||||
|
"X-Pipecat-Version": pipecat_version(),
|
||||||
|
},
|
||||||
)
|
)
|
||||||
|
|
||||||
await self._call_event_handler("on_connected")
|
await self._call_event_handler("on_connected")
|
||||||
|
|||||||
@@ -53,3 +53,6 @@ SPEECHMATICS_TTFS_P99: float = 0.74
|
|||||||
# These services run locally and should be replaced with measured values
|
# These services run locally and should be replaced with measured values
|
||||||
NVIDIA_TTFS_P99: float = DEFAULT_TTFS_P99
|
NVIDIA_TTFS_P99: float = DEFAULT_TTFS_P99
|
||||||
WHISPER_TTFS_P99: float = DEFAULT_TTFS_P99
|
WHISPER_TTFS_P99: float = DEFAULT_TTFS_P99
|
||||||
|
|
||||||
|
# No benchmark available yet; using conservative default
|
||||||
|
SMALLEST_TTFS_P99: float = DEFAULT_TTFS_P99
|
||||||
|
|||||||
Reference in New Issue
Block a user