🌟 LumosAI

A powerful enterprise-grade AI framework built with Rust for creating intelligent applications

🎉 Project Status Update: LumosAI has completed comprehensive project enhancement work!

✅ All compilation issues have been fixed

✅ Complete testing framework established (7/7 tests passing)

✅ Enterprise-grade features fully preserved

✅ Production-ready status achieved

📖 See Project Completion Report for detailed information

📖 Documentation | 🚀 Quick Start | 💡 Examples | 🤝 Contributing

✨ Features

🤖 Intelligent Agent System

Multi-Model Support: OpenAI GPT, Anthropic Claude, local models
Specialized Agents: Research, writing, analysis, and custom roles
Tool Integration: Extensible tool system with built-in tools
Conversation Memory: Persistent context and conversation history

🧠 Advanced RAG System

Document Processing: PDF, text, markdown, and web content
Smart Chunking: Recursive, semantic, and custom chunking strategies
Vector Storage: Memory, PostgreSQL, Qdrant, Weaviate backends
Hybrid Retrieval: Semantic search + keyword matching

🔄 Workflow Orchestration

Multi-Agent Collaboration: Sequential, parallel, and conditional workflows
Task Management: Complex task decomposition and execution
Event-Driven Architecture: Real-time event processing and routing
Error Handling: Robust retry mechanisms and fallback strategies

🛡️ Enterprise Security

Authentication: JWT, OAuth2, API keys, multi-factor authentication
Authorization: Role-based access control (RBAC) with fine-grained permissions
Multi-Tenant: Isolated tenant environments with custom configurations
Audit Logging: Comprehensive security and compliance logging

📊 Monitoring & Observability

Real-time Metrics: Performance, usage, and health monitoring
Distributed Tracing: Request tracing across agent interactions
Custom Dashboards: Grafana and Prometheus integration
Alerting: Intelligent alerting for system anomalies

⚡ High Performance

Rust Performance: Memory-safe, zero-cost abstractions
Async/Await: Non-blocking I/O for high concurrency
Caching: Intelligent caching at multiple layers
Scalability: Horizontal scaling with load balancing

🚀 Quick Start

Installation

Add LumosAI to your Cargo.toml:

[dependencies]
lumosai = "0.1.3"
tokio = { version = "1.0", features = ["full"] }

Basic Usage

use lumosai::prelude::*;

#[tokio::main]
async fn main() -> Result<()> {
    // 🤖 Create a simple agent
    let agent = Agent::builder()
        .name("assistant")
        .model("gpt-4")
        .system_prompt("You are a helpful AI assistant")
        .build()
        .await?;

    // 💬 Have a conversation
    let response = agent.chat("Hello, how are you?").await?;
    println!("Agent: {}", response);

    Ok(())
}

Advanced Example: RAG System

use lumosai::prelude::*;

#[tokio::main]
async fn main() -> Result<()> {
    // 📦 Create vector storage
    let storage = VectorStorage::memory().await?;

    // 🧠 Create RAG system
    let rag = RagSystem::builder()
        .storage(storage)
        .embedding_provider("openai")
        .chunking_strategy("recursive")
        .build()
        .await?;

    // 📄 Add documents
    rag.add_document("AI is transforming industries...").await?;

    // 🔍 Search and generate
    let results = rag.search("What is AI?", 5).await?;
    println!("Found {} relevant documents", results.len());

    Ok(())
}

💡 Examples

Our comprehensive example suite demonstrates real-world usage patterns:

Example	Description	Complexity
🤖 Basic Agent	Simple agent creation and conversation	⭐
🧠 RAG System	Document processing and retrieval	⭐⭐
🛠️ Tool Integration	Adding tools to agents	⭐⭐
💾 Memory System	Conversation memory and context	⭐⭐
📊 Vector Storage	Vector database operations	⭐⭐
🌊 Streaming Response	Real-time streaming responses	⭐⭐⭐
👥 Multi-Agent Workflow	Agent collaboration patterns	⭐⭐⭐
🚀 Enhanced Features	Advanced framework capabilities	⭐⭐⭐
⚡ Performance Benchmark	Performance testing and optimization	⭐⭐⭐
🔐 Authentication	Enterprise security features	⭐⭐⭐⭐
📈 Monitoring	System monitoring and metrics	⭐⭐⭐⭐
🎯 Complete API Demo	Full framework demonstration	⭐⭐⭐⭐⭐

Running Examples

# Basic agent example
cargo run --example basic_agent

# RAG system with document processing
cargo run --example rag_system

# Multi-agent collaboration
cargo run --example multi_agent_workflow

# Complete API demonstration
cargo run --example simplified_api_complete_demo

🏗️ Architecture

LumosAI follows a modular, layered architecture designed for scalability and maintainability:

┌─────────────────────────────────────────────────────────────┐
│                    Application Layer                        │
│  ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│  │   Web UI    │ │     CLI     │ │    Custom Applications  │ │
│  └─────────────┘ └─────────────┘ └─────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────────────────┐
│                     API Layer                               │
│  ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│  │  REST API   │ │  GraphQL    │ │      WebSocket API      │ │
│  └─────────────┘ └─────────────┘ └─────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────────────────┐
│                   Service Layer                             │
│  ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│  │   Agents    │ │  Workflows  │ │      Authentication     │ │
│  │   Memory    │ │     RAG     │ │       Monitoring        │ │
│  │   Tools     │ │   Events    │ │       Security          │ │
│  └─────────────┘ └─────────────┘ └─────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────────────────┐
│                    Core Layer                               │
│  ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│  │   Traits    │ │   Types     │ │       Utilities         │ │
│  │   Errors    │ │   Config    │ │       Macros            │ │
│  └─────────────┘ └─────────────┘ └─────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘
┌─────────────────────────────────────────────────────────────┐
│                Infrastructure Layer                         │
│  ┌─────────────┐ ┌─────────────┐ ┌─────────────────────────┐ │
│  │  Databases  │ │   Storage   │ │      External APIs      │ │
│  │   Cache     │ │   Queues    │ │       Providers         │ │
│  └─────────────┘ └─────────────┘ └─────────────────────────┘ │
└─────────────────────────────────────────────────────────────┘

Core Components

🤖 Agent System: Intelligent agents with specialized capabilities
🧠 RAG Engine: Advanced retrieval-augmented generation
🔄 Workflow Engine: Multi-agent orchestration and task management
💾 Memory System: Persistent context and conversation management
🛠️ Tool System: Extensible tool integration framework
🔐 Security Layer: Authentication, authorization, and audit logging
📊 Monitoring: Real-time metrics, tracing, and observability

📚 Documentation

📖 User Guides

🚀 Getting Started Guide - Your first steps with LumosAI
📖 Overview - Project overview and introduction
🏗️ Architecture - System architecture and design
⚙️ Tech Stack - Technology stack and dependencies
🔧 Core Components - Core framework components

🔧 Technical References

📋 API Reference - Complete API documentation
🛠️ Development Guide - Development setup and guidelines
🚀 Deployment Guide - Production deployment strategies
🧠 Vector Databases - Vector database integration guide
📊 Vector API Reference - Vector operations API

🛡️ Enterprise Features

⚡ Chain Operations - Best practices for chain operations
🔧 DSL Macros - Domain-specific language macros
🚀 Release Guide - Release management and versioning

💡 Tutorials & Examples

🧪 Testing Guide - Testing strategies and best practices
❓ FAQ - Frequently asked questions
🚀 Quick Start - Quick start guide

🤝 Contributing

We welcome contributions of all kinds! Whether you're fixing bugs, adding features, improving documentation, or sharing feedback, your contributions help make LumosAI better for everyone.

🚀 Quick Contribution Guide

🍴 Fork the repository
🌿 Create your feature branch (git checkout -b feature/amazing-feature)
✅ Make your changes (follow our coding standards)
🧪 Add tests for your changes
📝 Update documentation if needed
✨ Commit your changes (git commit -m 'Add amazing feature')
📤 Push to the branch (git push origin feature/amazing-feature)
🔄 Open a Pull Request

📋 Contribution Areas

🐛 Bug Reports: Help us identify and fix issues
💡 Feature Requests: Suggest new capabilities and improvements
📖 Documentation: Improve guides, examples, and API docs
🧪 Testing: Add test coverage and improve test quality
🎨 Examples: Create real-world usage examples
🔧 Performance: Optimize performance and resource usage
🛡️ Security: Enhance security features and practices

🎯 Development Setup

# Clone the repository
git clone https://github.com/louloulin/lumos.ai.git
cd lumosai

# Install Rust (if not already installed)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Build the project
cargo build

# Run tests
cargo test

# Run examples
cargo run --example basic_agent

# Check code quality
cargo clippy
cargo fmt --check

📏 Code Standards

🦀 Rust Best Practices: Follow Rust idioms and conventions
📝 Documentation: Document all public APIs with examples
🧪 Testing: Maintain high test coverage (aim for >80%)
🔍 Code Quality: Pass cargo clippy and cargo fmt checks
⚡ Performance: Consider performance implications of changes
🛡️ Security: Follow secure coding practices

🏷️ Issue Labels

good first issue - Perfect for newcomers
help wanted - Community contributions welcome
bug - Something isn't working
enhancement - New feature or improvement
documentation - Documentation improvements
performance - Performance-related changes
security - Security-related issues

🌟 Community & Support

💬 Join Our Community

💬 Discord: Join our Discord server for real-time discussions
📧 Mailing List: Subscribe to our newsletter for updates
🐦 Twitter: Follow @LumosAI for announcements
📺 YouTube: LumosAI Channel for tutorials and demos

🆘 Getting Help

📖 Documentation: Check our comprehensive docs
💡 Examples: Browse example applications
🐛 Issues: Report bugs on GitHub Issues
💬 Discussions: Ask questions in GitHub Discussions
📧 Email: Contact us at support@lumosai.com

🏆 Contributors

Thanks to all our amazing contributors! 🎉

🚀 Enterprise Support

For enterprise customers, we offer:

🎯 Priority Support: Dedicated support channels
🏗️ Custom Development: Tailored solutions for your needs
📚 Training & Consulting: Expert guidance and training
🔒 Security & Compliance: Enhanced security features
📈 SLA Guarantees: Service level agreements

Contact us at enterprise@lumosai.com for more information.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

MIT License

Copyright (c) 2024 LumosAI

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

⭐ Star us on GitHub if you find LumosAI helpful!

⭐ Star | 🐛 Report Bug | 💡 Request Feature | 📖 Documentation

Built with ❤️ by the LumosAI team

Name		Name	Last commit message	Last commit date
Latest commit History 295 Commits
benches		benches
docs		docs
examples		examples
lumos_macro		lumos_macro
lumosai_ai_extensions		lumosai_ai_extensions
lumosai_bindings		lumosai_bindings
lumosai_cli		lumosai_cli
lumosai_cloud		lumosai_cloud
lumosai_core		lumosai_core
lumosai_derive		lumosai_derive
lumosai_enterprise		lumosai_enterprise
lumosai_evals		lumosai_evals
lumosai_examples		lumosai_examples
lumosai_marketplace		lumosai_marketplace
lumosai_mcp		lumosai_mcp
lumosai_network		lumosai_network
lumosai_rag		lumosai_rag
lumosai_ui		lumosai_ui
lumosai_vector		lumosai_vector
scripts		scripts
src		src
tests		tests
.gitignore		.gitignore
.rustfmt.toml		.rustfmt.toml
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
Cargo.lock		Cargo.lock
Cargo.toml		Cargo.toml
LICENSE		LICENSE
PROJECT_CLEANUP_SUMMARY.md		PROJECT_CLEANUP_SUMMARY.md
README.md		README.md
README_CN.md		README_CN.md
bun.lock		bun.lock
bunfig.toml		bunfig.toml
deny.toml		deny.toml
docker-compose.vector-dbs.yml		docker-compose.vector-dbs.yml
next.config.js		next.config.js
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
release.toml		release.toml
tarpaulin.toml		tarpaulin.toml

License

louloulin/lumos.ai

Folders and files

Latest commit

History

Repository files navigation