Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 27 additions & 7 deletions livekit-plugins/livekit-plugins-soniox/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Soniox plugin for LiveKit Agents

Support for Soniox Speech-to-Text [Soniox](https://soniox.com/) API, using WebSocket streaming interface.
Support for Soniox [Speech-to-Text](https://soniox.com/docs/stt) and [Text-to-Speech](https://soniox.com/docs/tts) APIs, using WebSocket streaming interfaces.

See https://docs.livekit.io/agents/integrations/stt/soniox/ for more information.
See [STT documentation](https://docs.livekit.io/agents/models/stt/soniox/) and [TTS documentation](https://docs.livekit.io/agents/models/tts/soniox/) for more information.

## Installation

Expand All @@ -22,21 +22,41 @@ SONIOX_API_KEY=<your_soniox_api_key>

## Usage

Use Soniox in an `AgentSession` or as a standalone transcription service:
### Speech-to-Text (STT)

Use Soniox STT in an `AgentSession` or as a standalone transcription service:

```python
from livekit.plugins import soniox

session = AgentSession(
stt = soniox.STT(),
stt=soniox.STT(),
# ... llm, tts, etc.
)
```

Congratulations! You are now ready to use Soniox Speech-to-Text API in your LiveKit agents.
### Text-to-Speech (TTS)

Use Soniox TTS for real-time speech synthesis:

```python
from livekit.plugins import soniox

session = AgentSession(
tts=soniox.TTS(
language="en",
voice="Maya",
),
# ... stt, llm, etc.
)
```

You can test Soniox Speech-to-Text API in the LiveKit's [Voice AI quickstart](https://docs.livekit.io/agents/start/voice-ai/).
The TTS supports real-time streaming from LLM - text chunks are tokenized and sent to Soniox as words are formed, enabling low-latency speech synthesis.

## More information and reference

Explore integration details and find comprehensive examples in our [Soniox LiveKit integration guide](https://speechdev.soniox.com/docs/speech-to-text/integrations/livekit).
Explore integration details and find comprehensive examples:
- [Soniox STT LiveKit integration guide](https://soniox.com/docs/integrations/livekit)
- [Soniox API reference](https://soniox.com/docs/api-reference)
- [Soniox STT languages](https://soniox.com/docs/stt/concepts/supported-languages) and [Soniox TTS languages](https://soniox.com/docs/tts/concepts/languages)
- [Soniox TTS voices](https://soniox.com/docs/tts/concepts/voices)
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
STTOptions,
TranslationConfig,
)
from .tts import (
TTS,
SynthesizeStream,
)
from .version import __version__

__all__ = [
Expand All @@ -34,6 +38,8 @@
"ContextGeneralItem",
"ContextTranslationTerm",
"TranslationConfig",
"TTS",
"SynthesizeStream",
"__version__",
]

Expand Down
Loading