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.4.1.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.4.1-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for livekit_plugins_rtzr-1.4.1.tar.gz
Algorithm Hash digest
SHA256 e09d3173e95ac2cec48254eae66de9a37cd91b160b44b0a823d5b648db87aed7
MD5 55f82b561b5c3cd8b199d2b912e2a0b6
BLAKE2b-256 fe22ec9a23f66ce8871cb60af31568d856f30360107f292b12079b44d6691cb2

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for livekit_plugins_rtzr-1.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 65cdc06c7dd6ff21980e6dd44923313aaa3a1f69d04e7cc5cd9775a183fab773
MD5 e7ba6325a28cb5cedf57230dea08d1c9
BLAKE2b-256 c075de9f5d9ea4d1231c50a6c9b1b2165d3fc4a28c59d61c5677a796e49fd70e

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