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.5.0rc1.tar.gz (10.1 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.5.0rc1-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

Details for the file livekit_plugins_rtzr-1.5.0rc1.tar.gz.

File metadata

File hashes

Hashes for livekit_plugins_rtzr-1.5.0rc1.tar.gz
Algorithm Hash digest
SHA256 b5cf89858050d0557af40d2fdbdc2017b025775c8acdb8388121aea20112e7ba
MD5 3aa8d043548593cc0534efee6e95d54a
BLAKE2b-256 d83bea5ffe7cf9203b0c7e178f16fe38bacc8ca3c4397b46cea9f16181b9cd16

See more details on using hashes here.

File details

Details for the file livekit_plugins_rtzr-1.5.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for livekit_plugins_rtzr-1.5.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 89a764fbb7a73372c1c805d6cf46ae5ed932f02f576ca3e6272855842f512a65
MD5 c708818af5f5d56d5f381653d6ce432d
BLAKE2b-256 19d5ebd066535768ebd92a4a6939b1f2ff5bff728ace28d3fa38d18ef52089b4

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