Skip to main content

Agent Framework plugin for RTZR Streaming STT

Project description

RTZR plugin for LiveKit Agents

Support for RTZR Streaming STT via WebSocket interface, following the "Streaming STT" guide in the RTZR Developers docs.

  • Docs: https://developers.rtzr.ai/docs/en/ (see Streaming STT)

Installation

pip install livekit-plugins-rtzr

Prerequisites

Obtain client_id and client_secret from the RTZR Developers Console.

Set credentials as environment variables:

RTZR_CLIENT_ID=<your_client_id>
RTZR_CLIENT_SECRET=<your_client_secret>
# Override base HTTP API URL (used for token issuance)
RTZR_API_BASE=https://openapi.vito.ai

# Override WebSocket URL (used for live streaming)
RTZR_WEBSOCKET_URL=wss://openapi.vito.ai

If RTZR_WEBSOCKET_URL is not set, the plugin will derive it from RTZR_API_BASE by replacing the scheme with wss://.

Usage

Use RTZR STT in an AgentSession or as a standalone streaming service.

from livekit.agents import AgentSession
from livekit.plugins import rtzr

# Basic usage with env-based credentials
stt = rtzr.STT()

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

Keyword boosting (Streaming STT only, sommers_ko model only):

stt = rtzr.STT(
    model="sommers_ko",
    keywords=[
        "키워드",
        ("부스팅", 3.5),
        "키위드:-1.0",
    ],
)

Rules:

  • Use list entries as keyword or keyword:score, or use (keyword, score) tuples.
  • Score must be between -5.0 and 5.0, up to 100 keywords, each <= 20 chars.
  • Keywords must be written in Korean pronunciation (Hangul and spaces only); non-Korean input will error.

Notes:

  • The WebSocket streaming endpoint accepts raw PCM frames when encoding=LINEAR16.
  • The plugin relies on the server-side endpointing (EPD). You do not need to send finalize messages.
  • When the pipeline closes the stream, the plugin sends EOS to end the session.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

livekit_plugins_rtzr-1.3.11.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

livekit_plugins_rtzr-1.3.11-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

Details for the file livekit_plugins_rtzr-1.3.11.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_rtzr-1.3.11.tar.gz
Algorithm Hash digest
SHA256 eb42129ff9e0cf3d96b8bff10508b2324f7eb932a896fe8478d1c50a5d5a0188
MD5 58258818899a3be09c357e9272ac1b43
BLAKE2b-256 8f34b8bb9c5f7fc0e3774f90b18e648cd406c8bf0a3270727ee3398d25f7550a

See more details on using hashes here.

File details

Details for the file livekit_plugins_rtzr-1.3.11-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_rtzr-1.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 399bfa46e5f97735f94e882afa517b23fc81ebaed0f29017ddac291224adc4c5
MD5 3237fa234c81d7b0b04f2d9a8fb13522
BLAKE2b-256 198213981f62d68493e28ac2f9045efa3cb8f6f4ecd917901314d701e86ce4e9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page