> ## Documentation Index
> Fetch the complete documentation index at: https://docs.praison.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# praisonaiagents SDK

> Documentation for the praisonaiagents package - Core agent framework

# Module praisonaiagents

The `praisonaiagents` package provides a lightweight, high-performance framework for building AI agents with support for multi-agent orchestration, memory, knowledge bases, and tool integration.

## Quick Start

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents import Agent

agent = Agent(instructions="You are a helpful assistant")
response = agent.start("Hello!")
print(response)
```

## Core Modules

<CardGroup cols={2}>
  <Card title="Agent" icon="user" href="/docs/sdk/praisonaiagents/agent/agent">
    Core agent class for AI interactions
  </Card>

  <Card title="Agents" icon="users" href="/docs/sdk/praisonaiagents/agents/agents">
    Multi-agent orchestration
  </Card>

  <Card title="Task" icon="list-check" href="/docs/sdk/praisonaiagents/task/task">
    Task definition and management
  </Card>

  <Card title="Process" icon="diagram-project" href="/docs/sdk/praisonaiagents/process/process">
    Task execution flows
  </Card>
</CardGroup>

## Agent Variants

<CardGroup cols={2}>
  <Card title="ImageAgent" icon="image" href="/docs/sdk/praisonaiagents/agent/image_agent">
    Vision and image processing
  </Card>

  <Card title="RouterAgent" icon="route" href="/docs/sdk/praisonaiagents/agent/router_agent">
    Intelligent request routing
  </Card>

  <Card title="DeepResearchAgent" icon="magnifying-glass" href="/docs/sdk/praisonaiagents/agent/deep_research_agent">
    Multi-step research with citations
  </Card>

  <Card title="QueryRewriterAgent" icon="pen" href="/docs/sdk/praisonaiagents/agent/query_rewriter_agent">
    Query optimization for RAG
  </Card>

  <Card title="PromptExpanderAgent" icon="expand" href="/docs/sdk/praisonaiagents/agent/prompt_expander_agent">
    Prompt enhancement
  </Card>

  <Card title="ContextAgent" icon="layer-group" href="/docs/sdk/praisonaiagents/agent/context_agent">
    Context-aware processing
  </Card>
</CardGroup>

## Data & Memory

<CardGroup cols={2}>
  <Card title="Memory" icon="brain" href="/docs/sdk/praisonaiagents/memory/memory">
    Memory management for stateful agents
  </Card>

  <Card title="Knowledge" icon="book" href="/docs/sdk/praisonaiagents/knowledge/knowledge">
    Knowledge base and RAG support
  </Card>

  <Card title="Session" icon="clock" href="/docs/sdk/praisonaiagents/session">
    Session management and persistence
  </Card>

  <Card title="DB" icon="database" href="/docs/sdk/praisonaiagents/db/db">
    Database adapters and storage
  </Card>

  <Card title="Checkpoints" icon="bookmark" href="/docs/sdk/praisonaiagents/checkpoints/checkpoints">
    State checkpointing
  </Card>

  <Card title="Context" icon="folder-open" href="/docs/sdk/praisonaiagents/context/context">
    Context management
  </Card>
</CardGroup>

## Tools & Integration

<CardGroup cols={2}>
  <Card title="Tools" icon="wrench" href="/docs/sdk/praisonaiagents/tools/tools">
    Tool system and decorators
  </Card>

  <Card title="MCP" icon="plug" href="/docs/sdk/praisonaiagents/mcp/mcp">
    Model Context Protocol support
  </Card>

  <Card title="Handoff" icon="arrow-right-arrow-left" href="/docs/sdk/praisonaiagents/handoff/handoff">
    Agent-to-agent handoffs
  </Card>

  <Card title="Workflows" icon="sitemap" href="/docs/sdk/praisonaiagents/workflows/workflows">
    Multi-step workflow execution
  </Card>

  <Card title="Skills" icon="graduation-cap" href="/docs/sdk/praisonaiagents/skills/skills">
    Agent Skills standard support
  </Card>

  <Card title="LLM" icon="microchip" href="/docs/sdk/praisonaiagents/llm/llm">
    LLM configuration and providers
  </Card>
</CardGroup>

## Safety & Control

<CardGroup cols={2}>
  <Card title="Guardrails" icon="shield" href="/docs/sdk/praisonaiagents/guardrails/guardrails">
    Input/output validation
  </Card>

  <Card title="Planning" icon="clipboard-list" href="/docs/sdk/praisonaiagents/planning/planning">
    Planning mode support
  </Card>

  <Card title="Policy" icon="gavel" href="/docs/sdk/praisonaiagents/policy/policy">
    Policy-based controls
  </Card>

  <Card title="Approval" icon="check-double" href="/docs/sdk/praisonaiagents/approval">
    Human-in-the-loop approval
  </Card>

  <Card title="Thinking" icon="lightbulb" href="/docs/sdk/praisonaiagents/thinking/thinking">
    Extended thinking support
  </Card>

  <Card title="Compaction" icon="compress" href="/docs/sdk/praisonaiagents/compaction/compaction">
    Context compaction
  </Card>
</CardGroup>

## Observability

<CardGroup cols={2}>
  <Card title="Telemetry" icon="chart-line" href="/docs/sdk/praisonaiagents/telemetry">
    Observability and monitoring
  </Card>

  <Card title="Hooks" icon="link" href="/docs/sdk/praisonaiagents/hooks/hooks">
    Event hooks and callbacks
  </Card>

  <Card title="Display" icon="display" href="/docs/sdk/praisonaiagents/display">
    Console display utilities
  </Card>

  <Card title="Eval" icon="flask" href="/docs/sdk/praisonaiagents/eval/eval">
    Agent evaluation framework
  </Card>

  <Card title="Outputs" icon="square-check" href="/docs/sdk/praisonaiagents/outputs">
    Data classes for task outputs
  </Card>

  <Card title="FlowDisplay" icon="diagram-project" href="/docs/sdk/praisonaiagents/flow_display">
    Workflow visualization
  </Card>
</CardGroup>

## UI & Output

<CardGroup cols={2}>
  <Card title="UI" icon="window-maximize" href="/docs/sdk/praisonaiagents/ui/ui">
    UI components (AGUI, A2A)
  </Card>

  <Card title="Output" icon="file-export" href="/docs/sdk/praisonaiagents/output/output">
    Output formatting
  </Card>

  <Card title="LSP" icon="code" href="/docs/sdk/praisonaiagents/lsp/lsp">
    Language Server Protocol
  </Card>

  <Card title="Background" icon="clock-rotate-left" href="/docs/sdk/praisonaiagents/background/background">
    Background task execution
  </Card>
</CardGroup>

## Import Patterns

The SDK supports multiple import styles for different use cases:

### Simple Import (Recommended for Quick Start)

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
from praisonaiagents import Agent, AgentTeam, Task, tool, Tools
```

### Organized Imports (Recommended for Projects)

For larger projects, use sub-package imports for cleaner code organization:

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
# Core classes from root
from praisonaiagents import Agent, AgentTeam, Task

# Configuration from config sub-package
from praisonaiagents import MemoryConfig, OutputConfig, ExecutionConfig

# Tools from tools sub-package
from praisonaiagents import tool, BaseTool, Tools

# Memory from memory sub-package
from praisonaiagents import Memory, FileMemory

# Workflows from workflows sub-package
from praisonaiagents import AgentFlow, Pipeline, Route, Parallel
```

### Namespace Style

Use the `pa.` namespace for exploratory development:

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
import praisonaiagents as pa

agent = pa.Agent(instructions="...")
config = pa.config.MemoryConfig(user_id="u123")
memory = pa.memory.Memory(config=config)
```

### Backwards Compatibility

All legacy imports continue to work via lazy loading:

```python theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
# These all work (backwards compatible)
from praisonaiagents import MemoryConfig  # via __getattr__
from praisonaiagents import AgentFlow      # via __getattr__
from praisonaiagents import Memory        # via __getattr__
```

### Sub-Packages Reference

| Sub-Package                 | Key Exports                                                               | Description                   |
| --------------------------- | ------------------------------------------------------------------------- | ----------------------------- |
| `praisonaiagents.config`    | `MemoryConfig`, `OutputConfig`, `ExecutionConfig`, `PlanningConfig`, etc. | Feature configuration classes |
| `praisonaiagents.tools`     | `tool`, `BaseTool`, `Tools`, `ToolResult`, `FunctionTool`                 | Tool creation and management  |
| `praisonaiagents.memory`    | `Memory`, `FileMemory`, `RulesManager`                                    | Memory and persistence        |
| `praisonaiagents.workflows` | `Workflow`, `Pipeline`, `Route`, `Parallel`, `Loop`                       | Workflow orchestration        |

## Installation

```bash theme={"theme":{"light":"vitesse-light","dark":"vitesse-dark"}}
# Core package
pip install praisonaiagents

# With memory support
pip install "praisonaiagents[memory]"

# With knowledge/RAG support  
pip install "praisonaiagents[knowledge]"

# With MCP support
pip install "praisonaiagents[mcp]"
```

## See Also

* [SDK Reference](/docs/sdk/index)
* [Agent Module](/docs/sdk/praisonaiagents/agent/agent)
* [Quickstart Guide](/docs/quickstart)
