Skip to content

Documentation Overview

Welcome to YosrAI's comprehensive documentation. This section provides detailed information about the framework's components, features, and usage examples.

Structure

The documentation is organized into two main sections:

Core Components

The Core section covers the fundamental building blocks of YosrAI:

  • Providers: Learn about different LLM providers integration and configuration
  • LLM: Understand how to work with Language Models
  • Chat Manager: Explore conversation management capabilities
  • Agent: Deep dive into agent creation and configuration
  • Action: Learn about defining and handling agent actions
  • Context: Understand context management and manipulation

Examples

The Examples section showcases various use cases and implementation patterns:

  • Single Agent: Basic setup and usage of a standalone agent
  • Teacher and Student: Implementation of educational interaction scenarios
  • Assistant with Tools: Creating agents with tool-using capabilities
  • Chat and Summarize: Text processing and summarization examples
  • Two Players Debate: Multi-agent debate simulation
  • Social Media Post: Content generation and social media interactions

Getting Started

If you're new to YosrAI, we recommend:

  1. First reviewing the Getting Started guide
  2. Then exploring the Core Components to understand the framework's architecture
  3. Finally, checking out the Examples to see practical implementations

Need Help?

If you need assistance or want to contribute:

  • Check our GitHub repository for the latest updates
  • Join our community discussions
  • Report issues or suggest improvements through our issue tracker