Skip to content

docs: update for pipecat PR #4162#690

Open
markbackman wants to merge 1 commit intomainfrom
docs/pr-4162
Open

docs: update for pipecat PR #4162#690
markbackman wants to merge 1 commit intomainfrom
docs/pr-4162

Conversation

@markbackman
Copy link
Copy Markdown
Contributor

Automated documentation update for pipecat PR #4162.

Changes

New service page

  • server/services/stt/smallest.mdx — Created comprehensive documentation for SmallestSTTService, the new real-time speech-to-text service using Smallest AI's Pulse WebSocket API

Configuration updates

  • docs.json — Added server/services/stt/smallest to Speech-to-Text navigation (alphabetically between Sarvam and Soniox)
  • server/services/supported-services.mdx — Added Smallest AI STT to the Speech-to-Text services table

The new documentation covers:

  • Overview and WebSocket streaming architecture
  • Installation and prerequisites
  • Constructor parameters (api_key, base_url, encoding, sample_rate, settings, ttfs_p99_latency)
  • Runtime settings (model, language, word_timestamps, full_transcript, sentence_timestamps, redact_pii, redact_pci, numerals, diarize)
  • Usage examples (basic setup, advanced features, runtime settings updates)
  • Important notes (WebSocket management, VAD integration, keepalive, language support)
  • Event handlers (on_connected, on_disconnected, on_connection_error)

Gaps identified

None — the TTS service page already exists and did not require updates (only internal implementation details changed in the PR).

Add documentation for SmallestSTTService introduced in pipecat PR #4162.

- Created server/services/stt/smallest.mdx with full configuration and usage
- Added to docs.json navigation (Speech-to-Text section)
- Added to supported-services.mdx table

The new service provides real-time speech-to-text using Smallest AI's Pulse
WebSocket API with support for multiple languages, diarization, PII redaction,
and other advanced transcription features.
@markbackman markbackman added the auto-docs Automated documentation update from pipecat source changes label Apr 1, 2026
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 1, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
daily 🟢 Ready View Preview Apr 1, 2026, 5:48 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-docs Automated documentation update from pipecat source changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant