Skip to main content

Voice-Powered Agent Framework

Project description

Vixio

A streaming voice-powered agent framework based on pipeline architecture

Python 3.12+ License: MIT Status: Alpha

中文文档

Features

  • Pipeline Architecture: Chain multiple stations to form a complete processing flow
  • Station-based Processing: Each station handles specific tasks (VAD/ASR/Agent/TTS)
  • Streaming Support: Real-time audio processing with async queue chains
  • Modular Design: Install only what you need with optional dependencies
  • Multiple Providers: Support for both local inference and cloud services

Requirements

  • Python 3.12 or higher
  • uv (recommended package manager)

🚀 Quick Start

Get started with Vixio in just one command! Experience real-time voice conversation powered by Qwen Omni:

# Install and run in one step (requires DashScope API key)
uvx vixio run xiaozhi-server \
  --preset qwen-realtime \
  --dashscope-key sk-your-key-here

What you get:

  • 🎙️ WebSocket server running at http://localhost:8000
  • 🤖 End-to-end voice AI with Qwen Omni Realtime
  • ⚡ Low latency, integrated VAD + ASR + LLM + TTS
  • 📱 Ready for xiaozhi devices or custom clients

Get your API key: DashScope Console

Customize Your Bot

# Use custom prompt
uvx vixio run xiaozhi-server \
  --preset qwen-realtime \
  --dashscope-key sk-xxx \
  --prompt "你是一个专业的编程助手"

# Use pipeline mode (more control)
uvx vixio run xiaozhi-server \
  --dashscope-key sk-xxx

# Export template for full customization
uvx vixio init xiaozhi-server
cd xiaozhi-server
# Edit .env, config.yaml, prompt.txt
python run.py

Installation

Using uv (Recommended)

  1. Install with core dependencies only:
uv pip install vixio
  1. Install with specific providers:
# For Chinese local development (VAD + ASR + TTS + Agent)
uv pip install "vixio[dev-local-cn]"

# For Qwen platform integration
uv pip install "vixio[dev-qwen]"

# Or install individual components
uv pip install "vixio[xiaozhi,openai-agent,silero-vad-grpc]"

Using pip

pip install vixio

# With optional dependencies
pip install "vixio[dev-local-cn]"

Available Components

Transports

  • xiaozhi - Xiaozhi protocol transport (WebSocket + HTTP)

VAD (Voice Activity Detection)

  • silero-vad-grpc - Silero VAD via gRPC service
  • silero-vad-local - Silero VAD local inference

ASR (Automatic Speech Recognition)

  • sherpa-onnx-asr-grpc - Sherpa-ONNX ASR via gRPC service
  • sherpa-onnx-asr-local - Sherpa-ONNX ASR local inference
  • qwen - Qwen platform ASR

TTS (Text-to-Speech)

  • kokoro-cn-tts-grpc - Kokoro TTS via gRPC service
  • kokoro-cn-tts-local - Kokoro TTS local inference
  • edge-tts - Microsoft Edge TTS (cloud)
  • qwen - Qwen platform TTS

Agent

  • openai-agent - OpenAI-compatible LLM via LiteLLM

docker

CPU version

docker compose -f inference/docker-compose-inference.yml up -d --build

for China user

docker compose -f inference/docker-compose-inference.yml -f inference/docker-compose-inference-cn.yml up -d --build

GPU version

docker compose -f inference/docker-compose-inference-gpu.yml up -d --build

for china user:

docker compose -f inference/docker-compose-inference-gpu.yml -f inference/docker-compose-inference-gpu-cn.yml up -d --build

Getting Started

  1. Check out the examples/ directory for usage examples
  2. Configure your providers in a YAML config file
  3. Run your voice agent application

For detailed configuration and usage guide, see the documentation.

Project Status

Current Version: v0.1.0 (Alpha)

Note: This project is under active development. APIs may change.

License

MIT License - see LICENSE for details.

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

vixio-0.1.2.tar.gz (211.9 kB view details)

Uploaded Source

Built Distribution

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

vixio-0.1.2-py3-none-any.whl (260.4 kB view details)

Uploaded Python 3

File details

Details for the file vixio-0.1.2.tar.gz.

File metadata

  • Download URL: vixio-0.1.2.tar.gz
  • Upload date:
  • Size: 211.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.20

File hashes

Hashes for vixio-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ff5171aa2eeb89f6d7e1a8d68da4f49ba41df3fd3beada1b102e2569f5f74608
MD5 602fd6d1d58d4e4774a63d80561b676b
BLAKE2b-256 dc7735acbb24d53e1d072ffea51282d7ce3aaf1186338b250acce7e5bcbdc54b

See more details on using hashes here.

File details

Details for the file vixio-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: vixio-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 260.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.20

File hashes

Hashes for vixio-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f658788b764ccfc2c972c1f1cdc2d18b851ee2a8132190a38cecf78853c2a7c2
MD5 f20b38cb45aacdec6e39e2189b60ebad
BLAKE2b-256 3043e71e02b6382cd43b507e4eaddc3eb3c57b5d8a518fa5e60df22ce84e2d04

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