Skip to content

Welcome to YosrAI

Important Note

The documentation is not complete yet, and the libraries not yet released.

YosrAI is a powerful Python library designed to simplify the creation and management of AI agents. It provides a flexible and intuitive framework for building AI-powered applications with support for multiple language models, custom tools, and advanced chat capabilities.

🚀 Key Features

  • Flexible Agent System: Create and manage AI agents with different personalities, capabilities, and behaviors
  • Multi-Provider Support: Seamlessly integrate with various LLM providers (OpenAI, Anthropic, etc.)
  • Advanced Chat Management: Handle complex conversations with streaming support and state management
  • Tool Integration: Easily extend agents with custom tools and capabilities
  • Template System: Use Jinja2 templates for dynamic prompts and instructions
  • Async First: Built with modern async/await patterns for optimal performance

📦 Quick Installation

pip install yosrai

🎯 Quick Start

Here's a simple example to get you started:

from yosrai.core import Agent, LLM

# Initialize an agent with OpenAI
agent = Agent(
    agent_code="assistant",
    agent_name="AI Assistant",
    llm=LLM(provider="openai", model="gpt-3.5-turbo")
)

# Interact with the agent
response = await agent.act("Tell me about yourself!")

🏗️ Core Components

YosrAI is built around several key components:

  • Agent: The main interface for creating and managing AI agents
  • LLM: Handles language model configuration and interaction
  • Chat Manager: Manages chat sessions and message processing
  • Action: Defines agent behaviors and capabilities
  • Context: Manages state and contextual information
  • Providers: Integrates with different LLM providers

🔍 Use Cases

YosrAI is perfect for:

  • Building conversational AI applications
  • Creating specialized AI agents for specific tasks
  • Developing multi-agent systems
  • Implementing AI-powered tools and assistants
  • Prototyping and experimenting with LLM applications

📚 Next Steps

💡 Why YosrAI?

YosrAI stands out with its:

  • Simplicity: Clean, intuitive API design
  • Flexibility: Easily extensible architecture
  • Power: Advanced features when you need them
  • Modern: Built with latest Python features and best practices
  • Production-Ready: Reliable and scalable for real-world applications

🤝 Community

📄 License

YosrAI is released under the MIT License. See the LICENSE file for more details.