Skip to main content

Introduction

Welcome to the xRx documentation! This documentation is designed to help you understand and use the xRx system.

What is xRx?​

Any modality input (x), reasoning (R), any modality output (x).

xRx is a framework for building AI-powered applications that interact with users across multiple modalities, where "x" represents the flexible integration of text, voice, and other interaction forms.

Project Motivation​

We believe the way we interact with software is changing and we're excited to be on the forefront of this movement. The xRx repository accelerates the development of multimodal AI applications, going beyond the typical focus on audio experiences. It serves as a foundation for AI-powered reasoning systems capable of engaging users through various modalities, including audio, text, app widgets, and more. This versatility sets xRx apart from most current multimodal AI systems, positioning it as a comprehensive solution for the evolving landscape of software interaction.

Our documentation is structured to provide you with a comprehensive understanding of xRx and guide you through its implementation. Here's an overview of what you'll find:

  1. Introduction: You're here now! This section provides an overview of xRx and its core concepts.

  2. Quick Start: For those eager to dive in, this section will help you set up and run xRx quickly.

  3. Tutorials: Step-by-step guides for various use cases and configurations to help you get the most out of xRx.

  4. How It Works: Detailed explanations of xRx's system architecture, components, and underlying principles.

  5. References: In-depth documentation on key components like the Agent, Guardrails, TTS, and STT.

  6. Contributing: Guidelines for those interested in contributing to the xRx project.

Use the sidebar navigation to move between these sections. If you're looking for something specific, try using the search functionality at the top of the sidebar.

Contributing​

We're an open source project and are extremely open to contributors adding new features, integrations, and documentation! Please don't hesitate to reach out and get started building with us.

For more information on contributing, see our Contribution Guide.