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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for livekit_plugins_rtzr-1.4.4.tar.gz
Algorithm Hash digest
SHA256 cb71b17521b3808af21fdccfacfb289d33cbc0f0c79f3f8907b10218934a52b9
MD5 69e9793db0a9037412d433b2c7527949
BLAKE2b-256 84a3a335c71c2f1bbaf9051b86ed5a8e7d6d7566d74a4489989c73d121458c9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for livekit_plugins_rtzr-1.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 2fc487eb2e3b51779820c0f033a461c46c42c06e73bb3782fff48fa6ebf5baed
MD5 84d1f38307552159567b96573dc6596e
BLAKE2b-256 fb50acee379d9abd0ff682d81a3b8c40542a165fff56fb6c27e48a3450eebf04

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