Compare commits

...
50 Commits
Author SHA1 Message Date
Mervin Praison b183ac5cbd Release v2.3.3 2025-12-15 14:55:30 +00:00
Mervin Praison 5f57e1d2f1 feat: add memory info display and improve memory integration with system prompts
- Add _display_memory_info() method to show memory stats in rich panel (long-term, short-term, entities, storage path)
- Disable system prompt caching when memory is enabled (dynamic context)
- Inject memory context into system prompt with "## Memory" section
- Display memory info on first chat when verbose=True
- Add integration tests for memory with OpenAI API (injection and persistence)
- Update README with zero
2025-12-15 14:52:09 +00:00
Mervin Praison 5114165944 feat: add zero-dependency file-based memory system for all agents
- Add FileMemory class with JSON-based persistent storage (no extra dependencies)
- Add _init_memory(), get_memory_context(), store_memory() methods to Agent class
- Support memory types: short_term, long_term, entity, episodic
- Add memory=True/False/"file"/"sqlite"/"chromadb"/"mem0" configuration options
- Add lazy import for Memory class to avoid dependency issues
- Update README with memory usage examples and provider comparison
2025-12-15 14:37:33 +00:00
Mervin Praison 389442ea04 feat: add Claude Memory Tool support for persistent cross-conversation memory
- Add claude_memory parameter to Agent and LLM classes
- Add ClaudeMemoryTool with file-based persistent memory in .praison/claude_memory/
- Add _supports_claude_memory(), _is_memory_tool_call(), _execute_memory_tool_call() methods
- Add automatic beta header injection for Anthropic models
- Add memory tool definition to completion params when enabled
- Add ClaudeMemoryTool to TOOL_MAPPINGS with class-level import
- Update
2025-12-15 13:48:35 +00:00
Mervin Praison 6d7cc9c3ba Release v2.3.2 2025-12-15 13:34:15 +00:00
Mervin Praison 690e4497cc feat: add --save support for direct prompts
- Save output to output/prompts/ folder with timestamped filename
- Works with all flags: --web-search, --expand-prompt, etc.

Usage:
  praisonai 'latest AI trends' --web-search --save
  praisonai 'write a poem' --expand-prompt --save
2025-12-15 13:33:28 +00:00
Mervin Praison 041f5f0b08 fix: add current date to PromptExpanderAgent for time-sensitive context
- Add datetime import and current_date to all expansion prompts
- Ensures expanded prompts reference the correct current date (e.g., December 15, 2025)
- Fixes issue where prompts defaulted to outdated year references
2025-12-15 13:26:13 +00:00
Mervin Praison bc0d9a6213 feat: add CLI flags for web-search, web-fetch, and prompt-caching
- Add --web-search flag for native web search (OpenAI, Gemini, Anthropic, xAI, Perplexity)
- Add --web-fetch flag for URL content retrieval (Anthropic only)
- Add --prompt-caching flag to reduce costs (OpenAI, Anthropic, Bedrock, Deepseek)
- Update README with CLI and programmatic usage examples

Usage:
  praisonai 'latest AI news' --web-search --llm openai/gpt-4o-search-preview
  praisonai 'summarize https://example.com' --web-fetch --llm anthropic/claude-sonnet-4-20250514
  praisonai 'analyze...' --prompt-caching --llm anthropic/claude-sonnet-4-20250514
2025-12-15 12:56:02 +00:00
Mervin Praison a4427fa135 Release v2.3.1 2025-12-15 12:45:22 +00:00
Mervin Praison 51e8c65c8c feat: refactor model capabilities to use LiteLLM helper functions
- Replace static model lists with LiteLLM's built-in capability checks (supports_response_schema, supports_function_calling, supports_parallel_function_calling, supports_web_search)
- Add supports_function_calling() and supports_parallel_function_calling() functions
- Keep static list for web_fetch (no LiteLLM helper available yet)
- Update documentation to reference LiteLLM as primary source
- Add Web Fetch feature to README features
2025-12-15 12:32:09 +00:00
Mervin Praison 285ed672c5 feat: add native web search and web fetch documentation to README
- Add Native Web Search section with supported providers (OpenAI, Anthropic, Gemini, xAI, Perplexity)
- Add Web Fetch section for Anthropic models with configuration options
- Add code examples for web_search and web_fetch parameters
- Document web_fetch options (max_uses, allowed_domains, citations)
2025-12-15 12:20:41 +00:00
Mervin Praison c03e51e337 feat: add native web fetch support for Anthropic Claude models
- Add web_fetch parameter to Agent and LLM classes
- Add model_capabilities.py with MODELS_SUPPORTING_WEB_FETCH list (Claude 3.5+, 4+)
- Add supports_web_fetch() function to check model capabilities
- Add web_fetch tool definition with configurable options (max_uses, allowed_domains, blocked_domains, citations, max_content_tokens)
- Add _model_supports_web_fetch() method to Agent class
- Add warning log for unsupported models when web_
2025-12-15 12:18:08 +00:00
Mervin Praison f3ba05f6aa feat: expand structured outputs support for OpenAI, Anthropic, and Gemini models
- Add comprehensive list of OpenAI models with structured outputs (gpt-4o-2024-08-06+, gpt-4.1+, gpt-5+, o-series)
- Add Anthropic Claude 4+ models with structured outputs support (Sonnet 4.5, Opus 4.1/4.5, Haiku 4.5)
- Add all Google Gemini models (2.5-pro, 2.5-flash, 2.0-flash, 1.5-pro/flash)
- Add auto-detection for newer model versions (gpt-4.1+, gpt-5+, o-series, Claude 4+, all Gemini)
- Add azure/ prefix support
2025-12-15 12:07:46 +00:00
Mervin Praison 9cea3edcd6 feat: add native web search support for OpenAI, Gemini, Anthropic, xAI, and Perplexity models
- Add web_search parameter to Agent and LLM classes
- Add model_capabilities.py with MODELS_SUPPORTING_WEB_SEARCH list
- Add supports_web_search() function to check model capabilities
- Add automatic DuckDuckGo fallback for unsupported models
- Add web_search_options to LiteLLM completion params
- Remove incompatible parameters (temperature, top_p, etc.) for web search models
- Update README with Native
2025-12-15 11:59:19 +00:00
Mervin Praison 02a3bd3597 chore: add uv cache clean before uv lock in release.py 2025-12-15 11:26:08 +00:00
Mervin Praison 128c77926d chore: add uv cache clean before uv lock in bump_and_release.py 2025-12-15 11:25:42 +00:00
Mervin Praison 3aa1b825e4 Release v2.3.0 2025-12-15 11:24:46 +00:00
Mervin Praison b4ee30d837 chore: bump praisonaiagents version to 0.0.170 2025-12-15 11:11:46 +00:00
Mervin Praison 825648aead docs: add PromptExpanderAgent to README 2025-12-15 11:11:04 +00:00
Mervin Praison 1532c31e72 feat: add PromptExpanderAgent for detailed prompt expansion
- Add PromptExpanderAgent class with expansion strategies (BASIC, DETAILED, STRUCTURED, CREATIVE, AUTO)
- Add ExpandStrategy enum and ExpandResult dataclass
- Add CLI flags --expand-prompt and --expand-tools
- Add 20 unit tests for PromptExpanderAgent
- Export from praisonaiagents package

Usage:
  praisonai 'write a movie script' --expand-prompt
  praisonai 'AI blog' --expand-prompt --expand-tools tools.py
2025-12-15 11:09:25 +00:00
Mervin Praison b313fefd86 fix: QueryRewriterAgent preserves task intent instead of converting to questions 2025-12-15 10:57:53 +00:00
Mervin Praison 435e1afb55 test: add OPENAI_API_KEY environment variable to comprehensive test workflow and verify its presence 2025-12-15 10:47:29 +00:00
Mervin Praison 4cb3c0565a test: add skipif decorator for OPENAI_API_KEY check in CrewAI environment test 2025-12-15 10:42:00 +00:00
Mervin Praison a7634b66dc Release v2.2.99 2025-12-15 10:36:34 +00:00
Mervin Praison 3f0eaccbcb Release v2.2.98 2025-12-15 10:28:42 +00:00
Mervin Praison 47713d933a test: convert test assertions to pytest format and add TaskOutput descriptions
- Replace return True/False with pytest assertions in test_context_agent.py
- Add pytest.mark.skip decorators for unimplemented ContextAgent methods
- Add missing description parameter to TaskOutput instances in test_validation_feedback.py
2025-12-15 10:25:23 +00:00
Mervin Praison c82bfccd1d docs: add custom tools documentation with decorator, BaseTool class, and pip installable package examples 2025-12-15 10:20:11 +00:00
Mervin Praison ef7d1264e2 feat: add plugin system with tool registry and BaseTool support for external tool packages 2025-12-15 10:10:06 +00:00
Mervin Praison 2799304270 Release v2.2.97 2025-12-15 08:25:56 +00:00
Mervin Praison 4a85c135a6 Release v2.2.96 2025-12-15 07:57:25 +00:00
Mervin Praison cdb42a3f08 feat: add custom tools support to research command with file and built-in tool loading 2025-12-15 07:33:52 +00:00
Mervin Praison c8378118e7 docs: add query rewrite flag to research command and bump version to 2.2.94 2025-12-13 12:49:38 +00:00
Mervin Praison 0213764057 feat: add Query Rewriter Agent with multiple rewrite strategies and bump version to 0.0.166 2025-12-13 12:44:21 +00:00
Mervin Praison 2220114809 feat: add --save flag to research command for markdown output and bump version to 2.2.93 2025-12-13 11:58:36 +00:00
Mervin Praison 9fe4dbc172 chore: bump version to 2.2.92 and update praisonaiagents dependency to 0.0.165 2025-12-13 02:19:22 +00:00
Mervin Praison 180503fcd5 feat: add default research instructions to DeepResearchAgent and bump version to 0.0.165 2025-12-13 02:18:42 +00:00
Mervin Praison 0d8f936b19 chore: bump version to 2.2.91 and update praisonaiagents dependency to 0.0.164 2025-12-13 02:09:12 +00:00
Mervin Praison 8b53ebf5e3 docs: add Deep Research CLI documentation and bump version to 2.2.90 2025-12-13 01:44:52 +00:00
Mervin Praison 504c5a9759 chore: bump version to 2.2.89 and update praisonaiagents dependency to 0.0.163 2025-12-13 01:17:52 +00:00
Mervin Praison 8fef42fc03 feat: add Deep Research Agent support with OpenAI and Gemini integration 2025-12-13 01:15:07 +00:00
Mervin Praison 2f18cc1ea2 Merge branch 'main' of https://github.com/MervinPraison/PraisonAI 2025-12-13 01:13:29 +00:00
Mervin Praison ff7969cdbf docs: rewrite README from MCP SSE implementation to comprehensive PraisonAI Agents documentation 2025-12-13 01:13:28 +00:00
Mervin Praison 5fa84dc3eb Merge pull request #1084 from Dhivya-Bharathy/feature/agentic-rag
feat: Add Agentic RAG Example to Cookbooks
2025-11-03 14:14:46 +00:00
Mervin Praison 4bf8b980ed Merge pull request #1085 from Dhivya-Bharathy/feat/agentic-rag-tools
feat: Add Agentic RAG Tools Implementation
2025-11-03 14:14:24 +00:00
Mervin Praison 53e0fd19ab feat: add async run support and example scripts for multi-turn conversations 2025-08-30 11:54:59 +01:00
Dhivya-Bharathy 0cb6307d3c Add agentic_rag_gpt5 example with GPT-5 integration 2025-08-29 13:11:08 +05:30
Dhivya adce94410b Add files via upload 2025-08-29 13:01:08 +05:30
Dhivya-Bharathy 42aec561b1 Add agentic RAG Python implementation to tools 2025-08-28 14:09:09 +05:30
Dhivya acc805768d Update PraisonAI_RecipeAgent.ipynb 2025-08-28 13:00:50 +05:30
Dhivya-Bharathy 6d9fa167e3 Add agentic_rag example to cookbooks 2025-08-28 06:43:41 +00:00
68 changed files with 14950 additions and 402 deletions

No files matched your search

+9 -4
View File
@@ -27,6 +27,9 @@ jobs:
comprehensive-test:
runs-on: ubuntu-latest
timeout-minutes: 15
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
OPENAI_MODEL_NAME: gpt-4o-mini
strategy:
matrix:
python-version: ["3.11"]
@@ -55,11 +58,13 @@ jobs:
# Install knowledge dependencies from praisonai-agents
uv pip install --system "praisonaiagents[knowledge]"
- name: Set environment variables
- name: Verify environment variables
run: |
echo "OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY || 'sk-test-key-for-github-actions-testing-only-not-real' }}" >> $GITHUB_ENV
echo "OPENAI_API_BASE=${{ secrets.OPENAI_API_BASE || 'https://api.openai.com/v1' }}" >> $GITHUB_ENV
echo "OPENAI_MODEL_NAME=${{ secrets.OPENAI_MODEL_NAME || 'gpt-5-nano' }}" >> $GITHUB_ENV
if [ -n "$OPENAI_API_KEY" ]; then
echo "✅ OPENAI_API_KEY is set (length: ${#OPENAI_API_KEY})"
else
echo "⚠️ OPENAI_API_KEY is NOT set"
fi
- name: Run Comprehensive Test Suite
run: |
+2 -2
View File
@@ -34,7 +34,7 @@ jobs:
cd src/praisonai
uv pip install --system ."[ui,gradio,api,agentops,google,openai,anthropic,cohere,chat,code,realtime,call,crewai,autogen]"
uv pip install --system duckduckgo_search
uv pip install --system pytest pytest-asyncio pytest-cov
uv pip install --system pytest pytest-asyncio pytest-cov pytest-timeout
# Install knowledge dependencies from praisonai-agents
uv pip install --system "praisonaiagents[knowledge]"
@@ -262,7 +262,7 @@ jobs:
export OPENAI_API_KEY="$OPENAI_API_KEY"
export OPENAI_API_BASE="$OPENAI_API_BASE"
export OPENAI_MODEL_NAME="$OPENAI_MODEL_NAME"
cd src/praisonai && python -m pytest tests/test.py -v --tb=short --disable-warnings
cd src/praisonai && python -m pytest tests/test.py -v --tb=short --disable-warnings -m "not real" --timeout=60
- name: Upload coverage reports to Codecov
if: matrix.python-version == '3.11'
+2 -2
View File
@@ -27,7 +27,7 @@ jobs:
cd src/praisonai
uv pip install --system ."[ui,gradio,api,agentops,google,openai,anthropic,cohere,chat,code,realtime,call,crewai,autogen]"
uv pip install --system duckduckgo_search
uv pip install --system pytest pytest-asyncio pytest-cov
uv pip install --system pytest pytest-asyncio pytest-cov pytest-timeout
# Install knowledge dependencies from praisonai-agents
uv pip install --system "praisonaiagents[knowledge]"
@@ -489,7 +489,7 @@ jobs:
- name: Run Legacy Example Tests
run: |
cd src/praisonai && python -m pytest tests/test.py -v --tb=short --disable-warnings
cd src/praisonai && python -m pytest tests/test.py -v --tb=short --disable-warnings -m "not real" --timeout=60
continue-on-error: true
- name: Upload coverage reports to Codecov
+346
View File
@@ -53,6 +53,13 @@ PraisonAI is a production-ready Multi-AI Agents framework with self-reflection,
- 🛠️ 100+ Custom Tools
- 📄 YAML Configuration
- 💯 100+ LLM Support
- 🔬 **Deep Research Agents** (OpenAI & Gemini)
- 🔄 **Query Rewriter Agent** (HyDE, Step-back, Multi-query)
- 🌐 **Native Web Search** (OpenAI, Gemini, Anthropic, xAI, Perplexity)
- 📥 **Web Fetch** (Retrieve full content from URLs - Anthropic)
- 💾 **Prompt Caching** (Reduce costs & latency - OpenAI, Anthropic, Bedrock, Deepseek)
- 🧠 **Claude Memory Tool** (Persistent cross-conversation memory - Anthropic Beta)
- 💾 **File-Based Memory** (Zero-dependency persistent memory for all agents)
## Using Python Code
@@ -96,6 +103,121 @@ Run:
python app.py
```
### 3. Deep Research Agent
Automated research with real-time streaming, web search, and citations using OpenAI or Gemini Deep Research APIs.
```python
from praisonaiagents import DeepResearchAgent
# OpenAI Deep Research
agent = DeepResearchAgent(
model="o4-mini-deep-research", # or "o3-deep-research"
verbose=True
)
result = agent.research("What are the latest AI trends in 2025?")
print(result.report)
print(f"Citations: {len(result.citations)}")
```
```python
# Gemini Deep Research
from praisonaiagents import DeepResearchAgent
agent = DeepResearchAgent(
model="deep-research-pro", # Auto-detected as Gemini
verbose=True
)
result = agent.research("Research quantum computing advances")
print(result.report)
```
**Features:**
- 🔍 Multi-provider support (OpenAI, Gemini, LiteLLM)
- 📡 Real-time streaming with reasoning summaries
- 📚 Structured citations with URLs
- 🛠️ Built-in tools: web search, code interpreter, MCP, file search
- 🔄 Automatic provider detection from model name
### 4. Query Rewriter Agent
Transform user queries to improve RAG retrieval quality using multiple strategies.
```python
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
agent = QueryRewriterAgent(model="gpt-4o-mini")
# Basic - expands abbreviations, adds context
result = agent.rewrite("AI trends")
print(result.primary_query) # "What are the current trends in Artificial Intelligence?"
# HyDE - generates hypothetical document for semantic matching
result = agent.rewrite("What is quantum computing?", strategy=RewriteStrategy.HYDE)
# Step-back - generates broader context question
result = agent.rewrite("GPT-4 vs Claude 3?", strategy=RewriteStrategy.STEP_BACK)
# Sub-queries - decomposes complex questions
result = agent.rewrite("RAG setup and best embedding models?", strategy=RewriteStrategy.SUB_QUERIES)
# Contextual - resolves references using chat history
result = agent.rewrite("What about cost?", chat_history=[...])
```
**Strategies:**
- **BASIC**: Expand abbreviations, fix typos, add context
- **HYDE**: Generate hypothetical document for semantic matching
- **STEP_BACK**: Generate higher-level concept questions
- **SUB_QUERIES**: Decompose multi-part questions
- **MULTI_QUERY**: Generate multiple paraphrased versions
- **CONTEXTUAL**: Resolve references using conversation history
- **AUTO**: Automatically detect best strategy
### 5. Agent Memory (Zero Dependencies)
Enable persistent memory for agents - works out of the box without any extra packages.
```python
from praisonaiagents import Agent
# Enable memory with a single parameter
agent = Agent(
name="Personal Assistant",
instructions="You are a helpful assistant that remembers user preferences.",
memory=True, # Enables file-based memory (no extra deps!)
user_id="user123" # Isolate memory per user
)
# Store memories programmatically
agent.store_memory("User prefers dark mode", memory_type="short_term")
agent.store_memory("User's name is John", memory_type="long_term", importance=0.9)
# Memory is automatically injected into conversations
result = agent.start("What do you know about me?")
# Agent will recall: "Your name is John and you prefer dark mode"
# Memory persists across sessions - create new agent with same user_id
agent2 = Agent(name="Assistant", memory=True, user_id="user123")
# agent2 automatically loads all previous memories!
```
**Memory Types:**
- **Short-term**: Rolling buffer of recent context (auto-expires)
- **Long-term**: Persistent important facts (sorted by importance)
- **Entity**: People, places, organizations with attributes
- **Episodic**: Date-based interaction history
**Storage Options:**
| Option | Dependencies | Description |
|--------|-------------|-------------|
| `memory=True` | None | File-based JSON storage (default) |
| `memory="file"` | None | Explicit file-based storage |
| `memory="sqlite"` | Built-in | SQLite with indexing |
| `memory="chromadb"` | chromadb | Vector/semantic search |
## Using No Code
### Auto Mode:
@@ -105,6 +227,51 @@ export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx
praisonai --auto create a movie script about Robots in Mars
```
### Query Rewriting (works with any command):
```bash
# Rewrite query for better results (uses QueryRewriterAgent)
praisonai "AI trends" --query-rewrite
# Rewrite with search tools (agent decides when to search)
praisonai "latest developments" --query-rewrite --rewrite-tools "internet_search"
# Works with any prompt
praisonai "explain quantum computing" --query-rewrite -v
```
### Deep Research CLI:
```bash
# Default: OpenAI (o4-mini-deep-research)
praisonai research "What are the latest AI trends in 2025?"
# Use Gemini
praisonai research --model deep-research-pro "Your research query"
# Rewrite query before research
praisonai research --query-rewrite "AI trends"
# Rewrite with search tools
praisonai research --query-rewrite --rewrite-tools "internet_search" "AI trends"
# Use custom tools from file (gathers context before deep research)
praisonai research --tools tools.py "Your research query"
praisonai research -t my_tools.py "Your research query"
# Use built-in tools by name (comma-separated)
praisonai research --tools "internet_search,wiki_search" "Your query"
praisonai research -t "yfinance,calculator_tools" "Stock analysis query"
# Save output to file (output/research/{query}.md)
praisonai research --save "Your research query"
praisonai research -s "Your research query"
# Combine options
praisonai research --query-rewrite --tools tools.py --save "Your research query"
# Verbose mode (show debug logs)
praisonai research -v "Your research query"
```
## Using JavaScript Code
```bash
@@ -523,6 +690,172 @@ praisonai agents.yaml
</a>
</div>
## Custom Tools
### Using `@tool` Decorator
```python
from praisonaiagents import Agent, tool
@tool
def search(query: str) -> str:
"""Search the web for information."""
return f"Results for: {query}"
@tool
def calculate(expression: str) -> float:
"""Evaluate a math expression."""
return eval(expression)
agent = Agent(
instructions="You are a helpful assistant",
tools=[search, calculate]
)
agent.start("Search for AI news and calculate 15*4")
```
### Using `BaseTool` Class
```python
from praisonaiagents import Agent, BaseTool
class WeatherTool(BaseTool):
name = "weather"
description = "Get current weather for a location"
def run(self, location: str) -> str:
return f"Weather in {location}: 72°F, Sunny"
agent = Agent(
instructions="You are a weather assistant",
tools=[WeatherTool()]
)
agent.start("What's the weather in Paris?")
```
### Creating a Tool Package (pip installable)
```toml
# pyproject.toml
[project]
name = "my-praisonai-tools"
version = "1.0.0"
dependencies = ["praisonaiagents"]
[project.entry-points."praisonaiagents.tools"]
my_tool = "my_package:MyTool"
```
```python
# my_package/__init__.py
from praisonaiagents import BaseTool
class MyTool(BaseTool):
name = "my_tool"
description = "My custom tool"
def run(self, param: str) -> str:
return f"Result: {param}"
```
After `pip install`, tools are auto-discovered:
```python
agent = Agent(tools=["my_tool"]) # Works automatically!
```
## Prompt Expansion
Expand short prompts into detailed, actionable prompts:
### CLI Usage
```bash
# Expand a short prompt into detailed prompt
praisonai "write a movie script in 3 lines" --expand-prompt
# With verbose output
praisonai "blog about AI" --expand-prompt -v
# With tools for context gathering
praisonai "latest AI trends" --expand-prompt --expand-tools tools.py
# Combine with query rewrite
praisonai "AI news" --query-rewrite --expand-prompt
```
### Programmatic Usage
```python
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
# Basic usage
agent = PromptExpanderAgent()
result = agent.expand("write a movie script in 3 lines")
print(result.expanded_prompt)
# With specific strategy
result = agent.expand("blog about AI", strategy=ExpandStrategy.DETAILED)
# Available strategies: BASIC, DETAILED, STRUCTURED, CREATIVE, AUTO
```
**Key Difference:**
- `--query-rewrite`: Optimizes queries for **search/retrieval** (RAG)
- `--expand-prompt`: Expands prompts for **detailed task execution**
## Web Search, Web Fetch & Prompt Caching
### CLI Usage
```bash
# Web Search - Get real-time information
praisonai "What are the latest AI news today?" --web-search --llm openai/gpt-4o-search-preview
# Web Fetch - Retrieve and analyze URL content (Anthropic only)
praisonai "Summarize https://docs.praison.ai" --web-fetch --llm anthropic/claude-sonnet-4-20250514
# Prompt Caching - Reduce costs for repeated prompts
praisonai "Analyze this document..." --prompt-caching --llm anthropic/claude-sonnet-4-20250514
```
### Programmatic Usage
```python
from praisonaiagents import Agent
# Web Search
agent = Agent(
instructions="You are a research assistant",
llm="openai/gpt-4o-search-preview",
web_search=True
)
# Web Fetch (Anthropic only)
agent = Agent(
instructions="You are a content analyzer",
llm="anthropic/claude-sonnet-4-20250514",
web_fetch=True
)
# Prompt Caching
agent = Agent(
instructions="You are an AI assistant..." * 50, # Long system prompt
llm="anthropic/claude-sonnet-4-20250514",
prompt_caching=True
)
```
**Supported Providers:**
| Feature | Providers |
|---------|-----------|
| Web Search | OpenAI, Gemini, Anthropic, xAI, Perplexity |
| Web Fetch | Anthropic |
| Prompt Caching | OpenAI (auto), Anthropic, Bedrock, Deepseek |
## Development:
Below is used for development only.
@@ -540,6 +873,19 @@ uv pip install -r pyproject.toml --extra code
uv pip install -r pyproject.toml --extra "crewai,autogen"
```
### Bump and Release
```bash
# From project root - bumps version and releases in one command
python src/praisonai/scripts/bump_and_release.py 2.2.99
# With praisonaiagents dependency
python src/praisonai/scripts/bump_and_release.py 2.2.99 --agents 0.0.169
# Then publish
cd src/praisonai && uv publish
```
## Contributing
- Fork on GitHub: Use the "Fork" button on the repository page.
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
flask \
"praisonai>=2.2.88" \
"praisonai>=2.3.3" \
"praisonai[api]" \
gunicorn \
markdown
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=2.2.88" \
"praisonai>=2.3.3" \
"praisonai[chat]" \
"embedchain[github,youtube]"
+1 -1
View File
@@ -20,7 +20,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=2.2.88" \
"praisonai>=2.3.3" \
"praisonai[ui]" \
"praisonai[chat]" \
"praisonai[realtime]" \
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=2.2.88" \
"praisonai>=2.3.3" \
"praisonai[ui]" \
"praisonai[crewai]"
+2 -2
View File
@@ -121,7 +121,7 @@ healthcheck:
## 📦 Package Versions
All Docker images use consistent, up-to-date versions:
- PraisonAI: `>=2.2.88`
- PraisonAI: `>=2.2.95`
- PraisonAI Agents: `>=0.0.92`
- Python: `3.11-slim`
@@ -218,7 +218,7 @@ docker-compose up -d
### Version Pinning
To use specific versions, update the Dockerfile:
```dockerfile
RUN pip install "praisonai==2.2.88" "praisonaiagents==0.0.92"
RUN pip install "praisonai==2.2.95" "praisonaiagents==0.0.92"
```
## 🌐 Production Deployment
@@ -0,0 +1,481 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {
"id": "LJRJRQtFTagH"
},
"source": [
"# AI RAG Agent with Web Access using PraisonAI"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "Ph4RVTBCTcmB"
},
"source": [
"This notebook demonstrates how to build a Retrieval-Augmented Generation (RAG) agent with web access using GPT-4o and PraisonAI. The agent specializes in Thai recipes and can search the web for additional information."
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "tMxfwPPATy_o"
},
"source": [
"This RAG agent:\n",
"* Creates an AI assistant specialized in Thai recipes and cooking\n",
"* Has access to a PDF knowledge base about Thai recipes\n",
"* Can search the web using DuckDuckGo for additional information\n",
"* Provides comprehensive answers about Thai cuisine\n",
"* Uses PraisonAI framework for agent management"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "h68oMaCITmqt"
},
"source": [
"[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Dhivya-Bharathy/PraisonAI/blob/main/examples/cookbooks/rag_examples/agentic_rag/PraisonAI_RecipeAgent.ipynb)\n"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "cAdzoWXJUMfF"
},
"source": [
"# Dependencies"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "9D-2TlOrUNcu"
},
"outputs": [],
"source": [
"!pip install praisonaiagents openai requests"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "yY-4-kEIUW40"
},
"source": [
"# Set Up API Key"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {
"colab": {
"base_uri": "https://localhost:8080/"
},
"id": "f5bhQ05yUX6J",
"outputId": "dcf9d0d9-332e-4136-9289-4c39d898005c"
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Enter your OpenAI API key: ··········\n",
"✅ API key set successfully!\n"
]
}
],
"source": [
"import os\n",
"\n",
"# Set your OpenAI API key here\n",
"os.environ['OPENAI_API_KEY'] = 'Enter your api key here'\n",
"\n",
"# Or use this method to input it securely\n",
"from getpass import getpass\n",
"api_key = getpass('Enter your OpenAI API key: ')\n",
"os.environ['OPENAI_API_KEY'] = api_key\n",
"\n",
"print(\"✅ API key set successfully!\")"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "Eh0j-SegUi13"
},
"source": [
"# Tools"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {
"colab": {
"base_uri": "https://localhost:8080/"
},
"id": "Z1A9oifIUkQN",
"outputId": "9be78226-36fa-43c4-865d-2f7e6e2ba9de"
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"✅ Tools imported successfully!\n"
]
}
],
"source": [
"from praisonaiagents import Agent\n",
"import requests\n",
"import tempfile\n",
"from pathlib import Path\n",
"\n",
"print(\"✅ Tools imported successfully!\")"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "efnnREHXUnYA"
},
"source": [
"# YAML Prompt"
]
},
{
"cell_type": "code",
"execution_count": 4,
"metadata": {
"colab": {
"base_uri": "https://localhost:8080/"
},
"id": "kcM14-yQUqG-",
"outputId": "c5b6288d-a789-4a93-e20c-1d285370b667"
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"✅ Agent instructions configured!\n"
]
}
],
"source": [
"# Agent configuration and instructions\n",
"AGENT_INSTRUCTIONS = \"\"\"\n",
"You are a helpful AI assistant specialized in Thai recipes and cooking.\n",
"\n",
"You have access to a PDF knowledge base about Thai recipes from: https://phi-public.s3.amazonaws.com/recipes/ThaiRecipes.pdf\n",
"\n",
"You can also search the web for additional information about Thai cooking, ingredients, and techniques.\n",
"\n",
"When answering questions:\n",
"1. Use your knowledge about Thai cuisine to provide helpful information\n",
"2. If needed, search the web for additional details, current information, or clarification\n",
"3. Provide comprehensive, helpful answers about Thai cuisine\n",
"4. Always be informative and helpful about Thai cooking!\n",
"\n",
"You can use the internet_search function to search the web when needed.\n",
"\n",
"Focus on providing practical cooking advice, ingredient information, and authentic Thai recipe guidance.\n",
"\"\"\"\n",
"\n",
"print(\"✅ Agent instructions configured!\")"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "MCBRcXFJUulY"
},
"source": [
"# Main"
]
},
{
"cell_type": "code",
"execution_count": 5,
"metadata": {
"colab": {
"base_uri": "https://localhost:8080/"
},
"id": "YaRLbgMmUvXv",
"outputId": "8ed8d9f8-85a7-48de-ccc6-f617cd672a85"
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"🤖 Thai Recipe RAG Agent created successfully!\n",
"The agent is ready to answer questions about Thai cooking.\n"
]
}
],
"source": [
"# Create the RAG agent\n",
"rag_agent = Agent(\n",
" instructions=AGENT_INSTRUCTIONS,\n",
" llm=\"gpt-4o\",\n",
" markdown=True,\n",
" verbose=True\n",
")\n",
"\n",
"print(\"🤖 Thai Recipe RAG Agent created successfully!\")\n",
"print(\"The agent is ready to answer questions about Thai cooking.\")"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "QvZM94pGU0IX"
},
"source": [
"# Test the Agent"
]
},
{
"cell_type": "code",
"execution_count": 6,
"metadata": {
"colab": {
"base_uri": "https://localhost:8080/",
"height": 1000,
"referenced_widgets": [
"47739975c9f04ee5b4e69e8f445cbeda",
"08888d583cba4c01b3fdf8f30b06ca4f"
]
},
"id": "QPdrleKxU1VN",
"outputId": "a71a86cd-eff8-4309-9b50-173a30066c90"
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"🤔 Question: What are the essential ingredients for Thai cooking?\n"
]
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">╭─ </span><span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8; font-weight: bold\">Agent Info</span><span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\"> ────────────────────────────────────────────────────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span> <span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span> <span style=\"color: #ff9b9b; text-decoration-color: #ff9b9b; font-weight: bold\">👤 Agent:</span> <span style=\"color: #ffe5e5; text-decoration-color: #ffe5e5\">Agent</span> <span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span> <span style=\"color: #b4b4b3; text-decoration-color: #b4b4b3; font-weight: bold\">Role:</span> <span style=\"color: #ffe5e5; text-decoration-color: #ffe5e5\">Assistant</span> <span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span> <span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[38;2;210;227;200m╭─\u001b[0m\u001b[38;2;210;227;200m \u001b[0m\u001b[1;38;2;210;227;200mAgent Info\u001b[0m\u001b[38;2;210;227;200m \u001b[0m\u001b[38;2;210;227;200m───────────────────────────────────────────────────────────────────────────────────────────────────\u001b[0m\u001b[38;2;210;227;200m─╮\u001b[0m\n",
"\u001b[38;2;210;227;200m│\u001b[0m \u001b[38;2;210;227;200m│\u001b[0m\n",
"\u001b[38;2;210;227;200m│\u001b[0m \u001b[1;38;2;255;155;155m👤 Agent:\u001b[0m \u001b[38;2;255;229;229mAgent\u001b[0m \u001b[38;2;210;227;200m│\u001b[0m\n",
"\u001b[38;2;210;227;200m│\u001b[0m \u001b[1;38;2;180;180;179mRole:\u001b[0m \u001b[38;2;255;229;229mAssistant\u001b[0m \u001b[38;2;210;227;200m│\u001b[0m\n",
"\u001b[38;2;210;227;200m│\u001b[0m \u001b[38;2;210;227;200m│\u001b[0m\n",
"\u001b[38;2;210;227;200m╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "47739975c9f04ee5b4e69e8f445cbeda",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"Output()"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"></pre>\n"
],
"text/plain": []
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",
"</pre>\n"
],
"text/plain": [
"\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">Response generated in 8.4s</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[2mResponse generated in 8.4s\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #008080; text-decoration-color: #008080\">╭───────────────────────────────────────────────────── Task ──────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> What are the essential ingredients for Thai cooking? <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[36m╭─\u001b[0m\u001b[36m────────────────────────────────────────────────────\u001b[0m\u001b[36m Task \u001b[0m\u001b[36m─────────────────────────────────────────────────────\u001b[0m\u001b[36m─╮\u001b[0m\n",
"\u001b[36m│\u001b[0m What are the essential ingredients for Thai cooking? \u001b[36m│\u001b[0m\n",
"\u001b[36m╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #008080; text-decoration-color: #008080\">╭─────────────────────────────────────────────────── Response ────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> Thai cooking is known for its balance of five fundamental taste senses in each dish or the overall meal: sour, <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> sweet, salty, bitter, and spicy. Essential ingredients that help achieve this balance include: <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 1 </span><span style=\"font-weight: bold\">Fish Sauce (Nam Pla)</span>: A salty, savory sauce made from fermented fish. It's a cornerstone of Thai cooking, <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>used to add depth of flavor. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 2 </span><span style=\"font-weight: bold\">Lime Juice</span>: Used to add a fresh, tangy citrus flavor to dishes, especially in salads and some curries. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 3 </span><span style=\"font-weight: bold\">Chilies</span>: Thai cuisine often features fresh Thai bird's eye chilies for heat, as well as dried chilies for <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>certain recipes. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 4 </span><span style=\"font-weight: bold\">Lemongrass</span>: A citrusy, fragrant herb that is often used in soups, curries, and teas. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 5 </span><span style=\"font-weight: bold\">Galangal</span>: Similar to ginger, galangal has a sharp, peppery flavor and is used in soups and curries. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 6 </span><span style=\"font-weight: bold\">Kaffir Lime Leaves</span>: They add a distinct, zesty citrus aroma and flavor to Thai dishes. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 7 </span><span style=\"font-weight: bold\">Coconut Milk</span>: Adds richness and creaminess, commonly used in curries and desserts. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 8 </span><span style=\"font-weight: bold\">Palm Sugar</span>: Used as a sweetener, palm sugar has a nuanced flavor, unlike regular sugar. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 9 </span><span style=\"font-weight: bold\">Tamarind Paste</span>: Provides a sour element to many dishes, particularly pad Thai and some sauces. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 10 </span><span style=\"font-weight: bold\">Thai Basil</span>: Adds a spicy, peppery flavor, different from the sweet basil used in Western cooking. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 11 </span><span style=\"font-weight: bold\">Coriander (Cilantro)</span>: Used as a garnish and for its fresh, citrusy leaves and roots, which add depth to <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>sauces and stocks. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> 12 </span><span style=\"font-weight: bold\">Shrimp Paste</span>: A very pungent paste made from fermented shrimp, used sparingly to enrich the flavor of <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>dishes. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> These ingredients are commonly used in combination to create the complex and rich flavors characteristic of <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> Thai cuisine. Fresh and high-quality versions of these ingredients contribute significantly to the authenticity <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> of Thai dishes. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[36m╭─\u001b[0m\u001b[36m──────────────────────────────────────────────────\u001b[0m\u001b[36m Response \u001b[0m\u001b[36m───────────────────────────────────────────────────\u001b[0m\u001b[36m─╮\u001b[0m\n",
"\u001b[36m│\u001b[0m Thai cooking is known for its balance of five fundamental taste senses in each dish or the overall meal: sour, \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m sweet, salty, bitter, and spicy. Essential ingredients that help achieve this balance include: \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 1 \u001b[0m\u001b[1mFish Sauce (Nam Pla)\u001b[0m: A salty, savory sauce made from fermented fish. It's a cornerstone of Thai cooking, \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0mused to add depth of flavor. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 2 \u001b[0m\u001b[1mLime Juice\u001b[0m: Used to add a fresh, tangy citrus flavor to dishes, especially in salads and some curries. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 3 \u001b[0m\u001b[1mChilies\u001b[0m: Thai cuisine often features fresh Thai bird's eye chilies for heat, as well as dried chilies for \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0mcertain recipes. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 4 \u001b[0m\u001b[1mLemongrass\u001b[0m: A citrusy, fragrant herb that is often used in soups, curries, and teas. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 5 \u001b[0m\u001b[1mGalangal\u001b[0m: Similar to ginger, galangal has a sharp, peppery flavor and is used in soups and curries. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 6 \u001b[0m\u001b[1mKaffir Lime Leaves\u001b[0m: They add a distinct, zesty citrus aroma and flavor to Thai dishes. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 7 \u001b[0m\u001b[1mCoconut Milk\u001b[0m: Adds richness and creaminess, commonly used in curries and desserts. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 8 \u001b[0m\u001b[1mPalm Sugar\u001b[0m: Used as a sweetener, palm sugar has a nuanced flavor, unlike regular sugar. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 9 \u001b[0m\u001b[1mTamarind Paste\u001b[0m: Provides a sour element to many dishes, particularly pad Thai and some sauces. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 10 \u001b[0m\u001b[1mThai Basil\u001b[0m: Adds a spicy, peppery flavor, different from the sweet basil used in Western cooking. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 11 \u001b[0m\u001b[1mCoriander (Cilantro)\u001b[0m: Used as a garnish and for its fresh, citrusy leaves and roots, which add depth to \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0msauces and stocks. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m 12 \u001b[0m\u001b[1mShrimp Paste\u001b[0m: A very pungent paste made from fermented shrimp, used sparingly to enrich the flavor of \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0mdishes. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m These ingredients are commonly used in combination to create the complex and rich flavors characteristic of \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m Thai cuisine. Fresh and high-quality versions of these ingredients contribute significantly to the authenticity \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m of Thai dishes. \u001b[36m│\u001b[0m\n",
"\u001b[36m╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"�� Answer: Thai cooking is known for its balance of five fundamental taste senses in each dish or the overall meal: sour, sweet, salty, bitter, and spicy. Essential ingredients that help achieve this balance include:\n",
"\n",
"1. **Fish Sauce (Nam Pla)**: A salty, savory sauce made from fermented fish. It's a cornerstone of Thai cooking, used to add depth of flavor.\n",
"\n",
"2. **Lime Juice**: Used to add a fresh, tangy citrus flavor to dishes, especially in salads and some curries.\n",
"\n",
"3. **Chilies**: Thai cuisine often features fresh Thai bird's eye chilies for heat, as well as dried chilies for certain recipes.\n",
"\n",
"4. **Lemongrass**: A citrusy, fragrant herb that is often used in soups, curries, and teas.\n",
"\n",
"5. **Galangal**: Similar to ginger, galangal has a sharp, peppery flavor and is used in soups and curries.\n",
"\n",
"6. **Kaffir Lime Leaves**: They add a distinct, zesty citrus aroma and flavor to Thai dishes.\n",
"\n",
"7. **Coconut Milk**: Adds richness and creaminess, commonly used in curries and desserts.\n",
"\n",
"8. **Palm Sugar**: Used as a sweetener, palm sugar has a nuanced flavor, unlike regular sugar.\n",
"\n",
"9. **Tamarind Paste**: Provides a sour element to many dishes, particularly pad Thai and some sauces.\n",
"\n",
"10. **Thai Basil**: Adds a spicy, peppery flavor, different from the sweet basil used in Western cooking.\n",
"\n",
"11. **Coriander (Cilantro)**: Used as a garnish and for its fresh, citrusy leaves and roots, which add depth to sauces and stocks.\n",
"\n",
"12. **Shrimp Paste**: A very pungent paste made from fermented shrimp, used sparingly to enrich the flavor of dishes.\n",
"\n",
"These ingredients are commonly used in combination to create the complex and rich flavors characteristic of Thai cuisine. Fresh and high-quality versions of these ingredients contribute significantly to the authenticity of Thai dishes.\n"
]
}
],
"source": [
"# Test question 1: Basic Thai cooking\n",
"question1 = \"What are the essential ingredients for Thai cooking?\"\n",
"print(f\"🤔 Question: {question1}\")\n",
"\n",
"try:\n",
" response1 = rag_agent.start(question1)\n",
" print(f\"�� Answer: {response1}\")\n",
"except Exception as e:\n",
" print(f\"❌ Error: {e}\")"
]
}
],
"metadata": {
"colab": {
"provenance": []
},
"kernelspec": {
"display_name": "Python 3",
"name": "python3"
},
"language_info": {
"name": "python"
}
},
"nbformat": 4,
"nbformat_minor": 0
}
@@ -0,0 +1,556 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {
"id": "EA8l4cSVl3Lx"
},
"source": [
"# Agentic RAG with GPT-5 - Colab Notebook"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "I-8nOxJ2l7nO"
},
"source": [
"This Colab notebook sets up a Streamlit app using PraisonAI Agents framework.\n",
"It allows you to interact with an AI agent powered by GPT-5 for Q&A.\n",
"Currently, the knowledge base functionality is disabled due to compatibility issues."
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "g5I1tMkxmDQe"
},
"source": [
"- GPT-5 Integration (via OpenAI API)\n",
"- Streamlit Web App\n",
"- Agent Framework: PraisonAI Agents\n",
"- Markdown-formatted responses"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "yeEno7U0q2U_"
},
"source": [
"[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/Dhivya-Bharathy/PraisonAI/blob/main/examples/cookbooks/Qwen2.5_InstructionAgent.ipynb)\n"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "WV2GnzZCmGBR"
},
"source": [
"# Dependencies"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"id": "20wAadXemJ0k"
},
"outputs": [],
"source": [
"!pip install praisonaiagents python-dotenv streamlit"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "l71uCRarndvy"
},
"source": [
"# Set API Key"
]
},
{
"cell_type": "code",
"execution_count": 4,
"metadata": {
"id": "brfc-ZZKnfre"
},
"outputs": [],
"source": [
"import os\n",
"from dotenv import load_dotenv\n",
"\n",
"load_dotenv()\n",
"\n",
"OPENAI_API_KEY = \"Enter your api key here\"\n",
"\n",
"os.environ[\"OPENAI_API_KEY\"] = OPENAI_API_KEY\n"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "d1fGzyQCn1aQ"
},
"source": [
"# Tools and Imports"
]
},
{
"cell_type": "code",
"execution_count": 5,
"metadata": {
"id": "GcNPLkZXntIS"
},
"outputs": [],
"source": [
"import streamlit as st\n",
"from praisonaiagents import Agent\n",
"\n",
"# YAML Prompt Configuration\n",
"agent_config = {\n",
" \"name\": \"Knowledge Agent\",\n",
" \"instructions\": [\n",
" \"You are a helpful AI assistant. Answer questions based on your general knowledge.\",\n",
" \"Provide clear, well-structured answers in markdown format.\",\n",
" \"Use proper markdown formatting with headers, lists, and emphasis where appropriate.\",\n",
" \"Structure your response with clear sections and bullet points when helpful.\",\n",
" ],\n",
" \"llm\": \"gpt-5-nano\",\n",
" \"markdown\": True,\n",
" \"verbose\": True\n",
"}\n"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "jkmrh0gIn_4a"
},
"source": [
"# Initialize Agent"
]
},
{
"cell_type": "code",
"execution_count": 6,
"metadata": {
"id": "qaJvf8RyoAsB"
},
"outputs": [],
"source": [
"def create_agent():\n",
" \"\"\"Create an agent with reasoning capabilities\"\"\"\n",
" return Agent(\n",
" name=agent_config[\"name\"],\n",
" instructions=agent_config[\"instructions\"],\n",
" llm=agent_config[\"llm\"],\n",
" markdown=agent_config[\"markdown\"],\n",
" verbose=agent_config[\"verbose\"]\n",
" )"
]
},
{
"cell_type": "markdown",
"metadata": {
"id": "kvGJh3bbqTmh"
},
"source": [
"# Main Function"
]
},
{
"cell_type": "code",
"execution_count": 7,
"metadata": {
"colab": {
"base_uri": "https://localhost:8080/",
"height": 1000,
"referenced_widgets": [
"ad296d97510246de8eb0138ce8a8a166",
"f6e502b3dca442f0ae6c5739f5a6d159"
]
},
"id": "_QyxzqKKqUrW",
"outputId": "97be7e02-b034-4004-e9e3-56337e3f2887"
},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"�� Initializing Agentic RAG with GPT-5...\n",
"📚 Loading agent...\n",
"✅ Agent loaded successfully!\n",
"\n",
"🎯 Example queries you can try:\n",
"1. What is PraisonAI and how do Agents work?\n",
"2. What are Teams in PraisonAI and how do they work?\n",
"3. Give me a step-by-step guide to building a RAG system.\n",
"4. What are AI Agents?\n",
"\n",
"============================================================\n",
"\n",
"🤔 Enter your question (or 'quit' to exit):\n",
"> What is PraisonAI and how do Agents work?\n",
"🔍 Processing your question...\n"
]
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">╭─ </span><span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8; font-weight: bold\">Agent Info</span><span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\"> ────────────────────────────────────────────────────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span> <span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span> <span style=\"color: #ff9b9b; text-decoration-color: #ff9b9b; font-weight: bold\">👤 Agent:</span> <span style=\"color: #ffe5e5; text-decoration-color: #ffe5e5\">Knowledge Agent</span> <span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span> <span style=\"color: #b4b4b3; text-decoration-color: #b4b4b3; font-weight: bold\">Role:</span> <span style=\"color: #ffe5e5; text-decoration-color: #ffe5e5\">Assistant</span> <span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span> <span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">│</span>\n",
"<span style=\"color: #d2e3c8; text-decoration-color: #d2e3c8\">╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[38;2;210;227;200m╭─\u001b[0m\u001b[38;2;210;227;200m \u001b[0m\u001b[1;38;2;210;227;200mAgent Info\u001b[0m\u001b[38;2;210;227;200m \u001b[0m\u001b[38;2;210;227;200m───────────────────────────────────────────────────────────────────────────────────────────────────\u001b[0m\u001b[38;2;210;227;200m─╮\u001b[0m\n",
"\u001b[38;2;210;227;200m│\u001b[0m \u001b[38;2;210;227;200m│\u001b[0m\n",
"\u001b[38;2;210;227;200m│\u001b[0m \u001b[1;38;2;255;155;155m👤 Agent:\u001b[0m \u001b[38;2;255;229;229mKnowledge Agent\u001b[0m \u001b[38;2;210;227;200m│\u001b[0m\n",
"\u001b[38;2;210;227;200m│\u001b[0m \u001b[1;38;2;180;180;179mRole:\u001b[0m \u001b[38;2;255;229;229mAssistant\u001b[0m \u001b[38;2;210;227;200m│\u001b[0m\n",
"\u001b[38;2;210;227;200m│\u001b[0m \u001b[38;2;210;227;200m│\u001b[0m\n",
"\u001b[38;2;210;227;200m╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"application/vnd.jupyter.widget-view+json": {
"model_id": "ad296d97510246de8eb0138ce8a8a166",
"version_major": 2,
"version_minor": 0
},
"text/plain": [
"Output()"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"></pre>\n"
],
"text/plain": []
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\">\n",
"</pre>\n"
],
"text/plain": [
"\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #7f7f7f; text-decoration-color: #7f7f7f\">Response generated in 9.4s</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[2mResponse generated in 9.4s\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #008080; text-decoration-color: #008080\">╭───────────────────────────────────────────────────── Task ──────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> What is PraisonAI and how do Agents work? <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[36m╭─\u001b[0m\u001b[36m────────────────────────────────────────────────────\u001b[0m\u001b[36m Task \u001b[0m\u001b[36m─────────────────────────────────────────────────────\u001b[0m\u001b[36m─╮\u001b[0m\n",
"\u001b[36m│\u001b[0m What is PraisonAI and how do Agents work? \u001b[36m│\u001b[0m\n",
"\u001b[36m╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"data": {
"text/html": [
"<pre style=\"white-space:pre;overflow-x:auto;line-height:normal;font-family:Menlo,'DejaVu Sans Mono',consolas,'Courier New',monospace\"><span style=\"color: #008080; text-decoration-color: #008080\">╭─────────────────────────────────────────────────── Response ────────────────────────────────────────────────────╮</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> ┃ <span style=\"font-weight: bold\">What is PraisonAI?</span> ┃ <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> PraisonAI is a platform designed to leverage artificial intelligence to enhance personal and business <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> productivity. It typically involves developing AI models that can assist in various tasks, automate processes, <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> and provide insights based on data analysis. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"font-weight: bold; text-decoration: underline\">Key Features of PraisonAI</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Task Automation</span>: Automates repetitive tasks, allowing users to focus on more strategic activities. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Data Insights</span>: Analyzes large sets of data to provide actionable insights. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Natural Language Processing</span>: Enables users to interact with the AI through natural language, making it <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>user-friendly. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Customizable Solutions</span>: Tailors AI applications to meet specific user needs across various industries. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> ┃ <span style=\"font-weight: bold\">How Do Agents Work in PraisonAI?</span> ┃ <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> Agents in PraisonAI refer to autonomous or semi-autonomous AI systems that perform designated tasks or <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> functions. Here’s how they typically operate: <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"font-weight: bold; text-decoration: underline\">1. Types of Agents</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Reactive Agents</span>: Respond to the current environment without internal memory. They act solely based on <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>current inputs. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Deliberative Agents</span>: Have a model of their environment, plan their actions, and retain memories of past <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>interactions. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Learning Agents</span>: Improve their performance over time through experience, adapting to new information. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"font-weight: bold; text-decoration: underline\">2. Functionality of Agents</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Task Execution</span>: Agents can carry out specific tasks as programmed, such as scheduling, data entry, or <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>customer support. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Interaction</span>: They often interact with users through chat interfaces or APIs, providing a seamless user <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>experience. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Integration</span>: Can be integrated with other systems or software to enhance functionality, such as CRM systems, <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>databases, or other AI tools. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Continuous Learning</span>: Agents may utilize machine learning algorithms to adapt and evolve based on user <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> </span>interactions and data received. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"font-weight: bold; text-decoration: underline\">3. Benefits of Using Agents</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Increased Efficiency</span>: Automate routine tasks to reduce workload. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">24/7 Availability</span>: Provide consistent support and functionality without downtime. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Scalability</span>: Easily scale operations by deploying more agents as needed. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #808000; text-decoration-color: #808000; font-weight: bold\"> • </span><span style=\"font-weight: bold\">Data-Driven Decisions</span>: Use data insights to inform strategy and operations. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"font-weight: bold; text-decoration: underline\">Conclusion</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> PraisonAI represents a robust platform for enhancing productivity through AI, with agents serving as the heart <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> of this solution, performing various tasks and supporting users in achieving their goals efficiently. Whether <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> they are simple reactive agents or complex learning entities, their design focuses on making operations <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">│</span> smoother and more effective. <span style=\"color: #008080; text-decoration-color: #008080\">│</span>\n",
"<span style=\"color: #008080; text-decoration-color: #008080\">╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯</span>\n",
"</pre>\n"
],
"text/plain": [
"\u001b[36m╭─\u001b[0m\u001b[36m──────────────────────────────────────────────────\u001b[0m\u001b[36m Response \u001b[0m\u001b[36m───────────────────────────────────────────────────\u001b[0m\u001b[36m─╮\u001b[0m\n",
"\u001b[36m│\u001b[0m ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m ┃ \u001b[1mWhat is PraisonAI?\u001b[0m ┃ \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m PraisonAI is a platform designed to leverage artificial intelligence to enhance personal and business \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m productivity. It typically involves developing AI models that can assist in various tasks, automate processes, \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m and provide insights based on data analysis. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;4mKey Features of PraisonAI\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mTask Automation\u001b[0m: Automates repetitive tasks, allowing users to focus on more strategic activities. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mData Insights\u001b[0m: Analyzes large sets of data to provide actionable insights. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mNatural Language Processing\u001b[0m: Enables users to interact with the AI through natural language, making it \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0muser-friendly. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mCustomizable Solutions\u001b[0m: Tailors AI applications to meet specific user needs across various industries. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓ \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m ┃ \u001b[1mHow Do Agents Work in PraisonAI?\u001b[0m ┃ \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m ┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛ \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m Agents in PraisonAI refer to autonomous or semi-autonomous AI systems that perform designated tasks or \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m functions. Here’s how they typically operate: \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;4m1. \u001b[0m\u001b[1;4mTypes of Agents\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mReactive Agents\u001b[0m: Respond to the current environment without internal memory. They act solely based on \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0mcurrent inputs. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mDeliberative Agents\u001b[0m: Have a model of their environment, plan their actions, and retain memories of past \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0minteractions. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mLearning Agents\u001b[0m: Improve their performance over time through experience, adapting to new information. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;4m2. \u001b[0m\u001b[1;4mFunctionality of Agents\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mTask Execution\u001b[0m: Agents can carry out specific tasks as programmed, such as scheduling, data entry, or \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0mcustomer support. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mInteraction\u001b[0m: They often interact with users through chat interfaces or APIs, providing a seamless user \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0mexperience. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mIntegration\u001b[0m: Can be integrated with other systems or software to enhance functionality, such as CRM systems, \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0mdatabases, or other AI tools. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mContinuous Learning\u001b[0m: Agents may utilize machine learning algorithms to adapt and evolve based on user \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m \u001b[0minteractions and data received. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;4m3. \u001b[0m\u001b[1;4mBenefits of Using Agents\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mIncreased Efficiency\u001b[0m: Automate routine tasks to reduce workload. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1m24/7 Availability\u001b[0m: Provide consistent support and functionality without downtime. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mScalability\u001b[0m: Easily scale operations by deploying more agents as needed. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;33m • \u001b[0m\u001b[1mData-Driven Decisions\u001b[0m: Use data insights to inform strategy and operations. \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[1;4mConclusion\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m PraisonAI represents a robust platform for enhancing productivity through AI, with agents serving as the heart \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m of this solution, performing various tasks and supporting users in achieving their goals efficiently. Whether \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m they are simple reactive agents or complex learning entities, their design focuses on making operations \u001b[36m│\u001b[0m\n",
"\u001b[36m│\u001b[0m smoother and more effective. \u001b[36m│\u001b[0m\n",
"\u001b[36m╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯\u001b[0m\n"
]
},
"metadata": {},
"output_type": "display_data"
},
{
"name": "stdout",
"output_type": "stream",
"text": [
"\n",
"💡 Answer:\n",
"========================================\n",
"# What is PraisonAI?\n",
"\n",
"PraisonAI is a platform designed to leverage artificial intelligence to enhance personal and business productivity. It typically involves developing AI models that can assist in various tasks, automate processes, and provide insights based on data analysis.\n",
"\n",
"## Key Features of PraisonAI\n",
"\n",
"- **Task Automation**: Automates repetitive tasks, allowing users to focus on more strategic activities.\n",
"- **Data Insights**: Analyzes large sets of data to provide actionable insights.\n",
"- **Natural Language Processing**: Enables users to interact with the AI through natural language, making it user-friendly.\n",
"- **Customizable Solutions**: Tailors AI applications to meet specific user needs across various industries.\n",
"\n",
"# How Do Agents Work in PraisonAI?\n",
"\n",
"Agents in PraisonAI refer to autonomous or semi-autonomous AI systems that perform designated tasks or functions. Here’s how they typically operate:\n",
"\n",
"## 1. **Types of Agents**\n",
"\n",
"- **Reactive Agents**: Respond to the current environment without internal memory. They act solely based on current inputs.\n",
"- **Deliberative Agents**: Have a model of their environment, plan their actions, and retain memories of past interactions.\n",
"- **Learning Agents**: Improve their performance over time through experience, adapting to new information.\n",
"\n",
"## 2. **Functionality of Agents**\n",
"\n",
"- **Task Execution**: Agents can carry out specific tasks as programmed, such as scheduling, data entry, or customer support.\n",
"- **Interaction**: They often interact with users through chat interfaces or APIs, providing a seamless user experience.\n",
"- **Integration**: Can be integrated with other systems or software to enhance functionality, such as CRM systems, databases, or other AI tools.\n",
"- **Continuous Learning**: Agents may utilize machine learning algorithms to adapt and evolve based on user interactions and data received.\n",
"\n",
"## 3. **Benefits of Using Agents**\n",
"\n",
"- **Increased Efficiency**: Automate routine tasks to reduce workload.\n",
"- **24/7 Availability**: Provide consistent support and functionality without downtime.\n",
"- **Scalability**: Easily scale operations by deploying more agents as needed.\n",
"- **Data-Driven Decisions**: Use data insights to inform strategy and operations.\n",
"\n",
"## Conclusion\n",
"\n",
"PraisonAI represents a robust platform for enhancing productivity through AI, with agents serving as the heart of this solution, performing various tasks and supporting users in achieving their goals efficiently. Whether they are simple reactive agents or complex learning entities, their design focuses on making operations smoother and more effective.\n",
"========================================\n",
"\n",
"🤔 Enter your question (or 'quit' to exit):\n",
"> quit\n",
"👋 Goodbye!\n"
]
}
],
"source": [
"def main():\n",
" print(\"�� Initializing Agentic RAG with GPT-5...\")\n",
"\n",
" # Check if API key is set\n",
" if not OPENAI_API_KEY or OPENAI_API_KEY == \"your_openai_api_key_here\":\n",
" print(\"❌ Please set your OpenAI API key first!\")\n",
" print(\"�� Get your key from: https://platform.openai.com/\")\n",
" return\n",
"\n",
" try:\n",
" # Create agent\n",
" print(\"📚 Loading agent...\")\n",
" agent = create_agent()\n",
" print(\"✅ Agent loaded successfully!\")\n",
"\n",
" # Example queries\n",
" example_queries = [\n",
" \"What is PraisonAI and how do Agents work?\",\n",
" \"What are Teams in PraisonAI and how do they work?\",\n",
" \"Give me a step-by-step guide to building a RAG system.\",\n",
" \"What are AI Agents?\"\n",
" ]\n",
"\n",
" print(\"\\n🎯 Example queries you can try:\")\n",
" for i, query in enumerate(example_queries, 1):\n",
" print(f\"{i}. {query}\")\n",
"\n",
" print(\"\\n\" + \"=\"*60)\n",
"\n",
" # Interactive query loop\n",
" while True:\n",
" print(\"\\n🤔 Enter your question (or 'quit' to exit):\")\n",
" user_query = input(\"> \")\n",
"\n",
" if user_query.lower() in ['quit', 'exit', 'q']:\n",
" print(\"👋 Goodbye!\")\n",
" break\n",
"\n",
" if user_query.strip():\n",
" print(\"🔍 Processing your question...\")\n",
" try:\n",
" response = agent.start(user_query)\n",
" print(\"\\n💡 Answer:\")\n",
" print(\"=\"*40)\n",
" print(response)\n",
" print(\"=\"*40)\n",
" except Exception as e:\n",
" print(f\"❌ Error: {str(e)}\")\n",
" print(f\"🔍 Error type: {type(e).__name__}\")\n",
" print(\"💡 This might be due to API issues or model access problems.\")\n",
" else:\n",
" print(\"❌ Please enter a valid question.\")\n",
"\n",
" except Exception as e:\n",
" print(f\"❌ Failed to initialize agent: {str(e)}\")\n",
" print(\"�� Make sure your API key is correct and you have sufficient credits.\")\n",
"\n",
"# Run the main function\n",
"if __name__ == \"__main__\":\n",
" main()"
]
}
],
"metadata": {
"colab": {
"provenance": []
},
"kernelspec": {
"display_name": "Python 3",
"name": "python3"
},
"language_info": {
"name": "python"
}
},
"nbformat": 4,
"nbformat_minor": 0
}
@@ -0,0 +1,44 @@
from praisonaiagents import Agent
import os
# Set OpenAI API key if not already set
if not os.getenv("OPENAI_API_KEY"):
print("Please set your OpenAI API key: export OPENAI_API_KEY='your-api-key-here'")
exit(1)
# Create the RAG agent with web search capabilities
rag_agent = Agent(
instructions="""You are a helpful AI assistant specialized in Thai recipes and cooking.
You have access to a PDF knowledge base about Thai recipes from: https://phi-public.s3.amazonaws.com/recipes/ThaiRecipes.pdf
You can also search the web for additional information about Thai cooking, ingredients, and techniques.
When answering questions:
1. Use your knowledge about Thai cuisine to provide helpful information
2. If needed, search the web for additional details, current information, or clarification
3. Provide comprehensive, helpful answers about Thai cuisine
4. Always be informative and helpful about Thai cooking!
You can use the internet_search function to search the web when needed.""",
llm="gpt-4o",
markdown=True,
verbose=True
)
if __name__ == "__main__":
print("🤖 Thai Recipe RAG Agent is ready!")
print("Ask me anything about Thai recipes or cooking!")
print("Type 'quit' to exit.\n")
while True:
user_input = input("You: ")
if user_input.lower() in ['quit', 'exit', 'bye']:
print("👋 Goodbye! Happy cooking!")
break
try:
response = rag_agent.start(user_input)
print(f"\n🤖 Assistant: {response}\n")
except Exception as e:
print(f"❌ Error: {e}\n")
@@ -0,0 +1,154 @@
# 🧠 Agentic RAG with GPT-5
An agentic RAG application built with the PraisonAI Agents framework, featuring GPT-5 and built-in vector search for efficient knowledge retrieval and question answering.
## ✨ Features
- **🤖 GPT-5**: Latest OpenAI model for intelligent responses
- **🗄️ Built-in Vector Search**: ChromaDB integration for fast similarity search
- **🔍 Agentic RAG**: Intelligent retrieval augmented generation
- **📝 Markdown Formatting**: Beautiful, structured responses
- **🌐 Dynamic Knowledge**: Add URLs to expand knowledge base
- **⚡ Real-time Responses**: Fast answer generation- **🎯 Clean Interface**: Simplified UI without configuration complexity
## 🚀 Quick Start
### Prerequisites
- Python 3.11+
- OpenAI API key with GPT-5 access
### Installation
1. **Clone and navigate to the project**
```bash
cd rag_examples/agentic_rag_gpt5
```
2. **Install dependencies**
```bash
pip install -r requirements.txt
```
3. **Set up your OpenAI API key**
```bash
export OPENAI_API_KEY="your-api-key-here"
```
Or create a `.env` file:
```
OPENAI_API_KEY=your-api-key-here
```
4. **Run the application**
```bash
streamlit run agentic_rag_gpt5.py
```
## 🎯 How to Use
1. **Enter your OpenAI API key** in the sidebar
2. **Add knowledge sources** by entering URLs in the sidebar
3. **Ask questions** using the text area or suggested prompts
4. **Get answers** with markdown formatting
### Suggested Questions
- **"What is PraisonAI?"** - Learn about the PraisonAI Agents framework
- **"Teams in PraisonAI"** - Understand how teams work in PraisonAI
- **"Build RAG system"** - Get a step-by-step guide to building RAG systems
## 🏗️ Architecture
### Core Components
- **`Agent`**: PraisonAI Agents framework for intelligent Q&A
- **`knowledge`**: Built-in knowledge base that handles URLs and documents
- **`llm`**: OpenAI GPT-5-nano for generating responses
- **Built-in Vector Search**: Automatic similarity search without external setup
### Data Flow
1. **Knowledge Loading**: URLs are processed and stored in the built-in vector database
2. **Vector Search**: OpenAI embeddings enable semantic search
3. **Response Generation**: GPT-5-nano processes information and generates answers
4. **Formatted Output**: Markdown-formatted responses
## 🔧 Configuration
### Database Settings
- **Vector DB**: Built-in vector database with automatic indexing
- **Storage**: Local storage managed by PraisonAI Agents
- **Search**: Automatic similarity search
### Model Configuration
- **LLM**: OpenAI GPT-5-nano
- **Embeddings**: Automatic handling by PraisonAI Agents
- **Vector Store**: Built-in with automatic document processing
## 📚 Knowledge Management
### Adding Sources
- Use the sidebar to add new URLs
- Sources are automatically processed and indexed
- Current sources are displayed as numbered list
### Default Knowledge
- Starts with PraisonAI documentation: `https://docs.praisonai.com/introduction/agents.md`
- Expandable with any web-based documentation
## 🎨 UI Features
### Sidebar
- **API Key Management**: Secure input for OpenAI credentials
- **URL Addition**: Dynamic knowledge base expansion
- **Current Sources**: Numbered list of loaded URLs
### Main Interface
- **Suggested Prompts**: Quick access to common questions
- **Query Input**: Large text area for custom questions
- **Fast Responses**: Quick answer generation
- **Markdown Rendering**: Beautiful formatted responses
## 🛠️ Technical Details
### Dependencies
```
streamlit>=1.28.0
praisonaiagents>=0.1.0
openai>=1.0.0
python-dotenv>=1.0.0
```
### Key Features
- **Built-in Knowledge Base**: Automatic document processing and indexing
- **Vector Search**: Efficient similarity search with built-in database
- **Caching**: Efficient resource loading with Streamlit caching
- **Error Handling**: Graceful handling of API and processing errors
## 🔍 Troubleshooting
### Common Issues
**Knowledge base not loading**
- Check OpenAI API key is valid
- Ensure URLs are accessible
- Verify internet connection
**Agent initialization errors**
- Check if PraisonAI Agents is properly installed
- Verify OpenAI API key has sufficient credits
- Ensure Python version is 3.11+
### Performance Tips
- **Cache Resources**: Knowledge base and agent are cached for efficiency
- **Built-in Vector Search**: Fast similarity search without external setup
- **Local Storage**: Optimized local storage for optimal performance
## 🎯 Use Cases
- **Documentation Q&A**: Ask questions about technical documentation
- **Research Assistant**: Get answers from multiple knowledge sources
- **Learning Tool**: Interactive exploration of complex topics
- **Content Discovery**: Find relevant information across multiple sources
**Built with ❤️ using PraisonAI Agents and GPT-5**
@@ -0,0 +1,201 @@
import streamlit as st
import os
from praisonaiagents import Agent
from dotenv import load_dotenv
# Load environment variables
load_dotenv()
# Page configuration
st.set_page_config(
page_title="Agentic RAG with GPT-5",
page_icon="🧠",
layout="wide"
)
# Main title and description
st.title("🧠 Agentic RAG with GPT-5")
st.markdown("""
This app demonstrates an intelligent AI agent that:
1. **Answers** your questions clearly and concisely using GPT-5
⚠️ **Note**: Knowledge base functionality is temporarily disabled due to a compatibility issue with the current version of PraisonAI Agents.
Enter your OpenAI API key in the sidebar to get started!
""")
# Sidebar for API key and settings
with st.sidebar:
st.header("🔧 Configuration")
# OpenAI API Key
openai_key = st.text_input(
"OpenAI API Key",
type="password",
value=os.getenv("OPENAI_API_KEY", ""),
help="Get your key from https://platform.openai.com/"
)
# Add URLs to knowledge base
st.subheader("🌐 Add Knowledge Sources")
st.info("⚠️ Knowledge base functionality is temporarily disabled due to compatibility issues.")
new_url = st.text_input(
"Add URL",
placeholder="https://docs.praisonai.com/introduction",
help="Enter a URL to add to the knowledge base (currently disabled)"
)
if st.button("➕ Add URL", type="primary", disabled=True):
st.info("Knowledge base functionality is temporarily disabled.")
# Check if API key is provided
if openai_key:
# Initialize knowledge base (cached to avoid reloading)
@st.cache_resource(show_spinner="📚 Loading knowledge base...")
def load_knowledge() -> list:
"""Load and initialize the knowledge base with default URL"""
return ["https://docs.praisonai.com/introduction/agents.md"] # Default URL
# Initialize agent (cached to avoid reloading)
@st.cache_resource(show_spinner="🤖 Loading agent...")
def load_agent(_knowledge: list) -> Agent:
"""Create an agent with reasoning capabilities"""
# Note: Temporarily removed knowledge parameter to avoid rerank error
# TODO: Re-enable when PraisonAI Agents knowledge issue is resolved
return Agent(
name="Knowledge Agent",
instructions=[
"You are a helpful AI assistant. Answer questions based on your general knowledge.",
"Provide clear, well-structured answers in markdown format.",
"Use proper markdown formatting with headers, lists, and emphasis where appropriate.",
"Structure your response with clear sections and bullet points when helpful.",
],
llm="gpt-5-nano
markdown=True,
verbose=True
)
# Load knowledge and agent
knowledge = load_knowledge()
agent = load_agent(knowledge)
# Display current URLs in knowledge base
if knowledge:
st.sidebar.subheader("📚 Current Knowledge Sources")
for i, url in enumerate(knowledge, 1):
st.sidebar.markdown(f"{i}. {url}")
# Handle URL additions
if hasattr(st.session_state, 'urls_to_add') and st.session_state.urls_to_add:
with st.spinner("📥 Loading new documents..."):
knowledge.append(st.session_state.urls_to_add)
# Reinitialize agent with new knowledge
agent = load_agent(knowledge)
st.success(f"✅ Added: {st.session_state.urls_to_add}")
del st.session_state.urls_to_add
st.rerun()
# Main query section
st.divider()
st.subheader("🤔 Ask a Question")
# Suggested prompts
st.markdown("**Try these prompts:**")
col1, col2, col3 = st.columns(3)
with col1:
if st.button("What is PraisonAI?", use_container_width=True):
st.session_state.query = "What is PraisonAI and how do Agents work?"
with col2:
if st.button("Teams in PraisonAI", use_container_width=True):
st.session_state.query = "What are Teams in PraisonAI and how do they work?"
with col3:
if st.button("Build RAG system", use_container_width=True):
st.session_state.query = "Give me a step-by-step guide to building a RAG system."
# Query input
query = st.text_area(
"Your question:",
value=st.session_state.get("query", "What are AI Agents?"),
height=100,
help="Ask anything about the loaded knowledge sources"
)
# Run button
if st.button("🚀 Get Answer", type="primary"):
if query:
# Create container for answer
st.markdown("### 💡 Answer")
answer_container = st.container()
answer_placeholder = answer_container.empty()
# Get the agent's response
with st.spinner("🔍 Searching and generating answer..."):
try:
st.info("🤖 Agent is processing your question...")
response = agent.start(query)
answer_placeholder.markdown(
response,
unsafe_allow_html=True
)
except Exception as e:
st.error(f"Error getting response: {str(e)}")
st.error(f"Error type: {type(e).__name__}")
st.error(f"Full error details: {repr(e)}")
# Try to provide a helpful response
answer_placeholder.markdown("""
**⚠️ Error occurred while processing your question.**
This might be due to:
- Knowledge base configuration issues
- Model access problems
- Network connectivity issues
Please try again or check your OpenAI API key.
""")
else:
st.error("Please enter a question")
else:
# Show instructions if API key is missing
st.info("""
👋 **Welcome! To use this app, you need:**
- **OpenAI API Key** (set it in the sidebar)
- Sign up at [platform.openai.com](https://platform.openai.com/)
- Generate a new API key
Once you enter the key, the app will load the knowledge base and agent.
""")
# Footer with explanation
st.divider()
with st.expander("📖 How This Works"):
st.markdown("""
**This app uses the PraisonAI Agents framework to create an intelligent Q&A system:**
⚠️ **Current Status**: Knowledge base functionality is temporarily disabled due to compatibility issues with the current version of PraisonAI Agents (v0.0.157).
**What Works Now:**
1. **GPT-5 Integration**: OpenAI's GPT-5 model for generating intelligent responses
2. **Markdown Formatting**: Beautiful, structured responses
3. **Agent Framework**: PraisonAI Agents for orchestration
**What's Temporarily Disabled:**
- URL-based knowledge base
- Vector search and retrieval
- Document processing
**Key Components:**
- `Agent`: PraisonAI Agents framework for creating intelligent agents
- `llm`: OpenAI GPT-5-nano for generating responses
**Why PraisonAI Agents?**
- Easy-to-use agent framework
- Built-in error handling
- Clean API design
- Perfect for prototyping and production applications
**Next Steps:**
- Monitor PraisonAI Agents updates for knowledge base fixes
- Re-enable knowledge functionality when compatible version is available
""")
+725 -54
View File
@@ -1,83 +1,754 @@
# MCP SSE Server and Client Implementation
# PraisonAI Agents
This project demonstrates a working pattern for SSE-based MCP (Model Context Protocol) servers and clients. It consists of three main components:
A powerful Python framework for building AI agents with self-reflection, tool use, and multi-agent orchestration capabilities.
1. **server.py**: An SSE-based MCP server that provides simple tools
2. **client.py**: A standalone client that connects to the server and uses its tools with Claude
3. **mcp-sse.py**: A client using praisonaiagents that connects to the server and uses its tools with OpenAI
[![PyPI version](https://badge.fury.io/py/praisonaiagents.svg)](https://badge.fury.io/py/praisonaiagents)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
## Tools Provided by the Server
The server implements two simple tools:
- **get_greeting**: Returns a personalized greeting for a given name
- **get_weather**: Returns simulated weather data for a given city
## Setup and Usage
### Prerequisites
Make sure you have the required packages installed:
## Installation
```bash
pip install praisonaiagents mcp httpx starlette uvicorn anthropic python-dotenv
# Basic installation
pip install praisonaiagents
# With all features
pip install "praisonaiagents[all]"
# Specific features
pip install "praisonaiagents[memory]" # Memory support
pip install "praisonaiagents[knowledge]" # Knowledge base
pip install "praisonaiagents[mcp]" # Model Context Protocol
pip install "praisonaiagents[llm]" # LiteLLM support
pip install "praisonaiagents[mongodb]" # MongoDB integration
```
### Running the Server
## Quick Start
First, start the MCP SSE server:
### Basic Agent
```python
from praisonaiagents import Agent
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant.",
model="gpt-4o-mini"
)
response = agent.chat("What is the capital of France?")
print(response)
```
### Agent with Tools
```python
from praisonaiagents import Agent
def get_weather(city: str) -> str:
"""Get weather for a city."""
return f"Weather in {city}: Sunny, 22°C"
agent = Agent(
name="Weather Agent",
instructions="You help users check the weather.",
tools=[get_weather]
)
response = agent.chat("What's the weather in Paris?")
```
### Multi-Agent Workflow
```python
from praisonaiagents import Agent, Task, PraisonAIAgents
# Define agents
researcher = Agent(name="Researcher", instructions="Research topics thoroughly")
writer = Agent(name="Writer", instructions="Write clear, engaging content")
# Define tasks
research_task = Task(
description="Research AI trends in 2025",
agent=researcher,
expected_output="Research findings"
)
write_task = Task(
description="Write an article based on research",
agent=writer,
expected_output="Article draft"
)
# Run workflow
agents = PraisonAIAgents(agents=[researcher, writer], tasks=[research_task, write_task])
result = agents.start()
```
---
## Agent Types
### 1. Agent (Base)
The core agent class with self-reflection, tool use, and streaming support.
```python
from praisonaiagents import Agent
agent = Agent(
name="Assistant",
instructions="You are helpful.",
model="gpt-4o-mini",
verbose=True,
self_reflect=True, # Enable self-reflection
max_reflect=3 # Max reflection iterations
)
```
### 2. DeepResearchAgent 🆕
Automated research agent using OpenAI or Gemini Deep Research APIs with real-time streaming.
```python
from praisonaiagents import DeepResearchAgent
# OpenAI Deep Research
agent = DeepResearchAgent(
model="o4-mini-deep-research", # or "o3-deep-research"
verbose=True
)
result = agent.research("What are the latest AI trends?")
print(result.report)
print(f"Citations: {len(result.citations)}")
# Gemini Deep Research
agent = DeepResearchAgent(
model="deep-research-pro", # Auto-detected as Gemini
verbose=True
)
result = agent.research("Research quantum computing advances")
```
**Features:**
- **Multi-provider**: OpenAI, Gemini, and LiteLLM support
- **Auto-detection**: Provider detected from model name
- **Streaming**: Real-time progress with reasoning summaries (default: enabled)
- **Citations**: Structured citations with URLs
- **Tools**: Web search, code interpreter, MCP, file search
### 3. QueryRewriterAgent 🆕
Transform user queries to improve RAG retrieval quality using multiple strategies.
```python
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
agent = QueryRewriterAgent(model="gpt-4o-mini", verbose=True)
# Basic rewriting - expands abbreviations, adds context
result = agent.rewrite("AI trends")
print(result.primary_query)
# Output: "What are the current trends in Artificial Intelligence (AI)?"
# HyDE - generates hypothetical document for semantic matching
result = agent.rewrite("What is quantum computing?", strategy=RewriteStrategy.HYDE)
print(result.hypothetical_document)
# Step-back - generates broader context question
result = agent.rewrite("Difference between GPT-4 and Claude 3?", strategy=RewriteStrategy.STEP_BACK)
print(result.step_back_question)
# Sub-queries - decomposes complex questions
result = agent.rewrite("How to set up RAG and what embedding models to use?", strategy=RewriteStrategy.SUB_QUERIES)
print(result.sub_queries)
# Contextual - uses chat history to resolve references
result = agent.rewrite("What about its cost?", strategy=RewriteStrategy.CONTEXTUAL, chat_history=[...])
```
**Strategies:**
- **BASIC**: Expand abbreviations, fix typos, add context
- **HYDE**: Generate hypothetical document for better semantic matching
- **STEP_BACK**: Generate higher-level concept questions
- **SUB_QUERIES**: Decompose multi-part questions
- **MULTI_QUERY**: Generate multiple paraphrased versions
- **CONTEXTUAL**: Resolve references using conversation history
- **AUTO**: Automatically detect best strategy
### 4. ImageAgent
Agent specialized for image generation and analysis.
```python
from praisonaiagents import ImageAgent
agent = ImageAgent(
name="Artist",
instructions="Generate creative images"
)
result = agent.chat("Create an image of a sunset over mountains")
```
### 5. ContextAgent
Agent with persistent context across conversations.
```python
from praisonaiagents import ContextAgent
agent = ContextAgent(
name="Context Agent",
instructions="Remember our conversation"
)
```
### 6. RouterAgent
Routes requests to appropriate specialized agents.
```python
from praisonaiagents.agent import RouterAgent
router = RouterAgent(
agents=[weather_agent, math_agent, general_agent],
instructions="Route to the best agent for each query"
)
```
---
## Memory
Persistent memory with short-term, long-term, and graph memory support.
```python
from praisonaiagents import Agent, Memory
memory = Memory(
provider="chroma", # or "mongodb", "rag"
use_short_term=True,
use_long_term=True
)
agent = Agent(
name="Memory Agent",
memory=memory
)
```
**Memory Types:**
- **Short-term**: Recent conversation context
- **Long-term**: Persistent storage across sessions
- **Graph**: Relationship-based memory with Mem0
---
## Knowledge Base
Add documents and data sources to your agents.
```python
from praisonaiagents import Agent, Knowledge
knowledge = Knowledge(
sources=["docs/", "data.pdf", "https://example.com"],
chunking_method="semantic"
)
agent = Agent(
name="Knowledge Agent",
knowledge=knowledge
)
```
**Supported Sources:**
- PDF, Word, Excel, CSV files
- Directories of documents
- URLs and web pages
- Databases
---
## Tools
### Built-in Tools
```python
from praisonaiagents.tools import (
# Search
duckduckgo_search,
searxng_search,
# Data
read_csv, write_csv,
read_json, write_json,
read_yaml, write_yaml,
read_excel, write_excel,
# Finance
get_stock_price, get_stock_info,
# Research
arxiv_search,
wikipedia_search,
# Web
spider_scrape,
newspaper_extract,
# System
execute_shell,
run_python,
# Database
duckdb_query,
mongodb_query
)
```
### Custom Tools
```python
def my_tool(param: str) -> str:
"""Tool description for the agent."""
return f"Result: {param}"
agent = Agent(tools=[my_tool])
```
---
## MCP (Model Context Protocol)
Connect to MCP servers for extended capabilities.
```python
from praisonaiagents import Agent, MCP
# Local MCP server
agent = Agent(
tools=MCP(
command="npx",
args=["-y", "@modelcontextprotocol/server-filesystem", "/path"]
)
)
# Remote MCP server (SSE)
agent = Agent(
tools=MCP(url="http://localhost:8080/sse")
)
# With environment variables
agent = Agent(
tools=MCP(
command="npx",
args=["-y", "@modelcontextprotocol/server-brave-search"],
env={"BRAVE_API_KEY": "your-key"}
)
)
```
---
## Native Web Search
Enable real-time web search capabilities using LiteLLM's native web search.
```python
from praisonaiagents import Agent
# Enable web search with a supported model
agent = Agent(
name="Researcher",
instructions="You are a helpful research assistant.",
llm="openai/gpt-4o-search-preview",
web_search=True
)
result = agent.start("What are the latest developments in AI today?")
```
**Supported Providers:**
- **OpenAI**: `gpt-4o-search-preview`, `gpt-4o-mini-search-preview`
- **Anthropic**: `claude-3-5-sonnet-latest`, `claude-sonnet-4`
- **Google/Gemini**: `gemini-2.0-flash`, `gemini-2.5-pro`
- **xAI**: `grok-3`
- **Perplexity**: All models
---
## Web Fetch
Retrieve full content from specific URLs (Anthropic models only).
```python
from praisonaiagents import Agent
# Enable web fetch with an Anthropic model
agent = Agent(
name="Content Analyzer",
instructions="You can fetch and analyze web content.",
llm="anthropic/claude-sonnet-4-20250514",
web_fetch=True
)
result = agent.start("Fetch and summarize https://example.com")
```
**Web Fetch Options:**
```python
agent = Agent(
llm="anthropic/claude-sonnet-4-20250514",
web_fetch={
"max_uses": 10,
"allowed_domains": ["example.com"],
"citations": {"enabled": True}
}
)
```
---
## Prompt Caching
Reduce costs and latency by caching parts of prompts.
```python
from praisonaiagents import Agent
# Enable prompt caching for Anthropic models
agent = Agent(
name="Legal Analyst",
instructions="You are an AI assistant analyzing legal documents." * 50, # Long prompt
llm="anthropic/claude-3-5-sonnet-latest",
prompt_caching=True
)
# First call creates cache, subsequent calls use cached tokens
result = agent.start("Summarize the key terms")
```
**Supported Providers:**
- **OpenAI** (`openai/`) - Automatic caching for prompts ≥1024 tokens
- **Anthropic** (`anthropic/`) - Manual caching with `cache_control`
- **Bedrock** (`bedrock/`) - All models supporting prompt caching
- **Deepseek** (`deepseek/`) - Works like OpenAI
---
## Claude Memory Tool (Beta)
Enable Claude to store and retrieve information across conversations.
```python
from praisonaiagents import Agent
# Enable Claude memory (Anthropic models only)
agent = Agent(
name="Research Assistant",
llm="anthropic/claude-sonnet-4-20250514",
claude_memory=True
)
# Claude will automatically:
# 1. Check /memories directory before tasks
# 2. Store progress/learnings in files
# 3. Reference memories in future conversations
result = agent.start("Research AI trends and remember key findings")
```
**Features:**
- File-based persistent memory in `.praison/claude_memory/`
- Claude autonomously decides what to store/retrieve
- Supports: view, create, str_replace, insert, delete, rename commands
- Cross-conversation learning
**Supported Models:** Claude Sonnet 4, Claude Opus 4, Claude Haiku 4.5
---
## Memory (Zero Dependencies)
Enable persistent memory for agents without any extra packages.
```python
from praisonaiagents import Agent
# Simple: Enable file-based memory (no extra dependencies!)
agent = Agent(
name="Assistant",
memory=True # Uses FileMemory by default
)
# Store memories
agent.store_memory("User prefers dark mode", memory_type="short_term")
agent.store_memory("User's name is John", memory_type="long_term", importance=0.9)
# Get memory context for prompts
context = agent.get_memory_context(query="What does the user prefer?")
```
**Memory Types:**
- **Short-term**: Rolling buffer of recent context (auto-expires)
- **Long-term**: Persistent important facts
- **Entity**: People, places, organizations
- **Episodic**: Date-based interaction history
**Storage Providers:**
| Provider | Dependencies | Use Case |
|----------|-------------|----------|
| `memory=True` or `"file"` | None | Default, zero-config |
| `"sqlite"` | Built-in | Search, indexing |
| `"chromadb"` | chromadb | Semantic/vector search |
| `"mem0"` | mem0ai | Graph memory, cloud |
---
## Guardrails
Add safety checks and validation to agent responses.
```python
from praisonaiagents import Agent, LLMGuardrail
# LLM-based guardrail
guardrail = LLMGuardrail(
instructions="Ensure responses are professional and accurate"
)
agent = Agent(
name="Safe Agent",
guardrail=guardrail
)
```
---
## Handoffs
Transfer conversations between agents.
```python
from praisonaiagents import Agent, handoff
support_agent = Agent(name="Support", instructions="Handle support queries")
sales_agent = Agent(name="Sales", instructions="Handle sales queries")
# Enable handoffs
support_agent.handoffs = [handoff(sales_agent, "Transfer to sales")]
```
---
## Streaming
Real-time streaming responses.
```python
from praisonaiagents import Agent
agent = Agent(name="Streamer", verbose=True)
# Streaming is automatic with verbose=True
response = agent.chat("Tell me a story")
# Or use the stream method
for chunk in agent.stream("Tell me a story"):
print(chunk, end="", flush=True)
```
---
## Async Support
Full async/await support for all operations.
```python
import asyncio
from praisonaiagents import Agent
agent = Agent(name="Async Agent")
async def main():
response = await agent.achat("Hello!")
print(response)
asyncio.run(main())
```
---
## Telemetry
Built-in telemetry for monitoring and analytics.
```python
from praisonaiagents import enable_telemetry, disable_telemetry
# Enable full telemetry
enable_telemetry()
# Disable telemetry
disable_telemetry()
```
**Environment Variables:**
- `PRAISONAI_DISABLE_TELEMETRY=true` - Disable all telemetry
- `PRAISONAI_PERFORMANCE_MODE=true` - Minimal overhead mode
- `DO_NOT_TRACK=true` - Respect DNT preference
---
## Supported LLM Providers
PraisonAI Agents works with any LLM provider via LiteLLM:
| Provider | Model Example |
|----------|---------------|
| OpenAI | `gpt-4o`, `gpt-4o-mini`, `o1`, `o3` |
| Anthropic | `claude-3-5-sonnet`, `claude-3-opus` |
| Google | `gemini-2.0-flash`, `gemini-pro` |
| Ollama | `ollama/llama3`, `ollama/mistral` |
| Azure | `azure/gpt-4` |
| AWS Bedrock | `bedrock/claude-3` |
| Groq | `groq/llama3-70b` |
| Together | `together/mixtral-8x7b` |
```python
# Use any provider
agent = Agent(model="anthropic/claude-3-5-sonnet")
agent = Agent(model="ollama/llama3")
agent = Agent(model="gemini/gemini-2.0-flash")
```
---
## Configuration
### Environment Variables
```bash
python server.py
# API Keys
OPENAI_API_KEY=sk-...
ANTHROPIC_API_KEY=sk-ant-...
GEMINI_API_KEY=...
GOOGLE_API_KEY=...
# Logging
LOGLEVEL=DEBUG # DEBUG, INFO, WARNING, ERROR
# Telemetry
PRAISONAI_DISABLE_TELEMETRY=true
```
By default, the server runs on 0.0.0.0:8080, but you can customize the host and port:
---
```bash
python server.py --host 127.0.0.1 --port 8081
## Examples
### Research Agent with Citations
```python
from praisonaiagents import DeepResearchAgent
agent = DeepResearchAgent(
model="o4-mini-deep-research",
instructions="Provide data-rich insights with citations",
verbose=True
)
result = agent.research("Economic impact of AI on healthcare")
print(result.report)
for citation in result.citations:
print(f"- {citation.title}: {citation.url}")
```
### Running the Standalone Client
### Multi-Agent Research Team
The standalone client uses Claude to interact with the MCP server tools:
```python
from praisonaiagents import Agent, Task, PraisonAIAgents
```bash
# Set your Anthropic API key
export ANTHROPIC_API_KEY=your_api_key_here
researcher = Agent(
name="Researcher",
instructions="Research topics thoroughly",
tools=[duckduckgo_search]
)
# Run the client
python client.py http://0.0.0.0:8080/sse
analyst = Agent(
name="Analyst",
instructions="Analyze data and provide insights"
)
writer = Agent(
name="Writer",
instructions="Write clear reports"
)
tasks = [
Task(description="Research AI trends", agent=researcher),
Task(description="Analyze findings", agent=analyst),
Task(description="Write report", agent=writer)
]
team = PraisonAIAgents(agents=[researcher, analyst, writer], tasks=tasks)
result = team.start()
```
You'll see a prompt where you can type queries for Claude to process using the MCP tools.
### Agent with Memory and Knowledge
### Running the praisonaiagents Client
```python
from praisonaiagents import Agent, Memory, Knowledge
The praisonaiagents client uses OpenAI to interact with the MCP server tools:
```bash
# Set your OpenAI API key
export OPENAI_API_KEY=your_api_key_here
# Run the client
python mcp-sse.py
agent = Agent(
name="Smart Assistant",
memory=Memory(use_long_term=True),
knowledge=Knowledge(sources=["docs/"]),
instructions="Help users with their questions using available knowledge"
)
```
This will automatically send a query about the weather in Paris to the agent.
---
## How It Works
## API Reference
1. The server exposes MCP tools via an SSE endpoint
2. Clients connect to this endpoint and discover available tools
3. When a user makes a query, the client:
- For client.py: Uses Claude to determine which tool to call
- For mcp-sse.py: Uses OpenAI to determine which tool to call
4. The client executes the tool call against the server
5. The result is returned to the user
### Agent
This pattern allows for decoupled processes where the MCP server can run independently of clients, making it suitable for cloud-native applications.
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `name` | str | "Agent" | Agent name |
| `instructions` | str | "" | System instructions |
| `model` | str | "gpt-4o-mini" | LLM model |
| `tools` | list | [] | Available tools |
| `memory` | Memory | None | Memory instance |
| `knowledge` | Knowledge | None | Knowledge base |
| `verbose` | bool | False | Enable verbose output |
| `self_reflect` | bool | False | Enable self-reflection |
| `max_reflect` | int | 3 | Max reflection iterations |
## Customizing
### DeepResearchAgent
- To add more tools to the server, define new functions with the `@mcp.tool()` decorator in `server.py`
- To change the client's behavior, update the instructions and query in `mcp-sse.py`
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `model` | str | "o3-deep-research" | Research model |
| `provider` | str | None | Force provider (openai/gemini/litellm) |
| `verbose` | bool | True | Show progress |
| `poll_interval` | int | 5 | Gemini poll interval (seconds) |
| `max_wait_time` | int | 3600 | Max research time (seconds) |
### Task
| Parameter | Type | Default | Description |
|-----------|------|---------|-------------|
| `description` | str | required | Task description |
| `agent` | Agent | required | Assigned agent |
| `expected_output` | str | "" | Expected output format |
| `context` | list | [] | Context from other tasks |
---
## License
MIT License - see LICENSE file for details.
## Links
- [Documentation](https://docs.praison.ai)
- [GitHub](https://github.com/MervinPraison/PraisonAI)
- [PyPI](https://pypi.org/project/praisonaiagents/)
@@ -0,0 +1,48 @@
"""
Gemini Deep Research Agent Example
Uses Google's deep-research-pro model via the Interactions API
for automated research with web search.
Supports two modes:
1. Polling (default): Checks status periodically, shows progress logs
2. Streaming: Real-time output with thinking summaries (recommended)
Requirements:
- GEMINI_API_KEY or GOOGLE_API_KEY environment variable
- google-genai >= 1.55.0 (pip install google-genai)
"""
from dotenv import load_dotenv
load_dotenv()
from praisonaiagents import DeepResearchAgent
agent = DeepResearchAgent(
name="Gemini Researcher",
instructions="""
You are a professional researcher. Focus on:
- Comprehensive analysis with multiple perspectives
- Data-backed insights and trends
- Clear structure with executive summary
""",
model="deep-research-pro", # Auto-detected as Gemini
verbose=True,
)
print(f"Agent: {agent}")
print(f"Provider: {agent.provider}")
# Streaming is enabled by default for real-time progress updates
# This shows thinking summaries and streams the report as it's generated
result = agent.research(
"What is the current price of Ethereum?"
# stream=True is the default, set stream=False to disable
)
# The report is already printed during streaming when verbose=True
# But we can also access it programmatically:
print("\n" + "=" * 60)
print(f"Report length: {len(result.report)} characters")
print(f"Interaction ID: {result.interaction_id}")
print(f"Reasoning steps captured: {len(result.reasoning_steps)}")
print("=" * 60)
@@ -0,0 +1,47 @@
"""
OpenAI Deep Research Agent Example
Uses OpenAI's o3-deep-research or o4-mini-deep-research models
via the Responses API for automated research with web search.
Supports two modes:
1. Non-streaming (default): Waits for completion, returns full report
2. Streaming: Real-time progress with reasoning summaries and web searches
Requirements:
- OPENAI_API_KEY environment variable
"""
from dotenv import load_dotenv
load_dotenv()
from praisonaiagents import DeepResearchAgent
agent = DeepResearchAgent(
name="Research Assistant",
instructions="""
You are a professional researcher. Focus on:
- Data-rich insights with specific figures
- Reliable sources and citations
- Clear, structured responses
""",
model="o4-mini-deep-research", # or "o3-deep-research" for higher quality
verbose=True
)
print(f"Agent: {agent}")
print(f"Provider: {agent.provider}")
# Streaming is enabled by default for real-time progress updates
# Shows: reasoning summaries, web search queries, and report text as generated
result = agent.research(
"What is the current price of Bitcoin?"
# stream=True is the default, set stream=False to disable
)
# The report is already printed during streaming when verbose=True
# But we can also access it programmatically:
print("\n" + "=" * 60)
print(f"Report length: {len(result.report)} characters")
print(f"Citations: {len(result.citations)}")
print(f"Web searches: {len(result.web_searches)}")
print("=" * 60)
@@ -0,0 +1,94 @@
# PraisonAI Example Plugin
This is a template for creating tool plugins for PraisonAI Agents.
## Installation
```bash
# Install in development mode
pip install -e .
# Or install from PyPI (after publishing)
pip install praisonai-example-plugin
```
## Usage
After installation, tools are automatically discovered:
```python
from praisonaiagents import Agent
# Use tools by name - they're auto-discovered!
agent = Agent(
name="Assistant",
tools=["example_greet", "example_math", "example_reverse"]
)
# Or import and use directly
from praisonai_example_plugin import GreetTool, MathTool, reverse_text
agent = Agent(
name="Assistant",
tools=[GreetTool(), MathTool(), reverse_text]
)
```
## Creating Your Own Plugin
1. **Copy this template**
2. **Rename the package** in `pyproject.toml` and `src/` directory
3. **Add your tools** following the patterns in `__init__.py`
4. **Update entry_points** in `pyproject.toml` to register your tools
### Tool Patterns
**Class-based tool:**
```python
from praisonaiagents import BaseTool
class MyTool(BaseTool):
name = "my_tool"
description = "What this tool does"
def run(self, param: str) -> str:
return f"Result: {param}"
```
**Decorator-based tool:**
```python
from praisonaiagents import tool
@tool
def my_function(param: str) -> str:
"""What this function does."""
return f"Result: {param}"
```
### Registering Tools
In `pyproject.toml`:
```toml
[project.entry-points."praisonaiagents.tools"]
my_tool = "my_package:MyTool"
my_function = "my_package:my_function"
```
## Testing
```bash
pip install -e ".[dev]"
pytest
```
## Publishing
```bash
pip install build twine
python -m build
twine upload dist/*
```
## License
MIT
@@ -0,0 +1,49 @@
[build-system]
requires = ["setuptools>=61.0", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "praisonai-example-plugin"
version = "1.0.0"
description = "Example plugin for PraisonAI Agents - demonstrates tool plugin development"
readme = "README.md"
license = {text = "MIT"}
requires-python = ">=3.10"
authors = [
{name = "Your Name", email = "[email protected]"}
]
keywords = ["praisonai", "agents", "tools", "plugin"]
classifiers = [
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"License :: OSI Approved :: MIT License",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
]
dependencies = [
"praisonaiagents>=0.0.168",
]
[project.optional-dependencies]
dev = [
"pytest>=7.0.0",
"pytest-mock>=3.10.0",
]
# This is the key part - register your tools as entry points
# The format is: tool_name = "module.path:ClassName" or "module.path:function_name"
[project.entry-points."praisonaiagents.tools"]
example_greet = "praisonai_example_plugin:GreetTool"
example_math = "praisonai_example_plugin:MathTool"
example_reverse = "praisonai_example_plugin:reverse_text"
[project.urls]
Homepage = "https://github.com/yourusername/praisonai-example-plugin"
Documentation = "https://github.com/yourusername/praisonai-example-plugin#readme"
Repository = "https://github.com/yourusername/praisonai-example-plugin"
[tool.setuptools.packages.find]
where = ["src"]
@@ -0,0 +1,119 @@
"""PraisonAI Example Plugin - Demonstrates how to create tool plugins.
This package shows how external developers can create pip-installable
tool plugins for PraisonAI Agents.
Usage after installation:
from praisonaiagents import Agent
# Tools are auto-discovered via entry_points!
agent = Agent(tools=["example_greet", "example_math"])
# Or import directly
from praisonai_example_plugin import GreetTool, MathTool
agent = Agent(tools=[GreetTool(), MathTool()])
"""
from typing import Dict, Any
from praisonaiagents import BaseTool, tool
# =============================================================================
# Class-Based Tools
# =============================================================================
class GreetTool(BaseTool):
"""A tool that generates personalized greetings.
This demonstrates a simple class-based tool with multiple parameters.
"""
name = "example_greet"
description = "Generate a personalized greeting message"
version = "1.0.0"
def run(self, name: str, greeting: str = "Hello", punctuation: str = "!") -> str:
"""Generate a greeting.
Args:
name: The name of the person to greet
greeting: The greeting word (default: "Hello")
punctuation: End punctuation (default: "!")
Returns:
A formatted greeting string
"""
return f"{greeting}, {name}{punctuation}"
class MathTool(BaseTool):
"""A tool for basic mathematical operations.
Demonstrates returning structured data from a tool.
"""
name = "example_math"
description = "Perform basic math operations: add, subtract, multiply, divide"
version = "1.0.0"
def run(
self,
a: float,
b: float,
operation: str = "add"
) -> Dict[str, Any]:
"""Perform a math operation.
Args:
a: First number
b: Second number
operation: One of 'add', 'subtract', 'multiply', 'divide'
Returns:
Dict containing result and operation details
"""
ops = {
"add": ("+", lambda x, y: x + y),
"subtract": ("-", lambda x, y: x - y),
"multiply": ("*", lambda x, y: x * y),
"divide": ("/", lambda x, y: x / y if y != 0 else float('inf')),
}
if operation not in ops:
return {"error": f"Unknown operation: {operation}. Use: {list(ops.keys())}"}
symbol, func = ops[operation]
result = func(a, b)
return {
"result": result,
"expression": f"{a} {symbol} {b} = {result}",
"operation": operation
}
# =============================================================================
# Decorator-Based Tools
# =============================================================================
@tool(name="example_reverse", description="Reverse a string of text")
def reverse_text(text: str) -> str:
"""Reverse the input text.
Args:
text: The text to reverse
Returns:
The reversed text
"""
return text[::-1]
# =============================================================================
# Package Exports
# =============================================================================
__version__ = "1.0.0"
__all__ = [
"GreetTool",
"MathTool",
"reverse_text",
]
+8
View File
@@ -0,0 +1,8 @@
from praisonaiagents import Agent
agent = Agent(
instructions="You are a helpful assistant",
llm="gpt-5-nano"
)
agent.start("Why sky is Blue?")
agent.start("What was my previous question?")
+14
View File
@@ -0,0 +1,14 @@
from praisonaiagents import Agent
import asyncio
agent = Agent(
instructions="You are a helpful assistant",
llm="gpt-5-nano"
)
agent.run("Why sea is Blue?")
async def main():
await agent.arun("Why sky is Blue?")
await agent.arun("What was my previous question?")
asyncio.run(main())
@@ -15,9 +15,33 @@ _logging.configure_root_logger()
from .agent.agent import Agent
from .agent.image_agent import ImageAgent
from .agent.context_agent import ContextAgent, create_context_agent
from .agent.deep_research_agent import (
DeepResearchAgent,
DeepResearchResponse,
Citation,
ReasoningStep,
WebSearchCall,
CodeExecutionStep,
MCPCall,
FileSearchCall,
Provider
)
from .agent.query_rewriter_agent import (
QueryRewriterAgent,
RewriteStrategy,
RewriteResult
)
from .agent.prompt_expander_agent import (
PromptExpanderAgent,
ExpandStrategy,
ExpandResult
)
from .agents.agents import PraisonAIAgents
from .task.task import Task
from .tools.tools import Tools
from .tools.base import BaseTool, ToolResult, ToolValidationError, validate_tool
from .tools.decorator import tool, FunctionTool
from .tools.registry import get_registry, register_tool, get_tool, ToolRegistry
from .agents.autoagents import AutoAgents
from .knowledge.knowledge import Knowledge
from .knowledge.chunking import Chunking
@@ -154,6 +178,17 @@ __all__ = [
'Agents',
'Tools',
'Task',
# Plugin system
'BaseTool',
'ToolResult',
'ToolValidationError',
'validate_tool',
'tool',
'FunctionTool',
'ToolRegistry',
'get_registry',
'register_tool',
'get_tool',
'TaskOutput',
'ReflectionOutput',
'AutoAgents',
@@ -186,7 +221,22 @@ __all__ = [
'disable_performance_mode',
'cleanup_telemetry_resources',
'MinimalTelemetry',
'TelemetryCollector'
'TelemetryCollector',
'DeepResearchAgent',
'DeepResearchResponse',
'Citation',
'ReasoningStep',
'WebSearchCall',
'CodeExecutionStep',
'MCPCall',
'FileSearchCall',
'Provider',
'QueryRewriterAgent',
'RewriteStrategy',
'RewriteResult',
'PromptExpanderAgent',
'ExpandStrategy',
'ExpandResult'
]
# Add MCP to __all__ if available
@@ -4,5 +4,52 @@ from .image_agent import ImageAgent
from .context_agent import ContextAgent, create_context_agent
from .handoff import Handoff, handoff, handoff_filters, RECOMMENDED_PROMPT_PREFIX, prompt_with_handoff_instructions
from .router_agent import RouterAgent
from .deep_research_agent import (
DeepResearchAgent,
DeepResearchResponse,
Citation,
ReasoningStep,
WebSearchCall,
CodeExecutionStep,
MCPCall,
FileSearchCall,
Provider
)
from .query_rewriter_agent import (
QueryRewriterAgent,
RewriteStrategy,
RewriteResult
)
from .prompt_expander_agent import (
PromptExpanderAgent,
ExpandStrategy,
ExpandResult
)
__all__ = ['Agent', 'ImageAgent', 'ContextAgent', 'create_context_agent', 'Handoff', 'handoff', 'handoff_filters', 'RECOMMENDED_PROMPT_PREFIX', 'prompt_with_handoff_instructions', 'RouterAgent']
__all__ = [
'Agent',
'ImageAgent',
'ContextAgent',
'create_context_agent',
'Handoff',
'handoff',
'handoff_filters',
'RECOMMENDED_PROMPT_PREFIX',
'prompt_with_handoff_instructions',
'RouterAgent',
'DeepResearchAgent',
'DeepResearchResponse',
'Citation',
'ReasoningStep',
'WebSearchCall',
'CodeExecutionStep',
'MCPCall',
'FileSearchCall',
'Provider',
'QueryRewriterAgent',
'RewriteStrategy',
'RewriteResult',
'PromptExpanderAgent',
'ExpandStrategy',
'ExpandResult'
]
@@ -234,7 +234,11 @@ class Agent:
max_guardrail_retries: int = 3,
handoffs: Optional[List[Union['Agent', 'Handoff']]] = None,
base_url: Optional[str] = None,
api_key: Optional[str] = None
api_key: Optional[str] = None,
web_search: Optional[Union[bool, Dict[str, Any]]] = None,
web_fetch: Optional[Union[bool, Dict[str, Any]]] = None,
prompt_caching: Optional[bool] = None,
claude_memory: Optional[Union[bool, Any]] = None
):
"""Initialize an Agent instance.
@@ -400,7 +404,11 @@ class Agent:
model=model_name,
base_url=base_url,
api_key=api_key,
metrics=metrics
metrics=metrics,
web_search=web_search,
web_fetch=web_fetch,
prompt_caching=prompt_caching,
claude_memory=claude_memory
)
self._using_custom_llm = True
except ImportError as e:
@@ -435,6 +443,10 @@ class Agent:
if api_key:
llm_params['api_key'] = api_key
llm_params['metrics'] = metrics
llm_params['web_search'] = web_search
llm_params['web_fetch'] = web_fetch
llm_params['prompt_caching'] = prompt_caching
llm_params['claude_memory'] = claude_memory
self.llm_instance = LLM(**llm_params)
self._using_custom_llm = True
@@ -455,6 +467,15 @@ class Agent:
if callable(tools):
# If a single function/callable is passed, wrap it in a list
self.tools = [tools]
elif isinstance(tools, str):
# Single tool name string - resolve from registry
self.tools = self._resolve_tool_names([tools])
elif isinstance(tools, (list, tuple)):
# Check if list contains strings (tool names) that need resolution
if tools and all(isinstance(t, str) for t in tools):
self.tools = self._resolve_tool_names(tools)
else:
self.tools = list(tools)
else:
# Handle all falsy values (None, False, 0, "", etc.) by defaulting to empty list
self.tools = tools or []
@@ -462,7 +483,8 @@ class Agent:
self.max_iter = max_iter
self.max_rpm = max_rpm
self.max_execution_time = max_execution_time
self.memory = memory
self._memory_instance = None
self._init_memory(memory, user_id)
self.verbose = verbose
self.allow_delegation = allow_delegation
self.step_callback = step_callback
@@ -502,6 +524,23 @@ Your Goal: {self.goal}
# Store user_id
self.user_id = user_id or "praison"
self.reasoning_steps = reasoning_steps
self.web_search = web_search
self.web_fetch = web_fetch
self.prompt_caching = prompt_caching
self.claude_memory = claude_memory
# Handle web_search fallback: inject DuckDuckGo tool for unsupported models
if web_search and not self._model_supports_web_search():
from ..tools.duckduckgo_tools import internet_search
# Check if internet_search is not already in tools
tool_names = [getattr(t, '__name__', str(t)) for t in self.tools]
if 'internet_search' not in tool_names and 'duckduckgo' not in tool_names:
self.tools.append(internet_search)
logging.info("Model does not support native web search. Added DuckDuckGo fallback tool.")
# Log warning if web_fetch is enabled but model doesn't support it
if web_fetch and not self._model_supports_web_fetch():
logging.warning(f"Model '{self.llm}' does not support native web fetch. Web fetch will be ignored.")
# Initialize guardrail settings
self.guardrail = guardrail
@@ -567,6 +606,212 @@ Your Goal: {self.goal}
self._agent_id = str(uuid.uuid4())
return self._agent_id
def _model_supports_web_search(self) -> bool:
"""
Check if the agent's model supports native web search via LiteLLM.
Returns:
bool: True if the model supports native web search, False otherwise
"""
from ..llm.model_capabilities import supports_web_search
# Get the model name
if hasattr(self, 'llm_instance') and self.llm_instance:
model_name = self.llm_instance.model
elif hasattr(self, 'llm') and self.llm:
model_name = self.llm
else:
model_name = "gpt-5-nano"
return supports_web_search(model_name)
def _model_supports_web_fetch(self) -> bool:
"""
Check if the agent's model supports web fetch via LiteLLM.
Web fetch allows the model to retrieve full content from specific URLs.
Currently only supported by Anthropic Claude models.
Returns:
bool: True if the model supports web fetch, False otherwise
"""
from ..llm.model_capabilities import supports_web_fetch
# Get the model name
if hasattr(self, 'llm_instance') and self.llm_instance:
model_name = self.llm_instance.model
elif hasattr(self, 'llm') and self.llm:
model_name = self.llm
else:
model_name = "gpt-5-nano"
return supports_web_fetch(model_name)
def _model_supports_prompt_caching(self) -> bool:
"""
Check if the agent's model supports prompt caching via LiteLLM.
Prompt caching allows caching parts of prompts to reduce costs and latency.
Supported by OpenAI, Anthropic, Bedrock, and Deepseek.
Returns:
bool: True if the model supports prompt caching, False otherwise
"""
from ..llm.model_capabilities import supports_prompt_caching
# Get the model name
if hasattr(self, 'llm_instance') and self.llm_instance:
model_name = self.llm_instance.model
elif hasattr(self, 'llm') and self.llm:
model_name = self.llm
else:
model_name = "gpt-4o-mini"
return supports_prompt_caching(model_name)
def _init_memory(self, memory, user_id: Optional[str] = None):
"""
Initialize memory based on the memory parameter.
Args:
memory: Can be:
- True: Use FileMemory with default settings
- False/None: No memory
- "file": Use FileMemory
- "sqlite": Use existing Memory class with SQLite
- dict: Configuration for memory
- Memory/FileMemory instance: Use directly
user_id: User identifier for memory isolation
"""
self.memory = memory
if memory is None or memory is False:
self._memory_instance = None
return
# Determine user_id
mem_user_id = user_id or getattr(self, 'user_id', None) or "default"
if memory is True or memory == "file":
# Use FileMemory (zero dependencies)
from ..memory.file_memory import FileMemory
self._memory_instance = FileMemory(
user_id=mem_user_id,
verbose=1 if getattr(self, 'verbose', False) else 0
)
elif isinstance(memory, str) and memory in ("sqlite", "chromadb", "mem0", "mongodb"):
# Use full Memory class with specific provider
try:
from ..memory.memory import Memory
config = {"provider": memory if memory != "sqlite" else "rag"}
self._memory_instance = Memory(config)
except ImportError:
logging.warning(f"Memory provider '{memory}' requires additional dependencies. Falling back to FileMemory.")
from ..memory.file_memory import FileMemory
self._memory_instance = FileMemory(user_id=mem_user_id)
elif isinstance(memory, dict):
# Configuration dict
provider = memory.get("provider", "file")
if provider == "file":
from ..memory.file_memory import FileMemory
self._memory_instance = FileMemory(
user_id=memory.get("user_id", mem_user_id),
config=memory
)
else:
try:
from ..memory.memory import Memory
self._memory_instance = Memory(memory)
except ImportError:
logging.warning("Full Memory class requires additional dependencies. Falling back to FileMemory.")
from ..memory.file_memory import FileMemory
self._memory_instance = FileMemory(user_id=mem_user_id)
else:
# Assume it's already a memory instance
self._memory_instance = memory
def get_memory_context(self, query: Optional[str] = None) -> str:
"""
Get memory context for the current conversation.
Args:
query: Optional query to focus the context
Returns:
Formatted memory context string
"""
if not self._memory_instance:
return ""
if hasattr(self._memory_instance, 'get_context'):
return self._memory_instance.get_context(query=query)
return ""
def store_memory(self, content: str, memory_type: str = "short_term", **kwargs):
"""
Store content in memory.
Args:
content: Content to store
memory_type: Type of memory (short_term, long_term, entity, episodic)
**kwargs: Additional arguments for the memory method
"""
if not self._memory_instance:
return
if memory_type == "short_term" and hasattr(self._memory_instance, 'add_short_term'):
self._memory_instance.add_short_term(content, **kwargs)
elif memory_type == "long_term" and hasattr(self._memory_instance, 'add_long_term'):
self._memory_instance.add_long_term(content, **kwargs)
elif memory_type == "entity" and hasattr(self._memory_instance, 'add_entity'):
self._memory_instance.add_entity(content, **kwargs)
elif memory_type == "episodic" and hasattr(self._memory_instance, 'add_episodic'):
self._memory_instance.add_episodic(content, **kwargs)
def _display_memory_info(self):
"""Display memory information to user in a friendly format."""
if not self._memory_instance:
return
# Only display once per chat session
if hasattr(self, '_memory_displayed') and self._memory_displayed:
return
self._memory_displayed = True
stats = self._memory_instance.get_stats()
short_count = stats.get('short_term_count', 0)
long_count = stats.get('long_term_count', 0)
entity_count = stats.get('entity_count', 0)
storage_path = stats.get('storage_path', '')
total_memories = short_count + long_count + entity_count
if total_memories > 0:
from rich.panel import Panel
from rich.text import Text
# Build memory info text
info_parts = []
if long_count > 0:
info_parts.append(f"💾 {long_count} long-term")
if short_count > 0:
info_parts.append(f"⚡ {short_count} short-term")
if entity_count > 0:
info_parts.append(f"👤 {entity_count} entities")
memory_text = Text()
memory_text.append("🧠 Memory loaded: ", style="bold cyan")
memory_text.append(" | ".join(info_parts))
memory_text.append(f"\n📁 Storage: {storage_path}", style="dim")
self.console.print(Panel(
memory_text,
title="[bold]Agent Memory[/bold]",
border_style="cyan",
expand=False
))
@property
def llm_model(self):
"""Unified property to get the LLM model regardless of configuration type.
@@ -813,17 +1058,29 @@ Your Goal: {self.goal}
if not self.use_system_prompt:
return None
# Check cache first
tools_key = self._get_tools_cache_key(tools)
cache_key = f"{self.role}:{self.goal}:{tools_key}"
if cache_key in self._system_prompt_cache:
return self._system_prompt_cache[cache_key]
# Check cache first (skip cache if memory is enabled since context is dynamic)
if not self._memory_instance:
tools_key = self._get_tools_cache_key(tools)
cache_key = f"{self.role}:{self.goal}:{tools_key}"
if cache_key in self._system_prompt_cache:
return self._system_prompt_cache[cache_key]
else:
cache_key = None # Don't cache when memory is enabled
system_prompt = f"""{self.backstory}\n
Your Role: {self.role}\n
Your Goal: {self.goal}"""
# Add memory context if memory is enabled
if self._memory_instance:
memory_context = self.get_memory_context()
if memory_context:
system_prompt += f"\n\n## Memory (Information you remember about the user)\n{memory_context}"
# Display memory info to user if verbose
if self.verbose:
self._display_memory_info()
# Add tool usage instructions if tools are available
# Use provided tools or fall back to self.tools
tools_to_use = tools if tools is not None else self.tools
@@ -853,9 +1110,9 @@ Your Goal: {self.goal}"""
if tool_names:
system_prompt += f"\n\nYou have access to the following tools: {', '.join(tool_names)}. Use these tools when appropriate to help complete your tasks. Always use tools when they can help provide accurate information or perform actions."
# Cache the generated system prompt
# Cache the generated system prompt (only if cache_key is set, i.e., memory not enabled)
# Simple cache size limit to prevent unbounded growth
if len(self._system_prompt_cache) < self._max_cache_size:
if cache_key and len(self._system_prompt_cache) < self._max_cache_size:
self._system_prompt_cache[cache_key] = system_prompt
return system_prompt
@@ -1008,6 +1265,31 @@ Your Goal: {self.goal}"""
tools=self.tools
)
def _resolve_tool_names(self, tool_names):
"""Resolve tool names to actual tool instances from registry.
Args:
tool_names: List of tool name strings
Returns:
List of resolved tool instances
"""
resolved = []
try:
from ..tools.registry import get_registry
registry = get_registry()
for name in tool_names:
tool = registry.get(name)
if tool is not None:
resolved.append(tool)
else:
logging.warning(f"Tool '{name}' not found in registry")
except ImportError:
logging.warning("Tool registry not available, cannot resolve tool names")
return resolved
def _cast_arguments(self, func, arguments):
"""Cast arguments to their expected types based on function signature."""
if not callable(func) or not arguments:
@@ -1105,13 +1387,31 @@ Your Goal: {self.goal}"""
# Try to find the function in the agent's tools list first
func = None
for tool in self.tools if isinstance(self.tools, (list, tuple)) else []:
# Check for BaseTool instances (plugin system)
from ..tools.base import BaseTool
if isinstance(tool, BaseTool) and tool.name == function_name:
func = tool
break
# Check for FunctionTool (decorated functions)
if hasattr(tool, 'name') and getattr(tool, 'name', None) == function_name:
func = tool
break
if (callable(tool) and getattr(tool, '__name__', '') == function_name) or \
(inspect.isclass(tool) and tool.__name__ == function_name):
func = tool
break
if func is None:
# If not found in tools, try globals and main
# Check the global tool registry for plugins
try:
from ..tools.registry import get_registry
registry = get_registry()
func = registry.get(function_name)
except ImportError:
pass
if func is None:
# If not found in tools or registry, try globals and main
func = globals().get(function_name)
if not func:
import __main__
@@ -1119,6 +1419,12 @@ Your Goal: {self.goal}"""
if func:
try:
# BaseTool instances (plugin system) - call run() method
from ..tools.base import BaseTool
if isinstance(func, BaseTool):
casted_arguments = self._cast_arguments(func.run, arguments)
return func.run(**casted_arguments)
# Langchain: If it's a class with run but not _run, instantiate and call run
if inspect.isclass(func) and hasattr(func, 'run') and not hasattr(func, '_run'):
instance = func()
@@ -2082,13 +2388,17 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
display_error(f"Error in _achat_completion: {e}")
return None
async def arun(self, prompt: str, **kwargs):
"""Async alias for astart() method"""
return await self.astart(prompt, **kwargs)
async def astart(self, prompt: str, **kwargs):
"""Async version of start method"""
return await self.achat(prompt, **kwargs)
def run(self):
def run(self, prompt: str, **kwargs):
"""Alias for start() method"""
return self.start()
return self.start(prompt, **kwargs)
def start(self, prompt: str, **kwargs):
"""Start the agent with a prompt. This is a convenience method that wraps chat()."""
File diff suppressed because it is too large. Load diff
@@ -0,0 +1,367 @@
"""
Prompt Expander Agent Module
This module provides the PromptExpanderAgent class for expanding short prompts
into detailed, comprehensive prompts for better task execution.
Unlike QueryRewriterAgent (which optimizes queries for search/retrieval),
PromptExpanderAgent focuses on enriching prompts for task execution.
Supported Expansion Strategies:
- **BASIC**: Simple expansion with clarity improvements
- **DETAILED**: Rich expansion with context, constraints, and examples
- **STRUCTURED**: Expansion with clear structure (task, format, requirements)
- **CREATIVE**: Expansion with creative flair and vivid language
- **AUTO**: Automatically selects the best strategy based on prompt analysis
Example:
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
agent = PromptExpanderAgent(verbose=True)
# Basic expansion
result = agent.expand("write a movie script in 3 lines")
print(result.expanded_prompt)
# Detailed expansion
result = agent.expand("blog about AI", strategy=ExpandStrategy.DETAILED)
print(result.expanded_prompt)
# With tools for context gathering
from praisonaiagents.tools import internet_search
agent = PromptExpanderAgent(tools=[internet_search], verbose=True)
result = agent.expand("latest AI developments")
"""
import logging
from typing import List, Optional, Any, Dict
from dataclasses import dataclass, field
from enum import Enum
from datetime import datetime
class ExpandStrategy(Enum):
"""Enumeration of available prompt expansion strategies."""
BASIC = "basic"
DETAILED = "detailed"
STRUCTURED = "structured"
CREATIVE = "creative"
AUTO = "auto"
@dataclass
class ExpandResult:
"""Result of a prompt expansion operation."""
original_prompt: str
expanded_prompt: str
strategy_used: ExpandStrategy
metadata: Dict[str, Any] = field(default_factory=dict)
def __repr__(self):
return f"ExpandResult(strategy={self.strategy_used.value}, original_len={len(self.original_prompt)}, expanded_len={len(self.expanded_prompt)})"
class PromptExpanderAgent:
"""
Agent for expanding short prompts into detailed, comprehensive prompts.
This agent transforms brief task descriptions into rich, detailed prompts
that provide better context and guidance for task execution.
Key difference from QueryRewriterAgent:
- QueryRewriterAgent: Optimizes queries for search/retrieval (RAG)
- PromptExpanderAgent: Expands prompts for detailed task execution
Attributes:
name: Name of the agent
model: LLM model to use for expansion
verbose: Whether to print detailed logs
temperature: Temperature for LLM generation (higher = more creative)
tools: Optional tools for context gathering
Example:
agent = PromptExpanderAgent(model="gpt-4o-mini", verbose=True)
result = agent.expand("write a poem", strategy=ExpandStrategy.CREATIVE)
print(result.expanded_prompt)
"""
# Default prompts for each strategy
PROMPTS = {
"basic": """You are an expert at improving task prompts.
Current date: {current_date}
Given the following task prompt, expand it to be clearer and more actionable while preserving the original intent.
Guidelines:
- Keep it as a TASK/COMMAND (do NOT convert to a question)
- Add clarity without changing the core request
- Fix any ambiguity
- Keep it concise but complete
- Use the current date for any time-sensitive context
Original prompt: {prompt}
Expanded prompt:""",
"detailed": """You are an expert at creating comprehensive task prompts.
Current date: {current_date}
Given the following brief task prompt, expand it into a detailed, actionable prompt that provides rich context and clear guidance.
Guidelines:
- Keep it as a TASK/COMMAND (do NOT convert to a question)
- Add specific details about what to include
- Specify quality expectations
- Add relevant constraints or requirements
- Include format guidance if applicable
- Mention style or tone if relevant
- Use the current date for any time-sensitive context
Original prompt: {prompt}
Detailed expanded prompt:""",
"structured": """You are an expert at creating well-structured task prompts.
Current date: {current_date}
Given the following task prompt, expand it into a structured format with clear sections.
Guidelines:
- Keep it as a TASK/COMMAND (do NOT convert to a question)
- Use a clear structure:
* Task: What to do
* Format: Expected output format
* Requirements: Specific requirements
* Style: Tone or style guidance
* Constraints: Any limitations
- Be specific and actionable
- Use the current date for any time-sensitive context
Original prompt: {prompt}
Structured expanded prompt:""",
"creative": """You are an expert at crafting inspiring, creative task prompts.
Current date: {current_date}
Given the following task prompt, expand it with vivid language and creative direction while keeping it actionable.
Guidelines:
- Keep it as a TASK/COMMAND (do NOT convert to a question)
- Use evocative, inspiring language
- Paint a picture of the desired outcome
- Add creative direction and artistic guidance
- Make it exciting and engaging
- Preserve the core task intent
- Use the current date for any time-sensitive context
Original prompt: {prompt}
Creative expanded prompt:""",
"auto": """You are an expert at analyzing and expanding task prompts.
Current date: {current_date}
Analyze the following prompt and expand it appropriately based on its nature.
For short/vague prompts: Add significant detail and context
For task prompts: Preserve the action-oriented nature
For creative tasks: Add artistic direction
For technical tasks: Add precision and requirements
IMPORTANT: Keep it as a TASK/COMMAND. Never convert to a question.
Use the current date for any time-sensitive context.
Original prompt: {prompt}
{context}
Expanded prompt:"""
}
def __init__(
self,
name: str = "PromptExpanderAgent",
model: str = "gpt-4o-mini",
instructions: Optional[str] = None,
verbose: bool = False,
temperature: float = 0.7, # Higher for creativity
max_tokens: int = 1000,
tools: Optional[List[Any]] = None
):
"""
Initialize the PromptExpanderAgent.
Args:
name: Name of the agent
model: LLM model to use (default: gpt-4o-mini)
instructions: Custom instructions for the agent
verbose: Whether to print detailed logs
temperature: Temperature for LLM generation (default: 0.7 for creativity)
max_tokens: Maximum tokens for LLM response
tools: Optional list of tools for context gathering
"""
self.name = name
self.model = model
self.instructions = instructions
self.verbose = verbose
self.temperature = temperature
self.max_tokens = max_tokens
self.tools = tools or []
self._agent = None # Lazy initialized
# Setup logging
self.logger = logging.getLogger(__name__)
if self.verbose:
self.logger.setLevel(logging.DEBUG)
@property
def agent(self):
"""Lazy initialization of internal Agent."""
if self._agent is None:
from .agent import Agent
self._agent = Agent(
name=self.name,
role="Prompt Expansion Specialist",
goal="Expand brief prompts into detailed, actionable prompts for better task execution. Use available tools when needed to gather context.",
backstory="You are an expert at understanding user intent and transforming brief requests into comprehensive, detailed prompts.",
tools=self.tools,
llm=self.model,
verbose=self.verbose,
markdown=False
)
return self._agent
def _call_agent(self, prompt: str) -> str:
"""Call the internal Agent with the given prompt."""
try:
response = self.agent.chat(prompt)
return response if response else ""
except Exception as e:
self.logger.error(f"Agent call failed: {e}")
raise
def _is_short_prompt(self, prompt: str, threshold: int = 10) -> bool:
"""Check if prompt is considered short."""
return len(prompt.split()) < threshold
def _is_task_prompt(self, prompt: str) -> bool:
"""Check if prompt is a task/command (vs a question)."""
task_verbs = [
"write", "create", "generate", "build", "make", "design",
"develop", "implement", "compose", "draft", "produce",
"craft", "construct", "prepare", "draw", "paint", "code"
]
prompt_lower = prompt.lower().strip()
return any(prompt_lower.startswith(verb) for verb in task_verbs)
def _is_creative_task(self, prompt: str) -> bool:
"""Check if prompt is a creative task."""
creative_indicators = [
"poem", "story", "script", "song", "art", "creative",
"fiction", "novel", "essay", "blog", "article", "write"
]
prompt_lower = prompt.lower()
return any(ind in prompt_lower for ind in creative_indicators)
def _detect_strategy(self, prompt: str) -> ExpandStrategy:
"""Auto-detect the best expansion strategy for a prompt."""
# Very short prompts need detailed expansion
if self._is_short_prompt(prompt, threshold=5):
return ExpandStrategy.DETAILED
# Creative tasks benefit from creative expansion
if self._is_creative_task(prompt):
return ExpandStrategy.CREATIVE
# Task prompts get structured expansion
if self._is_task_prompt(prompt):
return ExpandStrategy.STRUCTURED
# Default to basic
return ExpandStrategy.BASIC
def expand(
self,
prompt: str,
strategy: ExpandStrategy = ExpandStrategy.AUTO,
context: Optional[str] = None
) -> ExpandResult:
"""
Expand a prompt using the specified strategy.
All operations go through an internal Agent which automatically handles
tool calling when tools are provided. The agent decides when to use tools
based on the prompt context.
Args:
prompt: The original user prompt
strategy: Expansion strategy to use
context: Additional context to help with expansion
Returns:
ExpandResult containing the expanded prompt
"""
if self.verbose:
self.logger.debug(f"Expanding prompt: '{prompt}' with strategy: {strategy.value}")
if self.tools:
print(f"[cyan]Agent has {len(self.tools)} tools available (will use if needed)...[/cyan]")
# Auto-detect strategy if needed
if strategy == ExpandStrategy.AUTO:
strategy = self._detect_strategy(prompt)
if self.verbose:
self.logger.debug(f"Auto-detected strategy: {strategy.value}")
# Build the expansion prompt
if strategy == ExpandStrategy.AUTO:
# Fallback if auto-detect returns AUTO
strategy = ExpandStrategy.DETAILED
# Get current date for time-sensitive context
current_date = datetime.now().strftime("%B %d, %Y")
expansion_prompt = self.PROMPTS[strategy.value].format(
prompt=prompt,
context=context or "",
current_date=current_date
)
# Call the agent
expanded = self._call_agent(expansion_prompt).strip()
# If expansion failed, return original
if not expanded:
expanded = prompt
return ExpandResult(
original_prompt=prompt,
expanded_prompt=expanded,
strategy_used=strategy,
metadata={
"original_length": len(prompt),
"expanded_length": len(expanded),
"has_context": bool(context),
"has_tools": bool(self.tools)
}
)
# Convenience methods for direct strategy access
def expand_basic(self, prompt: str, context: Optional[str] = None) -> ExpandResult:
"""Convenience method for basic expansion."""
return self.expand(prompt, strategy=ExpandStrategy.BASIC, context=context)
def expand_detailed(self, prompt: str, context: Optional[str] = None) -> ExpandResult:
"""Convenience method for detailed expansion."""
return self.expand(prompt, strategy=ExpandStrategy.DETAILED, context=context)
def expand_structured(self, prompt: str, context: Optional[str] = None) -> ExpandResult:
"""Convenience method for structured expansion."""
return self.expand(prompt, strategy=ExpandStrategy.STRUCTURED, context=context)
def expand_creative(self, prompt: str, context: Optional[str] = None) -> ExpandResult:
"""Convenience method for creative expansion."""
return self.expand(prompt, strategy=ExpandStrategy.CREATIVE, context=context)
@@ -0,0 +1,632 @@
"""
Query Rewriter Agent Module
This module provides the QueryRewriterAgent class for transforming user queries
to improve retrieval quality in RAG applications.
Supported Rewriting Strategies:
- **BASIC**: Simple rephrasing for clarity and keyword optimization
- **HYDE**: Hypothetical Document Embeddings - generates a hypothetical answer
- **STEP_BACK**: Generates higher-level concept questions for complex queries
- **SUB_QUERIES**: Decomposes multi-part questions into focused sub-queries
- **MULTI_QUERY**: Generates multiple paraphrased versions for ensemble retrieval
- **CONTEXTUAL**: Uses conversation history to resolve references and context
Example:
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
agent = QueryRewriterAgent(verbose=True)
# Basic rewriting
result = agent.rewrite("AI trends")
print(result.rewritten_queries)
# HyDE for better semantic matching
result = agent.rewrite("What is quantum computing?", strategy=RewriteStrategy.HYDE)
print(result.hypothetical_document)
# Contextual with chat history
chat_history = [
{"role": "user", "content": "Tell me about Python"},
{"role": "assistant", "content": "Python is a programming language..."}
]
result = agent.rewrite("What about its performance?", chat_history=chat_history)
# With search tools for context-aware rewriting
from praisonaiagents.tools import internet_search
agent = QueryRewriterAgent(tools=[internet_search], verbose=True)
result = agent.rewrite("latest AI developments") # Searches first, then rewrites
"""
import logging
import json
from typing import List, Optional, Any, Dict
from dataclasses import dataclass, field
from enum import Enum
class RewriteStrategy(Enum):
"""Enumeration of available query rewriting strategies."""
BASIC = "basic"
HYDE = "hyde"
STEP_BACK = "step_back"
SUB_QUERIES = "sub_queries"
MULTI_QUERY = "multi_query"
CONTEXTUAL = "contextual"
AUTO = "auto"
@dataclass
class RewriteResult:
"""Result of a query rewriting operation."""
original_query: str
rewritten_queries: List[str]
strategy_used: RewriteStrategy
hypothetical_document: Optional[str] = None
step_back_question: Optional[str] = None
sub_queries: Optional[List[str]] = None
metadata: Dict[str, Any] = field(default_factory=dict)
def __repr__(self):
return f"RewriteResult(strategy={self.strategy_used.value}, queries={len(self.rewritten_queries)})"
@property
def primary_query(self) -> str:
"""Returns the primary rewritten query."""
return self.rewritten_queries[0] if self.rewritten_queries else self.original_query
@property
def all_queries(self) -> List[str]:
"""Returns all queries including original and rewritten."""
queries = [self.original_query]
queries.extend(self.rewritten_queries)
if self.step_back_question:
queries.append(self.step_back_question)
if self.sub_queries:
queries.extend(self.sub_queries)
return list(set(queries)) # Remove duplicates
class QueryRewriterAgent:
"""
Agent for rewriting queries to improve retrieval quality in RAG applications.
This agent transforms user queries using various strategies to bridge the gap
between how users ask questions and how information is stored in knowledge bases.
Attributes:
name: Name of the agent
model: LLM model to use for rewriting
verbose: Whether to print detailed logs
max_queries: Maximum number of queries to generate for multi-query strategy
abbreviations: Dictionary of common abbreviations to expand
Example:
agent = QueryRewriterAgent(model="gpt-4o-mini", verbose=True)
result = agent.rewrite("ML best practices", strategy=RewriteStrategy.MULTI_QUERY)
for query in result.rewritten_queries:
print(query)
"""
# Default prompts for each strategy
PROMPTS = {
"basic": """You are an expert at improving prompts and queries.
Given the following input, improve it while preserving its original intent and type.
Guidelines:
- If it's a TASK (e.g., "write X", "create Y", "generate Z"), keep it as a task - do NOT convert to a question
- If it's a QUESTION (e.g., "what is X?", "how does Y work?"), keep it as a question
- Expand abbreviations and acronyms
- Fix typos and grammatical errors
- Add relevant context if too short
- Keep the original intent and action intact
IMPORTANT: If the input is a command/task to DO something, the output must also be a command/task to DO that thing.
Input: {query}
Improved version:""",
"hyde": """You are an expert at generating hypothetical documents.
Given the following query, write a detailed hypothetical document that would perfectly answer this query. This document will be used to find similar real documents in a knowledge base.
Guidelines:
- Write as if you are answering the query directly
- Include specific details, facts, and terminology
- Use the same style and vocabulary as the target documents
- Be comprehensive but focused on the query topic
Query: {query}
Hypothetical document:""",
"step_back": """You are an expert at generating step-back questions.
Given the following query, generate a more general, higher-level question that captures the broader concept. This helps retrieve background information needed to answer the specific query.
Guidelines:
- Identify the underlying concept or principle
- Create a question about fundamentals or general knowledge
- The step-back question should provide context for the original query
Query: {query}
Step-back question:""",
"sub_queries": """You are an expert at decomposing complex queries.
Given the following query, break it down into simpler, focused sub-queries. Each sub-query should address one specific aspect of the original question.
Guidelines:
- Identify distinct aspects or components of the query
- Create independent, self-contained sub-queries
- Each sub-query should be answerable on its own
- Return as a JSON array of strings
Query: {query}
Sub-queries (JSON array):""",
"multi_query": """You are an expert at query expansion and paraphrasing.
Given the following query, generate {num_queries} different versions that capture the same intent but use different words, phrases, or perspectives.
Guidelines:
- Use synonyms and alternative phrasings
- Try different question formats (what, how, why, etc.)
- Include both formal and informal versions
- Add relevant context or specificity
- Return as a JSON array of strings
Query: {query}
Alternative queries (JSON array):""",
"contextual": """You are an expert at understanding conversational context.
Given the conversation history and a follow-up query, rewrite the query as a standalone question that captures all relevant context.
Guidelines:
- Resolve pronouns and references (it, this, that, etc.)
- Include relevant context from the conversation
- Keep entity names and important details
- Make the query self-contained and clear
Conversation history:
{chat_history}
Follow-up query: {query}
Standalone question:""",
"auto": """You are an expert at analyzing and improving prompts and queries.
Analyze the following input and improve it while preserving its original intent and type.
Input types to consider:
1. TASK/COMMAND (write, create, generate, build) → Keep as a task, make it clearer
2. QUESTION (what, how, why, when) → Keep as a question, make it more specific
3. Short/keyword inputs → Expand with context but preserve type
4. Complex multi-part inputs → Clarify structure
5. Well-formed inputs → Minor optimization only
IMPORTANT: Never convert a task into a question. "Write X" should remain "Write X", not "How to write X?"
Input: {query}
{context}
Improved version:"""
}
def __init__(
self,
name: str = "QueryRewriterAgent",
model: str = "gpt-4o-mini",
instructions: Optional[str] = None,
verbose: bool = False,
max_queries: int = 5,
abbreviations: Optional[Dict[str, str]] = None,
temperature: float = 0.3,
max_tokens: int = 500,
tools: Optional[List[Any]] = None
):
"""
Initialize the QueryRewriterAgent.
Args:
name: Name of the agent
model: LLM model to use (default: gpt-4o-mini)
instructions: Custom instructions for the agent
verbose: Whether to print detailed logs
max_queries: Maximum queries for multi-query strategy
abbreviations: Custom abbreviation expansions
temperature: Temperature for LLM generation
max_tokens: Maximum tokens for LLM response
tools: Optional list of tools (agent decides when to use them)
"""
self.name = name
self.model = model
self.instructions = instructions
self.verbose = verbose
self.max_queries = max_queries
self.temperature = temperature
self.max_tokens = max_tokens
self.tools = tools or []
self._agent = None # Lazy initialized
# Default abbreviations (can be extended)
self.abbreviations = abbreviations or {
"AI": "Artificial Intelligence",
"ML": "Machine Learning",
"NLP": "Natural Language Processing",
"LLM": "Large Language Model",
"RAG": "Retrieval Augmented Generation",
"API": "Application Programming Interface",
"DB": "Database",
"UI": "User Interface",
"UX": "User Experience",
"SDK": "Software Development Kit",
"CLI": "Command Line Interface",
}
# Setup logging
self.logger = logging.getLogger(__name__)
if self.verbose:
self.logger.setLevel(logging.DEBUG)
@property
def agent(self):
"""Lazy initialization of internal Agent."""
if self._agent is None:
from .agent import Agent
self._agent = Agent(
name=self.name,
role="Query Rewriting Specialist",
goal="Rewrite queries for better search and retrieval results. Use available tools when needed to gather context.",
backstory="You are an expert at understanding user intent and transforming queries for optimal information retrieval.",
tools=self.tools,
llm=self.model,
verbose=self.verbose,
markdown=False
)
return self._agent
def _call_agent(self, prompt: str) -> str:
"""Call the internal Agent with the given prompt."""
try:
response = self.agent.chat(prompt)
return response if response else ""
except Exception as e:
self.logger.error(f"Agent call failed: {e}")
raise
def _expand_abbreviations(self, query: str) -> str:
"""Expand known abbreviations in the query."""
words = query.split()
expanded = []
for word in words:
clean_word = word.strip(".,!?;:")
if clean_word.upper() in self.abbreviations:
expanded.append(f"{clean_word} ({self.abbreviations[clean_word.upper()]})")
else:
expanded.append(word)
return " ".join(expanded)
def _is_short_query(self, query: str, threshold: int = 5) -> bool:
"""Check if query is considered short (keyword-style)."""
return len(query.split()) < threshold
def _parse_json_array(self, text: str) -> List[str]:
"""Parse a JSON array from LLM response."""
try:
# Try direct JSON parsing
result = json.loads(text)
if isinstance(result, list):
return [str(item) for item in result]
except json.JSONDecodeError:
pass
# Try to extract JSON array from text
import re
match = re.search(r'\[.*?\]', text, re.DOTALL)
if match:
try:
result = json.loads(match.group())
if isinstance(result, list):
return [str(item) for item in result]
except json.JSONDecodeError:
pass
# Fallback: split by newlines and clean up
lines = [line.strip() for line in text.split('\n') if line.strip()]
lines = [line.lstrip('0123456789.-) ').strip('"\'') for line in lines]
return [line for line in lines if line and len(line) > 3]
def rewrite(
self,
query: str,
strategy: RewriteStrategy = RewriteStrategy.AUTO,
chat_history: Optional[List[Dict[str, str]]] = None,
context: Optional[str] = None,
num_queries: int = None
) -> RewriteResult:
"""
Rewrite a query using the specified strategy.
All operations go through an internal Agent which automatically handles
tool calling when tools are provided. The agent decides when to use tools
based on the query context.
Args:
query: The original user query
strategy: Rewriting strategy to use
chat_history: Previous conversation messages for contextual rewriting
context: Additional context about the knowledge base
num_queries: Number of queries for multi-query strategy
Returns:
RewriteResult containing rewritten queries
"""
if self.verbose:
self.logger.debug(f"Rewriting query: '{query}' with strategy: {strategy.value}")
if self.tools:
print(f"[cyan]Agent has {len(self.tools)} tools available (will use if needed)...[/cyan]")
# Auto-detect strategy if needed
if strategy == RewriteStrategy.AUTO:
strategy = self._detect_strategy(query, chat_history)
if self.verbose:
self.logger.debug(f"Auto-detected strategy: {strategy.value}")
# All calls go through the internal Agent which handles tool calling
combined_context = context or ""
# Dispatch to appropriate method
if strategy == RewriteStrategy.BASIC:
return self._rewrite_basic(query, combined_context)
elif strategy == RewriteStrategy.HYDE:
return self._rewrite_hyde(query, combined_context)
elif strategy == RewriteStrategy.STEP_BACK:
return self._rewrite_step_back(query, combined_context)
elif strategy == RewriteStrategy.SUB_QUERIES:
return self._rewrite_sub_queries(query, combined_context)
elif strategy == RewriteStrategy.MULTI_QUERY:
return self._rewrite_multi_query(query, num_queries or self.max_queries, combined_context)
elif strategy == RewriteStrategy.CONTEXTUAL:
return self._rewrite_contextual(query, chat_history or [], combined_context)
else:
# Default to basic
return self._rewrite_basic(query, combined_context)
def _detect_strategy(
self,
query: str,
chat_history: Optional[List[Dict[str, str]]] = None
) -> RewriteStrategy:
"""Auto-detect the best rewriting strategy for a query."""
# If chat history exists and query seems like a follow-up
if chat_history and self._is_follow_up(query):
return RewriteStrategy.CONTEXTUAL
# Short keyword queries
if self._is_short_query(query):
return RewriteStrategy.BASIC
# Complex multi-part queries
if self._is_complex_query(query):
return RewriteStrategy.SUB_QUERIES
# Questions that might benefit from step-back
if self._needs_step_back(query):
return RewriteStrategy.STEP_BACK
# Default to basic
return RewriteStrategy.BASIC
def _is_follow_up(self, query: str) -> bool:
"""Check if query appears to be a follow-up question."""
follow_up_indicators = [
"it", "this", "that", "they", "them", "their",
"what about", "how about", "and", "also", "more",
"same", "similar", "related"
]
query_lower = query.lower()
return any(indicator in query_lower for indicator in follow_up_indicators)
def _is_complex_query(self, query: str) -> bool:
"""Check if query contains multiple distinct questions."""
# Check for multiple question marks or conjunctions
if query.count('?') > 1:
return True
complex_indicators = [" and ", " or ", " also ", " as well as ", " plus "]
return any(ind in query.lower() for ind in complex_indicators)
def _needs_step_back(self, query: str) -> bool:
"""Check if query would benefit from a step-back question."""
# Queries about specific details often benefit from broader context
specific_indicators = [
"specific", "exactly", "precisely", "particular",
"difference between", "compare", "versus", "vs"
]
return any(ind in query.lower() for ind in specific_indicators)
def _rewrite_basic(self, query: str, context: str = "") -> RewriteResult:
"""Basic query rewriting for clarity and keyword optimization."""
# First expand abbreviations
expanded_query = self._expand_abbreviations(query)
# Build prompt with optional context
prompt = self.PROMPTS["basic"].format(query=expanded_query)
if context:
prompt += f"\n\nAdditional context to help with rewriting:\n{context}"
rewritten = self._call_agent(prompt).strip()
return RewriteResult(
original_query=query,
rewritten_queries=[rewritten],
strategy_used=RewriteStrategy.BASIC,
metadata={"expanded_abbreviations": expanded_query != query, "has_context": bool(context)}
)
def _rewrite_hyde(self, query: str, context: str = "") -> RewriteResult:
"""HyDE: Generate hypothetical document for better semantic matching."""
prompt = self.PROMPTS["hyde"].format(query=query)
if context:
prompt += f"\n\nUse this context to make the hypothetical document more accurate:\n{context}"
hypothetical_doc = self._call_agent(prompt).strip()
# The hypothetical document itself becomes the search query
return RewriteResult(
original_query=query,
rewritten_queries=[hypothetical_doc[:500]], # Truncate for embedding
strategy_used=RewriteStrategy.HYDE,
hypothetical_document=hypothetical_doc,
metadata={"full_document_length": len(hypothetical_doc), "has_context": bool(context)}
)
def _rewrite_step_back(self, query: str, context: str = "") -> RewriteResult:
"""Generate step-back question for broader context retrieval."""
# Generate step-back question
prompt = self.PROMPTS["step_back"].format(query=query)
if context:
prompt += f"\n\nContext:\n{context}"
step_back = self._call_agent(prompt).strip()
# Also do basic rewriting of original
basic_result = self._rewrite_basic(query, context)
return RewriteResult(
original_query=query,
rewritten_queries=basic_result.rewritten_queries,
strategy_used=RewriteStrategy.STEP_BACK,
step_back_question=step_back,
metadata={"includes_step_back": True, "has_context": bool(context)}
)
def _rewrite_sub_queries(self, query: str, context: str = "") -> RewriteResult:
"""Decompose complex query into focused sub-queries."""
prompt = self.PROMPTS["sub_queries"].format(query=query)
if context:
prompt += f"\n\nContext to help with decomposition:\n{context}"
response = self._call_agent(prompt).strip()
sub_queries = self._parse_json_array(response)
# Ensure we have at least one sub-query
if not sub_queries:
sub_queries = [query]
return RewriteResult(
original_query=query,
rewritten_queries=sub_queries,
strategy_used=RewriteStrategy.SUB_QUERIES,
sub_queries=sub_queries,
metadata={"num_sub_queries": len(sub_queries), "has_context": bool(context)}
)
def _rewrite_multi_query(self, query: str, num_queries: int, context: str = "") -> RewriteResult:
"""Generate multiple paraphrased versions for ensemble retrieval."""
prompt = self.PROMPTS["multi_query"].format(
query=query,
num_queries=num_queries
)
if context:
prompt += f"\n\nContext to help with paraphrasing:\n{context}"
response = self._call_agent(prompt).strip()
queries = self._parse_json_array(response)
# Ensure we have queries and limit to max
if not queries:
queries = [query]
queries = queries[:num_queries]
return RewriteResult(
original_query=query,
rewritten_queries=queries,
strategy_used=RewriteStrategy.MULTI_QUERY,
metadata={"num_generated": len(queries), "has_context": bool(context)}
)
def _rewrite_contextual(
self,
query: str,
chat_history: List[Dict[str, str]],
context: str = ""
) -> RewriteResult:
"""Rewrite query using conversation context."""
# Format chat history
history_str = ""
for msg in chat_history[-10:]: # Last 10 messages
role = msg.get("role", "user")
content = msg.get("content", "")
history_str += f"{role.capitalize()}: {content}\n"
prompt = self.PROMPTS["contextual"].format(
chat_history=history_str,
query=query
)
if context:
prompt += f"\n\nAdditional context:\n{context}"
rewritten = self._call_agent(prompt).strip()
return RewriteResult(
original_query=query,
rewritten_queries=[rewritten],
strategy_used=RewriteStrategy.CONTEXTUAL,
metadata={
"history_length": len(chat_history),
"history_used": min(10, len(chat_history)),
"has_context": bool(context)
}
)
# Convenience methods for direct strategy access
def rewrite_basic(self, query: str) -> RewriteResult:
"""Convenience method for basic rewriting."""
return self.rewrite(query, strategy=RewriteStrategy.BASIC)
def rewrite_hyde(self, query: str) -> RewriteResult:
"""Convenience method for HyDE rewriting."""
return self.rewrite(query, strategy=RewriteStrategy.HYDE)
def rewrite_step_back(self, query: str) -> RewriteResult:
"""Convenience method for step-back rewriting."""
return self.rewrite(query, strategy=RewriteStrategy.STEP_BACK)
def rewrite_sub_queries(self, query: str) -> RewriteResult:
"""Convenience method for sub-query decomposition."""
return self.rewrite(query, strategy=RewriteStrategy.SUB_QUERIES)
def rewrite_multi_query(self, query: str, num_queries: int = None) -> RewriteResult:
"""Convenience method for multi-query generation."""
return self.rewrite(
query,
strategy=RewriteStrategy.MULTI_QUERY,
num_queries=num_queries
)
def rewrite_contextual(
self,
query: str,
chat_history: List[Dict[str, str]]
) -> RewriteResult:
"""Convenience method for contextual rewriting."""
return self.rewrite(
query,
strategy=RewriteStrategy.CONTEXTUAL,
chat_history=chat_history
)
def add_abbreviation(self, abbrev: str, expansion: str) -> None:
"""Add a custom abbreviation expansion."""
self.abbreviations[abbrev.upper()] = expansion
def add_abbreviations(self, abbreviations: Dict[str, str]) -> None:
"""Add multiple custom abbreviation expansions."""
for abbrev, expansion in abbreviations.items():
self.abbreviations[abbrev.upper()] = expansion
+206 -1
View File
@@ -239,6 +239,10 @@ class LLM:
api_key: Optional[str] = None,
base_url: Optional[str] = None,
events: List[Any] = [],
web_search: Optional[Union[bool, Dict[str, Any]]] = None,
web_fetch: Optional[Union[bool, Dict[str, Any]]] = None,
prompt_caching: Optional[bool] = None,
claude_memory: Optional[Union[bool, Any]] = None,
**extra_settings
):
# Configure logging only once at the class level
@@ -273,6 +277,11 @@ class LLM:
self.base_url = base_url
self.events = events
self.extra_settings = extra_settings
self.web_search = web_search
self.web_fetch = web_fetch
self.prompt_caching = prompt_caching
self.claude_memory = claude_memory
self._claude_memory_tool = None # Lazy initialized
self._console = None # Lazy load console when needed
self.chat_history = []
self.verbose = extra_settings.get('verbose', True)
@@ -381,6 +390,109 @@ class LLM:
else:
return False
def _supports_web_search(self) -> bool:
"""
Check if the current model supports native web search via LiteLLM.
Native web search allows the model to search the web in real-time
without requiring external tools like DuckDuckGo.
Returns:
bool: True if the model supports native web search, False otherwise
"""
from .model_capabilities import supports_web_search
return supports_web_search(self.model)
def _supports_web_fetch(self) -> bool:
"""
Check if the current model supports web fetch via LiteLLM.
Web fetch allows the model to retrieve full content from specific URLs
(web pages and PDF documents). Currently only supported by Anthropic Claude models.
Returns:
bool: True if the model supports web fetch, False otherwise
"""
from .model_capabilities import supports_web_fetch
return supports_web_fetch(self.model)
def _supports_prompt_caching(self) -> bool:
"""
Check if the current model supports prompt caching via LiteLLM.
Prompt caching allows caching parts of prompts to reduce costs and latency.
Supported by OpenAI, Anthropic, Bedrock, and Deepseek.
Returns:
bool: True if the model supports prompt caching, False otherwise
"""
from .model_capabilities import supports_prompt_caching
return supports_prompt_caching(self.model)
def _get_claude_memory_tool(self):
"""
Get or initialize the Claude Memory Tool instance.
Returns:
ClaudeMemoryTool instance if claude_memory is enabled, None otherwise
"""
if not self.claude_memory:
return None
if self._claude_memory_tool is None:
from ..tools.claude_memory_tool import ClaudeMemoryTool
if isinstance(self.claude_memory, bool):
# Create default memory tool
self._claude_memory_tool = ClaudeMemoryTool()
else:
# Use provided memory tool instance
self._claude_memory_tool = self.claude_memory
return self._claude_memory_tool
def _supports_claude_memory(self) -> bool:
"""
Check if the current model supports Claude Memory Tool.
Claude Memory Tool is only supported by Anthropic Claude models.
Returns:
bool: True if the model supports Claude Memory Tool
"""
if not self.claude_memory:
return False
return self._is_anthropic_model()
def _is_memory_tool_call(self, function_name: str) -> bool:
"""
Check if a tool call is for the Claude Memory Tool.
Args:
function_name: Name of the function being called
Returns:
bool: True if this is a memory tool call
"""
return function_name == "memory" and self._supports_claude_memory()
def _execute_memory_tool_call(self, arguments: Dict[str, Any]) -> str:
"""
Execute a Claude Memory Tool call.
Args:
arguments: The arguments from Claude's tool call
Returns:
Result string from the memory operation
"""
memory_tool = self._get_claude_memory_tool()
if not memory_tool:
return "Error: Memory tool not initialized"
return memory_tool.process_tool_call(arguments)
def _generate_ollama_tool_summary(self, tool_results: List[Any], response_text: str) -> Optional[str]:
"""
Generate a summary from tool results for Ollama to prevent infinite loops.
@@ -724,7 +836,21 @@ class LLM:
# Skip system messages for legacy o1 models as they don't support them
if not self._needs_system_message_skip():
messages.append({"role": "system", "content": system_prompt})
# Apply prompt caching for Anthropic models if enabled
if self.prompt_caching and self._supports_prompt_caching() and self._is_anthropic_model():
# Anthropic requires cache_control in content array format
messages.append({
"role": "system",
"content": [
{
"type": "text",
"text": system_prompt,
"cache_control": {"type": "ephemeral"}
}
]
})
else:
messages.append({"role": "system", "content": system_prompt})
# Add chat history if provided
if chat_history:
@@ -2295,6 +2421,12 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
return False
return any(prefix in self.model.lower() for prefix in ['gemini', 'gemini/', 'google/gemini'])
def _is_anthropic_model(self) -> bool:
"""Check if the model is an Anthropic Claude model."""
if not self.model:
return False
return any(prefix in self.model.lower() for prefix in ['claude', 'anthropic/', 'anthropic/claude'])
def _is_streaming_error_recoverable(self, error: Exception) -> bool:
"""Check if a streaming error is recoverable (e.g., malformed chunk vs connection error)."""
error_msg = str(error).lower()
@@ -3171,6 +3303,79 @@ Output MUST be JSON with 'reflection' and 'satisfactory'.
logging.debug(f"Could not verify function calling support: {e}. Setting tool_choice anyway.")
params['tool_choice'] = 'auto'
# Add web_search_options if web_search is enabled and model supports it
if self.web_search and self._supports_web_search():
if isinstance(self.web_search, dict):
# Use custom web_search_options provided by user
params['web_search_options'] = self.web_search
else:
# Use default web_search_options
params['web_search_options'] = {"search_context_size": "medium"}
logging.debug(f"Web search enabled with options: {params['web_search_options']}")
# Some web search models (like gpt-4o-search-preview) don't support certain parameters
# Remove incompatible parameters to avoid BadRequestError
incompatible_params = ['temperature', 'top_p', 'presence_penalty', 'frequency_penalty', 'logit_bias']
for param in incompatible_params:
if param in params:
del params[param]
logging.debug(f"Removed incompatible parameter '{param}' for web search model")
# Add web_fetch tool if web_fetch is enabled and model supports it
# Web fetch is passed as a tool (unlike web_search which uses web_search_options)
if self.web_fetch and self._supports_web_fetch():
# Build the web_fetch tool definition
web_fetch_tool = {
"type": "web_fetch_20250910",
"name": "web_fetch",
}
# Add optional parameters from web_fetch dict if provided
if isinstance(self.web_fetch, dict):
if 'max_uses' in self.web_fetch:
web_fetch_tool['max_uses'] = self.web_fetch['max_uses']
if 'allowed_domains' in self.web_fetch:
web_fetch_tool['allowed_domains'] = self.web_fetch['allowed_domains']
if 'blocked_domains' in self.web_fetch:
web_fetch_tool['blocked_domains'] = self.web_fetch['blocked_domains']
if 'citations' in self.web_fetch:
web_fetch_tool['citations'] = self.web_fetch['citations']
if 'max_content_tokens' in self.web_fetch:
web_fetch_tool['max_content_tokens'] = self.web_fetch['max_content_tokens']
else:
# Default max_uses if web_fetch=True
web_fetch_tool['max_uses'] = 5
# Add web_fetch tool to existing tools or create tools list
if 'tools' in params and params['tools']:
params['tools'].append(web_fetch_tool)
else:
params['tools'] = [web_fetch_tool]
logging.debug(f"Web fetch enabled with tool: {web_fetch_tool}")
# Add Claude Memory Tool if enabled and model supports it
if self._supports_claude_memory():
memory_tool = self._get_claude_memory_tool()
if memory_tool:
# Add the memory tool definition
memory_tool_def = memory_tool.get_tool_definition()
# Add memory tool to existing tools or create tools list
if 'tools' in params and params['tools']:
params['tools'].append(memory_tool_def)
else:
params['tools'] = [memory_tool_def]
# Add the beta header for Anthropic
beta_header = memory_tool.get_beta_header()
if 'extra_headers' in params:
params['extra_headers']['anthropic-beta'] = beta_header
else:
params['extra_headers'] = {'anthropic-beta': beta_header}
logging.debug(f"Claude memory tool enabled with beta header: {beta_header}")
return params
def _prepare_response_logging(self, temperature: float, stream: bool, verbose: bool, markdown: bool, **kwargs) -> Optional[Dict[str, Any]]:
@@ -1,62 +1,30 @@
"""
Model capabilities configuration for different LLM providers.
This module defines which models support specific features like structured outputs.
This module uses LiteLLM's helper functions as the primary source for model capability detection.
LiteLLM is maintained by many contributors and is more accurate and up-to-date.
LiteLLM Helper Functions:
- litellm.supports_web_search(model=) - Check web search support
- litellm.supports_function_calling(model=) - Check function calling support
- litellm.supports_parallel_function_calling(model=) - Check parallel function calling
- litellm.supports_response_schema(model=) - Check JSON schema/structured outputs support
- litellm.utils.supports_prompt_caching(model=) - Check prompt caching support
- litellm.get_supported_openai_params(model=) - Get all supported params
Sources:
- https://docs.litellm.ai/docs/completion/web_search
- https://docs.litellm.ai/docs/completion/json_mode
- https://docs.litellm.ai/docs/completion/function_call
- https://docs.litellm.ai/docs/completion/prompt_caching
"""
# Models that support OpenAI-style structured outputs (response_format with Pydantic models)
MODELS_SUPPORTING_STRUCTURED_OUTPUTS = {
# OpenAI models
"gpt-5-nano",
"gpt-5-nano",
"gpt-4-turbo",
"gpt-4-turbo-preview",
"gpt-4-turbo-2024-04-09",
"gpt-4-1106-preview",
"gpt-4-0125-preview",
"gpt-3.5-turbo",
"gpt-3.5-turbo-1106",
"gpt-3.5-turbo-0125",
# New/Future OpenAI models (as mentioned by user)
"codex-mini",
"o3-pro",
"gpt-4.5-preview",
"o3-mini",
"o1",
"o1-preview",
"o1-mini",
"gpt-4.1",
"gpt-4.1-nano",
"gpt-4.1-mini",
"o4-mini",
"o3",
# Gemini models that support structured outputs
"gemini-2.0-flash",
"gemini-2.0-flash-exp",
"gemini-1.5-pro",
"gemini-1.5-pro-latest",
"gemini-1.5-flash",
"gemini-1.5-flash-latest",
"gemini-1.5-flash-8b",
"gemini-1.5-flash-8b-latest",
}
# Models that explicitly DON'T support structured outputs
MODELS_NOT_SUPPORTING_STRUCTURED_OUTPUTS = {
# Audio preview models
"gpt-4o-audio-preview",
"gpt-5-nano-audio-preview",
# Legacy o1 models (don't support system messages either)
"o1-preview-2024-09-12",
"o1-mini-2024-09-12",
}
def supports_structured_outputs(model_name: str) -> bool:
"""
Check if a model supports OpenAI-style structured outputs.
Check if a model supports structured outputs (JSON schema).
Uses LiteLLM's supports_response_schema() as the primary check.
Args:
model_name: The name of the model to check
@@ -67,34 +35,72 @@ def supports_structured_outputs(model_name: str) -> bool:
if not model_name:
return False
# Strip provider prefixes (e.g., 'google/', 'openai/', etc.)
model_without_provider = model_name
for prefix in ['google/', 'openai/', 'anthropic/', 'gemini/', 'mistral/', 'deepseek/', 'groq/']:
if model_name.startswith(prefix):
model_without_provider = model_name[len(prefix):]
break
try:
import litellm
# Use LiteLLM's built-in check - most accurate and up-to-date
if hasattr(litellm, 'supports_response_schema'):
return litellm.supports_response_schema(model=model_name)
except Exception:
pass
# First check if it's explicitly in the NOT supporting list
if model_without_provider in MODELS_NOT_SUPPORTING_STRUCTURED_OUTPUTS:
return False
def supports_function_calling(model_name: str) -> bool:
"""
Check if a model supports function calling.
Uses LiteLLM's supports_function_calling() as the primary check.
Args:
model_name: The name of the model to check
Returns:
bool: True if the model supports function calling, False otherwise
"""
if not model_name:
return False
# Then check if it's in the supporting list
if model_without_provider in MODELS_SUPPORTING_STRUCTURED_OUTPUTS:
return True
try:
import litellm
# Use LiteLLM's built-in check - most accurate and up-to-date
if hasattr(litellm, 'supports_function_calling'):
return litellm.supports_function_calling(model=model_name)
except Exception:
pass
# For models with version suffixes, check the base model name
base_model = model_without_provider.split('-2024-')[0].split('-2025-')[0]
if base_model in MODELS_SUPPORTING_STRUCTURED_OUTPUTS:
return True
return False
def supports_parallel_function_calling(model_name: str) -> bool:
"""
Check if a model supports parallel function calling.
Uses LiteLLM's supports_parallel_function_calling() as the primary check.
Args:
model_name: The name of the model to check
Returns:
bool: True if the model supports parallel function calling, False otherwise
"""
if not model_name:
return False
try:
import litellm
# Use LiteLLM's built-in check - most accurate and up-to-date
if hasattr(litellm, 'supports_parallel_function_calling'):
return litellm.supports_parallel_function_calling(model=model_name)
except Exception:
pass
# Default to False for unknown models
return False
def supports_streaming_with_tools(model_name: str) -> bool:
"""
Check if a model supports streaming when tools are provided.
Most models that support structured outputs also support streaming with tools.
Args:
model_name: The name of the model to check
@@ -102,15 +108,153 @@ def supports_streaming_with_tools(model_name: str) -> bool:
Returns:
bool: True if the model supports streaming with tools, False otherwise
"""
# For now, use the same logic as structured outputs
# In the future, this could be a separate list if needed
return supports_structured_outputs(model_name)
# Models that support function calling generally support streaming with tools
return supports_function_calling(model_name)
# Supported Gemini internal tools
GEMINI_INTERNAL_TOOLS = {'googleSearch', 'urlContext', 'codeExecution'}
def supports_web_search(model_name: str) -> bool:
"""
Check if a model supports native web search via LiteLLM.
Uses LiteLLM's supports_web_search() as the primary check.
Native web search allows the model to search the web in real-time
without requiring external tools like DuckDuckGo.
Supported providers:
- OpenAI (gpt-4o-search-preview, gpt-4o-mini-search-preview)
- xAI (grok-3)
- Anthropic (claude-3-5-sonnet-latest, claude-sonnet-4, etc.)
- Google/Vertex AI (gemini-2.0-flash, gemini-2.5-*, etc.)
- Perplexity (all models)
Args:
model_name: The name of the model to check (with or without provider prefix)
Returns:
bool: True if the model supports native web search, False otherwise
"""
if not model_name:
return False
try:
import litellm
# Use LiteLLM's built-in check - most accurate and up-to-date
if hasattr(litellm, 'supports_web_search'):
return litellm.supports_web_search(model=model_name)
except Exception:
pass
return False
def supports_prompt_caching(model_name: str) -> bool:
"""
Check if a model supports prompt caching via LiteLLM.
Uses LiteLLM's supports_prompt_caching() as the primary check.
Prompt caching allows caching parts of prompts to reduce costs and latency
on subsequent requests with similar prompts.
Supported providers:
- OpenAI (openai/) - Automatic caching for prompts ≥1024 tokens
- Anthropic (anthropic/) - Manual caching with cache_control
- Bedrock (bedrock/) - All models that support prompt caching
- Deepseek (deepseek/) - Works like OpenAI
Args:
model_name: The name of the model to check (with or without provider prefix)
Returns:
bool: True if the model supports prompt caching, False otherwise
"""
if not model_name:
return False
try:
from litellm.utils import supports_prompt_caching as litellm_supports_prompt_caching
return litellm_supports_prompt_caching(model=model_name)
except Exception:
pass
return False
# Models that support web fetch via LiteLLM (Anthropic only)
# Web fetch retrieves full content from specific URLs (web pages and PDFs)
# Source: https://docs.litellm.ai/docs/completion/web_fetch
# Note: LiteLLM doesn't have a supports_web_fetch() helper yet, so we maintain a static list
MODELS_SUPPORTING_WEB_FETCH = {
# Anthropic Claude models with web fetch support
"claude-opus-4-1-20250805",
"claude-opus-4-1",
"claude-opus-4-20250514",
"claude-opus-4",
"claude-sonnet-4-20250514",
"claude-sonnet-4",
"claude-3-7-sonnet-20250219",
"claude-3-7-sonnet-latest",
"claude-3-5-sonnet-latest",
"claude-3-5-sonnet-20241022",
"claude-3-5-haiku-latest",
"claude-3-5-haiku-20241022",
}
def supports_web_fetch(model_name: str) -> bool:
"""
Check if a model supports web fetch via LiteLLM.
Web fetch allows the model to retrieve full content from specific URLs
(web pages and PDF documents). Currently only supported by Anthropic Claude models.
Note: LiteLLM doesn't have a supports_web_fetch() helper yet, so we use a static list
with auto-detection for Claude 4+ models.
Args:
model_name: The name of the model to check (with or without provider prefix)
Returns:
bool: True if the model supports web fetch, False otherwise
"""
if not model_name:
return False
# Strip provider prefixes
model_without_provider = model_name
for prefix in ['anthropic/', 'bedrock/', 'vertex_ai/']:
if model_name.startswith(prefix):
model_without_provider = model_name[len(prefix):]
break
# Check our static list
if model_without_provider in MODELS_SUPPORTING_WEB_FETCH:
return True
# Check base model name (without version suffix)
base_model = model_without_provider.split('-2024-')[0].split('-2025-')[0]
if base_model in MODELS_SUPPORTING_WEB_FETCH:
return True
# Auto-support for Claude 4+ models (Anthropic only)
model_lower = model_without_provider.lower()
if 'claude' in model_lower:
import re
# Match patterns like claude-4, claude-5, claude-sonnet-4, claude-opus-4, etc.
version_match = re.search(r'claude-(?:sonnet-|opus-|haiku-)?(\d+)', model_lower)
if version_match:
version = int(version_match.group(1))
if version >= 4: # Claude 4 and later
return True
return False
def is_gemini_internal_tool(tool) -> bool:
"""
Check if a tool is a Gemini internal tool and should be included in formatted tools.
@@ -8,8 +8,19 @@ This module provides memory management capabilities including:
- User memory for preferences/history
- Quality-based storage decisions
- Graph memory support via Mem0
Memory Providers:
- FileMemory: Zero-dependency JSON file-based storage (default)
- Memory: Full-featured with SQLite, ChromaDB, Mem0, MongoDB support
"""
from .memory import Memory
from .file_memory import FileMemory, create_memory
__all__ = ["Memory"]
# Lazy import for Memory to avoid dependency issues
def __getattr__(name):
if name == "Memory":
from .memory import Memory
return Memory
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
__all__ = ["FileMemory", "Memory", "create_memory"]
@@ -0,0 +1,857 @@
"""
File-based Memory System for PraisonAI Agents.
Zero-dependency memory implementation using JSON files.
Provides short-term, long-term, entity, and episodic memory
without requiring any external packages.
Storage Structure:
.praison/memory/{user_id}/
├── config.json # Memory configuration
├── short_term.json # Rolling buffer (recent context)
├── long_term.json # Persistent facts/knowledge
├── entities.json # Named entities
├── episodic/ # Date-based memories
│ └── {date}.json
└── summaries.json # LLM-generated summaries
"""
import json
import time
import fcntl
import hashlib
import logging
from pathlib import Path
from datetime import datetime, timedelta
from typing import Any, Dict, List, Optional
from dataclasses import dataclass, asdict, field
logger = logging.getLogger(__name__)
@dataclass
class MemoryItem:
"""A single memory item."""
id: str
content: str
metadata: Dict[str, Any] = field(default_factory=dict)
created_at: float = field(default_factory=time.time)
updated_at: float = field(default_factory=time.time)
access_count: int = 0
importance: float = 0.5 # 0.0 to 1.0
def to_dict(self) -> Dict[str, Any]:
return asdict(self)
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> 'MemoryItem':
return cls(**data)
@dataclass
class EntityItem:
"""An entity memory item (person, place, concept)."""
id: str
name: str
entity_type: str # person, place, organization, concept, etc.
attributes: Dict[str, Any] = field(default_factory=dict)
relationships: List[Dict[str, str]] = field(default_factory=list)
created_at: float = field(default_factory=time.time)
updated_at: float = field(default_factory=time.time)
def to_dict(self) -> Dict[str, Any]:
return asdict(self)
@classmethod
def from_dict(cls, data: Dict[str, Any]) -> 'EntityItem':
return cls(**data)
class FileMemory:
"""
Zero-dependency file-based memory system.
Uses JSON files for persistence with support for:
- Short-term memory (rolling buffer)
- Long-term memory (persistent facts)
- Entity memory (people, places, concepts)
- Episodic memory (date-based interactions)
- Memory summarization (optional, requires LLM)
Example:
```python
memory = FileMemory(user_id="user123")
# Store short-term memory
memory.add_short_term("User prefers dark mode")
# Store long-term memory
memory.add_long_term("User's name is John", importance=0.9)
# Store entity
memory.add_entity("John", "person", {"role": "developer"})
# Search memories
results = memory.search("John")
# Get context for LLM
context = memory.get_context(query="What does John prefer?")
```
"""
DEFAULT_CONFIG = {
"short_term_limit": 100, # Max items in short-term memory
"long_term_limit": 1000, # Max items in long-term memory
"episodic_retention_days": 30, # Days to keep episodic memories
"enable_summarization": False, # Requires LLM
"summarization_threshold": 50, # Summarize after N items
"importance_threshold": 0.7, # Min importance for long-term
"auto_promote": True, # Auto-promote important short-term to long-term
}
def __init__(
self,
user_id: str = "default",
base_path: Optional[str] = None,
config: Optional[Dict[str, Any]] = None,
verbose: int = 0
):
"""
Initialize FileMemory.
Args:
user_id: Unique identifier for the user/session
base_path: Base directory for memory storage (default: .praison/memory)
config: Configuration overrides
verbose: Verbosity level (0=quiet, 1=info, 2+=debug)
"""
self.user_id = user_id
self.verbose = verbose
# Set up paths
if base_path:
self.base_path = Path(base_path)
else:
self.base_path = Path(".praison/memory")
self.user_path = self.base_path / user_id
self.episodic_path = self.user_path / "episodic"
# Create directories
self.user_path.mkdir(parents=True, exist_ok=True)
self.episodic_path.mkdir(parents=True, exist_ok=True)
# File paths
self.config_file = self.user_path / "config.json"
self.short_term_file = self.user_path / "short_term.json"
self.long_term_file = self.user_path / "long_term.json"
self.entities_file = self.user_path / "entities.json"
self.summaries_file = self.user_path / "summaries.json"
# Load or create config
self.config = self._load_config(config)
# Initialize memory stores
self._short_term: List[MemoryItem] = []
self._long_term: List[MemoryItem] = []
self._entities: Dict[str, EntityItem] = {}
self._summaries: List[Dict[str, Any]] = []
# Load existing data
self._load_all()
self._log(f"FileMemory initialized for user '{user_id}' at {self.user_path}")
def _log(self, msg: str, level: int = logging.INFO):
"""Log message if verbose."""
if self.verbose >= 1:
logger.log(level, msg)
def _generate_id(self, content: str) -> str:
"""Generate a unique ID for content."""
timestamp = str(time.time())
hash_input = f"{content}{timestamp}{self.user_id}"
return hashlib.sha256(hash_input.encode()).hexdigest()[:16]
# -------------------------------------------------------------------------
# File Operations
# -------------------------------------------------------------------------
def _read_json(self, filepath: Path, default: Any = None) -> Any:
"""Read JSON file with file locking."""
if not filepath.exists():
return default if default is not None else []
try:
with open(filepath, 'r', encoding='utf-8') as f:
fcntl.flock(f.fileno(), fcntl.LOCK_SH)
try:
data = json.load(f)
finally:
fcntl.flock(f.fileno(), fcntl.LOCK_UN)
return data
except (json.JSONDecodeError, IOError) as e:
self._log(f"Error reading {filepath}: {e}", logging.WARNING)
return default if default is not None else []
def _write_json(self, filepath: Path, data: Any) -> bool:
"""Write JSON file with file locking."""
try:
with open(filepath, 'w', encoding='utf-8') as f:
fcntl.flock(f.fileno(), fcntl.LOCK_EX)
try:
json.dump(data, f, indent=2, ensure_ascii=False)
finally:
fcntl.flock(f.fileno(), fcntl.LOCK_UN)
return True
except IOError as e:
self._log(f"Error writing {filepath}: {e}", logging.ERROR)
return False
def _load_config(self, overrides: Optional[Dict[str, Any]] = None) -> Dict[str, Any]:
"""Load or create configuration."""
config = self.DEFAULT_CONFIG.copy()
# Load existing config
if self.config_file.exists():
saved_config = self._read_json(self.config_file, {})
config.update(saved_config)
# Apply overrides
if overrides:
config.update(overrides)
# Save config
self._write_json(self.config_file, config)
return config
def _load_all(self):
"""Load all memory data from files."""
# Load short-term
short_data = self._read_json(self.short_term_file, [])
self._short_term = [MemoryItem.from_dict(item) for item in short_data]
# Load long-term
long_data = self._read_json(self.long_term_file, [])
self._long_term = [MemoryItem.from_dict(item) for item in long_data]
# Load entities
entities_data = self._read_json(self.entities_file, {})
self._entities = {k: EntityItem.from_dict(v) for k, v in entities_data.items()}
# Load summaries
self._summaries = self._read_json(self.summaries_file, [])
self._log(f"Loaded {len(self._short_term)} short-term, {len(self._long_term)} long-term, {len(self._entities)} entities")
def _save_short_term(self):
"""Save short-term memory to file."""
data = [item.to_dict() for item in self._short_term]
self._write_json(self.short_term_file, data)
def _save_long_term(self):
"""Save long-term memory to file."""
data = [item.to_dict() for item in self._long_term]
self._write_json(self.long_term_file, data)
def _save_entities(self):
"""Save entities to file."""
data = {k: v.to_dict() for k, v in self._entities.items()}
self._write_json(self.entities_file, data)
def _save_summaries(self):
"""Save summaries to file."""
self._write_json(self.summaries_file, self._summaries)
# -------------------------------------------------------------------------
# Short-Term Memory
# -------------------------------------------------------------------------
def add_short_term(
self,
content: str,
metadata: Optional[Dict[str, Any]] = None,
importance: float = 0.5
) -> str:
"""
Add item to short-term memory.
Args:
content: The memory content
metadata: Optional metadata dict
importance: Importance score (0.0 to 1.0)
Returns:
The generated memory ID
"""
item = MemoryItem(
id=self._generate_id(content),
content=content,
metadata=metadata or {},
importance=importance
)
self._short_term.append(item)
# Enforce limit (rolling buffer)
limit = self.config["short_term_limit"]
if len(self._short_term) > limit:
# Before removing, check if should promote to long-term
if self.config["auto_promote"]:
self._auto_promote_to_long_term()
# Remove oldest items
self._short_term = self._short_term[-limit:]
self._save_short_term()
self._log(f"Added short-term memory: {content[:50]}...")
return item.id
def get_short_term(self, limit: Optional[int] = None) -> List[MemoryItem]:
"""Get short-term memories, most recent first."""
items = list(reversed(self._short_term))
if limit:
items = items[:limit]
return items
def _auto_promote_to_long_term(self):
"""Promote high-importance short-term memories to long-term."""
threshold = self.config["importance_threshold"]
promoted = []
for item in self._short_term:
if item.importance >= threshold:
# Check if not already in long-term
existing_ids = {m.id for m in self._long_term}
if item.id not in existing_ids:
self._long_term.append(item)
promoted.append(item.id)
if promoted:
self._save_long_term()
self._log(f"Auto-promoted {len(promoted)} items to long-term memory")
# -------------------------------------------------------------------------
# Long-Term Memory
# -------------------------------------------------------------------------
def add_long_term(
self,
content: str,
metadata: Optional[Dict[str, Any]] = None,
importance: float = 0.8
) -> str:
"""
Add item to long-term memory.
Args:
content: The memory content
metadata: Optional metadata dict
importance: Importance score (0.0 to 1.0)
Returns:
The generated memory ID
"""
item = MemoryItem(
id=self._generate_id(content),
content=content,
metadata=metadata or {},
importance=importance
)
self._long_term.append(item)
# Enforce limit
limit = self.config["long_term_limit"]
if len(self._long_term) > limit:
# Remove lowest importance items
self._long_term.sort(key=lambda x: x.importance, reverse=True)
self._long_term = self._long_term[:limit]
self._save_long_term()
self._log(f"Added long-term memory: {content[:50]}...")
return item.id
def get_long_term(self, limit: Optional[int] = None) -> List[MemoryItem]:
"""Get long-term memories, sorted by importance."""
items = sorted(self._long_term, key=lambda x: x.importance, reverse=True)
if limit:
items = items[:limit]
return items
# -------------------------------------------------------------------------
# Entity Memory
# -------------------------------------------------------------------------
def add_entity(
self,
name: str,
entity_type: str,
attributes: Optional[Dict[str, Any]] = None,
relationships: Optional[List[Dict[str, str]]] = None
) -> str:
"""
Add or update an entity.
Args:
name: Entity name
entity_type: Type (person, place, organization, concept)
attributes: Entity attributes
relationships: List of relationships [{type, target}]
Returns:
The entity ID
"""
entity_id = self._generate_id(f"{name}:{entity_type}")
# Check if entity exists
existing = self._find_entity_by_name(name, entity_type)
if existing:
# Update existing entity
existing.attributes.update(attributes or {})
if relationships:
existing.relationships.extend(relationships)
existing.updated_at = time.time()
entity_id = existing.id
else:
# Create new entity
entity = EntityItem(
id=entity_id,
name=name,
entity_type=entity_type,
attributes=attributes or {},
relationships=relationships or []
)
self._entities[entity_id] = entity
self._save_entities()
self._log(f"Added/updated entity: {name} ({entity_type})")
return entity_id
def get_entity(self, name: str, entity_type: Optional[str] = None) -> Optional[EntityItem]:
"""Get entity by name and optionally type."""
return self._find_entity_by_name(name, entity_type)
def get_all_entities(self, entity_type: Optional[str] = None) -> List[EntityItem]:
"""Get all entities, optionally filtered by type."""
entities = list(self._entities.values())
if entity_type:
entities = [e for e in entities if e.entity_type == entity_type]
return entities
def _find_entity_by_name(self, name: str, entity_type: Optional[str] = None) -> Optional[EntityItem]:
"""Find entity by name."""
name_lower = name.lower()
for entity in self._entities.values():
if entity.name.lower() == name_lower:
if entity_type is None or entity.entity_type == entity_type:
return entity
return None
# -------------------------------------------------------------------------
# Episodic Memory
# -------------------------------------------------------------------------
def add_episodic(
self,
content: str,
metadata: Optional[Dict[str, Any]] = None,
date: Optional[str] = None
) -> str:
"""
Add episodic memory (date-based).
Args:
content: The memory content
metadata: Optional metadata
date: Date string (YYYY-MM-DD), defaults to today
Returns:
The memory ID
"""
if date is None:
date = datetime.now().strftime("%Y-%m-%d")
episodic_file = self.episodic_path / f"{date}.json"
# Load existing episodic memories for this date
episodes = self._read_json(episodic_file, [])
# Create new item
item = MemoryItem(
id=self._generate_id(content),
content=content,
metadata=metadata or {}
)
episodes.append(item.to_dict())
self._write_json(episodic_file, episodes)
self._log(f"Added episodic memory for {date}: {content[:50]}...")
return item.id
def get_episodic(
self,
date: Optional[str] = None,
days_back: int = 7
) -> List[MemoryItem]:
"""
Get episodic memories.
Args:
date: Specific date (YYYY-MM-DD), or None for recent
days_back: Number of days to look back if date is None
Returns:
List of episodic memories
"""
if date:
episodic_file = self.episodic_path / f"{date}.json"
data = self._read_json(episodic_file, [])
return [MemoryItem.from_dict(item) for item in data]
# Get memories from last N days
all_episodes = []
for i in range(days_back):
check_date = (datetime.now() - timedelta(days=i)).strftime("%Y-%m-%d")
episodic_file = self.episodic_path / f"{check_date}.json"
if episodic_file.exists():
data = self._read_json(episodic_file, [])
all_episodes.extend([MemoryItem.from_dict(item) for item in data])
return all_episodes
def cleanup_episodic(self):
"""Remove old episodic memories based on retention policy."""
retention_days = self.config["episodic_retention_days"]
cutoff_date = datetime.now() - timedelta(days=retention_days)
removed = 0
for episodic_file in self.episodic_path.glob("*.json"):
try:
file_date = datetime.strptime(episodic_file.stem, "%Y-%m-%d")
if file_date < cutoff_date:
episodic_file.unlink()
removed += 1
except ValueError:
continue
if removed:
self._log(f"Cleaned up {removed} old episodic memory files")
return removed
# -------------------------------------------------------------------------
# Search & Retrieval
# -------------------------------------------------------------------------
def search(
self,
query: str,
memory_types: Optional[List[str]] = None,
limit: int = 10
) -> List[Dict[str, Any]]:
"""
Search across all memory types.
Args:
query: Search query
memory_types: List of types to search (short_term, long_term, entity, episodic)
limit: Maximum results
Returns:
List of matching memories with scores
"""
if memory_types is None:
memory_types = ["short_term", "long_term", "entity", "episodic"]
results = []
query_lower = query.lower()
query_words = set(query_lower.split())
def score_match(text: str) -> float:
"""Simple relevance scoring."""
text_lower = text.lower()
# Exact match
if query_lower in text_lower:
return 1.0
# Word overlap
text_words = set(text_lower.split())
overlap = len(query_words & text_words)
if overlap > 0:
return overlap / len(query_words) * 0.8
return 0.0
# Search short-term
if "short_term" in memory_types:
for item in self._short_term:
score = score_match(item.content)
if score > 0:
results.append({
"type": "short_term",
"item": item.to_dict(),
"score": score * item.importance
})
# Search long-term
if "long_term" in memory_types:
for item in self._long_term:
score = score_match(item.content)
if score > 0:
results.append({
"type": "long_term",
"item": item.to_dict(),
"score": score * item.importance
})
# Search entities
if "entity" in memory_types:
for entity in self._entities.values():
score = max(
score_match(entity.name),
score_match(str(entity.attributes))
)
if score > 0:
results.append({
"type": "entity",
"item": entity.to_dict(),
"score": score
})
# Search episodic (recent only)
if "episodic" in memory_types:
episodes = self.get_episodic(days_back=7)
for item in episodes:
score = score_match(item.content)
if score > 0:
results.append({
"type": "episodic",
"item": item.to_dict(),
"score": score
})
# Sort by score and limit
results.sort(key=lambda x: x["score"], reverse=True)
return results[:limit]
def get_context(
self,
query: Optional[str] = None,
include_short_term: bool = True,
include_long_term: bool = True,
include_entities: bool = True,
include_episodic: bool = False,
max_tokens: int = 2000
) -> str:
"""
Build context string for LLM from memories.
Args:
query: Optional query to focus context
include_short_term: Include short-term memories
include_long_term: Include long-term memories
include_entities: Include entity information
include_episodic: Include recent episodic memories
max_tokens: Approximate max tokens (chars / 4)
Returns:
Formatted context string
"""
context_parts = []
char_limit = max_tokens * 4 # Rough estimate
# If query provided, use search
if query:
memory_types = []
if include_short_term:
memory_types.append("short_term")
if include_long_term:
memory_types.append("long_term")
if include_entities:
memory_types.append("entity")
if include_episodic:
memory_types.append("episodic")
results = self.search(query, memory_types, limit=20)
if results:
context_parts.append("## Relevant Memories")
for r in results:
if r["type"] == "entity":
item = r["item"]
context_parts.append(f"- {item['name']} ({item['entity_type']}): {item['attributes']}")
else:
context_parts.append(f"- {r['item']['content']}")
else:
# No query - include recent/important memories
if include_long_term:
long_term = self.get_long_term(limit=10)
if long_term:
context_parts.append("## Important Facts")
for item in long_term:
context_parts.append(f"- {item.content}")
if include_entities:
entities = self.get_all_entities()
if entities:
context_parts.append("## Known Entities")
for entity in entities[:10]:
attrs = ", ".join(f"{k}={v}" for k, v in entity.attributes.items())
context_parts.append(f"- {entity.name} ({entity.entity_type}): {attrs}")
if include_short_term:
short_term = self.get_short_term(limit=10)
if short_term:
context_parts.append("## Recent Context")
for item in short_term:
context_parts.append(f"- {item.content}")
if include_episodic:
episodes = self.get_episodic(days_back=3)
if episodes:
context_parts.append("## Recent Interactions")
for item in episodes[:10]:
context_parts.append(f"- {item.content}")
# Join and truncate
context = "\n".join(context_parts)
if len(context) > char_limit:
context = context[:char_limit] + "\n... (truncated)"
return context
# -------------------------------------------------------------------------
# Summarization
# -------------------------------------------------------------------------
def add_summary(
self,
summary: str,
source_type: str,
source_count: int,
metadata: Optional[Dict[str, Any]] = None
):
"""
Add a summary (typically LLM-generated).
Args:
summary: The summary text
source_type: What was summarized (short_term, episodic, etc.)
source_count: Number of items summarized
metadata: Optional metadata
"""
self._summaries.append({
"id": self._generate_id(summary),
"summary": summary,
"source_type": source_type,
"source_count": source_count,
"metadata": metadata or {},
"created_at": time.time()
})
self._save_summaries()
self._log(f"Added summary for {source_count} {source_type} items")
def get_summaries(self, limit: int = 5) -> List[Dict[str, Any]]:
"""Get recent summaries."""
return list(reversed(self._summaries))[:limit]
# -------------------------------------------------------------------------
# Utility Methods
# -------------------------------------------------------------------------
def clear_short_term(self):
"""Clear all short-term memory."""
self._short_term = []
self._save_short_term()
self._log("Cleared short-term memory")
def clear_all(self):
"""Clear all memory for this user."""
self._short_term = []
self._long_term = []
self._entities = {}
self._summaries = []
self._save_short_term()
self._save_long_term()
self._save_entities()
self._save_summaries()
# Clear episodic
for f in self.episodic_path.glob("*.json"):
f.unlink()
self._log("Cleared all memory")
def get_stats(self) -> Dict[str, Any]:
"""Get memory statistics."""
episodic_count = sum(1 for _ in self.episodic_path.glob("*.json"))
return {
"user_id": self.user_id,
"short_term_count": len(self._short_term),
"long_term_count": len(self._long_term),
"entity_count": len(self._entities),
"episodic_days": episodic_count,
"summary_count": len(self._summaries),
"storage_path": str(self.user_path)
}
def export(self) -> Dict[str, Any]:
"""Export all memory data."""
return {
"user_id": self.user_id,
"config": self.config,
"short_term": [item.to_dict() for item in self._short_term],
"long_term": [item.to_dict() for item in self._long_term],
"entities": {k: v.to_dict() for k, v in self._entities.items()},
"summaries": self._summaries,
"exported_at": time.time()
}
def import_data(self, data: Dict[str, Any]):
"""Import memory data from export."""
if "short_term" in data:
self._short_term = [MemoryItem.from_dict(item) for item in data["short_term"]]
self._save_short_term()
if "long_term" in data:
self._long_term = [MemoryItem.from_dict(item) for item in data["long_term"]]
self._save_long_term()
if "entities" in data:
self._entities = {k: EntityItem.from_dict(v) for k, v in data["entities"].items()}
self._save_entities()
if "summaries" in data:
self._summaries = data["summaries"]
self._save_summaries()
self._log("Imported memory data")
# Convenience function for simple usage
def create_memory(
user_id: str = "default",
**kwargs
) -> FileMemory:
"""
Create a FileMemory instance.
Args:
user_id: User identifier
**kwargs: Additional configuration
Returns:
FileMemory instance
"""
return FileMemory(user_id=user_id, **kwargs)
@@ -9,6 +9,85 @@ A tool is a piece of code that helps our AI agents perform specific tasks. Think
- A stock market tool lets agents check stock prices
- A weather tool lets agents check the weather
## Plugin System (NEW!)
PraisonAI now supports a plugin system for creating and distributing tools. External developers can create pip-installable tool packages!
### Quick Start
```python
from praisonaiagents import BaseTool, tool, Agent
# Method 1: Class-based tool
class WeatherTool(BaseTool):
name = "get_weather"
description = "Get weather for a location"
def run(self, location: str) -> dict:
return {"temp": 72, "condition": "sunny"}
# Method 2: Decorator-based tool
@tool
def search(query: str) -> list:
"""Search the web."""
return [{"title": "Result", "url": "https://..."}]
# Use with Agent
agent = Agent(
name="Assistant",
tools=[WeatherTool(), search]
)
```
### Creating a Plugin Package
External developers can create pip-installable plugins:
**1. Create your tool package:**
```
praisonai-weather/
├── pyproject.toml
├── src/
│ └── praisonai_weather/
│ ├── __init__.py
│ └── tools.py
```
**2. Define your tool in `tools.py`:**
```python
from praisonaiagents import BaseTool
class WeatherTool(BaseTool):
name = "weather"
description = "Get current weather"
def run(self, location: str) -> dict:
# Your implementation
return {"temp": 72}
```
**3. Register via entry_points in `pyproject.toml`:**
```toml
[project]
name = "praisonai-weather"
version = "1.0.0"
[project.entry-points."praisonaiagents.tools"]
weather = "praisonai_weather.tools:WeatherTool"
```
**4. Users install and use:**
```bash
pip install praisonai-weather
```
```python
from praisonaiagents import Agent
# Tool is auto-discovered!
agent = Agent(tools=["weather"])
```
## Creating New Tools: The Two Approaches
### 1. Function-Based Approach (Simple Tools)
@@ -173,6 +173,9 @@ TOOL_MAPPINGS = {
'cot_save': ('.train.data.generatecot', 'GenerateCOT'), # Save single QA to file
'cot_upload_to_huggingface': ('.train.data.generatecot', 'GenerateCOT'), # Upload dataset to HuggingFace
'cot_tools': ('.train.data.generatecot', 'GenerateCOT'), # Full toolkit access
# Claude Memory Tool (Anthropic Beta)
'ClaudeMemoryTool': ('.claude_memory_tool', 'ClaudeMemoryTool'),
}
_instances = {} # Cache for class instances
@@ -184,6 +187,11 @@ def __getattr__(name: str) -> Any:
module_path, class_name = TOOL_MAPPINGS[name]
# Return class itself (not instance) for ClaudeMemoryTool
if name == 'ClaudeMemoryTool':
module = import_module(module_path, __package__)
return getattr(module, class_name)
if class_name is None:
# Direct function import
module = import_module(module_path, __package__)
@@ -0,0 +1,298 @@
"""Base classes for PraisonAI Agent tools.
This module provides the foundation for creating tools that can be used by agents.
External developers can create plugins by subclassing BaseTool.
Usage:
from praisonaiagents import BaseTool
class MyTool(BaseTool):
name = "my_tool"
description = "Does something useful"
def run(self, query: str) -> str:
return f"Result for {query}"
"""
from abc import ABC, abstractmethod
from typing import Any, Dict, Optional, Type, get_type_hints
import inspect
import logging
class ToolValidationError(Exception):
"""Raised when a tool fails validation."""
pass
class ToolResult:
"""Wrapper for tool execution results."""
def __init__(
self,
output: Any,
success: bool = True,
error: Optional[str] = None,
metadata: Optional[Dict[str, Any]] = None
):
self.output = output
self.success = success
self.error = error
self.metadata = metadata or {}
def __str__(self) -> str:
if self.success:
return str(self.output)
return f"Error: {self.error}"
def __repr__(self) -> str:
return f"ToolResult(success={self.success}, output={self.output!r})"
def to_dict(self) -> Dict[str, Any]:
return {
"output": self.output,
"success": self.success,
"error": self.error,
"metadata": self.metadata
}
class BaseTool(ABC):
"""Abstract base class for all PraisonAI tools.
Subclass this to create custom tools that can be:
- Used directly by agents
- Distributed as pip-installable plugins
- Auto-discovered via entry_points
Attributes:
name: Unique identifier for the tool
description: Human-readable description (used by LLM)
version: Tool version string (default: "1.0.0")
parameters: JSON Schema for parameters (auto-generated if not provided)
Example:
class WeatherTool(BaseTool):
name = "get_weather"
description = "Get current weather for a location"
def run(self, location: str, units: str = "celsius") -> dict:
# Implementation here
return {"temp": 22, "condition": "sunny"}
"""
# Required class attributes (must be overridden)
name: str = ""
description: str = ""
# Optional class attributes
version: str = "1.0.0"
parameters: Optional[Dict[str, Any]] = None # JSON Schema, auto-generated if None
def __init__(self):
"""Initialize the tool and validate configuration."""
if not self.name:
# Use class name as default
self.name = self.__class__.__name__.lower().replace("tool", "")
if not self.description:
# Use docstring as default
self.description = self.__class__.__doc__ or f"Tool: {self.name}"
# Auto-generate parameters schema if not provided
if self.parameters is None:
self.parameters = self._generate_parameters_schema()
def _generate_parameters_schema(self) -> Dict[str, Any]:
"""Generate JSON Schema from run() method signature."""
schema = {
"type": "object",
"properties": {},
"required": []
}
try:
sig = inspect.signature(self.run)
hints = get_type_hints(self.run) if hasattr(self.run, '__annotations__') else {}
for param_name, param in sig.parameters.items():
if param_name == 'self':
continue
# Get type hint
param_type = hints.get(param_name, Any)
json_type = self._python_type_to_json(param_type)
# Build property schema
prop_schema = {"type": json_type}
# Add description from docstring if available
# (Could parse docstring for param descriptions)
schema["properties"][param_name] = prop_schema
# Check if required (no default value)
if param.default is inspect.Parameter.empty:
schema["required"].append(param_name)
except Exception as e:
logging.debug(f"Could not generate schema for {self.name}: {e}")
return schema
@staticmethod
def _python_type_to_json(python_type: Type) -> str:
"""Convert Python type to JSON Schema type."""
type_map = {
str: "string",
int: "integer",
float: "number",
bool: "boolean",
list: "array",
dict: "object",
type(None): "null"
}
# Handle Optional, Union, etc.
origin = getattr(python_type, '__origin__', None)
if origin is not None:
# For List[X], return "array"
if origin is list:
return "array"
# For Dict[X, Y], return "object"
if origin is dict:
return "object"
return type_map.get(python_type, "string")
@abstractmethod
def run(self, **kwargs) -> Any:
"""Execute the tool with given arguments.
This method must be implemented by subclasses.
Args:
**kwargs: Tool-specific arguments
Returns:
Tool output (any type, will be converted to string for LLM)
"""
pass
def __call__(self, **kwargs) -> Any:
"""Allow tool to be called directly like a function."""
return self.run(**kwargs)
def safe_run(self, **kwargs) -> ToolResult:
"""Execute tool with error handling, returning ToolResult."""
try:
output = self.run(**kwargs)
return ToolResult(output=output, success=True)
except Exception as e:
logging.error(f"Tool {self.name} failed: {e}")
return ToolResult(
output=None,
success=False,
error=str(e)
)
def get_schema(self) -> Dict[str, Any]:
"""Get OpenAI-compatible function schema for this tool."""
return {
"type": "function",
"function": {
"name": self.name,
"description": self.description,
"parameters": self.parameters
}
}
def __str__(self) -> str:
return f"{self.__class__.__name__}(name='{self.name}')"
def __repr__(self) -> str:
return f"{self.__class__.__name__}(name='{self.name}', description='{self.description[:50]}...')"
def validate(self) -> bool:
"""Validate the tool configuration.
Raises:
ToolValidationError: If validation fails
Returns:
True if validation passes
"""
errors = []
# Check required fields
if not self.name or not isinstance(self.name, str):
errors.append("Tool must have a non-empty string 'name'")
if not self.description or not isinstance(self.description, str):
errors.append("Tool must have a non-empty string 'description'")
# Check that run() is implemented (not abstract)
if getattr(self.run, '__isabstractmethod__', False):
errors.append("Tool must implement the 'run()' method")
# Check parameters schema is valid
if self.parameters:
if not isinstance(self.parameters, dict):
errors.append("'parameters' must be a dictionary")
elif "type" not in self.parameters:
errors.append("'parameters' must have a 'type' field")
if errors:
raise ToolValidationError(f"Tool '{self.name}' validation failed: {'; '.join(errors)}")
return True
@classmethod
def validate_class(cls) -> bool:
"""Validate a tool class before instantiation.
This can be used to check if a class is a valid tool without creating an instance.
Returns:
True if the class appears to be a valid tool
"""
# Check it's a subclass of BaseTool
if not issubclass(cls, BaseTool):
return False
# Check it has required class attributes or will get them from __init__
# (name and description can be set in __init__ so we can't strictly require them)
# Check run() is defined (not just inherited abstract)
if 'run' not in cls.__dict__:
return False
return True
def validate_tool(tool: Any) -> bool:
"""Validate any tool-like object.
Args:
tool: Object to validate (BaseTool, callable, etc.)
Returns:
True if valid
Raises:
ToolValidationError: If validation fails
"""
if isinstance(tool, BaseTool):
return tool.validate()
if callable(tool):
# For plain functions, check they have a name
name = getattr(tool, '__name__', None) or getattr(tool, 'name', None)
if not name:
raise ToolValidationError("Callable tool must have a __name__ or name attribute")
return True
raise ToolValidationError(f"Invalid tool type: {type(tool)}")
# For backward compatibility - tools can also just be functions
# The @tool decorator (in decorator.py) wraps functions into BaseTool instances
@@ -0,0 +1,529 @@
"""
Claude Memory Tool - File-based persistent memory for Claude models.
This module implements Anthropic's Memory Tool API (beta) which enables Claude
to store and retrieve information across conversations through a memory file directory.
The memory tool operates client-side - you control where and how the data is stored.
Beta Header: context-management-2025-06-27
Tool Type: memory_20250818
Supported Models:
- Claude Sonnet 4.5 (claude-sonnet-4-5-20250929)
- Claude Sonnet 4 (claude-sonnet-4-20250514)
- Claude Haiku 4.5 (claude-haiku-4-5-20251001)
- Claude Opus 4.5 (claude-opus-4-5-20251101)
- Claude Opus 4.1 (claude-opus-4-1-20250805)
- Claude Opus 4 (claude-opus-4-20250514)
Reference: https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/memory-tool
"""
import shutil
import logging
from pathlib import Path
from typing import Any, Dict, List, Optional
logger = logging.getLogger(__name__)
# Memory system prompt that Claude uses to manage memory
MEMORY_SYSTEM_PROMPT = """
IMPORTANT: ALWAYS VIEW YOUR MEMORY DIRECTORY BEFORE DOING ANYTHING ELSE.
MEMORY PROTOCOL:
1. Use the `view` command of your `memory` tool to check for earlier progress.
2. ... (work on the task) ...
- As you make progress, record status / progress / thoughts etc in your memory.
ASSUME INTERRUPTION: Your context window might be reset at any moment, so you risk losing any progress that is not recorded in your memory directory.
When editing your memory folder, always try to keep its content up-to-date, coherent and organized. You can rename or delete files that are no longer relevant. Do not create new files unless necessary.
"""
class ClaudeMemoryTool:
"""
File-based memory tool for Claude models.
Implements Anthropic's Memory Tool API (beta). Claude autonomously decides
what to store and retrieve from the memory directory.
Storage: {base_path}/memories/
Commands:
- view: Show directory contents or file contents with optional line ranges
- create: Create or overwrite a file
- str_replace: Replace text in a file
- insert: Insert text at a specific line
- delete: Delete a file or directory
- rename: Rename or move a file/directory
Example:
```python
from praisonaiagents import Agent
from praisonaiagents.tools import ClaudeMemoryTool
# Use default storage
agent = Agent(
name="Assistant",
llm="anthropic/claude-sonnet-4-20250514",
claude_memory=True
)
# Or with custom storage path
memory = ClaudeMemoryTool(base_path="./my_project/memory")
agent = Agent(
name="Assistant",
llm="anthropic/claude-sonnet-4-20250514",
claude_memory=memory
)
```
Security:
- All paths are validated to prevent directory traversal attacks
- Paths must start with /memories
- Symlinks are not followed outside the memory directory
"""
# Beta header required for memory tool
BETA_HEADER = "context-management-2025-06-27"
# Tool definition for API requests
TOOL_DEFINITION = {
"type": "memory_20250818",
"name": "memory"
}
def __init__(
self,
base_path: Optional[str] = None,
user_id: Optional[str] = None,
max_file_size: int = 1024 * 1024, # 1MB default
max_files: int = 100
):
"""
Initialize the Claude Memory Tool.
Args:
base_path: Base directory for memory storage.
Defaults to .praison/claude_memory/{user_id}
user_id: User identifier for user-specific memory.
Defaults to "default"
max_file_size: Maximum size per file in bytes (default 1MB)
max_files: Maximum number of files allowed (default 100)
"""
self.user_id = user_id or "default"
if base_path:
self.base_path = Path(base_path)
else:
self.base_path = Path(f".praison/claude_memory/{self.user_id}")
self.memory_root = self.base_path / "memories"
self.max_file_size = max_file_size
self.max_files = max_files
# Create memory directory
self.memory_root.mkdir(parents=True, exist_ok=True)
logger.debug(f"ClaudeMemoryTool initialized at {self.memory_root}")
def _validate_path(self, path: str) -> Path:
"""
Validate and resolve memory paths securely.
Args:
path: Path string starting with /memories
Returns:
Resolved Path object within memory directory
Raises:
ValueError: If path is invalid or attempts directory traversal
"""
if not path:
raise ValueError("Path cannot be empty")
if not path.startswith("/memories"):
raise ValueError(f"Path must start with /memories, got: {path}")
# Remove /memories prefix and leading slashes
relative_path = path[len("/memories"):].lstrip("/")
# Resolve the full path
if relative_path:
full_path = self.memory_root / relative_path
else:
full_path = self.memory_root
# Security check: ensure resolved path is within memory_root
try:
resolved = full_path.resolve()
resolved.relative_to(self.memory_root.resolve())
except ValueError as e:
raise ValueError(f"Path {path} would escape /memories directory") from e
# Check for suspicious patterns
if ".." in path or "~" in path:
raise ValueError(f"Invalid path pattern in: {path}")
return full_path
def execute(self, command: str, **kwargs) -> str:
"""
Execute a memory command.
Args:
command: Command name (view, create, str_replace, insert, delete, rename)
**kwargs: Command-specific arguments
Returns:
Result string from the command
Raises:
ValueError: If command is unknown
"""
commands = {
"view": self.view,
"create": self.create,
"str_replace": self.str_replace,
"insert": self.insert,
"delete": self.delete,
"rename": self.rename
}
if command not in commands:
raise ValueError(f"Unknown command: {command}. Valid commands: {list(commands.keys())}")
return commands[command](**kwargs)
def view(self, path: str, view_range: Optional[List[int]] = None) -> str:
"""
Show directory contents or file contents with optional line ranges.
Args:
path: Path to view (e.g., "/memories" or "/memories/notes.txt")
view_range: Optional [start_line, end_line] for file viewing.
Use -1 for end_line to read to end of file.
Returns:
Directory listing or file contents with line numbers
Raises:
RuntimeError: If path cannot be read
"""
full_path = self._validate_path(path)
if full_path.is_dir():
# List directory contents
items: List[str] = []
try:
for item in sorted(full_path.iterdir()):
# Skip hidden files
if item.name.startswith("."):
continue
# Add trailing slash for directories
items.append(f"{item.name}/" if item.is_dir() else item.name)
result = f"Directory: {path}\n"
if items:
result += "\n".join([f"- {item}" for item in items])
else:
result += "(empty directory)"
return result
except Exception as e:
raise RuntimeError(f"Cannot read directory {path}: {e}") from e
elif full_path.is_file():
# Read file contents
try:
content = full_path.read_text(encoding="utf-8")
lines = content.splitlines()
# Apply view range if specified
if view_range:
start_line = max(1, view_range[0]) - 1 # Convert to 0-indexed
end_line = len(lines) if view_range[1] == -1 else view_range[1]
lines = lines[start_line:end_line]
start_num = start_line + 1
else:
start_num = 1
# Add line numbers
numbered_lines = [
f"{i + start_num:4d}: {line}"
for i, line in enumerate(lines)
]
return "\n".join(numbered_lines) if numbered_lines else "(empty file)"
except Exception as e:
raise RuntimeError(f"Cannot read file {path}: {e}") from e
else:
raise RuntimeError(f"Path not found: {path}")
def create(self, path: str, file_text: str) -> str:
"""
Create or overwrite a file.
Args:
path: Path for the new file (e.g., "/memories/notes.txt")
file_text: Content to write to the file
Returns:
Success message
Raises:
ValueError: If file would exceed size limit or max files reached
"""
full_path = self._validate_path(path)
# Check file size limit
if len(file_text.encode('utf-8')) > self.max_file_size:
raise ValueError(
f"File content exceeds maximum size of {self.max_file_size} bytes"
)
# Check max files limit (only for new files)
if not full_path.exists():
current_files = sum(1 for _ in self.memory_root.rglob("*") if _.is_file())
if current_files >= self.max_files:
raise ValueError(
f"Maximum number of files ({self.max_files}) reached. "
"Delete some files before creating new ones."
)
# Create parent directories if needed
full_path.parent.mkdir(parents=True, exist_ok=True)
# Write file
full_path.write_text(file_text, encoding="utf-8")
return f"File created successfully at {path}"
def str_replace(self, path: str, old_str: str, new_str: str) -> str:
"""
Replace text in a file.
Args:
path: Path to the file
old_str: Text to find (must be unique in file)
new_str: Replacement text
Returns:
Success message
Raises:
FileNotFoundError: If file doesn't exist
ValueError: If old_str not found or appears multiple times
"""
full_path = self._validate_path(path)
if not full_path.is_file():
raise FileNotFoundError(f"File not found: {path}")
content = full_path.read_text(encoding="utf-8")
# Count occurrences
count = content.count(old_str)
if count == 0:
raise ValueError(f"Text not found in {path}")
elif count > 1:
raise ValueError(
f"Text appears {count} times in {path}. Must be unique for replacement."
)
# Replace and write
new_content = content.replace(old_str, new_str)
# Check size limit
if len(new_content.encode('utf-8')) > self.max_file_size:
raise ValueError(
f"Resulting file would exceed maximum size of {self.max_file_size} bytes"
)
full_path.write_text(new_content, encoding="utf-8")
return f"File {path} has been edited"
def insert(self, path: str, insert_line: int, insert_text: str) -> str:
"""
Insert text at a specific line.
Args:
path: Path to the file
insert_line: Line number to insert at (0-indexed)
insert_text: Text to insert
Returns:
Success message
Raises:
FileNotFoundError: If file doesn't exist
ValueError: If line number is invalid
"""
full_path = self._validate_path(path)
if not full_path.is_file():
raise FileNotFoundError(f"File not found: {path}")
lines = full_path.read_text(encoding="utf-8").splitlines()
# Validate line number
if insert_line < 0 or insert_line > len(lines):
raise ValueError(
f"Invalid insert_line {insert_line}. Must be 0-{len(lines)}"
)
# Insert the text (strip trailing newline to avoid double newlines)
lines.insert(insert_line, insert_text.rstrip("\n"))
# Reconstruct content
new_content = "\n".join(lines) + "\n"
# Check size limit
if len(new_content.encode('utf-8')) > self.max_file_size:
raise ValueError(
f"Resulting file would exceed maximum size of {self.max_file_size} bytes"
)
full_path.write_text(new_content, encoding="utf-8")
return f"Text inserted at line {insert_line} in {path}"
def delete(self, path: str) -> str:
"""
Delete a file or directory.
Args:
path: Path to delete
Returns:
Success message
Raises:
ValueError: If trying to delete /memories root
FileNotFoundError: If path doesn't exist
"""
# Prevent deleting the root memories directory
if path == "/memories" or path == "/memories/":
raise ValueError("Cannot delete the /memories directory itself")
full_path = self._validate_path(path)
if full_path.is_file():
full_path.unlink()
return f"File deleted: {path}"
elif full_path.is_dir():
shutil.rmtree(full_path)
return f"Directory deleted: {path}"
else:
raise FileNotFoundError(f"Path not found: {path}")
def rename(self, old_path: str, new_path: str) -> str:
"""
Rename or move a file/directory.
Args:
old_path: Current path
new_path: New path
Returns:
Success message
Raises:
FileNotFoundError: If source doesn't exist
ValueError: If destination already exists
"""
old_full_path = self._validate_path(old_path)
new_full_path = self._validate_path(new_path)
if not old_full_path.exists():
raise FileNotFoundError(f"Source path not found: {old_path}")
if new_full_path.exists():
raise ValueError(f"Destination already exists: {new_path}")
# Create parent directories if needed
new_full_path.parent.mkdir(parents=True, exist_ok=True)
# Rename/move
old_full_path.rename(new_full_path)
return f"Renamed {old_path} to {new_path}"
def clear_all(self) -> str:
"""
Clear all memory files.
Returns:
Success message
"""
if self.memory_root.exists():
shutil.rmtree(self.memory_root)
self.memory_root.mkdir(parents=True, exist_ok=True)
return "All memory cleared"
def get_tool_definition(self) -> Dict[str, Any]:
"""
Get the tool definition for API requests.
Returns:
Tool definition dict for Anthropic API
"""
return self.TOOL_DEFINITION.copy()
def get_beta_header(self) -> str:
"""
Get the beta header value for API requests.
Returns:
Beta header string
"""
return self.BETA_HEADER
def get_system_prompt(self) -> str:
"""
Get the memory system prompt to append to agent instructions.
Returns:
Memory protocol system prompt
"""
return MEMORY_SYSTEM_PROMPT
def process_tool_call(self, tool_input: Dict[str, Any]) -> str:
"""
Process a memory tool call from Claude.
Args:
tool_input: The input dict from Claude's tool_use block
Contains 'command' and command-specific parameters
Returns:
Result string to return to Claude
Example:
```python
# Claude sends:
# {"command": "view", "path": "/memories"}
result = memory_tool.process_tool_call(tool_input)
```
"""
command = tool_input.get("command")
if not command:
return "Error: No command specified in tool input"
try:
# Extract command-specific parameters
params = {k: v for k, v in tool_input.items() if k != "command"}
return self.execute(command, **params)
except Exception as e:
return f"Error: {str(e)}"
def __repr__(self) -> str:
return f"ClaudeMemoryTool(base_path='{self.base_path}', user_id='{self.user_id}')"
@@ -0,0 +1,225 @@
"""Tool decorator for converting functions into tools.
This module provides the @tool decorator for easily creating tools from functions.
Usage:
from praisonaiagents import tool
@tool
def search(query: str) -> list:
'''Search the web for information.'''
return [...]
# Or with explicit parameters:
@tool(name="web_search", description="Search the internet")
def search(query: str, max_results: int = 5) -> list:
return [...]
"""
import inspect
import functools
import logging
from typing import Any, Callable, Dict, Optional, Union, get_type_hints
from .base import BaseTool
class FunctionTool(BaseTool):
"""A BaseTool wrapper for plain functions.
Created automatically by the @tool decorator.
"""
def __init__(
self,
func: Callable,
name: Optional[str] = None,
description: Optional[str] = None,
version: str = "1.0.0"
):
self._func = func
self.name = name or func.__name__
self.description = description or func.__doc__ or f"Tool: {self.name}"
self.version = version
# Generate schema from the original function, not run()
self.parameters = self._generate_schema_from_func(func)
# Copy function metadata
functools.update_wrapper(self, func)
# Skip parent's schema generation since we already did it
# Just set defaults that parent would set
if not self.name:
self.name = self.__class__.__name__.lower().replace("tool", "")
if not self.description:
self.description = self.__class__.__doc__ or f"Tool: {self.name}"
def _generate_schema_from_func(self, func: Callable) -> Dict[str, Any]:
"""Generate JSON Schema from the wrapped function's signature."""
schema = {
"type": "object",
"properties": {},
"required": []
}
try:
sig = inspect.signature(func)
hints = get_type_hints(func) if hasattr(func, '__annotations__') else {}
for param_name, param in sig.parameters.items():
if param_name in ('self', 'cls'):
continue
# Get type hint
param_type = hints.get(param_name, Any)
json_type = BaseTool._python_type_to_json(param_type)
schema["properties"][param_name] = {"type": json_type}
# Check if required (no default value)
if param.default is inspect.Parameter.empty:
schema["required"].append(param_name)
except Exception as e:
logging.debug(f"Could not generate schema for {func.__name__}: {e}")
return schema
def run(self, **kwargs) -> Any:
"""Execute the wrapped function."""
return self._func(**kwargs)
def __call__(self, *args, **kwargs) -> Any:
"""Allow calling with positional args like the original function."""
return self._func(*args, **kwargs)
def tool(
func: Optional[Callable] = None,
*,
name: Optional[str] = None,
description: Optional[str] = None,
version: str = "1.0.0"
) -> Union[FunctionTool, Callable[[Callable], FunctionTool]]:
"""Decorator to convert a function into a tool.
Can be used with or without arguments:
@tool
def my_func(x: str) -> str:
'''Does something.'''
return x
@tool(name="custom_name", description="Custom description")
def my_func(x: str) -> str:
return x
Args:
func: The function to wrap (when used without parentheses)
name: Override the tool name (default: function name)
description: Override description (default: function docstring)
version: Tool version (default: "1.0.0")
Returns:
FunctionTool instance that wraps the function
"""
def decorator(fn: Callable) -> FunctionTool:
tool_instance = FunctionTool(
func=fn,
name=name,
description=description,
version=version
)
# Register with global registry if available
try:
from .registry import get_registry
registry = get_registry()
if registry:
registry.register(tool_instance)
except ImportError:
pass # Registry not yet available
return tool_instance
# Handle both @tool and @tool(...) syntax
if func is not None:
# Called without parentheses: @tool
return decorator(func)
else:
# Called with parentheses: @tool(...)
return decorator
def is_tool(obj: Any) -> bool:
"""Check if an object is a tool (BaseTool instance or decorated function)."""
if isinstance(obj, BaseTool):
return True
if isinstance(obj, FunctionTool):
return True
# Check for tools created by other frameworks
if hasattr(obj, 'run') and hasattr(obj, 'name'):
return True
return False
def get_tool_schema(obj: Any) -> Optional[Dict[str, Any]]:
"""Get OpenAI-compatible schema for any tool-like object.
Supports:
- BaseTool instances
- FunctionTool instances
- Plain functions (generates schema from signature)
- LangChain tools
- CrewAI tools
"""
# BaseTool or FunctionTool
if isinstance(obj, BaseTool):
return obj.get_schema()
# Plain callable
if callable(obj):
return _schema_from_function(obj)
return None
def _schema_from_function(func: Callable) -> Dict[str, Any]:
"""Generate OpenAI function schema from a plain function."""
name = getattr(func, '__name__', 'unknown')
description = func.__doc__ or f"Function: {name}"
# Build parameters schema
properties = {}
required = []
try:
sig = inspect.signature(func)
hints = get_type_hints(func) if hasattr(func, '__annotations__') else {}
for param_name, param in sig.parameters.items():
if param_name == 'self':
continue
param_type = hints.get(param_name, Any)
json_type = BaseTool._python_type_to_json(param_type)
properties[param_name] = {"type": json_type}
if param.default is inspect.Parameter.empty:
required.append(param_name)
except Exception as e:
logging.debug(f"Could not generate schema for {name}: {e}")
return {
"type": "function",
"function": {
"name": name,
"description": description.strip(),
"parameters": {
"type": "object",
"properties": properties,
"required": required
}
}
}
@@ -0,0 +1,244 @@
"""Example plugin tools demonstrating the BaseTool and @tool patterns.
This module shows how to create tools using the new plugin system.
External developers can use these patterns to create pip-installable plugins.
Usage:
from praisonaiagents import BaseTool, tool, Agent
# Method 1: Class-based tool
class MyTool(BaseTool):
name = "my_tool"
description = "Does something useful"
def run(self, param: str) -> str:
return f"Result: {param}"
# Method 2: Decorator-based tool
@tool
def my_function(param: str) -> str:
'''Does something useful.'''
return f"Result: {param}"
# Use with Agent
agent = Agent(tools=[MyTool(), my_function])
"""
from typing import Dict, Any, List
from .base import BaseTool
from .decorator import tool
# =============================================================================
# Example 1: Simple Class-Based Tool
# =============================================================================
class EchoTool(BaseTool):
"""A simple tool that echoes input back.
This demonstrates the minimal BaseTool implementation.
"""
name = "echo"
description = "Echo the input message back"
def run(self, message: str) -> str:
"""Echo the message.
Args:
message: The message to echo
Returns:
The same message
"""
return message
# =============================================================================
# Example 2: Tool with Multiple Parameters
# =============================================================================
class MathTool(BaseTool):
"""A tool for basic math operations.
Demonstrates:
- Multiple parameters with types
- Default parameter values
- Returning structured data
"""
name = "basic_math"
description = "Perform basic math operations (add, subtract, multiply, divide)"
def run(
self,
a: float,
b: float,
operation: str = "add"
) -> Dict[str, Any]:
"""Perform a math operation.
Args:
a: First number
b: Second number
operation: One of 'add', 'subtract', 'multiply', 'divide'
Returns:
Dict with result and operation details
"""
operations = {
"add": lambda x, y: x + y,
"subtract": lambda x, y: x - y,
"multiply": lambda x, y: x * y,
"divide": lambda x, y: x / y if y != 0 else float('inf')
}
if operation not in operations:
return {"error": f"Unknown operation: {operation}"}
result = operations[operation](a, b)
return {
"result": result,
"operation": operation,
"expression": f"{a} {operation} {b} = {result}"
}
# =============================================================================
# Example 3: Tool with State (Instance Variables)
# =============================================================================
class CounterTool(BaseTool):
"""A tool that maintains state between calls.
Demonstrates:
- Instance variables for state
- Custom __init__ with super() call
"""
name = "counter"
description = "A counter that increments each time it's called"
def __init__(self, start: int = 0):
self._count = start
super().__init__() # Important: call parent init
def run(self, increment: int = 1) -> Dict[str, int]:
"""Increment the counter.
Args:
increment: Amount to increment by (default: 1)
Returns:
Dict with previous and current count
"""
previous = self._count
self._count += increment
return {
"previous": previous,
"current": self._count,
"increment": increment
}
# =============================================================================
# Example 4: Decorator-Based Tools
# =============================================================================
@tool
def greet(name: str, greeting: str = "Hello") -> str:
"""Generate a greeting message.
Args:
name: Name of the person to greet
greeting: The greeting word (default: "Hello")
Returns:
A greeting string
"""
return f"{greeting}, {name}!"
@tool(name="reverse_text", description="Reverse a string of text")
def reverse_string(text: str) -> str:
"""Reverse the input text."""
return text[::-1]
@tool
def list_numbers(start: int, end: int, step: int = 1) -> List[int]:
"""Generate a list of numbers.
Args:
start: Starting number (inclusive)
end: Ending number (exclusive)
step: Step between numbers (default: 1)
Returns:
List of integers
"""
return list(range(start, end, step))
# =============================================================================
# Example 5: Tool with Error Handling
# =============================================================================
class SafeDivideTool(BaseTool):
"""A division tool with proper error handling.
Demonstrates:
- Error handling in run()
- Returning error information
"""
name = "safe_divide"
description = "Safely divide two numbers with error handling"
def run(self, numerator: float, denominator: float) -> Dict[str, Any]:
"""Divide numerator by denominator.
Args:
numerator: The number to divide
denominator: The number to divide by
Returns:
Dict with result or error message
"""
if denominator == 0:
return {
"success": False,
"error": "Division by zero is not allowed"
}
result = numerator / denominator
return {
"success": True,
"result": result
}
# =============================================================================
# Convenience exports
# =============================================================================
# These can be imported directly:
# from praisonaiagents.tools.example_plugin import echo_tool, math_tool, greet
echo_tool = EchoTool()
math_tool = MathTool()
counter_tool = CounterTool()
safe_divide_tool = SafeDivideTool()
__all__ = [
# Classes
'EchoTool',
'MathTool',
'CounterTool',
'SafeDivideTool',
# Instances
'echo_tool',
'math_tool',
'counter_tool',
'safe_divide_tool',
# Decorated functions
'greet',
'reverse_string',
'list_numbers',
]
@@ -0,0 +1,225 @@
"""Tool registry for managing and discovering tools.
This module provides centralized tool management with support for:
- Manual registration
- Auto-discovery via entry_points
- Tool lookup by name
Usage:
from praisonaiagents.tools.registry import get_registry
registry = get_registry()
registry.register(my_tool)
tool = registry.get("my_tool")
"""
import logging
from typing import Callable, Dict, List, Optional, Union
from importlib.metadata import entry_points
from .base import BaseTool
# Entry point group name for external plugins
ENTRY_POINT_GROUP = "praisonaiagents.tools"
class ToolRegistry:
"""Central registry for all tools.
Provides:
- Tool registration (manual and auto-discovery)
- Tool lookup by name
- Tool listing and filtering
- Entry points discovery for external plugins
"""
def __init__(self):
self._tools: Dict[str, BaseTool] = {}
self._functions: Dict[str, Callable] = {} # For backward compat with plain functions
self._discovered: bool = False
def register(
self,
tool: Union[BaseTool, Callable],
name: Optional[str] = None,
overwrite: bool = False
) -> None:
"""Register a tool with the registry.
Args:
tool: BaseTool instance or callable function
name: Override name (default: tool.name or function.__name__)
overwrite: If True, overwrite existing tool with same name
Raises:
ValueError: If tool with same name exists and overwrite=False
"""
# Handle BaseTool instances
if isinstance(tool, BaseTool):
tool_name = name or tool.name
if tool_name in self._tools and not overwrite:
logging.debug(f"Tool '{tool_name}' already registered, skipping")
return
self._tools[tool_name] = tool
logging.debug(f"Registered tool: {tool_name}")
return
# Handle plain callables
if callable(tool):
tool_name = name or getattr(tool, '__name__', str(id(tool)))
if tool_name in self._functions and not overwrite:
logging.debug(f"Function '{tool_name}' already registered, skipping")
return
self._functions[tool_name] = tool
logging.debug(f"Registered function: {tool_name}")
return
raise TypeError(f"Cannot register {type(tool)}, expected BaseTool or callable")
def unregister(self, name: str) -> bool:
"""Remove a tool from the registry.
Args:
name: Tool name to remove
Returns:
True if tool was removed, False if not found
"""
if name in self._tools:
del self._tools[name]
return True
if name in self._functions:
del self._functions[name]
return True
return False
def get(self, name: str) -> Optional[Union[BaseTool, Callable]]:
"""Get a tool by name.
Args:
name: Tool name
Returns:
BaseTool instance, callable, or None if not found
"""
# Check BaseTool registry first
if name in self._tools:
return self._tools[name]
# Check functions registry
if name in self._functions:
return self._functions[name]
# Try auto-discovery if not found
if not self._discovered:
self.discover_plugins()
if name in self._tools:
return self._tools[name]
return None
def list_tools(self) -> List[str]:
"""List all registered tool names."""
return list(self._tools.keys()) + list(self._functions.keys())
def list_base_tools(self) -> List[BaseTool]:
"""List all registered BaseTool instances."""
return list(self._tools.values())
def get_all(self) -> Dict[str, Union[BaseTool, Callable]]:
"""Get all registered tools as a dict."""
result = dict(self._tools)
result.update(self._functions)
return result
def discover_plugins(self) -> int:
"""Discover and register tools from entry_points.
External packages can register tools by adding to pyproject.toml:
[project.entry-points."praisonaiagents.tools"]
my_tool = "my_package.tools:MyTool"
Returns:
Number of tools discovered
"""
if self._discovered:
return 0
count = 0
try:
# Python 3.10+ style
eps = entry_points(group=ENTRY_POINT_GROUP)
except TypeError:
# Python 3.9 fallback
try:
all_eps = entry_points()
eps = all_eps.get(ENTRY_POINT_GROUP, [])
except Exception:
eps = []
for ep in eps:
try:
tool_class_or_func = ep.load()
# If it's a class, instantiate it
if isinstance(tool_class_or_func, type) and issubclass(tool_class_or_func, BaseTool):
tool_instance = tool_class_or_func()
self.register(tool_instance, name=ep.name)
# If it's already an instance or callable
elif isinstance(tool_class_or_func, BaseTool):
self.register(tool_class_or_func, name=ep.name)
elif callable(tool_class_or_func):
self.register(tool_class_or_func, name=ep.name)
else:
logging.warning(f"Entry point '{ep.name}' is not a valid tool")
continue
count += 1
logging.info(f"Discovered plugin tool: {ep.name}")
except Exception as e:
logging.warning(f"Failed to load plugin '{ep.name}': {e}")
self._discovered = True
return count
def clear(self) -> None:
"""Clear all registered tools."""
self._tools.clear()
self._functions.clear()
self._discovered = False
def __contains__(self, name: str) -> bool:
return name in self._tools or name in self._functions
def __len__(self) -> int:
return len(self._tools) + len(self._functions)
def __repr__(self) -> str:
return f"ToolRegistry(tools={len(self._tools)}, functions={len(self._functions)})"
# Global registry instance
_global_registry: Optional[ToolRegistry] = None
def get_registry() -> ToolRegistry:
"""Get the global tool registry instance."""
global _global_registry
if _global_registry is None:
_global_registry = ToolRegistry()
return _global_registry
def register_tool(
tool: Union[BaseTool, Callable],
name: Optional[str] = None
) -> None:
"""Convenience function to register a tool with the global registry."""
get_registry().register(tool, name=name)
def get_tool(name: str) -> Optional[Union[BaseTool, Callable]]:
"""Convenience function to get a tool from the global registry."""
return get_registry().get(name)
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "praisonaiagents"
version = "0.0.161"
version = "0.0.178"
description = "Praison AI agents for completing complex tasks with Self Reflection Agents"
requires-python = ">=3.10"
authors = [
@@ -0,0 +1,141 @@
"""
Query Rewriter Agent Example
Demonstrates various query rewriting strategies for improving RAG retrieval.
"""
from dotenv import load_dotenv
load_dotenv()
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
def main():
# Initialize the agent
agent = QueryRewriterAgent(
model="gpt-4o-mini",
verbose=True
)
print("=" * 60)
print("Query Rewriter Agent Examples")
print("=" * 60)
# 1. Basic Rewriting - Short keyword queries
print("\n1. BASIC REWRITING (Short Queries)")
print("-" * 40)
short_queries = [
"AI trends",
"python performance",
"RAG best practices"
]
for query in short_queries:
result = agent.rewrite(query, strategy=RewriteStrategy.BASIC)
print(f"Original: {query}")
print(f"Rewritten: {result.primary_query}")
print()
# 2. HyDE - Hypothetical Document Embeddings
print("\n2. HYDE (Hypothetical Document)")
print("-" * 40)
query = "What is quantum computing?"
result = agent.rewrite(query, strategy=RewriteStrategy.HYDE)
print(f"Original: {query}")
print("Hypothetical Document (truncated):")
print(f"{result.hypothetical_document[:300]}...")
print()
# 3. Step-Back - Higher-level concept questions
print("\n3. STEP-BACK (Broader Context)")
print("-" * 40)
query = "What is the difference between GPT-4 and Claude 3?"
result = agent.rewrite(query, strategy=RewriteStrategy.STEP_BACK)
print(f"Original: {query}")
print(f"Rewritten: {result.primary_query}")
print(f"Step-back Question: {result.step_back_question}")
print()
# 4. Sub-Queries - Decompose complex questions
print("\n4. SUB-QUERIES (Decomposition)")
print("-" * 40)
query = "How do I set up a RAG pipeline with vector search and what are the best embedding models to use?"
result = agent.rewrite(query, strategy=RewriteStrategy.SUB_QUERIES)
print(f"Original: {query}")
print("Sub-queries:")
for i, sq in enumerate(result.sub_queries, 1):
print(f" {i}. {sq}")
print()
# 5. Multi-Query - Multiple paraphrased versions
print("\n5. MULTI-QUERY (Ensemble Retrieval)")
print("-" * 40)
query = "How to improve LLM response quality?"
result = agent.rewrite(query, strategy=RewriteStrategy.MULTI_QUERY, num_queries=3)
print(f"Original: {query}")
print("Alternative queries:")
for i, q in enumerate(result.rewritten_queries, 1):
print(f" {i}. {q}")
print()
# 6. Contextual - Using conversation history
print("\n6. CONTEXTUAL (With Chat History)")
print("-" * 40)
chat_history = [
{"role": "user", "content": "Tell me about Python programming"},
{"role": "assistant", "content": "Python is a high-level programming language known for its simplicity and readability..."},
{"role": "user", "content": "What frameworks are popular?"},
{"role": "assistant", "content": "Popular Python frameworks include Django for web development, FastAPI for APIs, and PyTorch for ML..."}
]
query = "What about its performance compared to others?"
result = agent.rewrite(query, strategy=RewriteStrategy.CONTEXTUAL, chat_history=chat_history)
print(f"Original: {query}")
print(f"Standalone: {result.primary_query}")
print()
# 7. AUTO - Automatic strategy detection
print("\n7. AUTO (Automatic Strategy Detection)")
print("-" * 40)
test_queries = [
("ML", None), # Short query -> BASIC
("What about the cost?", chat_history), # Follow-up -> CONTEXTUAL
("Compare transformers vs RNNs and explain their use cases", None), # Complex -> SUB_QUERIES
]
for query, history in test_queries:
result = agent.rewrite(query, strategy=RewriteStrategy.AUTO, chat_history=history)
print(f"Query: {query}")
print(f"Detected Strategy: {result.strategy_used.value}")
print(f"Result: {result.primary_query}")
print()
# 8. Custom Abbreviations
print("\n8. CUSTOM ABBREVIATIONS")
print("-" * 40)
agent.add_abbreviations({
"K8s": "Kubernetes",
"TF": "TensorFlow",
"PT": "PyTorch"
})
query = "K8s deployment for TF models"
result = agent.rewrite(query, strategy=RewriteStrategy.BASIC)
print(f"Original: {query}")
print(f"Rewritten: {result.primary_query}")
print()
print("=" * 60)
print("Examples Complete!")
print("=" * 60)
if __name__ == "__main__":
main()
@@ -0,0 +1,344 @@
"""
Deep Research Agent Examples
This file demonstrates how to use the DeepResearchAgent for automated
complex research workflows using multiple providers:
- **OpenAI**: o3-deep-research, o4-mini-deep-research (via Responses API)
- **Gemini**: deep-research-pro (via Interactions API)
- **LiteLLM**: Unified interface for OpenAI models
Requirements:
- OPENAI_API_KEY for OpenAI/LiteLLM providers
- GEMINI_API_KEY for Gemini provider
- OpenAI SDK >= 1.0.0
- google-genai for Gemini (pip install google-genai)
- litellm for LiteLLM provider (pip install litellm)
Available models:
OpenAI:
- o3-deep-research: Higher quality, in-depth synthesis
- o4-mini-deep-research: Faster, lightweight
Gemini:
- deep-research-pro: Gemini 3 Pro powered research agent
"""
from praisonaiagents import DeepResearchAgent, Provider
# =============================================================================
# Example 1: Basic Research Query
# =============================================================================
def basic_research_example():
"""Simple research query with default settings."""
agent = DeepResearchAgent(
name="Research Assistant",
instructions="""
You are a professional researcher. Focus on:
- Data-rich insights with specific figures and trends
- Reliable sources: peer-reviewed research, official reports
- Include inline citations
""",
model="o4-mini-deep-research", # Use faster model
verbose=True
)
result = agent.research(
"What are the key trends in renewable energy adoption in 2024?"
)
print("=" * 60)
print("RESEARCH REPORT")
print("=" * 60)
print(result.report)
print("\n" + "=" * 60)
print("CITATIONS")
print("=" * 60)
for i, citation in enumerate(result.citations, 1):
print(f"{i}. {citation.title}")
print(f" URL: {citation.url}")
return result
# =============================================================================
# Example 2: Gemini Deep Research
# =============================================================================
def gemini_research_example():
"""Research using Gemini Deep Research Agent."""
agent = DeepResearchAgent(
name="Gemini Researcher",
instructions="""
You are a professional researcher. Focus on:
- Comprehensive analysis with multiple perspectives
- Data-backed insights and trends
- Clear structure with executive summary
""",
model="deep-research-pro", # Gemini model - auto-detected
verbose=True
)
print(f"Using provider: {agent.provider}") # Should be Provider.GEMINI
result = agent.research(
"What are the latest breakthroughs in fusion energy research?"
)
print("=" * 60)
print("GEMINI RESEARCH REPORT")
print("=" * 60)
print(result.report[:1000] + "..." if len(result.report) > 1000 else result.report)
return result
# =============================================================================
# Example 3: Research with Code Interpreter (OpenAI)
# =============================================================================
def research_with_code_example():
"""Research with code execution for data analysis."""
agent = DeepResearchAgent(
name="Data Analyst",
instructions="""
You are a data analyst. When appropriate:
- Use code to analyze data and create visualizations
- Summarize data in tables
- Include specific statistics and metrics
""",
model="o3-deep-research",
enable_code_interpreter=True,
verbose=True
)
result = agent.research(
"Analyze the global smartphone market share trends over the past 5 years.",
summary_mode="detailed"
)
# Check if any code was executed
if result.code_executions:
print("\nCode executed during research:")
for code in result.code_executions:
print(f" Input: {code.input_code[:100]}...")
if code.output:
print(f" Output: {code.output[:100]}...")
return result
# =============================================================================
# Example 4: Using LiteLLM Provider
# =============================================================================
def litellm_research_example():
"""Research using LiteLLM for unified interface."""
agent = DeepResearchAgent(
name="LiteLLM Researcher",
instructions="You are a professional researcher.",
model="o3-deep-research",
use_litellm=True, # Use LiteLLM instead of direct OpenAI
verbose=True
)
print(f"Using provider: {agent.provider}") # Should be Provider.LITELLM
result = agent.research(
"What are the key trends in sustainable agriculture?"
)
print(f"Report length: {len(result.report)} characters")
return result
# =============================================================================
# Example 5: Research with MCP Integration (OpenAI)
# =============================================================================
def research_with_mcp_example():
"""Research with custom MCP server for internal documents."""
agent = DeepResearchAgent(
name="Internal Researcher",
instructions="""
You are a researcher with access to internal documents.
- Use the internal file lookup tool to retrieve company data
- Combine internal data with public research
- Prioritize internal sources when available
""",
model="o3-deep-research",
mcp_servers=[
{
"label": "internal_docs",
"url": "https://your-mcp-server.com/sse/",
"require_approval": "never"
}
],
verbose=True
)
result = agent.research(
"What is our company's market position compared to competitors?"
)
# Check MCP calls
if result.mcp_calls:
print("\nMCP tools used:")
for call in result.mcp_calls:
print(f" - {call.name}@{call.server_label}: {call.arguments}")
return result
# =============================================================================
# Example 6: Gemini with File Search
# =============================================================================
def gemini_file_search_example():
"""Research using Gemini with your own data via File Search."""
agent = DeepResearchAgent(
name="Document Researcher",
instructions="""
Compare our internal documents against current public information.
Prioritize insights from our internal data.
""",
model="deep-research-pro",
enable_file_search=True,
file_search_stores=["fileSearchStores/my-store-name"],
verbose=True
)
result = agent.research(
"Compare our 2025 fiscal year report against current market trends."
)
return result
# =============================================================================
# Example 7: Clarifying Questions Workflow
# =============================================================================
def clarifying_workflow_example():
"""Use clarifying questions before research."""
agent = DeepResearchAgent(
name="Research Assistant",
verbose=True
)
# Step 1: Get clarifying questions
initial_query = "Help me research AI trends"
questions = agent.clarify(initial_query)
print("Clarifying Questions:")
print(questions)
# Step 2: User provides more details (simulated)
detailed_query = """
I'd like to research AI trends in healthcare specifically.
Focus on:
- Diagnostic AI applications
- FDA-approved AI tools
- Cost savings for hospitals
Time period: 2023-2024
"""
# Step 3: Rewrite the query for optimal research
rewritten = agent.rewrite_query(detailed_query)
print("\nRewritten Query:")
print(rewritten)
# Step 4: Perform the research
result = agent.research(rewritten)
return result
# =============================================================================
# Example 5: Async Research
# =============================================================================
async def async_research_example():
"""Perform research asynchronously."""
import asyncio
agent = DeepResearchAgent(
name="Async Researcher",
model="o4-mini-deep-research",
verbose=True
)
# Run multiple research queries concurrently
queries = [
"What are the latest developments in quantum computing?",
"What are the trends in electric vehicle adoption?",
]
tasks = [agent.aresearch(q) for q in queries]
results = await asyncio.gather(*tasks)
for query, result in zip(queries, results):
print(f"\nQuery: {query}")
print(f"Report length: {len(result.report)} chars")
print(f"Citations: {len(result.citations)}")
return results
# =============================================================================
# Example 6: Inspecting Intermediate Steps
# =============================================================================
def inspect_steps_example():
"""Inspect the research process steps."""
agent = DeepResearchAgent(
name="Detailed Researcher",
model="o4-mini-deep-research",
verbose=True
)
result = agent.research(
"What are the environmental impacts of cryptocurrency mining?"
)
print("\n" + "=" * 60)
print("RESEARCH PROCESS ANALYSIS")
print("=" * 60)
# Reasoning steps
print(f"\nReasoning Steps ({len(result.reasoning_steps)}):")
for i, step in enumerate(result.reasoning_steps, 1):
print(f" {i}. {step.text[:100]}...")
# Web searches
print(f"\nWeb Searches ({len(result.web_searches)}):")
for search in result.web_searches:
print(f" - Query: {search.query}")
print(f" Status: {search.status}")
# Sources
print(f"\nUnique Sources ({len(result.get_all_sources())}):")
for source in result.get_all_sources()[:10]:
print(f" - {source['title']}")
print(f" {source['url']}")
return result
# =============================================================================
# Main
# =============================================================================
if __name__ == "__main__":
import os
if not os.environ.get("OPENAI_API_KEY"):
print("Error: OPENAI_API_KEY environment variable not set")
print("Please set it before running examples:")
print(" export OPENAI_API_KEY='your-api-key'")
exit(1)
print("Running basic research example...")
result = basic_research_example()
print(f"\nCompleted! Report has {len(result.report)} characters and {len(result.citations)} citations.")
@@ -0,0 +1,283 @@
"""
Test file for DeepResearchAgent
This file tests the OpenAI Deep Research API integration.
Requires OPENAI_API_KEY environment variable to be set.
Usage:
python tests/deep_research_test.py
"""
import os
import sys
# Add parent directory to path for imports
sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
from praisonaiagents import (
DeepResearchAgent,
DeepResearchResponse,
Citation,
ReasoningStep,
WebSearchCall,
CodeExecutionStep,
MCPCall,
FileSearchCall,
Provider
)
def test_basic_import():
"""Test that all classes can be imported."""
print("✓ All Deep Research classes imported successfully")
print(f" - DeepResearchAgent: {DeepResearchAgent}")
print(f" - DeepResearchResponse: {DeepResearchResponse}")
print(f" - Citation: {Citation}")
print(f" - ReasoningStep: {ReasoningStep}")
print(f" - WebSearchCall: {WebSearchCall}")
print(f" - CodeExecutionStep: {CodeExecutionStep}")
print(f" - MCPCall: {MCPCall}")
print(f" - FileSearchCall: {FileSearchCall}")
print(f" - Provider: {Provider}")
print(f" - Provider.OPENAI: {Provider.OPENAI}")
print(f" - Provider.GEMINI: {Provider.GEMINI}")
print(f" - Provider.LITELLM: {Provider.LITELLM}")
return True
def test_agent_initialization():
"""Test DeepResearchAgent initialization."""
# Check if API key is available
if not os.environ.get("OPENAI_API_KEY"):
print("⚠ Skipping initialization test - OPENAI_API_KEY not set")
return True
agent = DeepResearchAgent(
name="Test Researcher",
instructions="You are a professional researcher.",
model="o3-deep-research",
verbose=True
)
print(f"✓ Agent initialized: {agent}")
print(f" - Name: {agent.name}")
print(f" - Model: {agent.model}")
print(f" - Web search enabled: {agent.enable_web_search}")
print(f" - Code interpreter enabled: {agent.enable_code_interpreter}")
return True
def test_data_classes():
"""Test data class creation and methods."""
# Test Citation
citation = Citation(
title="Test Source",
url="https://example.com",
start_index=0,
end_index=100
)
print(f"✓ Citation created: {citation}")
# Test ReasoningStep
reasoning = ReasoningStep(text="Analyzing the query...")
print(f"✓ ReasoningStep created: {reasoning}")
# Test WebSearchCall
search = WebSearchCall(query="test query", status="completed")
print(f"✓ WebSearchCall created: {search}")
# Test CodeExecutionStep
code = CodeExecutionStep(input_code="print('hello')", output="hello")
print(f"✓ CodeExecutionStep created: {code}")
# Test MCPCall
mcp = MCPCall(name="fetch", server_label="internal", arguments={"file_id": "123"})
print(f"✓ MCPCall created: {mcp}")
# Test DeepResearchResponse
response = DeepResearchResponse(
report="This is a test report about AI.",
citations=[citation],
reasoning_steps=[reasoning],
web_searches=[search],
code_executions=[code],
mcp_calls=[mcp]
)
print(f"✓ DeepResearchResponse created")
print(f" - Report length: {len(response.report)} chars")
print(f" - Citations: {len(response.citations)}")
print(f" - Sources: {response.get_all_sources()}")
return True
def test_research_query():
"""Test actual research query (requires API key)."""
if not os.environ.get("OPENAI_API_KEY"):
print("⚠ Skipping research test - OPENAI_API_KEY not set")
return True
agent = DeepResearchAgent(
name="Healthcare Researcher",
instructions="""
You are a professional researcher preparing a structured, data-driven report.
Focus on data-rich insights with specific figures and trends.
Include inline citations and prioritize reliable sources.
""",
model="o4-mini-deep-research", # Use faster model for testing
verbose=True,
enable_code_interpreter=False
)
print("\n🔍 Starting deep research query...")
print(" (This may take several minutes)")
try:
result = agent.research(
"What are the key trends in AI adoption in healthcare in 2024?",
summary_mode="concise"
)
print(f"\n✓ Research completed!")
print(f" - Report length: {len(result.report)} characters")
print(f" - Citations found: {len(result.citations)}")
print(f" - Reasoning steps: {len(result.reasoning_steps)}")
print(f" - Web searches: {len(result.web_searches)}")
print(f" - Code executions: {len(result.code_executions)}")
# Print first 500 chars of report
print(f"\n📄 Report excerpt:")
print(f" {result.report[:500]}...")
# Print some citations
if result.citations:
print(f"\n📚 Sample citations:")
for i, c in enumerate(result.citations[:3]):
print(f" {i+1}. {c.title}: {c.url}")
# Print web searches
if result.web_searches:
print(f"\n🔎 Web searches performed:")
for s in result.web_searches[:5]:
print(f" - {s.query} ({s.status})")
return True
except Exception as e:
print(f"✗ Research failed: {e}")
return False
def test_clarify_and_rewrite():
"""Test clarifying questions and query rewriting."""
if not os.environ.get("OPENAI_API_KEY"):
print("⚠ Skipping clarify/rewrite test - OPENAI_API_KEY not set")
return True
agent = DeepResearchAgent(
name="Research Assistant",
verbose=True
)
print("\n🤔 Testing clarifying questions...")
try:
questions = agent.clarify("Help me research AI trends")
print(f"✓ Clarifying questions generated:")
print(f" {questions[:300]}...")
except Exception as e:
print(f"✗ Clarify failed: {e}")
return False
print("\n✍️ Testing query rewriting...")
try:
rewritten = agent.rewrite_query("Research AI in healthcare")
print(f"✓ Query rewritten:")
print(f" {rewritten[:300]}...")
except Exception as e:
print(f"✗ Rewrite failed: {e}")
return False
return True
def test_mcp_configuration():
"""Test MCP server configuration."""
if not os.environ.get("OPENAI_API_KEY"):
print("⚠ Skipping MCP test - OPENAI_API_KEY not set")
return True
# Test agent with MCP configuration
agent = DeepResearchAgent(
name="MCP Researcher",
instructions="You are a researcher with access to internal documents.",
mcp_servers=[
{
"label": "internal_docs",
"url": "https://example.com/mcp/sse/",
"require_approval": "never"
}
],
verbose=True
)
print(f"✓ Agent with MCP configured: {agent}")
print(f" - MCP servers: {len(agent.mcp_servers)}")
# Test tool building
tools = agent._build_tools(
web_search=True,
code_interpreter=True,
mcp_servers=agent.mcp_servers
)
print(f"✓ Tools built: {len(tools)} tools")
for t in tools:
print(f" - {t.get('type', 'unknown')}")
return True
def run_all_tests():
"""Run all tests."""
print("=" * 60)
print("DeepResearchAgent Test Suite")
print("=" * 60)
tests = [
("Import Test", test_basic_import),
("Data Classes Test", test_data_classes),
("Agent Initialization Test", test_agent_initialization),
("MCP Configuration Test", test_mcp_configuration),
("Clarify & Rewrite Test", test_clarify_and_rewrite),
("Research Query Test", test_research_query),
]
results = []
for name, test_fn in tests:
print(f"\n{'─' * 40}")
print(f"Running: {name}")
print(f"{'─' * 40}")
try:
success = test_fn()
results.append((name, success))
except Exception as e:
print(f"✗ Test failed with exception: {e}")
results.append((name, False))
# Summary
print(f"\n{'=' * 60}")
print("Test Summary")
print(f"{'=' * 60}")
passed = sum(1 for _, s in results if s)
total = len(results)
print(f"Passed: {passed}/{total}")
for name, success in results:
status = "✓" if success else "✗"
print(f" {status} {name}")
return passed == total
if __name__ == "__main__":
success = run_all_tests()
sys.exit(0 if success else 1)
@@ -0,0 +1,403 @@
"""
Tests for QueryRewriterAgent
Run with: python -m pytest tests/query_rewriter_test.py -v
"""
import pytest
from unittest.mock import patch
class TestQueryRewriterImports:
"""Test that all imports work correctly."""
def test_import_from_package(self):
"""Test importing from main package."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy, RewriteResult
assert QueryRewriterAgent is not None
assert RewriteStrategy is not None
assert RewriteResult is not None
def test_import_from_agent_module(self):
"""Test importing from agent module."""
from praisonaiagents.agent import QueryRewriterAgent, RewriteStrategy, RewriteResult
assert QueryRewriterAgent is not None
assert RewriteStrategy is not None
assert RewriteResult is not None
class TestRewriteStrategy:
"""Test RewriteStrategy enum."""
def test_strategy_values(self):
"""Test all strategy values exist."""
from praisonaiagents import RewriteStrategy
assert RewriteStrategy.BASIC.value == "basic"
assert RewriteStrategy.HYDE.value == "hyde"
assert RewriteStrategy.STEP_BACK.value == "step_back"
assert RewriteStrategy.SUB_QUERIES.value == "sub_queries"
assert RewriteStrategy.MULTI_QUERY.value == "multi_query"
assert RewriteStrategy.CONTEXTUAL.value == "contextual"
assert RewriteStrategy.AUTO.value == "auto"
class TestRewriteResult:
"""Test RewriteResult dataclass."""
def test_result_creation(self):
"""Test creating a RewriteResult."""
from praisonaiagents import RewriteResult, RewriteStrategy
result = RewriteResult(
original_query="test query",
rewritten_queries=["rewritten test query"],
strategy_used=RewriteStrategy.BASIC
)
assert result.original_query == "test query"
assert result.rewritten_queries == ["rewritten test query"]
assert result.strategy_used == RewriteStrategy.BASIC
def test_primary_query_property(self):
"""Test primary_query property."""
from praisonaiagents import RewriteResult, RewriteStrategy
result = RewriteResult(
original_query="test",
rewritten_queries=["first", "second"],
strategy_used=RewriteStrategy.MULTI_QUERY
)
assert result.primary_query == "first"
def test_primary_query_fallback(self):
"""Test primary_query falls back to original if empty."""
from praisonaiagents import RewriteResult, RewriteStrategy
result = RewriteResult(
original_query="test",
rewritten_queries=[],
strategy_used=RewriteStrategy.BASIC
)
assert result.primary_query == "test"
def test_all_queries_property(self):
"""Test all_queries property combines all queries."""
from praisonaiagents import RewriteResult, RewriteStrategy
result = RewriteResult(
original_query="original",
rewritten_queries=["rewritten"],
strategy_used=RewriteStrategy.STEP_BACK,
step_back_question="step back",
sub_queries=["sub1", "sub2"]
)
all_q = result.all_queries
assert "original" in all_q
assert "rewritten" in all_q
assert "step back" in all_q
assert "sub1" in all_q
assert "sub2" in all_q
class TestQueryRewriterAgentInit:
"""Test QueryRewriterAgent initialization."""
def test_default_initialization(self):
"""Test agent initializes with defaults."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
assert agent.name == "QueryRewriterAgent"
assert agent.model == "gpt-4o-mini"
assert not agent.verbose
assert agent.max_queries == 5
assert agent.temperature == 0.3
assert agent.max_tokens == 500
def test_custom_initialization(self):
"""Test agent initializes with custom values."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent(
name="CustomRewriter",
model="gpt-4o",
verbose=True,
max_queries=10,
temperature=0.5,
max_tokens=1000
)
assert agent.name == "CustomRewriter"
assert agent.model == "gpt-4o"
assert agent.verbose
assert agent.max_queries == 10
assert agent.temperature == 0.5
assert agent.max_tokens == 1000
def test_default_abbreviations(self):
"""Test default abbreviations are set."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
assert "AI" in agent.abbreviations
assert "ML" in agent.abbreviations
assert "RAG" in agent.abbreviations
assert agent.abbreviations["AI"] == "Artificial Intelligence"
class TestAbbreviationExpansion:
"""Test abbreviation expansion functionality."""
def test_expand_abbreviations(self):
"""Test _expand_abbreviations method."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
result = agent._expand_abbreviations("AI trends")
assert "Artificial Intelligence" in result
def test_add_abbreviation(self):
"""Test adding single abbreviation."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
agent.add_abbreviation("K8s", "Kubernetes")
assert "K8S" in agent.abbreviations
assert agent.abbreviations["K8S"] == "Kubernetes"
def test_add_abbreviations(self):
"""Test adding multiple abbreviations."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
agent.add_abbreviations({
"TF": "TensorFlow",
"PT": "PyTorch"
})
assert "TF" in agent.abbreviations
assert "PT" in agent.abbreviations
class TestQueryDetection:
"""Test query analysis methods."""
def test_is_short_query(self):
"""Test short query detection."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
assert agent._is_short_query("AI")
assert agent._is_short_query("AI trends")
assert not agent._is_short_query("What are the latest AI trends in 2025?")
def test_is_follow_up(self):
"""Test follow-up query detection."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
assert agent._is_follow_up("What about it?")
assert agent._is_follow_up("And this one?")
assert not agent._is_follow_up("What is AI?")
def test_is_complex_query(self):
"""Test complex query detection."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
assert agent._is_complex_query("What is A and what is B?")
assert agent._is_complex_query("Question one? Question two?")
assert not agent._is_complex_query("What is AI?")
class TestStrategyDetection:
"""Test automatic strategy detection."""
def test_detect_basic_for_short(self):
"""Test BASIC detected for short queries."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
agent = QueryRewriterAgent()
strategy = agent._detect_strategy("AI")
assert strategy == RewriteStrategy.BASIC
def test_detect_contextual_for_followup(self):
"""Test CONTEXTUAL detected for follow-up with history."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
agent = QueryRewriterAgent()
chat_history = [{"role": "user", "content": "Tell me about Python"}]
strategy = agent._detect_strategy("What about it?", chat_history)
assert strategy == RewriteStrategy.CONTEXTUAL
def test_detect_sub_queries_for_complex(self):
"""Test SUB_QUERIES detected for complex queries."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
agent = QueryRewriterAgent()
strategy = agent._detect_strategy("What is A and what is B?")
assert strategy == RewriteStrategy.SUB_QUERIES
class TestJSONParsing:
"""Test JSON array parsing from LLM responses."""
def test_parse_valid_json(self):
"""Test parsing valid JSON array."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
result = agent._parse_json_array('["query1", "query2"]')
assert result == ["query1", "query2"]
def test_parse_json_in_text(self):
"""Test extracting JSON from surrounding text."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
result = agent._parse_json_array('Here are the queries: ["q1", "q2"]')
assert result == ["q1", "q2"]
def test_parse_fallback_newlines(self):
"""Test fallback to newline splitting."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
result = agent._parse_json_array("1. Query one\n2. Query two\n3. Query three")
assert len(result) >= 2
class TestRewriteWithMockedLLM:
"""Test rewrite methods with mocked LLM."""
@patch.object(__import__('praisonaiagents.agent.query_rewriter_agent', fromlist=['QueryRewriterAgent']).QueryRewriterAgent, '_call_agent')
def test_rewrite_basic(self, mock_llm):
"""Test basic rewriting with mocked LLM."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
mock_llm.return_value = "What are the current trends in AI?"
agent = QueryRewriterAgent()
result = agent.rewrite("AI trends", strategy=RewriteStrategy.BASIC)
assert result.strategy_used == RewriteStrategy.BASIC
assert len(result.rewritten_queries) > 0
mock_llm.assert_called_once()
@patch.object(__import__('praisonaiagents.agent.query_rewriter_agent', fromlist=['QueryRewriterAgent']).QueryRewriterAgent, '_call_agent')
def test_rewrite_hyde(self, mock_llm):
"""Test HyDE rewriting with mocked LLM."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
mock_llm.return_value = "Quantum computing is a type of computation..."
agent = QueryRewriterAgent()
result = agent.rewrite("What is quantum computing?", strategy=RewriteStrategy.HYDE)
assert result.strategy_used == RewriteStrategy.HYDE
assert result.hypothetical_document is not None
mock_llm.assert_called_once()
@patch.object(__import__('praisonaiagents.agent.query_rewriter_agent', fromlist=['QueryRewriterAgent']).QueryRewriterAgent, '_call_agent')
def test_rewrite_step_back(self, mock_llm):
"""Test step-back rewriting with mocked LLM."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
# First call for step-back, second for basic
mock_llm.side_effect = [
"What are the fundamentals of language models?",
"What are the differences between GPT-4 and Claude 3?"
]
agent = QueryRewriterAgent()
result = agent.rewrite("GPT-4 vs Claude 3?", strategy=RewriteStrategy.STEP_BACK)
assert result.strategy_used == RewriteStrategy.STEP_BACK
assert result.step_back_question is not None
@patch.object(__import__('praisonaiagents.agent.query_rewriter_agent', fromlist=['QueryRewriterAgent']).QueryRewriterAgent, '_call_agent')
def test_rewrite_sub_queries(self, mock_llm):
"""Test sub-query decomposition with mocked LLM."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
mock_llm.return_value = '["What is RAG?", "What are the best embedding models?"]'
agent = QueryRewriterAgent()
result = agent.rewrite("RAG setup and embedding models?", strategy=RewriteStrategy.SUB_QUERIES)
assert result.strategy_used == RewriteStrategy.SUB_QUERIES
assert result.sub_queries is not None
assert len(result.sub_queries) >= 1
@patch.object(__import__('praisonaiagents.agent.query_rewriter_agent', fromlist=['QueryRewriterAgent']).QueryRewriterAgent, '_call_agent')
def test_rewrite_multi_query(self, mock_llm):
"""Test multi-query generation with mocked LLM."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
mock_llm.return_value = '["Query 1", "Query 2", "Query 3"]'
agent = QueryRewriterAgent()
result = agent.rewrite("LLM quality?", strategy=RewriteStrategy.MULTI_QUERY, num_queries=3)
assert result.strategy_used == RewriteStrategy.MULTI_QUERY
assert len(result.rewritten_queries) >= 1
@patch.object(__import__('praisonaiagents.agent.query_rewriter_agent', fromlist=['QueryRewriterAgent']).QueryRewriterAgent, '_call_agent')
def test_rewrite_contextual(self, mock_llm):
"""Test contextual rewriting with mocked LLM."""
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
mock_llm.return_value = "How does Python's performance compare to other languages?"
agent = QueryRewriterAgent()
chat_history = [
{"role": "user", "content": "Tell me about Python"},
{"role": "assistant", "content": "Python is a programming language..."}
]
result = agent.rewrite(
"What about its performance?",
strategy=RewriteStrategy.CONTEXTUAL,
chat_history=chat_history
)
assert result.strategy_used == RewriteStrategy.CONTEXTUAL
assert "Python" in result.primary_query or len(result.rewritten_queries) > 0
class TestConvenienceMethods:
"""Test convenience methods."""
def test_convenience_methods_exist(self):
"""Test all convenience methods exist."""
from praisonaiagents import QueryRewriterAgent
agent = QueryRewriterAgent()
assert hasattr(agent, 'rewrite_basic')
assert hasattr(agent, 'rewrite_hyde')
assert hasattr(agent, 'rewrite_step_back')
assert hasattr(agent, 'rewrite_sub_queries')
assert hasattr(agent, 'rewrite_multi_query')
assert hasattr(agent, 'rewrite_contextual')
if __name__ == "__main__":
pytest.main([__file__, "-v"])
@@ -0,0 +1,460 @@
"""
Tests for Claude Memory Tool.
Claude Memory Tool enables Claude to store and retrieve information across
conversations through a memory file directory.
Reference: https://docs.anthropic.com/en/docs/agents-and-tools/tool-use/memory-tool
"""
import os
import shutil
import tempfile
import pytest
from pathlib import Path
class TestClaudeMemoryToolBasics:
"""Tests for ClaudeMemoryTool basic functionality."""
def test_import(self):
"""Test that ClaudeMemoryTool can be imported."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
assert ClaudeMemoryTool is not None
def test_init_default(self):
"""Test default initialization."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
assert tool.memory_root.exists()
assert tool.user_id == "default"
def test_init_with_user_id(self):
"""Test initialization with custom user_id."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir, user_id="test_user")
assert tool.user_id == "test_user"
def test_get_tool_definition(self):
"""Test tool definition for API."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
definition = tool.get_tool_definition()
assert definition["type"] == "memory_20250818"
assert definition["name"] == "memory"
def test_get_beta_header(self):
"""Test beta header value."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
header = tool.get_beta_header()
assert header == "context-management-2025-06-27"
class TestClaudeMemoryToolPathValidation:
"""Tests for path validation and security."""
def test_valid_path(self):
"""Test valid path validation."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
path = tool._validate_path("/memories")
assert path == tool.memory_root
def test_valid_subpath(self):
"""Test valid subpath validation."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
path = tool._validate_path("/memories/notes.txt")
assert path == tool.memory_root / "notes.txt"
def test_invalid_path_no_memories_prefix(self):
"""Test that paths without /memories prefix are rejected."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
with pytest.raises(ValueError, match="must start with /memories"):
tool._validate_path("/etc/passwd")
def test_directory_traversal_blocked(self):
"""Test that directory traversal is blocked."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
with pytest.raises(ValueError):
tool._validate_path("/memories/../../../etc/passwd")
class TestClaudeMemoryToolCommands:
"""Tests for memory tool commands."""
def test_view_empty_directory(self):
"""Test viewing empty directory."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
result = tool.view(path="/memories")
assert "Directory: /memories" in result
assert "(empty directory)" in result
def test_create_and_view_file(self):
"""Test creating and viewing a file."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
# Create file
result = tool.create(path="/memories/notes.txt", file_text="Hello, World!")
assert "created successfully" in result
# View file
result = tool.view(path="/memories/notes.txt")
assert "Hello, World!" in result
def test_view_directory_with_files(self):
"""Test viewing directory with files."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
# Create files
tool.create(path="/memories/file1.txt", file_text="Content 1")
tool.create(path="/memories/file2.txt", file_text="Content 2")
# View directory
result = tool.view(path="/memories")
assert "file1.txt" in result
assert "file2.txt" in result
def test_str_replace(self):
"""Test string replacement in file."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
# Create file
tool.create(path="/memories/notes.txt", file_text="Hello, World!")
# Replace text
result = tool.str_replace(
path="/memories/notes.txt",
old_str="World",
new_str="Claude"
)
assert "edited" in result
# Verify replacement
result = tool.view(path="/memories/notes.txt")
assert "Hello, Claude!" in result
def test_str_replace_not_found(self):
"""Test string replacement when text not found."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
tool.create(path="/memories/notes.txt", file_text="Hello, World!")
with pytest.raises(ValueError, match="not found"):
tool.str_replace(
path="/memories/notes.txt",
old_str="Nonexistent",
new_str="Replacement"
)
def test_insert(self):
"""Test inserting text at line."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
# Create file with multiple lines
tool.create(path="/memories/notes.txt", file_text="Line 1\nLine 2\nLine 3")
# Insert at line 1
result = tool.insert(
path="/memories/notes.txt",
insert_line=1,
insert_text="Inserted Line"
)
assert "inserted" in result
# Verify insertion
result = tool.view(path="/memories/notes.txt")
assert "Inserted Line" in result
def test_delete_file(self):
"""Test deleting a file."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
# Create and delete file
tool.create(path="/memories/notes.txt", file_text="Content")
result = tool.delete(path="/memories/notes.txt")
assert "deleted" in result
# Verify deletion
with pytest.raises(RuntimeError):
tool.view(path="/memories/notes.txt")
def test_delete_root_blocked(self):
"""Test that deleting /memories root is blocked."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
with pytest.raises(ValueError, match="Cannot delete"):
tool.delete(path="/memories")
def test_rename(self):
"""Test renaming a file."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
# Create file
tool.create(path="/memories/old.txt", file_text="Content")
# Rename
result = tool.rename(
old_path="/memories/old.txt",
new_path="/memories/new.txt"
)
assert "Renamed" in result
# Verify rename
with pytest.raises(RuntimeError):
tool.view(path="/memories/old.txt")
result = tool.view(path="/memories/new.txt")
assert "Content" in result
def test_clear_all(self):
"""Test clearing all memory."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
# Create files
tool.create(path="/memories/file1.txt", file_text="Content 1")
tool.create(path="/memories/file2.txt", file_text="Content 2")
# Clear all
result = tool.clear_all()
assert "cleared" in result
# Verify empty
result = tool.view(path="/memories")
assert "(empty directory)" in result
class TestClaudeMemoryToolProcessToolCall:
"""Tests for process_tool_call method."""
def test_process_view_command(self):
"""Test processing view command."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
result = tool.process_tool_call({
"command": "view",
"path": "/memories"
})
assert "Directory: /memories" in result
def test_process_create_command(self):
"""Test processing create command."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
result = tool.process_tool_call({
"command": "create",
"path": "/memories/test.txt",
"file_text": "Test content"
})
assert "created" in result
def test_process_unknown_command(self):
"""Test processing unknown command."""
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
with tempfile.TemporaryDirectory() as tmpdir:
tool = ClaudeMemoryTool(base_path=tmpdir)
result = tool.process_tool_call({
"command": "unknown_command",
"path": "/memories"
})
assert "Error" in result
class TestLLMClaudeMemoryIntegration:
"""Tests for LLM class integration with Claude Memory Tool."""
def test_llm_init_with_claude_memory_true(self):
"""Test LLM initialization with claude_memory=True."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-sonnet-4-20250514", claude_memory=True)
assert llm.claude_memory == True
def test_llm_init_with_claude_memory_false(self):
"""Test LLM initialization with claude_memory=False."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-sonnet-4-20250514", claude_memory=False)
assert llm.claude_memory == False
def test_llm_init_without_claude_memory(self):
"""Test LLM initialization without claude_memory parameter."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini")
assert llm.claude_memory is None
def test_llm_supports_claude_memory_anthropic(self):
"""Test _supports_claude_memory for Anthropic model."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-sonnet-4-20250514", claude_memory=True)
assert llm._supports_claude_memory() == True
def test_llm_supports_claude_memory_non_anthropic(self):
"""Test _supports_claude_memory for non-Anthropic model."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini", claude_memory=True)
assert llm._supports_claude_memory() == False
def test_llm_get_claude_memory_tool(self):
"""Test _get_claude_memory_tool method."""
from praisonaiagents.llm.llm import LLM
from praisonaiagents.tools.claude_memory_tool import ClaudeMemoryTool
llm = LLM(model="anthropic/claude-sonnet-4-20250514", claude_memory=True)
tool = llm._get_claude_memory_tool()
assert isinstance(tool, ClaudeMemoryTool)
def test_llm_is_memory_tool_call(self):
"""Test _is_memory_tool_call method."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-sonnet-4-20250514", claude_memory=True)
assert llm._is_memory_tool_call("memory") == True
assert llm._is_memory_tool_call("other_tool") == False
class TestAgentClaudeMemoryIntegration:
"""Tests for Agent class integration with Claude Memory Tool."""
def test_agent_init_with_claude_memory_true(self):
"""Test Agent initialization with claude_memory=True."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-sonnet-4-20250514",
claude_memory=True
)
assert agent.claude_memory == True
def test_agent_init_with_claude_memory_false(self):
"""Test Agent initialization with claude_memory=False."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-sonnet-4-20250514",
claude_memory=False
)
assert agent.claude_memory == False
def test_agent_init_without_claude_memory(self):
"""Test Agent initialization without claude_memory parameter."""
from praisonaiagents import Agent
agent = Agent(name="Test Agent")
assert agent.claude_memory is None
def test_agent_passes_claude_memory_to_llm(self):
"""Test that Agent passes claude_memory to LLM instance."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-sonnet-4-20250514",
claude_memory=True
)
if hasattr(agent, 'llm_instance') and agent.llm_instance:
assert agent.llm_instance.claude_memory == True
class TestClaudeMemoryToolIntegration:
"""Integration tests for Claude Memory Tool (requires API key)."""
@pytest.mark.skip(reason="Requires ANTHROPIC_API_KEY environment variable")
def test_claude_memory_with_anthropic(self):
"""Test Claude memory with actual Anthropic API."""
import os
from praisonaiagents import Agent
# Skip if no API key
if not os.getenv("ANTHROPIC_API_KEY"):
pytest.skip("ANTHROPIC_API_KEY not set")
agent = Agent(
name="Memory Test Agent",
instructions="You are a helpful assistant with memory capabilities.",
llm="anthropic/claude-sonnet-4-20250514",
claude_memory=True,
verbose=False
)
# First call - should check memory
result1 = agent.start("Remember that my favorite color is blue.")
assert result1 is not None
# Second call - should recall from memory
result2 = agent.start("What is my favorite color?")
assert result2 is not None
@@ -11,6 +11,7 @@ This test script validates the ContextAgent implementation for:
"""
import sys
import pytest
from pathlib import Path
# Add the src directory to Python path
@@ -34,11 +35,11 @@ def test_imports():
from praisonaiagents.agent.context_agent import ContextAgent as DirectContextAgent
print("✅ Successfully imported ContextAgent from direct module")
return True
assert True
except ImportError as e:
print(f"❌ Import failed: {e}")
return False
assert False, str(e)
def test_basic_instantiation():
"""Test basic ContextAgent instantiation."""
@@ -64,11 +65,11 @@ def test_basic_instantiation():
factory_agent = create_context_agent(llm="gpt-5-nano")
print("✅ Successfully created ContextAgent using factory function")
return True, [context_agent, custom_agent, factory_agent]
assert True
except Exception as e:
print(f"❌ Instantiation failed: {e}")
return False, []
assert False, str(e)
def test_agent_inheritance():
"""Test that ContextAgent properly inherits from Agent."""
@@ -89,12 +90,13 @@ def test_agent_inheritance():
assert hasattr(context_agent, 'goal'), "Should have goal attribute"
print("✅ ContextAgent has all required Agent attributes")
return True
assert True
except Exception as e:
print(f"❌ Inheritance test failed: {e}")
return False
assert False, str(e)
@pytest.mark.skip(reason="ContextAgent methods not yet implemented")
def test_context_engineering_methods():
"""Test Context Engineering specific methods."""
print("\\n🧪 Testing Context Engineering Methods...")
@@ -137,12 +139,13 @@ def test_context_engineering_methods():
print(f"✅ All {len(async_methods)} async methods are available")
return True
assert True
except Exception as e:
print(f"❌ Method availability test failed: {e}")
return False
assert False, str(e)
@pytest.mark.skip(reason="ContextAgent methods not yet implemented")
def test_basic_functionality():
"""Test basic functionality of ContextAgent methods."""
print("\\n🧪 Testing Basic Functionality...")
@@ -194,11 +197,11 @@ def test_basic_functionality():
assert "PRP" in prp, "Should contain PRP reference"
print("✅ generate_prp works correctly")
return True
assert True
except Exception as e:
print(f"❌ Functionality test failed: {e}")
return False
assert False, str(e)
def test_backward_compatibility():
"""Test that existing PraisonAI functionality still works."""
@@ -232,11 +235,11 @@ def test_backward_compatibility():
print("✅ All expected exports are available")
return True
assert True
except Exception as e:
print(f"❌ Backward compatibility test failed: {e}")
return False
assert False, str(e)
def test_syntax_validation():
"""Test that all Python files have valid syntax."""
@@ -268,14 +271,14 @@ def test_syntax_validation():
ast.parse(content)
print(f"✅ {example_file.name} has valid Python syntax")
return True
assert True
except SyntaxError as e:
print(f"❌ Syntax error found: {e}")
return False
assert False, str(e)
except Exception as e:
print(f"❌ Syntax validation failed: {e}")
return False
assert False, str(e)
def run_all_tests():
"""Run all tests and provide summary."""
@@ -0,0 +1,653 @@
"""
Tests for FileMemory - Zero-dependency file-based memory system.
"""
import tempfile
import pytest
class TestFileMemoryBasics:
"""Tests for FileMemory basic functionality."""
def test_import(self):
"""Test that FileMemory can be imported."""
from praisonaiagents.memory.file_memory import FileMemory
assert FileMemory is not None
def test_init_default(self):
"""Test default initialization."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
assert memory.user_id == "default"
assert memory.user_path.exists()
def test_init_with_user_id(self):
"""Test initialization with custom user_id."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir, user_id="test_user")
assert memory.user_id == "test_user"
assert "test_user" in str(memory.user_path)
def test_config_persistence(self):
"""Test that config is saved and loaded."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
# Create with custom config
memory1 = FileMemory(
base_path=tmpdir,
config={"short_term_limit": 50}
)
assert memory1.config["short_term_limit"] == 50
# Create new instance - should load saved config
memory2 = FileMemory(base_path=tmpdir)
assert memory2.config["short_term_limit"] == 50
class TestShortTermMemory:
"""Tests for short-term memory functionality."""
def test_add_short_term(self):
"""Test adding short-term memory."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
mem_id = memory.add_short_term("User prefers dark mode")
assert mem_id is not None
assert len(memory._short_term) == 1
def test_get_short_term(self):
"""Test retrieving short-term memories."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_short_term("Memory 1")
memory.add_short_term("Memory 2")
memory.add_short_term("Memory 3")
# Get all
items = memory.get_short_term()
assert len(items) == 3
# Most recent first
assert items[0].content == "Memory 3"
# Get limited
items = memory.get_short_term(limit=2)
assert len(items) == 2
def test_short_term_rolling_buffer(self):
"""Test that short-term memory enforces limit."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(
base_path=tmpdir,
config={"short_term_limit": 5, "auto_promote": False}
)
# Add more than limit
for i in range(10):
memory.add_short_term(f"Memory {i}")
# Should only have last 5
assert len(memory._short_term) == 5
items = memory.get_short_term()
assert items[0].content == "Memory 9"
def test_short_term_persistence(self):
"""Test that short-term memory persists to file."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
# Add memory
memory1 = FileMemory(base_path=tmpdir)
memory1.add_short_term("Persistent memory")
# Create new instance - should load from file
memory2 = FileMemory(base_path=tmpdir)
items = memory2.get_short_term()
assert len(items) == 1
assert items[0].content == "Persistent memory"
class TestLongTermMemory:
"""Tests for long-term memory functionality."""
def test_add_long_term(self):
"""Test adding long-term memory."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
mem_id = memory.add_long_term("User's name is John", importance=0.9)
assert mem_id is not None
assert len(memory._long_term) == 1
def test_get_long_term_sorted_by_importance(self):
"""Test that long-term memories are sorted by importance."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_long_term("Low importance", importance=0.3)
memory.add_long_term("High importance", importance=0.9)
memory.add_long_term("Medium importance", importance=0.6)
items = memory.get_long_term()
assert items[0].content == "High importance"
assert items[1].content == "Medium importance"
assert items[2].content == "Low importance"
def test_auto_promote_to_long_term(self):
"""Test auto-promotion of high-importance short-term to long-term."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(
base_path=tmpdir,
config={
"short_term_limit": 3,
"auto_promote": True,
"importance_threshold": 0.7
}
)
# Add high importance items
memory.add_short_term("Important 1", importance=0.8)
memory.add_short_term("Important 2", importance=0.9)
memory.add_short_term("Low importance", importance=0.3)
# Trigger promotion by exceeding limit
memory.add_short_term("New item", importance=0.5)
# High importance items should be in long-term
long_term = memory.get_long_term()
assert len(long_term) >= 2
class TestEntityMemory:
"""Tests for entity memory functionality."""
def test_add_entity(self):
"""Test adding an entity."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
entity_id = memory.add_entity(
name="John",
entity_type="person",
attributes={"role": "developer", "company": "Acme"}
)
assert entity_id is not None
assert len(memory._entities) == 1
def test_get_entity(self):
"""Test retrieving an entity."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_entity("John", "person", {"role": "developer"})
entity = memory.get_entity("John")
assert entity is not None
assert entity.name == "John"
assert entity.entity_type == "person"
assert entity.attributes["role"] == "developer"
def test_update_entity(self):
"""Test updating an existing entity."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_entity("John", "person", {"role": "developer"})
memory.add_entity("John", "person", {"company": "Acme"})
entity = memory.get_entity("John")
assert entity.attributes["role"] == "developer"
assert entity.attributes["company"] == "Acme"
def test_get_all_entities(self):
"""Test getting all entities."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_entity("John", "person", {})
memory.add_entity("Acme", "organization", {})
memory.add_entity("New York", "place", {})
# All entities
all_entities = memory.get_all_entities()
assert len(all_entities) == 3
# Filter by type
people = memory.get_all_entities(entity_type="person")
assert len(people) == 1
assert people[0].name == "John"
class TestEpisodicMemory:
"""Tests for episodic memory functionality."""
def test_add_episodic(self):
"""Test adding episodic memory."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
mem_id = memory.add_episodic("Had a meeting about project X")
assert mem_id is not None
def test_get_episodic_by_date(self):
"""Test retrieving episodic memories by date."""
from praisonaiagents.memory.file_memory import FileMemory
from datetime import datetime
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
today = datetime.now().strftime("%Y-%m-%d")
memory.add_episodic("Today's event", date=today)
episodes = memory.get_episodic(date=today)
assert len(episodes) == 1
assert episodes[0].content == "Today's event"
def test_get_recent_episodic(self):
"""Test retrieving recent episodic memories."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_episodic("Event 1")
memory.add_episodic("Event 2")
episodes = memory.get_episodic(days_back=7)
assert len(episodes) == 2
class TestSearch:
"""Tests for search functionality."""
def test_search_short_term(self):
"""Test searching short-term memory."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_short_term("User prefers dark mode")
memory.add_short_term("User likes Python programming")
memory.add_short_term("Weather is sunny today")
results = memory.search("user", memory_types=["short_term"])
assert len(results) == 2
def test_search_all_types(self):
"""Test searching across all memory types."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_short_term("John mentioned Python")
memory.add_long_term("John is a developer")
memory.add_entity("John", "person", {"skill": "Python"})
results = memory.search("John")
assert len(results) >= 3
def test_search_relevance_scoring(self):
"""Test that search results are scored by relevance."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_short_term("Python is great", importance=0.5)
memory.add_short_term("I love Python programming", importance=0.8)
results = memory.search("Python")
assert len(results) == 2
# Higher importance should score higher
assert results[0]["score"] >= results[1]["score"]
class TestContext:
"""Tests for context building."""
def test_get_context_empty(self):
"""Test getting context with no memories."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
context = memory.get_context()
assert context == ""
def test_get_context_with_memories(self):
"""Test getting context with memories."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_long_term("User's name is John", importance=0.9)
memory.add_short_term("User asked about Python")
memory.add_entity("John", "person", {"role": "developer"})
context = memory.get_context()
assert "John" in context
assert "Important Facts" in context or "Known Entities" in context
def test_get_context_with_query(self):
"""Test getting focused context with query."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_long_term("User's name is John")
memory.add_long_term("User likes Python")
memory.add_long_term("Weather is sunny")
context = memory.get_context(query="John")
assert "John" in context
class TestUtilities:
"""Tests for utility methods."""
def test_clear_short_term(self):
"""Test clearing short-term memory."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_short_term("Memory 1")
memory.add_short_term("Memory 2")
memory.clear_short_term()
assert len(memory._short_term) == 0
def test_clear_all(self):
"""Test clearing all memory."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir)
memory.add_short_term("Short term")
memory.add_long_term("Long term")
memory.add_entity("John", "person", {})
memory.add_episodic("Episode")
memory.clear_all()
assert len(memory._short_term) == 0
assert len(memory._long_term) == 0
assert len(memory._entities) == 0
def test_get_stats(self):
"""Test getting memory statistics."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
memory = FileMemory(base_path=tmpdir, user_id="test_user")
memory.add_short_term("Short term")
memory.add_long_term("Long term")
memory.add_entity("John", "person", {})
stats = memory.get_stats()
assert stats["user_id"] == "test_user"
assert stats["short_term_count"] == 1
assert stats["long_term_count"] == 1
assert stats["entity_count"] == 1
def test_export_import(self):
"""Test exporting and importing memory data."""
from praisonaiagents.memory.file_memory import FileMemory
with tempfile.TemporaryDirectory() as tmpdir:
# Create and populate memory
memory1 = FileMemory(base_path=tmpdir, user_id="user1")
memory1.add_short_term("Short term memory")
memory1.add_long_term("Long term memory")
memory1.add_entity("John", "person", {"role": "dev"})
# Export
exported = memory1.export()
# Import to new memory
memory2 = FileMemory(base_path=tmpdir, user_id="user2")
memory2.import_data(exported)
assert len(memory2._short_term) == 1
assert len(memory2._long_term) == 1
assert len(memory2._entities) == 1
class TestAgentIntegration:
"""Tests for Agent class integration with FileMemory."""
def test_agent_memory_true(self):
"""Test Agent with memory=True uses FileMemory."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
memory=True
)
assert agent.memory is True
assert agent._memory_instance is not None
def test_agent_memory_false(self):
"""Test Agent with memory=False has no memory."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
memory=False
)
assert agent._memory_instance is None
def test_agent_memory_file(self):
"""Test Agent with memory='file' uses FileMemory."""
from praisonaiagents import Agent
from praisonaiagents.memory.file_memory import FileMemory
agent = Agent(
name="Test Agent",
memory="file"
)
assert isinstance(agent._memory_instance, FileMemory)
def test_agent_store_memory(self):
"""Test Agent store_memory method."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
memory=True
)
agent.store_memory("User prefers dark mode", memory_type="short_term")
items = agent._memory_instance.get_short_term()
assert len(items) == 1
assert items[0].content == "User prefers dark mode"
def test_agent_get_memory_context(self):
"""Test Agent get_memory_context method."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
memory=True
)
agent.store_memory("User's name is John", memory_type="long_term", importance=0.9)
context = agent.get_memory_context()
assert "John" in context
class TestCreateMemoryFunction:
"""Tests for create_memory convenience function."""
def test_create_memory(self):
"""Test create_memory function."""
from praisonaiagents.memory import create_memory
with tempfile.TemporaryDirectory() as tmpdir:
memory = create_memory(user_id="test", base_path=tmpdir)
assert memory.user_id == "test"
memory.add_short_term("Test memory")
assert len(memory._short_term) == 1
class TestMemoryIntegrationWithOpenAI:
"""Integration tests for memory with OpenAI API (requires OPENAI_API_KEY)."""
def test_memory_injection_into_system_prompt(self):
"""Test that memory context is injected into system prompt and agent recalls it."""
import os
import shutil
# Skip if no API key
if not os.getenv("OPENAI_API_KEY"):
pytest.skip("OPENAI_API_KEY not set")
from praisonaiagents import Agent
test_user_id = "integration_test_user"
try:
# Create agent with memory enabled
agent = Agent(
name="Memory Test Agent",
role="Assistant",
goal="Help users and remember their information",
backstory="You are a helpful assistant with memory capabilities.",
# Uses default model (gpt-4o-mini via OPENAI_MODEL_NAME or fallback)
memory=True,
user_id=test_user_id,
verbose=False
)
# Store memories BEFORE the chat
agent.store_memory("User's favorite color is blue", memory_type="short_term")
agent.store_memory("User's name is Alice", memory_type="long_term", importance=0.95)
agent.store_memory("User works as a software engineer", memory_type="long_term", importance=0.9)
# Add entity
agent._memory_instance.add_entity("Alice", "person", {
"occupation": "software engineer",
"favorite_color": "blue"
})
# Ask agent about the user - should recall from memory
result = agent.start("What is my name and what do I do for work? Answer in one sentence.")
# Verify the response contains the remembered information
assert result is not None
result_lower = result.lower()
assert "alice" in result_lower, f"Expected 'alice' in response: {result}"
assert "software" in result_lower or "engineer" in result_lower, f"Expected occupation in response: {result}"
print(f"✅ Memory injection test passed! Response: {result}")
finally:
# Cleanup
memory_path = f".praison/memory/{test_user_id}"
if os.path.exists(memory_path):
shutil.rmtree(memory_path)
def test_memory_persistence_across_agent_instances(self):
"""Test that memory persists when creating new agent instances."""
import os
import shutil
# Skip if no API key
if not os.getenv("OPENAI_API_KEY"):
pytest.skip("OPENAI_API_KEY not set")
from praisonaiagents import Agent
test_user_id = "persistence_test_user"
try:
# First agent - store memories
agent1 = Agent(
name="Agent 1",
# Uses default model (gpt-4o-mini via OPENAI_MODEL_NAME or fallback)
memory=True,
user_id=test_user_id,
verbose=False
)
agent1.store_memory("User prefers Python over JavaScript", memory_type="long_term", importance=0.9)
agent1.store_memory("User is learning machine learning", memory_type="short_term")
# Verify memories stored
stats1 = agent1._memory_instance.get_stats()
assert stats1["long_term_count"] == 1
assert stats1["short_term_count"] == 1
# Second agent - same user_id, should load memories
agent2 = Agent(
name="Agent 2",
# Uses default model (gpt-4o-mini via OPENAI_MODEL_NAME or fallback)
memory=True,
user_id=test_user_id,
verbose=False
)
# Verify memories loaded
stats2 = agent2._memory_instance.get_stats()
assert stats2["long_term_count"] == 1, f"Expected 1 long-term memory, got {stats2}"
assert stats2["short_term_count"] == 1, f"Expected 1 short-term memory, got {stats2}"
# Ask about preferences - should recall from loaded memory
result = agent2.start("What programming language do I prefer? Answer in one word.")
assert result is not None
assert "python" in result.lower(), f"Expected 'python' in response: {result}"
print(f"✅ Memory persistence test passed! Response: {result}")
finally:
# Cleanup
memory_path = f".praison/memory/{test_user_id}"
if os.path.exists(memory_path):
shutil.rmtree(memory_path)
@@ -0,0 +1,855 @@
"""Tests for the plugin system (BaseTool, @tool decorator, ToolRegistry).
Run with: pytest tests/test_plugin_system.py -v
"""
import pytest
from typing import List
class TestBaseTool:
"""Tests for BaseTool abstract class."""
def test_import_from_main_package(self):
"""BaseTool should be importable from praisonaiagents."""
from praisonaiagents import BaseTool
assert BaseTool is not None
def test_subclass_with_required_attributes(self):
"""Subclass with name, description, and run() should work."""
from praisonaiagents import BaseTool
class MyTool(BaseTool):
name = "my_tool"
description = "A test tool"
def run(self, query: str) -> str:
return f"Result: {query}"
tool = MyTool()
assert tool.name == "my_tool"
assert tool.description == "A test tool"
assert tool.run(query="test") == "Result: test"
def test_auto_name_from_class(self):
"""Name should default to lowercase class name without 'tool'."""
from praisonaiagents import BaseTool
class WeatherTool(BaseTool):
description = "Get weather"
def run(self) -> str:
return "sunny"
tool = WeatherTool()
assert tool.name == "weather"
def test_auto_description_from_docstring(self):
"""Description should default to class docstring."""
from praisonaiagents import BaseTool
class MyTool(BaseTool):
"""This tool does amazing things."""
name = "my_tool"
def run(self) -> str:
return "done"
tool = MyTool()
assert "amazing things" in tool.description
def test_auto_generate_parameters_schema(self):
"""Parameters schema should be auto-generated from run() signature."""
from praisonaiagents import BaseTool
class SearchTool(BaseTool):
name = "search"
description = "Search for things"
def run(self, query: str, max_results: int = 5) -> List[str]:
return []
tool = SearchTool()
schema = tool.parameters
assert schema["type"] == "object"
assert "query" in schema["properties"]
assert "max_results" in schema["properties"]
assert "query" in schema["required"]
assert "max_results" not in schema["required"] # Has default
def test_callable_like_function(self):
"""Tool should be callable directly."""
from praisonaiagents import BaseTool
class AddTool(BaseTool):
name = "add"
description = "Add numbers"
def run(self, a: int, b: int) -> int:
return a + b
tool = AddTool()
result = tool(a=2, b=3)
assert result == 5
def test_safe_run_success(self):
"""safe_run() should return ToolResult on success."""
from praisonaiagents import BaseTool
class OkTool(BaseTool):
name = "ok"
description = "Always works"
def run(self) -> str:
return "ok"
tool = OkTool()
result = tool.safe_run()
assert result.success is True
assert result.output == "ok"
assert result.error is None
def test_safe_run_failure(self):
"""safe_run() should catch exceptions and return ToolResult."""
from praisonaiagents import BaseTool
class FailTool(BaseTool):
name = "fail"
description = "Always fails"
def run(self) -> str:
raise ValueError("Something went wrong")
tool = FailTool()
result = tool.safe_run()
assert result.success is False
assert result.output is None
assert "Something went wrong" in result.error
def test_get_schema_openai_format(self):
"""get_schema() should return OpenAI-compatible function schema."""
from praisonaiagents import BaseTool
class MyTool(BaseTool):
name = "my_tool"
description = "Does something"
def run(self, x: str) -> str:
return x
tool = MyTool()
schema = tool.get_schema()
assert schema["type"] == "function"
assert schema["function"]["name"] == "my_tool"
assert schema["function"]["description"] == "Does something"
assert "parameters" in schema["function"]
class TestToolDecorator:
"""Tests for @tool decorator."""
def test_import_from_main_package(self):
"""tool decorator should be importable from praisonaiagents."""
from praisonaiagents import tool
assert tool is not None
def test_decorator_without_args(self):
"""@tool without arguments should work."""
from praisonaiagents import tool
@tool
def my_search(query: str) -> List[str]:
"""Search for things."""
return [query]
assert my_search.name == "my_search"
assert "Search for things" in my_search.description
result = my_search(query="test")
assert result == ["test"]
def test_decorator_with_args(self):
"""@tool(name=..., description=...) should work."""
from praisonaiagents import tool
@tool(name="custom_search", description="Custom description")
def search(query: str) -> List[str]:
return [query]
assert search.name == "custom_search"
assert search.description == "Custom description"
def test_decorated_function_is_basetool(self):
"""Decorated function should be a BaseTool instance."""
from praisonaiagents import tool, BaseTool
@tool
def my_func(x: str) -> str:
return x
assert isinstance(my_func, BaseTool)
def test_decorated_function_has_schema(self):
"""Decorated function should have auto-generated schema."""
from praisonaiagents import tool
@tool
def calculate(a: int, b: int, operation: str = "add") -> int:
"""Perform calculation."""
return a + b
schema = calculate.get_schema()
params = schema["function"]["parameters"]
assert "a" in params["properties"]
assert "b" in params["properties"]
assert "operation" in params["properties"]
assert "a" in params["required"]
assert "operation" not in params["required"]
def test_decorated_function_callable_both_ways(self):
"""Decorated function should work with positional and keyword args."""
from praisonaiagents import tool
@tool
def greet(name: str, greeting: str = "Hello") -> str:
return f"{greeting}, {name}!"
# Keyword args (BaseTool style)
assert greet(name="World") == "Hello, World!"
# Positional args (function style)
assert greet("World", "Hi") == "Hi, World!"
class TestToolRegistry:
"""Tests for ToolRegistry."""
def test_import_from_main_package(self):
"""Registry functions should be importable from praisonaiagents."""
from praisonaiagents import get_registry, register_tool, get_tool, ToolRegistry
assert get_registry is not None
assert register_tool is not None
assert get_tool is not None
assert ToolRegistry is not None
def test_register_and_get_basetool(self):
"""Should register and retrieve BaseTool instances."""
from praisonaiagents import BaseTool, ToolRegistry
class MyTool(BaseTool):
name = "registry_test_tool"
description = "Test"
def run(self) -> str:
return "ok"
registry = ToolRegistry()
tool = MyTool()
registry.register(tool)
retrieved = registry.get("registry_test_tool")
assert retrieved is tool
def test_register_and_get_function(self):
"""Should register and retrieve plain functions."""
from praisonaiagents import ToolRegistry
def my_func(x: str) -> str:
return x
registry = ToolRegistry()
registry.register(my_func)
retrieved = registry.get("my_func")
assert retrieved is my_func
def test_register_with_custom_name(self):
"""Should allow custom name override."""
from praisonaiagents import ToolRegistry
def original_name() -> str:
return "ok"
registry = ToolRegistry()
registry.register(original_name, name="custom_name")
assert registry.get("custom_name") is original_name
assert registry.get("original_name") is None
def test_list_tools(self):
"""Should list all registered tool names."""
from praisonaiagents import ToolRegistry, BaseTool
class Tool1(BaseTool):
name = "tool1"
description = "First"
def run(self): return 1
class Tool2(BaseTool):
name = "tool2"
description = "Second"
def run(self): return 2
registry = ToolRegistry()
registry.register(Tool1())
registry.register(Tool2())
names = registry.list_tools()
assert "tool1" in names
assert "tool2" in names
def test_unregister(self):
"""Should remove tools from registry."""
from praisonaiagents import ToolRegistry
def temp_func() -> str:
return "temp"
registry = ToolRegistry()
registry.register(temp_func)
assert "temp_func" in registry
result = registry.unregister("temp_func")
assert result is True
assert "temp_func" not in registry
def test_no_duplicate_registration(self):
"""Should not overwrite existing tools by default."""
from praisonaiagents import ToolRegistry
def func_v1() -> str:
return "v1"
def func_v2() -> str:
return "v2"
registry = ToolRegistry()
registry.register(func_v1, name="my_func")
registry.register(func_v2, name="my_func") # Should be ignored
retrieved = registry.get("my_func")
assert retrieved() == "v1"
def test_overwrite_registration(self):
"""Should overwrite when overwrite=True."""
from praisonaiagents import ToolRegistry
def func_v1() -> str:
return "v1"
def func_v2() -> str:
return "v2"
registry = ToolRegistry()
registry.register(func_v1, name="my_func")
registry.register(func_v2, name="my_func", overwrite=True)
retrieved = registry.get("my_func")
assert retrieved() == "v2"
def test_global_registry_singleton(self):
"""get_registry() should return same instance."""
from praisonaiagents import get_registry
reg1 = get_registry()
reg2 = get_registry()
assert reg1 is reg2
def test_clear_registry(self):
"""clear() should remove all tools."""
from praisonaiagents import ToolRegistry
registry = ToolRegistry()
registry.register(lambda: "a", name="a")
registry.register(lambda: "b", name="b")
assert len(registry) == 2
registry.clear()
assert len(registry) == 0
class TestToolResult:
"""Tests for ToolResult wrapper."""
def test_import_from_main_package(self):
"""ToolResult should be importable from praisonaiagents."""
from praisonaiagents import ToolResult
assert ToolResult is not None
def test_success_result(self):
"""Should create success result."""
from praisonaiagents import ToolResult
result = ToolResult(output="data", success=True)
assert result.success is True
assert result.output == "data"
assert result.error is None
def test_error_result(self):
"""Should create error result."""
from praisonaiagents import ToolResult
result = ToolResult(output=None, success=False, error="Failed")
assert result.success is False
assert result.error == "Failed"
def test_to_dict(self):
"""Should convert to dictionary."""
from praisonaiagents import ToolResult
result = ToolResult(output="data", success=True, metadata={"key": "value"})
d = result.to_dict()
assert d["output"] == "data"
assert d["success"] is True
assert d["metadata"]["key"] == "value"
def test_str_representation(self):
"""String should show output or error."""
from praisonaiagents import ToolResult
success = ToolResult(output="hello", success=True)
assert str(success) == "hello"
failure = ToolResult(output=None, success=False, error="oops")
assert "oops" in str(failure)
class TestFunctionTool:
"""Tests for FunctionTool class."""
def test_import_from_main_package(self):
"""FunctionTool should be importable from praisonaiagents."""
from praisonaiagents import FunctionTool
assert FunctionTool is not None
def test_wraps_function(self):
"""Should wrap a function and preserve its behavior."""
from praisonaiagents import FunctionTool
def original(x: int, y: int) -> int:
"""Add two numbers."""
return x + y
wrapped = FunctionTool(original)
assert wrapped.name == "original"
assert "Add two numbers" in wrapped.description
assert wrapped(1, 2) == 3
assert wrapped.run(x=1, y=2) == 3
class TestAgentIntegration:
"""Tests for Agent integration with plugin tools."""
def test_agent_with_basetool_instance(self):
"""Agent should accept BaseTool instances in tools list."""
from praisonaiagents import Agent, BaseTool
class AddTool(BaseTool):
name = "add"
description = "Add two numbers"
def run(self, a: int, b: int) -> int:
return a + b
tool = AddTool()
agent = Agent(
name="TestAgent",
role="Tester",
goal="Test tools",
tools=[tool]
)
assert len(agent.tools) == 1
assert agent.tools[0] is tool
def test_agent_with_decorated_tool(self):
"""Agent should accept @tool decorated functions."""
from praisonaiagents import Agent, tool
@tool
def multiply(a: int, b: int) -> int:
"""Multiply two numbers."""
return a * b
agent = Agent(
name="TestAgent",
role="Tester",
goal="Test tools",
tools=[multiply]
)
assert len(agent.tools) == 1
assert agent.tools[0].name == "multiply"
def test_agent_execute_basetool(self):
"""Agent.execute_tool should work with BaseTool instances."""
from praisonaiagents import Agent, BaseTool
class ConcatTool(BaseTool):
name = "concat"
description = "Concatenate strings"
def run(self, a: str, b: str) -> str:
return a + b
agent = Agent(
name="TestAgent",
role="Tester",
goal="Test tools",
tools=[ConcatTool()]
)
result = agent.execute_tool("concat", {"a": "hello", "b": "world"})
assert result == "helloworld"
def test_agent_execute_decorated_tool(self):
"""Agent.execute_tool should work with @tool decorated functions."""
from praisonaiagents import Agent, tool
@tool
def subtract(a: int, b: int) -> int:
"""Subtract b from a."""
return a - b
agent = Agent(
name="TestAgent",
role="Tester",
goal="Test tools",
tools=[subtract]
)
result = agent.execute_tool("subtract", {"a": 10, "b": 3})
assert result == 7
def test_agent_with_tool_names_from_registry(self):
"""Agent should resolve tool names from registry."""
from praisonaiagents import Agent, BaseTool, register_tool, get_registry
# Clear registry first
get_registry().clear()
class DivideTool(BaseTool):
name = "divide"
description = "Divide two numbers"
def run(self, a: float, b: float) -> float:
return a / b
# Register tool
register_tool(DivideTool())
# Create agent with tool name string
agent = Agent(
name="TestAgent",
role="Tester",
goal="Test tools",
tools=["divide"]
)
assert len(agent.tools) == 1
assert agent.tools[0].name == "divide"
# Clean up
get_registry().clear()
def test_agent_execute_tool_from_registry(self):
"""Agent should find tools in registry during execute_tool."""
from praisonaiagents import Agent, BaseTool, register_tool, get_registry
# Clear registry first
get_registry().clear()
class PowerTool(BaseTool):
name = "power"
description = "Raise to power"
def run(self, base: int, exp: int) -> int:
return base ** exp
register_tool(PowerTool())
# Agent without tools - should still find from registry
agent = Agent(
name="TestAgent",
role="Tester",
goal="Test tools",
tools=[]
)
result = agent.execute_tool("power", {"base": 2, "exp": 3})
assert result == 8
# Clean up
get_registry().clear()
class TestPluginDiscovery:
"""Tests for entry_points plugin discovery."""
def test_discover_plugins_returns_count(self):
"""discover_plugins() should return number of plugins found."""
from praisonaiagents import ToolRegistry
registry = ToolRegistry()
count = registry.discover_plugins()
# Should return 0 or more (no external plugins installed in test env)
assert isinstance(count, int)
assert count >= 0
def test_discover_plugins_only_runs_once(self):
"""discover_plugins() should only run once per registry."""
from praisonaiagents import ToolRegistry
registry = ToolRegistry()
_count1 = registry.discover_plugins() # First call
count2 = registry.discover_plugins()
# Second call should return 0 (already discovered)
assert count2 == 0
assert _count1 >= 0 # Use variable to avoid lint warning
def test_discover_plugins_with_mock_entry_point(self, mocker):
"""Should load tools from mocked entry_points."""
from praisonaiagents import ToolRegistry, BaseTool
from unittest.mock import MagicMock
# Create a mock tool class
class MockPluginTool(BaseTool):
name = "mock_plugin"
description = "A mocked plugin tool"
def run(self) -> str:
return "mocked"
# Create mock entry point
mock_ep = MagicMock()
mock_ep.name = "mock_plugin"
mock_ep.load.return_value = MockPluginTool
# Mock entry_points to return our mock
mocker.patch(
'praisonaiagents.tools.registry.entry_points',
return_value=[mock_ep]
)
registry = ToolRegistry()
count = registry.discover_plugins()
assert count == 1
assert "mock_plugin" in registry
tool = registry.get("mock_plugin")
assert tool.run() == "mocked"
def test_discover_plugins_handles_load_error(self, mocker):
"""Should handle errors when loading plugins gracefully."""
from praisonaiagents import ToolRegistry
from unittest.mock import MagicMock
# Create mock entry point that raises on load
mock_ep = MagicMock()
mock_ep.name = "broken_plugin"
mock_ep.load.side_effect = ImportError("Module not found")
mocker.patch(
'praisonaiagents.tools.registry.entry_points',
return_value=[mock_ep]
)
registry = ToolRegistry()
# Should not raise, just log warning
count = registry.discover_plugins()
assert count == 0
assert "broken_plugin" not in registry
def test_discover_callable_function(self, mocker):
"""Should register plain functions from entry_points."""
from praisonaiagents import ToolRegistry
from unittest.mock import MagicMock
def plugin_function(x: str) -> str:
return f"plugin: {x}"
mock_ep = MagicMock()
mock_ep.name = "func_plugin"
mock_ep.load.return_value = plugin_function
mocker.patch(
'praisonaiagents.tools.registry.entry_points',
return_value=[mock_ep]
)
registry = ToolRegistry()
count = registry.discover_plugins()
assert count == 1
func = registry.get("func_plugin")
assert func("test") == "plugin: test"
def test_auto_discover_on_get_if_not_found(self, mocker):
"""get() should trigger discovery if tool not found."""
from praisonaiagents import ToolRegistry, BaseTool
from unittest.mock import MagicMock
class LazyTool(BaseTool):
name = "lazy_tool"
description = "Lazy loaded"
def run(self) -> str:
return "lazy"
mock_ep = MagicMock()
mock_ep.name = "lazy_tool"
mock_ep.load.return_value = LazyTool
mocker.patch(
'praisonaiagents.tools.registry.entry_points',
return_value=[mock_ep]
)
registry = ToolRegistry()
# Don't call discover_plugins() explicitly
# get() should trigger it
tool = registry.get("lazy_tool")
assert tool is not None
assert tool.run() == "lazy"
class TestToolValidation:
"""Tests for tool validation."""
def test_import_validation_error(self):
"""ToolValidationError should be importable."""
from praisonaiagents import ToolValidationError
assert ToolValidationError is not None
def test_import_validate_tool(self):
"""validate_tool should be importable."""
from praisonaiagents import validate_tool
assert validate_tool is not None
def test_valid_tool_passes_validation(self):
"""Valid tool should pass validation."""
from praisonaiagents import BaseTool
class ValidTool(BaseTool):
name = "valid"
description = "A valid tool"
def run(self) -> str:
return "ok"
tool = ValidTool()
assert tool.validate() is True
def test_tool_without_name_gets_auto_name(self):
"""Tool without name should get auto-generated name from class."""
from praisonaiagents import BaseTool
class MyCustomTool(BaseTool):
name = "" # Empty name - will be auto-filled
description = "Has description"
def run(self) -> str:
return "ok"
tool = MyCustomTool()
# Name should be auto-generated from class name
assert tool.name == "mycustom" # "MyCustomTool" -> "mycustom" (lowercase, "tool" removed)
assert tool.validate() is True
def test_tool_without_description_gets_auto_description(self):
"""Tool without description should get auto-generated description."""
from praisonaiagents import BaseTool
class NoDescTool(BaseTool):
"""This is the docstring description."""
name = "no_desc"
description = "" # Empty - will use docstring
def run(self) -> str:
return "ok"
tool = NoDescTool()
# Description should be auto-generated from docstring
assert "docstring description" in tool.description
assert tool.validate() is True
def test_tool_with_manually_cleared_name_fails(self):
"""Tool with name manually cleared after init should fail validation."""
from praisonaiagents import BaseTool, ToolValidationError
class MyTool(BaseTool):
name = "my_tool"
description = "Test"
def run(self) -> str:
return "ok"
tool = MyTool()
tool.name = "" # Manually clear after init
with pytest.raises(ToolValidationError):
tool.validate()
def test_validate_tool_function_with_basetool(self):
"""validate_tool() should work with BaseTool instances."""
from praisonaiagents import BaseTool, validate_tool
class MyTool(BaseTool):
name = "my_tool"
description = "Test"
def run(self) -> str:
return "ok"
assert validate_tool(MyTool()) is True
def test_validate_tool_function_with_callable(self):
"""validate_tool() should work with plain callables."""
from praisonaiagents import validate_tool
def my_func() -> str:
return "ok"
assert validate_tool(my_func) is True
def test_validate_tool_rejects_invalid_type(self):
"""validate_tool() should reject non-tool objects."""
from praisonaiagents import validate_tool, ToolValidationError
with pytest.raises(ToolValidationError):
validate_tool("not a tool")
with pytest.raises(ToolValidationError):
validate_tool(123)
def test_validate_class_method(self):
"""BaseTool.validate_class() should check class validity."""
from praisonaiagents import BaseTool
class ValidTool(BaseTool):
name = "valid"
description = "Valid"
def run(self) -> str:
return "ok"
assert ValidTool.validate_class() is True
def test_decorated_tool_passes_validation(self):
"""@tool decorated functions should pass validation."""
from praisonaiagents import tool, validate_tool
@tool
def my_search(query: str) -> list:
"""Search for things."""
return []
assert validate_tool(my_search) is True
if __name__ == "__main__":
pytest.main([__file__, "-v"])
@@ -0,0 +1,239 @@
"""
Tests for prompt caching feature.
Prompt caching allows caching parts of prompts to reduce costs and latency.
Supported by OpenAI, Anthropic, Bedrock, and Deepseek.
Source: https://docs.litellm.ai/docs/completion/prompt_caching
"""
import pytest
from unittest.mock import patch, MagicMock
class TestSupportsPromptCaching:
"""Tests for the supports_prompt_caching function in model_capabilities.py"""
def test_supports_prompt_caching_anthropic(self):
"""Test that Anthropic Claude models support prompt caching."""
from praisonaiagents.llm.model_capabilities import supports_prompt_caching
# Mock litellm.utils.supports_prompt_caching
with patch('praisonaiagents.llm.model_capabilities.supports_prompt_caching') as mock_func:
# Just test that the function exists and can be called
mock_func.return_value = True
result = mock_func(model="anthropic/claude-3-5-sonnet-latest")
assert result == True
def test_supports_prompt_caching_openai(self):
"""Test that OpenAI models support prompt caching."""
from praisonaiagents.llm.model_capabilities import supports_prompt_caching
with patch('litellm.utils.supports_prompt_caching', return_value=True):
# The function should delegate to litellm
result = supports_prompt_caching("openai/gpt-4o")
# Result depends on litellm's implementation
assert isinstance(result, bool)
def test_supports_prompt_caching_empty_model(self):
"""Test that empty model name returns False."""
from praisonaiagents.llm.model_capabilities import supports_prompt_caching
assert supports_prompt_caching("") == False
assert supports_prompt_caching(None) == False
class TestLLMPromptCachingParameter:
"""Tests for prompt_caching parameter in LLM class."""
def test_llm_init_with_prompt_caching_true(self):
"""Test LLM initialization with prompt_caching=True."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-3-5-sonnet-latest", prompt_caching=True)
assert llm.prompt_caching == True
def test_llm_init_with_prompt_caching_false(self):
"""Test LLM initialization with prompt_caching=False."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-3-5-sonnet-latest", prompt_caching=False)
assert llm.prompt_caching == False
def test_llm_init_without_prompt_caching(self):
"""Test LLM initialization without prompt_caching parameter."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini")
assert llm.prompt_caching is None
def test_llm_supports_prompt_caching_method(self):
"""Test _supports_prompt_caching method exists and works."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-3-5-sonnet-latest")
# Method should exist and return a boolean
result = llm._supports_prompt_caching()
assert isinstance(result, bool)
def test_llm_is_anthropic_model_method(self):
"""Test _is_anthropic_model method."""
from praisonaiagents.llm.llm import LLM
# Anthropic model
llm_anthropic = LLM(model="anthropic/claude-3-5-sonnet-latest")
assert llm_anthropic._is_anthropic_model() == True
# OpenAI model
llm_openai = LLM(model="gpt-4o-mini")
assert llm_openai._is_anthropic_model() == False
# Gemini model
llm_gemini = LLM(model="gemini/gemini-2.0-flash")
assert llm_gemini._is_anthropic_model() == False
class TestLLMBuildMessagesWithPromptCaching:
"""Tests for _build_messages with prompt caching enabled."""
def test_build_messages_with_prompt_caching_anthropic(self):
"""Test that _build_messages adds cache_control for Anthropic models."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-3-5-sonnet-latest", prompt_caching=True)
# Mock _supports_prompt_caching to return True
with patch.object(llm, '_supports_prompt_caching', return_value=True):
messages, _ = llm._build_messages(
prompt="Hello",
system_prompt="You are a helpful assistant."
)
# Check that system message has cache_control
system_msg = messages[0]
assert system_msg["role"] == "system"
# For Anthropic with prompt_caching, content should be an array
assert isinstance(system_msg["content"], list)
assert system_msg["content"][0]["type"] == "text"
assert system_msg["content"][0]["cache_control"] == {"type": "ephemeral"}
def test_build_messages_without_prompt_caching(self):
"""Test that _build_messages doesn't add cache_control when disabled."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-3-5-sonnet-latest", prompt_caching=False)
messages, _ = llm._build_messages(
prompt="Hello",
system_prompt="You are a helpful assistant."
)
# Check that system message is a simple string
system_msg = messages[0]
assert system_msg["role"] == "system"
assert isinstance(system_msg["content"], str)
def test_build_messages_prompt_caching_non_anthropic(self):
"""Test that prompt caching doesn't affect non-Anthropic models."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini", prompt_caching=True)
messages, _ = llm._build_messages(
prompt="Hello",
system_prompt="You are a helpful assistant."
)
# For non-Anthropic models, content should remain a string
system_msg = messages[0]
assert system_msg["role"] == "system"
assert isinstance(system_msg["content"], str)
class TestAgentPromptCachingParameter:
"""Tests for prompt_caching parameter in Agent class."""
def test_agent_init_with_prompt_caching_true(self):
"""Test Agent initialization with prompt_caching=True."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-3-5-sonnet-latest",
prompt_caching=True
)
assert agent.prompt_caching == True
def test_agent_init_with_prompt_caching_false(self):
"""Test Agent initialization with prompt_caching=False."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-3-5-sonnet-latest",
prompt_caching=False
)
assert agent.prompt_caching == False
def test_agent_init_without_prompt_caching(self):
"""Test Agent initialization without prompt_caching parameter."""
from praisonaiagents import Agent
agent = Agent(name="Test Agent")
assert agent.prompt_caching is None
def test_agent_model_supports_prompt_caching_method(self):
"""Test _model_supports_prompt_caching method exists."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-3-5-sonnet-latest"
)
# Method should exist and return a boolean
result = agent._model_supports_prompt_caching()
assert isinstance(result, bool)
def test_agent_passes_prompt_caching_to_llm(self):
"""Test that Agent passes prompt_caching to LLM instance."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-3-5-sonnet-latest",
prompt_caching=True
)
# Check that LLM instance has prompt_caching set
if hasattr(agent, 'llm_instance') and agent.llm_instance:
assert agent.llm_instance.prompt_caching == True
class TestPromptCachingIntegration:
"""Integration tests for prompt caching (requires API key)."""
@pytest.mark.skip(reason="Requires ANTHROPIC_API_KEY environment variable")
def test_prompt_caching_with_anthropic(self):
"""Test prompt caching with actual Anthropic API."""
import os
from praisonaiagents import Agent
# Skip if no API key
if not os.getenv("ANTHROPIC_API_KEY"):
pytest.skip("ANTHROPIC_API_KEY not set")
agent = Agent(
name="Caching Test Agent",
instructions="You are a helpful assistant." * 100, # Long system prompt
llm="anthropic/claude-3-5-sonnet-latest",
prompt_caching=True,
verbose=False
)
# First call - should create cache
result1 = agent.start("What is 2+2?")
assert result1 is not None
# Second call - should use cache
result2 = agent.start("What is 3+3?")
assert result2 is not None
@@ -0,0 +1,316 @@
"""
Tests for PromptExpanderAgent
Run with: python -m pytest tests/test_prompt_expander_agent.py -v
"""
import pytest
from unittest.mock import patch, MagicMock
class TestPromptExpanderImports:
"""Test that all imports work correctly."""
def test_import_from_package(self):
"""Test importing from main package."""
from praisonaiagents import PromptExpanderAgent, ExpandStrategy, ExpandResult
assert PromptExpanderAgent is not None
assert ExpandStrategy is not None
assert ExpandResult is not None
def test_import_from_agent_module(self):
"""Test importing from agent module."""
from praisonaiagents.agent import PromptExpanderAgent, ExpandStrategy, ExpandResult
assert PromptExpanderAgent is not None
assert ExpandStrategy is not None
assert ExpandResult is not None
class TestExpandStrategy:
"""Test ExpandStrategy enum."""
def test_strategy_values(self):
"""Test all strategy values exist."""
from praisonaiagents import ExpandStrategy
assert ExpandStrategy.BASIC.value == "basic"
assert ExpandStrategy.DETAILED.value == "detailed"
assert ExpandStrategy.STRUCTURED.value == "structured"
assert ExpandStrategy.CREATIVE.value == "creative"
assert ExpandStrategy.AUTO.value == "auto"
class TestExpandResult:
"""Test ExpandResult dataclass."""
def test_result_creation(self):
"""Test creating an ExpandResult."""
from praisonaiagents import ExpandResult, ExpandStrategy
result = ExpandResult(
original_prompt="write a movie script",
expanded_prompt="Write a compelling movie script...",
strategy_used=ExpandStrategy.BASIC
)
assert result.original_prompt == "write a movie script"
assert result.expanded_prompt == "Write a compelling movie script..."
assert result.strategy_used == ExpandStrategy.BASIC
def test_result_with_metadata(self):
"""Test ExpandResult with metadata."""
from praisonaiagents import ExpandResult, ExpandStrategy
result = ExpandResult(
original_prompt="test",
expanded_prompt="expanded test",
strategy_used=ExpandStrategy.DETAILED,
metadata={"word_count": 50, "has_context": True}
)
assert result.metadata["word_count"] == 50
assert result.metadata["has_context"] is True
class TestPromptExpanderAgentInit:
"""Test PromptExpanderAgent initialization."""
def test_default_initialization(self):
"""Test agent initializes with defaults."""
from praisonaiagents import PromptExpanderAgent
agent = PromptExpanderAgent()
assert agent.name == "PromptExpanderAgent"
assert agent.model == "gpt-4o-mini"
assert not agent.verbose
assert agent.temperature == 0.7 # Higher for creativity
def test_custom_initialization(self):
"""Test agent initializes with custom values."""
from praisonaiagents import PromptExpanderAgent
agent = PromptExpanderAgent(
name="CustomExpander",
model="gpt-4o",
verbose=True,
temperature=0.5
)
assert agent.name == "CustomExpander"
assert agent.model == "gpt-4o"
assert agent.verbose
assert agent.temperature == 0.5
def test_initialization_with_tools(self):
"""Test agent initializes with tools."""
from praisonaiagents import PromptExpanderAgent
def mock_tool(query: str) -> str:
return "mock result"
agent = PromptExpanderAgent(tools=[mock_tool])
assert len(agent.tools) == 1
class TestPromptExpansion:
"""Test prompt expansion functionality."""
def test_expand_preserves_task_intent(self):
"""Test that expansion preserves task intent (not converting to question)."""
from praisonaiagents import PromptExpanderAgent, ExpandResult
agent = PromptExpanderAgent()
# Mock the internal agent call
with patch.object(agent, '_call_agent') as mock_call:
mock_call.return_value = "Write a compelling three-line movie script that captures a dramatic moment with vivid imagery and emotional depth."
result = agent.expand("write a movie script in 3 lines")
assert result.original_prompt == "write a movie script in 3 lines"
assert "Write" in result.expanded_prompt # Should start with action verb
assert "?" not in result.expanded_prompt # Should NOT be a question
def test_expand_adds_detail(self):
"""Test that expansion adds meaningful detail."""
from praisonaiagents import PromptExpanderAgent
agent = PromptExpanderAgent()
with patch.object(agent, '_call_agent') as mock_call:
mock_call.return_value = "Create a detailed blog post about artificial intelligence trends in 2025, covering key developments in large language models, multimodal AI, and autonomous agents. Include specific examples and expert predictions."
result = agent.expand("write about AI")
# Expanded should be longer than original
assert len(result.expanded_prompt) > len(result.original_prompt)
class TestExpandStrategies:
"""Test different expansion strategies."""
def test_basic_strategy(self):
"""Test BASIC expansion strategy."""
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
agent = PromptExpanderAgent()
with patch.object(agent, '_call_agent') as mock_call:
mock_call.return_value = "Write a movie script in three lines."
result = agent.expand("movie script 3 lines", strategy=ExpandStrategy.BASIC)
assert result.strategy_used == ExpandStrategy.BASIC
mock_call.assert_called_once()
def test_detailed_strategy(self):
"""Test DETAILED expansion strategy."""
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
agent = PromptExpanderAgent()
with patch.object(agent, '_call_agent') as mock_call:
mock_call.return_value = """Write a compelling three-line movie script that:
- Opens with a hook that immediately grabs attention
- Builds tension or emotion in the middle line
- Delivers a powerful, memorable conclusion
Include vivid imagery, strong verbs, and emotional resonance."""
result = agent.expand("movie script 3 lines", strategy=ExpandStrategy.DETAILED)
assert result.strategy_used == ExpandStrategy.DETAILED
def test_structured_strategy(self):
"""Test STRUCTURED expansion strategy."""
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
agent = PromptExpanderAgent()
with patch.object(agent, '_call_agent') as mock_call:
mock_call.return_value = """Task: Write a three-line movie script
Format: Three lines, each serving a narrative purpose
Requirements:
- Line 1: Setup/Hook
- Line 2: Conflict/Development
- Line 3: Resolution/Twist
Style: Cinematic, impactful"""
result = agent.expand("movie script 3 lines", strategy=ExpandStrategy.STRUCTURED)
assert result.strategy_used == ExpandStrategy.STRUCTURED
def test_creative_strategy(self):
"""Test CREATIVE expansion strategy."""
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
agent = PromptExpanderAgent()
with patch.object(agent, '_call_agent') as mock_call:
mock_call.return_value = "Craft an unforgettable three-line movie script that transports the reader into a vivid world. Let each line breathe with cinematic tension - a hook that grabs, a twist that surprises, and a finale that lingers in the mind long after reading."
result = agent.expand("movie script 3 lines", strategy=ExpandStrategy.CREATIVE)
assert result.strategy_used == ExpandStrategy.CREATIVE
def test_auto_strategy_detection(self):
"""Test AUTO strategy detects appropriate expansion type."""
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
agent = PromptExpanderAgent()
# Short prompts should get DETAILED expansion
strategy = agent._detect_strategy("AI")
assert strategy in [ExpandStrategy.BASIC, ExpandStrategy.DETAILED]
# Task prompts should preserve task nature
strategy = agent._detect_strategy("write a poem about love")
assert strategy is not None
class TestToolsIntegration:
"""Test tools integration with PromptExpanderAgent."""
def test_expand_with_tools(self):
"""Test expansion with tools for context gathering."""
from praisonaiagents import PromptExpanderAgent
def search_tool(query: str) -> str:
return "Latest AI trends: LLMs, multimodal, agents"
agent = PromptExpanderAgent(tools=[search_tool])
assert len(agent.tools) == 1
def test_tools_passed_to_internal_agent(self):
"""Test that tools are passed to the internal agent."""
from praisonaiagents import PromptExpanderAgent
def mock_tool(query: str) -> str:
return "result"
agent = PromptExpanderAgent(tools=[mock_tool])
# Access the lazy-initialized agent
internal_agent = agent.agent
# The internal agent should have the tools
assert internal_agent.tools is not None
class TestConvenienceMethods:
"""Test convenience methods."""
def test_convenience_methods_exist(self):
"""Test all convenience methods exist."""
from praisonaiagents import PromptExpanderAgent
agent = PromptExpanderAgent()
assert hasattr(agent, 'expand')
assert hasattr(agent, 'expand_basic')
assert hasattr(agent, 'expand_detailed')
assert hasattr(agent, 'expand_structured')
assert hasattr(agent, 'expand_creative')
class TestEdgeCases:
"""Test edge cases."""
def test_empty_prompt(self):
"""Test handling of empty prompt."""
from praisonaiagents import PromptExpanderAgent
agent = PromptExpanderAgent()
with patch.object(agent, '_call_agent') as mock_call:
mock_call.return_value = ""
result = agent.expand("")
# Should return original if expansion fails
assert result.expanded_prompt == "" or result.original_prompt == ""
def test_already_detailed_prompt(self):
"""Test that already detailed prompts are minimally modified."""
from praisonaiagents import PromptExpanderAgent
agent = PromptExpanderAgent()
detailed_prompt = """Write a comprehensive blog post about machine learning,
covering supervised learning, unsupervised learning, and reinforcement learning.
Include code examples in Python and real-world applications."""
with patch.object(agent, '_call_agent') as mock_call:
# For detailed prompts, minimal expansion expected
mock_call.return_value = detailed_prompt + " Ensure clarity and technical accuracy."
result = agent.expand(detailed_prompt)
# Should not drastically change already detailed prompts
assert result.original_prompt == detailed_prompt
if __name__ == "__main__":
pytest.main([__file__, "-v"])
@@ -59,12 +59,14 @@ class TestValidationFeedback:
# Simulate task execution results
collect_task.result = TaskOutput(
description="Collected data",
raw="Collected only 3 items",
agent="agent1"
)
collect_task.status = "completed"
validate_task.result = TaskOutput(
description="Validation result",
raw="Not enough results, need at least 10",
agent="agent2"
)
@@ -219,12 +221,14 @@ class TestValidationFeedback:
# Simulate task execution results
data_task.result = TaskOutput(
description="Generated data",
raw="Generated data with errors",
agent="agent1"
)
data_task.status = "completed"
validate_task.result = TaskOutput(
description="Validation result",
raw="Data has errors, please fix",
agent="agent2"
)
@@ -0,0 +1,284 @@
"""
Test suite for web_fetch feature.
This module tests the web fetch functionality that allows LLMs to retrieve
full content from specific URLs (web pages and PDF documents).
Currently only supported by Anthropic Claude models.
"""
import pytest
import os
class TestSupportsWebFetch:
"""Test the supports_web_fetch function in model_capabilities."""
def test_anthropic_claude_opus_4_1_supports_web_fetch(self):
"""Test that Claude Opus 4.1 supports web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert supports_web_fetch("anthropic/claude-opus-4-1-20250805")
assert supports_web_fetch("claude-opus-4-1")
def test_anthropic_claude_opus_4_supports_web_fetch(self):
"""Test that Claude Opus 4 supports web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert supports_web_fetch("anthropic/claude-opus-4-20250514")
assert supports_web_fetch("claude-opus-4")
def test_anthropic_claude_sonnet_4_supports_web_fetch(self):
"""Test that Claude Sonnet 4 supports web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert supports_web_fetch("anthropic/claude-sonnet-4-20250514")
assert supports_web_fetch("claude-sonnet-4")
def test_anthropic_claude_3_7_sonnet_supports_web_fetch(self):
"""Test that Claude 3.7 Sonnet supports web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert supports_web_fetch("anthropic/claude-3-7-sonnet-20250219")
assert supports_web_fetch("claude-3-7-sonnet-latest")
def test_anthropic_claude_3_5_sonnet_supports_web_fetch(self):
"""Test that Claude 3.5 Sonnet supports web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert supports_web_fetch("anthropic/claude-3-5-sonnet-latest")
assert supports_web_fetch("claude-3-5-sonnet-20241022")
def test_anthropic_claude_3_5_haiku_supports_web_fetch(self):
"""Test that Claude 3.5 Haiku supports web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert supports_web_fetch("anthropic/claude-3-5-haiku-latest")
assert supports_web_fetch("claude-3-5-haiku-20241022")
def test_claude_5_auto_supports_web_fetch(self):
"""Test that Claude 5+ models auto-support web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert supports_web_fetch("claude-5")
assert supports_web_fetch("claude-sonnet-5")
assert supports_web_fetch("claude-opus-5")
def test_openai_models_do_not_support_web_fetch(self):
"""Test that OpenAI models do not support web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert not supports_web_fetch("openai/gpt-4o")
assert not supports_web_fetch("gpt-4o-mini")
assert not supports_web_fetch("gpt-4o-search-preview")
def test_gemini_models_do_not_support_web_fetch(self):
"""Test that Gemini models do not support web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert not supports_web_fetch("gemini/gemini-2.0-flash")
assert not supports_web_fetch("gemini-2.5-pro")
def test_unknown_models_do_not_support_web_fetch(self):
"""Test that unknown models do not support web fetch."""
from praisonaiagents.llm.model_capabilities import supports_web_fetch
assert not supports_web_fetch("ollama/llama3")
assert not supports_web_fetch("unknown/model")
class TestLLMWebFetchParameter:
"""Test the web_fetch parameter in LLM class."""
def test_llm_init_with_web_fetch_true(self):
"""Test LLM initialization with web_fetch=True."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-3-5-sonnet-latest", web_fetch=True)
assert llm.web_fetch is True
def test_llm_init_with_web_fetch_dict(self):
"""Test LLM initialization with web_fetch as dict."""
from praisonaiagents.llm.llm import LLM
web_fetch_config = {
"max_uses": 10,
"allowed_domains": ["example.com"],
"citations": {"enabled": True}
}
llm = LLM(model="anthropic/claude-3-5-sonnet-latest", web_fetch=web_fetch_config)
assert llm.web_fetch == web_fetch_config
def test_llm_init_without_web_fetch(self):
"""Test LLM initialization without web_fetch."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini")
assert llm.web_fetch is None
def test_llm_supports_web_fetch_method(self):
"""Test LLM._supports_web_fetch() method."""
from praisonaiagents.llm.llm import LLM
# Claude model should support web fetch
llm_claude = LLM(model="anthropic/claude-3-5-sonnet-latest")
assert llm_claude._supports_web_fetch()
# OpenAI model should not support web fetch
llm_openai = LLM(model="gpt-4o-mini")
assert not llm_openai._supports_web_fetch()
class TestLLMBuildCompletionParamsWebFetch:
"""Test _build_completion_params with web_fetch."""
def test_build_params_with_web_fetch_true(self):
"""Test that web_fetch=True adds web_fetch tool to params."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="anthropic/claude-3-5-sonnet-latest", web_fetch=True)
params = llm._build_completion_params()
assert 'tools' in params
# Find the web_fetch tool
web_fetch_tool = None
for tool in params['tools']:
if isinstance(tool, dict) and tool.get('type') == 'web_fetch_20250910':
web_fetch_tool = tool
break
assert web_fetch_tool is not None
assert web_fetch_tool['name'] == 'web_fetch'
assert web_fetch_tool['max_uses'] == 5 # default
def test_build_params_with_web_fetch_dict(self):
"""Test that web_fetch dict adds customized web_fetch tool."""
from praisonaiagents.llm.llm import LLM
web_fetch_config = {
"max_uses": 10,
"allowed_domains": ["example.com", "docs.example.com"],
"citations": {"enabled": True},
"max_content_tokens": 50000
}
llm = LLM(model="anthropic/claude-3-5-sonnet-latest", web_fetch=web_fetch_config)
params = llm._build_completion_params()
assert 'tools' in params
# Find the web_fetch tool
web_fetch_tool = None
for tool in params['tools']:
if isinstance(tool, dict) and tool.get('type') == 'web_fetch_20250910':
web_fetch_tool = tool
break
assert web_fetch_tool is not None
assert web_fetch_tool['max_uses'] == 10
assert web_fetch_tool['allowed_domains'] == ["example.com", "docs.example.com"]
assert web_fetch_tool['citations'] == {"enabled": True}
assert web_fetch_tool['max_content_tokens'] == 50000
def test_build_params_web_fetch_unsupported_model(self):
"""Test that web_fetch is ignored for unsupported models."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini", web_fetch=True)
params = llm._build_completion_params()
# Should not have web_fetch tool
if 'tools' in params:
for tool in params['tools']:
if isinstance(tool, dict):
assert tool.get('type') != 'web_fetch_20250910'
class TestAgentWebFetchParameter:
"""Test the web_fetch parameter in Agent class."""
def test_agent_init_with_web_fetch_true(self):
"""Test Agent initialization with web_fetch=True."""
from praisonaiagents.agent.agent import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-3-5-sonnet-latest",
web_fetch=True
)
assert agent.web_fetch is True
def test_agent_init_with_web_fetch_dict(self):
"""Test Agent initialization with web_fetch as dict."""
from praisonaiagents.agent.agent import Agent
web_fetch_config = {"max_uses": 10, "allowed_domains": ["example.com"]}
agent = Agent(
name="Test Agent",
llm="anthropic/claude-3-5-sonnet-latest",
web_fetch=web_fetch_config
)
assert agent.web_fetch == web_fetch_config
def test_agent_init_without_web_fetch(self):
"""Test Agent initialization without web_fetch."""
from praisonaiagents.agent.agent import Agent
agent = Agent(name="Test Agent", llm="gpt-4o-mini")
assert agent.web_fetch is None
def test_agent_passes_web_fetch_to_llm(self):
"""Test that Agent passes web_fetch to LLM instance."""
from praisonaiagents.agent.agent import Agent
agent = Agent(
name="Test Agent",
llm="anthropic/claude-3-5-sonnet-latest",
web_fetch=True
)
assert agent.llm_instance.web_fetch is True
def test_agent_model_supports_web_fetch_method(self):
"""Test Agent._model_supports_web_fetch() method."""
from praisonaiagents.agent.agent import Agent
# Claude model should support web fetch
agent_claude = Agent(
name="Claude Agent",
llm="anthropic/claude-3-5-sonnet-latest"
)
assert agent_claude._model_supports_web_fetch()
# OpenAI model should not support web fetch
agent_openai = Agent(
name="OpenAI Agent",
llm="gpt-4o-mini"
)
assert not agent_openai._model_supports_web_fetch()
class TestWebFetchWithWebSearch:
"""Test that web_fetch and web_search can be used together."""
def test_both_web_fetch_and_web_search(self):
"""Test using both web_fetch and web_search on supported model."""
from praisonaiagents.llm.llm import LLM
llm = LLM(
model="anthropic/claude-3-5-sonnet-latest",
web_search=True,
web_fetch=True
)
params = llm._build_completion_params()
# Should have web_search_options
assert 'web_search_options' in params
# Should also have web_fetch tool
assert 'tools' in params
web_fetch_found = False
for tool in params['tools']:
if isinstance(tool, dict) and tool.get('type') == 'web_fetch_20250910':
web_fetch_found = True
break
assert web_fetch_found
@pytest.mark.skipif(
not os.getenv('ANTHROPIC_API_KEY'),
reason="ANTHROPIC_API_KEY not set"
)
class TestWebFetchIntegration:
"""Integration tests for web_fetch (requires API key)."""
def test_web_fetch_with_anthropic(self):
"""Test actual web fetch with Anthropic API."""
from praisonaiagents.agent.agent import Agent
agent = Agent(
name="Web Fetch Agent",
instructions="You are a helpful assistant that can fetch web content.",
llm="anthropic/claude-3-5-sonnet-latest",
web_fetch=True
)
# This would make an actual API call
# response = agent.chat("Fetch and summarize https://example.com")
# assert response is not None
pass # Skip actual API call in tests
@@ -0,0 +1,255 @@
"""
Test file for web_search feature (TDD approach).
Tests the LiteLLM native web search integration with fallback to DuckDuckGo.
"""
import pytest
import os
from unittest.mock import patch
class TestWebSearchSupport:
"""Test web search capability detection."""
def test_supports_web_search_openai_search_preview(self):
"""Test that gpt-4o-search-preview is detected as supporting web search."""
from praisonaiagents.llm.model_capabilities import supports_web_search
assert supports_web_search("openai/gpt-4o-search-preview") == True
def test_supports_web_search_xai_grok(self):
"""Test that xai/grok-3 is detected as supporting web search."""
from praisonaiagents.llm.model_capabilities import supports_web_search
assert supports_web_search("xai/grok-3") == True
def test_supports_web_search_anthropic_claude(self):
"""Test that claude-3-5-sonnet-latest is detected as supporting web search."""
from praisonaiagents.llm.model_capabilities import supports_web_search
assert supports_web_search("anthropic/claude-3-5-sonnet-latest") == True
def test_supports_web_search_gemini(self):
"""Test that gemini-2.0-flash is detected as supporting web search."""
from praisonaiagents.llm.model_capabilities import supports_web_search
assert supports_web_search("gemini-2.0-flash") == True
def test_supports_web_search_ollama_false(self):
"""Test that ollama models don't support native web search."""
from praisonaiagents.llm.model_capabilities import supports_web_search
assert supports_web_search("ollama/llama3") == False
def test_supports_web_search_unknown_model(self):
"""Test that unknown models default to False."""
from praisonaiagents.llm.model_capabilities import supports_web_search
assert supports_web_search("unknown/model") == False
class TestLLMWebSearchParameter:
"""Test LLM class web_search parameter."""
def test_llm_init_with_web_search_true(self):
"""Test LLM initialization with web_search=True."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini", web_search=True)
assert llm.web_search == True
def test_llm_init_with_web_search_dict(self):
"""Test LLM initialization with web_search as dict."""
from praisonaiagents.llm.llm import LLM
web_search_options = {"search_context_size": "high"}
llm = LLM(model="gpt-4o-mini", web_search=web_search_options)
assert llm.web_search == web_search_options
def test_llm_init_with_web_search_false(self):
"""Test LLM initialization with web_search=False."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini", web_search=False)
assert llm.web_search == False
def test_llm_init_without_web_search(self):
"""Test LLM initialization without web_search (default None)."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini")
assert llm.web_search is None
def test_llm_supports_web_search_method(self):
"""Test LLM._supports_web_search() method."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="openai/gpt-4o-search-preview")
assert llm._supports_web_search() == True
def test_llm_supports_web_search_method_ollama(self):
"""Test LLM._supports_web_search() returns False for Ollama."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="ollama/llama3")
assert llm._supports_web_search() == False
class TestLLMBuildCompletionParams:
"""Test _build_completion_params includes web_search_options."""
def test_build_params_with_web_search_true(self):
"""Test that web_search=True adds web_search_options to params."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="openai/gpt-4o-search-preview", web_search=True)
with patch.object(llm, '_supports_web_search', return_value=True):
params = llm._build_completion_params(messages=[{"role": "user", "content": "test"}])
assert "web_search_options" in params
assert params["web_search_options"] == {"search_context_size": "medium"}
def test_build_params_with_web_search_dict(self):
"""Test that web_search dict is passed correctly."""
from praisonaiagents.llm.llm import LLM
web_search_options = {"search_context_size": "high"}
llm = LLM(model="openai/gpt-4o-search-preview", web_search=web_search_options)
with patch.object(llm, '_supports_web_search', return_value=True):
params = llm._build_completion_params(messages=[{"role": "user", "content": "test"}])
assert "web_search_options" in params
assert params["web_search_options"] == {"search_context_size": "high"}
def test_build_params_without_web_search(self):
"""Test that web_search_options is not added when web_search is None."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="gpt-4o-mini")
params = llm._build_completion_params(messages=[{"role": "user", "content": "test"}])
assert "web_search_options" not in params
def test_build_params_web_search_unsupported_model(self):
"""Test that web_search_options is not added for unsupported models."""
from praisonaiagents.llm.llm import LLM
llm = LLM(model="ollama/llama3", web_search=True)
with patch.object(llm, '_supports_web_search', return_value=False):
params = llm._build_completion_params(messages=[{"role": "user", "content": "test"}])
assert "web_search_options" not in params
class TestAgentWebSearchParameter:
"""Test Agent class web_search parameter."""
def test_agent_init_with_web_search_true(self):
"""Test Agent initialization with web_search=True."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
instructions="Test",
web_search=True
)
assert agent.web_search == True
def test_agent_init_with_web_search_dict(self):
"""Test Agent initialization with web_search as dict."""
from praisonaiagents import Agent
web_search_options = {"search_context_size": "high"}
agent = Agent(
name="Test Agent",
instructions="Test",
web_search=web_search_options
)
assert agent.web_search == web_search_options
def test_agent_init_without_web_search(self):
"""Test Agent initialization without web_search (default None)."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
instructions="Test"
)
assert agent.web_search is None
def test_agent_with_custom_llm_passes_web_search(self):
"""Test that Agent passes web_search to custom LLM instance."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
instructions="Test",
llm="openai/gpt-4o-search-preview",
web_search=True
)
# When using custom LLM (with /), it creates llm_instance
assert hasattr(agent, 'llm_instance')
assert agent.llm_instance.web_search == True
class TestWebSearchFallback:
"""Test fallback to DuckDuckGo when native web search not supported."""
def test_fallback_tool_injection_for_unsupported_model(self):
"""Test that DuckDuckGo tool is injected for unsupported models."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
instructions="Test",
llm="ollama/llama3",
web_search=True
)
# Check that internet_search tool was added to tools
tool_names = [getattr(t, '__name__', str(t)) for t in agent.tools]
assert 'internet_search' in tool_names or 'duckduckgo' in tool_names
def test_no_fallback_for_supported_model(self):
"""Test that no fallback tool is added for supported models."""
from praisonaiagents import Agent
agent = Agent(
name="Test Agent",
instructions="Test",
llm="openai/gpt-4o-search-preview",
web_search=True,
tools=[] # Explicitly empty tools
)
# For supported models, tools should remain empty (native web search used)
# Only check if no DuckDuckGo tool was auto-added
tool_names = [getattr(t, '__name__', str(t)) for t in agent.tools]
# internet_search should NOT be auto-added for supported models
assert 'internet_search' not in tool_names
class TestDuckDuckGoToolPreservation:
"""Test that DuckDuckGo tools still work as before."""
def test_duckduckgo_import(self):
"""Test that DuckDuckGo tools can still be imported."""
from praisonaiagents.tools import internet_search, duckduckgo
assert callable(internet_search)
assert callable(duckduckgo)
def test_explicit_duckduckgo_tool_usage(self):
"""Test that explicit DuckDuckGo tool usage still works."""
from praisonaiagents import Agent
from praisonaiagents.tools import internet_search
agent = Agent(
name="Test Agent",
instructions="Test",
tools=[internet_search]
)
assert internet_search in agent.tools
class TestWebSearchIntegration:
"""Integration tests for web search (requires API keys)."""
@pytest.mark.skipif(
not os.getenv("OPENAI_API_KEY"),
reason="OPENAI_API_KEY not set"
)
def test_web_search_with_openai(self):
"""Test actual web search with OpenAI (integration test)."""
from praisonaiagents import Agent
agent = Agent(
name="Researcher",
instructions="You are a helpful research assistant.",
llm="openai/gpt-4o-search-preview",
web_search=True
)
result = agent.start("What is the current weather in San Francisco?")
assert result is not None
assert len(result) > 0
if __name__ == "__main__":
pytest.main([__file__, "-v"])
+2 -2
View File
@@ -1,5 +1,5 @@
version = 1
revision = 2
revision = 3
requires-python = ">=3.10"
resolution-markers = [
"python_full_version >= '3.13'",
@@ -2422,7 +2422,7 @@ wheels = [
[[package]]
name = "praisonaiagents"
version = "0.0.161"
version = "0.0.178"
source = { editable = "." }
dependencies = [
{ name = "aiohttp" },
+932 -5
View File
@@ -1,9 +1,936 @@
# PraisonAI Package
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/logo/dark.png" />
<source media="(prefers-color-scheme: light)" srcset="docs/logo/light.png" />
<img alt="PraisonAI Logo" src="docs/logo/light.png" />
</picture>
</p>
This is the PraisonAI package, which serves as a wrapper for PraisonAIAgents.
<p align="center">
<a href="https://github.com/MervinPraison/PraisonAI"><img src="https://static.pepy.tech/badge/PraisonAI" alt="Total Downloads" /></a>
<a href="https://github.com/MervinPraison/PraisonAI"><img src="https://img.shields.io/github/v/release/MervinPraison/PraisonAI" alt="Latest Stable Version" /></a>
<a href="https://github.com/MervinPraison/PraisonAI"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License" /></a>
</p>
It provides a simple and intuitive interface for working with AI agents and their capabilities.
<div align="center">
## Directory Structure
# Praison AI
<a href="https://trendshift.io/repositories/9130" target="_blank"><img src="https://trendshift.io/api/badge/repositories/9130" alt="MervinPraison%2FPraisonAI | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
</div>
PraisonAI is a production-ready Multi-AI Agents framework with self-reflection, designed to create AI Agents to automate and solve problems ranging from simple tasks to complex challenges. By integrating PraisonAI Agents, AG2 (Formerly AutoGen), and CrewAI into a low-code solution, it streamlines the building and management of multi-agent LLM systems, emphasising simplicity, customisation, and effective human-agent collaboration.
<div align="center">
<a href="https://docs.praison.ai">
<p align="center">
<img src="https://img.shields.io/badge/📚_Documentation-Visit_docs.praison.ai-blue?style=for-the-badge&logo=bookstack&logoColor=white" alt="Documentation" />
</p>
</a>
</div>
## Key Features
- 🤖 Automated AI Agents Creation
- 🔄 Self Reflection AI Agents
- 🧠 Reasoning AI Agents
- 👁️ Multi Modal AI Agents
- 🤝 Multi Agent Collaboration
- 🎭 AI Agent Workflow
- 📚 Add Custom Knowledge
- 🧠 Agents with Short and Long Term Memory
- 📄 Chat with PDF Agents
- 💻 Code Interpreter Agents
- 📚 RAG Agents
- 🤔 Async & Parallel Processing
- 🔄 Auto Agents
- 🔢 Math Agents
- 🎯 Structured Output Agents
- 🔗 LangChain Integrated Agents
- 📞 Callback Agents
- 🤏 Mini AI Agents
- 🛠️ 100+ Custom Tools
- 📄 YAML Configuration
- 💯 100+ LLM Support
- 🔬 **Deep Research Agents** (OpenAI & Gemini)
- 🔄 **Query Rewriter Agent** (HyDE, Step-back, Multi-query)
- 🌐 **Native Web Search** (OpenAI, Gemini, Anthropic, xAI, Perplexity)
- 📥 **Web Fetch** (Retrieve full content from URLs - Anthropic)
- 💾 **Prompt Caching** (Reduce costs & latency - OpenAI, Anthropic, Bedrock, Deepseek)
- 🧠 **Claude Memory Tool** (Persistent cross-conversation memory - Anthropic Beta)
- 💾 **File-Based Memory** (Zero-dependency persistent memory for all agents)
## Using Python Code
Light weight package dedicated for coding:
```bash
pip install praisonaiagents
```
```bash
export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx
```
### 1. Single Agent
Create app.py file and add the code below:
```python
from praisonaiagents import Agent
agent = Agent(instructions="Your are a helpful AI assistant")
agent.start("Write a movie script about a robot in Mars")
```
Run:
```bash
python app.py
```
### 2. Multi Agents
Create app.py file and add the code below:
```python
from praisonaiagents import Agent, PraisonAIAgents
research_agent = Agent(instructions="Research about AI")
summarise_agent = Agent(instructions="Summarise research agent's findings")
agents = PraisonAIAgents(agents=[research_agent, summarise_agent])
agents.start()
```
Run:
```bash
python app.py
```
### 3. Deep Research Agent
Automated research with real-time streaming, web search, and citations using OpenAI or Gemini Deep Research APIs.
```python
from praisonaiagents import DeepResearchAgent
# OpenAI Deep Research
agent = DeepResearchAgent(
model="o4-mini-deep-research", # or "o3-deep-research"
verbose=True
)
result = agent.research("What are the latest AI trends in 2025?")
print(result.report)
print(f"Citations: {len(result.citations)}")
```
```python
# Gemini Deep Research
from praisonaiagents import DeepResearchAgent
agent = DeepResearchAgent(
model="deep-research-pro", # Auto-detected as Gemini
verbose=True
)
result = agent.research("Research quantum computing advances")
print(result.report)
```
**Features:**
- 🔍 Multi-provider support (OpenAI, Gemini, LiteLLM)
- 📡 Real-time streaming with reasoning summaries
- 📚 Structured citations with URLs
- 🛠️ Built-in tools: web search, code interpreter, MCP, file search
- 🔄 Automatic provider detection from model name
### 4. Query Rewriter Agent
Transform user queries to improve RAG retrieval quality using multiple strategies.
```python
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
agent = QueryRewriterAgent(model="gpt-4o-mini")
# Basic - expands abbreviations, adds context
result = agent.rewrite("AI trends")
print(result.primary_query) # "What are the current trends in Artificial Intelligence?"
# HyDE - generates hypothetical document for semantic matching
result = agent.rewrite("What is quantum computing?", strategy=RewriteStrategy.HYDE)
# Step-back - generates broader context question
result = agent.rewrite("GPT-4 vs Claude 3?", strategy=RewriteStrategy.STEP_BACK)
# Sub-queries - decomposes complex questions
result = agent.rewrite("RAG setup and best embedding models?", strategy=RewriteStrategy.SUB_QUERIES)
# Contextual - resolves references using chat history
result = agent.rewrite("What about cost?", chat_history=[...])
```
**Strategies:**
- **BASIC**: Expand abbreviations, fix typos, add context
- **HYDE**: Generate hypothetical document for semantic matching
- **STEP_BACK**: Generate higher-level concept questions
- **SUB_QUERIES**: Decompose multi-part questions
- **MULTI_QUERY**: Generate multiple paraphrased versions
- **CONTEXTUAL**: Resolve references using conversation history
- **AUTO**: Automatically detect best strategy
### 5. Agent Memory (Zero Dependencies)
Enable persistent memory for agents - works out of the box without any extra packages.
```python
from praisonaiagents import Agent
# Enable memory with a single parameter
agent = Agent(
name="Personal Assistant",
instructions="You are a helpful assistant that remembers user preferences.",
memory=True, # Enables file-based memory (no extra deps!)
user_id="user123" # Isolate memory per user
)
# Store memories programmatically
agent.store_memory("User prefers dark mode", memory_type="short_term")
agent.store_memory("User's name is John", memory_type="long_term", importance=0.9)
# Memory is automatically injected into conversations
result = agent.start("What do you know about me?")
# Agent will recall: "Your name is John and you prefer dark mode"
# Memory persists across sessions - create new agent with same user_id
agent2 = Agent(name="Assistant", memory=True, user_id="user123")
# agent2 automatically loads all previous memories!
```
**Memory Types:**
- **Short-term**: Rolling buffer of recent context (auto-expires)
- **Long-term**: Persistent important facts (sorted by importance)
- **Entity**: People, places, organizations with attributes
- **Episodic**: Date-based interaction history
**Storage Options:**
| Option | Dependencies | Description |
|--------|-------------|-------------|
| `memory=True` | None | File-based JSON storage (default) |
| `memory="file"` | None | Explicit file-based storage |
| `memory="sqlite"` | Built-in | SQLite with indexing |
| `memory="chromadb"` | chromadb | Vector/semantic search |
## Using No Code
### Auto Mode:
```bash
pip install praisonai
export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx
praisonai --auto create a movie script about Robots in Mars
```
### Query Rewriting (works with any command):
```bash
# Rewrite query for better results (uses QueryRewriterAgent)
praisonai "AI trends" --query-rewrite
# Rewrite with search tools (agent decides when to search)
praisonai "latest developments" --query-rewrite --rewrite-tools "internet_search"
# Works with any prompt
praisonai "explain quantum computing" --query-rewrite -v
```
### Deep Research CLI:
```bash
# Default: OpenAI (o4-mini-deep-research)
praisonai research "What are the latest AI trends in 2025?"
# Use Gemini
praisonai research --model deep-research-pro "Your research query"
# Rewrite query before research
praisonai research --query-rewrite "AI trends"
# Rewrite with search tools
praisonai research --query-rewrite --rewrite-tools "internet_search" "AI trends"
# Use custom tools from file (gathers context before deep research)
praisonai research --tools tools.py "Your research query"
praisonai research -t my_tools.py "Your research query"
# Use built-in tools by name (comma-separated)
praisonai research --tools "internet_search,wiki_search" "Your query"
praisonai research -t "yfinance,calculator_tools" "Stock analysis query"
# Save output to file (output/research/{query}.md)
praisonai research --save "Your research query"
praisonai research -s "Your research query"
# Combine options
praisonai research --query-rewrite --tools tools.py --save "Your research query"
# Verbose mode (show debug logs)
praisonai research -v "Your research query"
```
## Using JavaScript Code
```bash
npm install praisonai
export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx
```
```javascript
const { Agent } = require('praisonai');
const agent = new Agent({ instructions: 'You are a helpful AI assistant' });
agent.start('Write a movie script about a robot in Mars');
```
![PraisonAI CLI Demo](docs/demo/praisonai-cli-demo.gif)
## Star History
[![Star History Chart](https://api.star-history.com/svg?repos=MervinPraison/PraisonAI&type=Date)](https://docs.praison.ai)
## AI Agents Flow
```mermaid
graph LR
%% Define the main flow
Start([▶ Start]) --> Agent1
Agent1 --> Process[⚙ Process]
Process --> Agent2
Agent2 --> Output([✓ Output])
Process -.-> Agent1
%% Define subgraphs for agents and their tasks
subgraph Agent1[ ]
Task1[📋 Task]
AgentIcon1[🤖 AI Agent]
Tools1[🔧 Tools]
Task1 --- AgentIcon1
AgentIcon1 --- Tools1
end
subgraph Agent2[ ]
Task2[📋 Task]
AgentIcon2[🤖 AI Agent]
Tools2[🔧 Tools]
Task2 --- AgentIcon2
AgentIcon2 --- Tools2
end
classDef input fill:#8B0000,stroke:#7C90A0,color:#fff
classDef process fill:#189AB4,stroke:#7C90A0,color:#fff
classDef tools fill:#2E8B57,stroke:#7C90A0,color:#fff
classDef transparent fill:none,stroke:none
class Start,Output,Task1,Task2 input
class Process,AgentIcon1,AgentIcon2 process
class Tools1,Tools2 tools
class Agent1,Agent2 transparent
```
## AI Agents with Tools
Create AI agents that can use tools to interact with external systems and perform actions.
```mermaid
flowchart TB
subgraph Tools
direction TB
T3[Internet Search]
T1[Code Execution]
T2[Formatting]
end
Input[Input] ---> Agents
subgraph Agents
direction LR
A1[Agent 1]
A2[Agent 2]
A3[Agent 3]
end
Agents ---> Output[Output]
T3 --> A1
T1 --> A2
T2 --> A3
style Tools fill:#189AB4,color:#fff
style Agents fill:#8B0000,color:#fff
style Input fill:#8B0000,color:#fff
style Output fill:#8B0000,color:#fff
```
## AI Agents with Memory
Create AI agents with memory capabilities for maintaining context and information across tasks.
```mermaid
flowchart TB
subgraph Memory
direction TB
STM[Short Term]
LTM[Long Term]
end
subgraph Store
direction TB
DB[(Vector DB)]
end
Input[Input] ---> Agents
subgraph Agents
direction LR
A1[Agent 1]
A2[Agent 2]
A3[Agent 3]
end
Agents ---> Output[Output]
Memory <--> Store
Store <--> A1
Store <--> A2
Store <--> A3
style Memory fill:#189AB4,color:#fff
style Store fill:#2E8B57,color:#fff
style Agents fill:#8B0000,color:#fff
style Input fill:#8B0000,color:#fff
style Output fill:#8B0000,color:#fff
```
## AI Agents with Different Processes
### Sequential Process
The simplest form of task execution where tasks are performed one after another.
```mermaid
graph LR
Input[Input] --> A1
subgraph Agents
direction LR
A1[Agent 1] --> A2[Agent 2] --> A3[Agent 3]
end
A3 --> Output[Output]
classDef input fill:#8B0000,stroke:#7C90A0,color:#fff
classDef process fill:#189AB4,stroke:#7C90A0,color:#fff
classDef transparent fill:none,stroke:none
class Input,Output input
class A1,A2,A3 process
class Agents transparent
```
### Hierarchical Process
Uses a manager agent to coordinate task execution and agent assignments.
```mermaid
graph TB
Input[Input] --> Manager
subgraph Agents
Manager[Manager Agent]
subgraph Workers
direction LR
W1[Worker 1]
W2[Worker 2]
W3[Worker 3]
end
Manager --> W1
Manager --> W2
Manager --> W3
end
W1 --> Manager
W2 --> Manager
W3 --> Manager
Manager --> Output[Output]
classDef input fill:#8B0000,stroke:#7C90A0,color:#fff
classDef process fill:#189AB4,stroke:#7C90A0,color:#fff
classDef transparent fill:none,stroke:none
class Input,Output input
class Manager,W1,W2,W3 process
class Agents,Workers transparent
```
### Workflow Process
Advanced process type supporting complex task relationships and conditional execution.
```mermaid
graph LR
Input[Input] --> Start
subgraph Workflow
direction LR
Start[Start] --> C1{Condition}
C1 --> |Yes| A1[Agent 1]
C1 --> |No| A2[Agent 2]
A1 --> Join
A2 --> Join
Join --> A3[Agent 3]
end
A3 --> Output[Output]
classDef input fill:#8B0000,stroke:#7C90A0,color:#fff
classDef process fill:#189AB4,stroke:#7C90A0,color:#fff
classDef decision fill:#2E8B57,stroke:#7C90A0,color:#fff
classDef transparent fill:none,stroke:none
class Input,Output input
class Start,A1,A2,A3,Join process
class C1 decision
class Workflow transparent
```
#### Agentic Routing Workflow
Create AI agents that can dynamically route tasks to specialized LLM instances.
```mermaid
flowchart LR
In[In] --> Router[LLM Call Router]
Router --> LLM1[LLM Call 1]
Router --> LLM2[LLM Call 2]
Router --> LLM3[LLM Call 3]
LLM1 --> Out[Out]
LLM2 --> Out
LLM3 --> Out
style In fill:#8B0000,color:#fff
style Router fill:#2E8B57,color:#fff
style LLM1 fill:#2E8B57,color:#fff
style LLM2 fill:#2E8B57,color:#fff
style LLM3 fill:#2E8B57,color:#fff
style Out fill:#8B0000,color:#fff
```
#### Agentic Orchestrator Worker
Create AI agents that orchestrate and distribute tasks among specialized workers.
```mermaid
flowchart LR
In[In] --> Router[LLM Call Router]
Router --> LLM1[LLM Call 1]
Router --> LLM2[LLM Call 2]
Router --> LLM3[LLM Call 3]
LLM1 --> Synthesizer[Synthesizer]
LLM2 --> Synthesizer
LLM3 --> Synthesizer
Synthesizer --> Out[Out]
style In fill:#8B0000,color:#fff
style Router fill:#2E8B57,color:#fff
style LLM1 fill:#2E8B57,color:#fff
style LLM2 fill:#2E8B57,color:#fff
style LLM3 fill:#2E8B57,color:#fff
style Synthesizer fill:#2E8B57,color:#fff
style Out fill:#8B0000,color:#fff
```
#### Agentic Autonomous Workflow
Create AI agents that can autonomously monitor, act, and adapt based on environment feedback.
```mermaid
flowchart LR
Human[Human] <--> LLM[LLM Call]
LLM -->|ACTION| Environment[Environment]
Environment -->|FEEDBACK| LLM
LLM --> Stop[Stop]
style Human fill:#8B0000,color:#fff
style LLM fill:#2E8B57,color:#fff
style Environment fill:#8B0000,color:#fff
style Stop fill:#333,color:#fff
```
#### Agentic Parallelization
Create AI agents that can execute tasks in parallel for improved performance.
```mermaid
flowchart LR
In[In] --> LLM2[LLM Call 2]
In --> LLM1[LLM Call 1]
In --> LLM3[LLM Call 3]
LLM1 --> Aggregator[Aggregator]
LLM2 --> Aggregator
LLM3 --> Aggregator
Aggregator --> Out[Out]
style In fill:#8B0000,color:#fff
style LLM1 fill:#2E8B57,color:#fff
style LLM2 fill:#2E8B57,color:#fff
style LLM3 fill:#2E8B57,color:#fff
style Aggregator fill:#fff,color:#000
style Out fill:#8B0000,color:#fff
```
#### Agentic Prompt Chaining
Create AI agents with sequential prompt chaining for complex workflows.
```mermaid
flowchart LR
In[In] --> LLM1[LLM Call 1] --> Gate{Gate}
Gate -->|Pass| LLM2[LLM Call 2] -->|Output 2| LLM3[LLM Call 3] --> Out[Out]
Gate -->|Fail| Exit[Exit]
style In fill:#8B0000,color:#fff
style LLM1 fill:#2E8B57,color:#fff
style LLM2 fill:#2E8B57,color:#fff
style LLM3 fill:#2E8B57,color:#fff
style Out fill:#8B0000,color:#fff
style Exit fill:#8B0000,color:#fff
```
#### Agentic Evaluator Optimizer
Create AI agents that can generate and optimize solutions through iterative feedback.
```mermaid
flowchart LR
In[In] --> Generator[LLM Call Generator]
Generator -->|SOLUTION| Evaluator[LLM Call Evaluator] -->|ACCEPTED| Out[Out]
Evaluator -->|REJECTED + FEEDBACK| Generator
style In fill:#8B0000,color:#fff
style Generator fill:#2E8B57,color:#fff
style Evaluator fill:#2E8B57,color:#fff
style Out fill:#8B0000,color:#fff
```
#### Repetitive Agents
Create AI agents that can efficiently handle repetitive tasks through automated loops.
```mermaid
flowchart LR
In[Input] --> LoopAgent[("Looping Agent")]
LoopAgent --> Task[Task]
Task --> |Next iteration| LoopAgent
Task --> |Done| Out[Output]
style In fill:#8B0000,color:#fff
style LoopAgent fill:#2E8B57,color:#fff,shape:circle
style Task fill:#2E8B57,color:#fff
style Out fill:#8B0000,color:#fff
```
## Adding Models
<div align="center">
<a href="https://docs.praison.ai/models">
<p align="center">
<img src="https://img.shields.io/badge/%F0%9F%93%9A_Models-Visit_docs.praison.ai-blue?style=for-the-badge&logo=bookstack&logoColor=white" alt="Models" />
</p>
</a>
</div>
## Ollama Integration
```bash
export OPENAI_BASE_URL=http://localhost:11434/v1
```
## Groq Integration
Replace xxxx with Groq API KEY:
```bash
export OPENAI_API_KEY=xxxxxxxxxxx
export OPENAI_BASE_URL=https://api.groq.com/openai/v1
```
## No Code Options
## Agents Playbook
### Simple Playbook Example
Create `agents.yaml` file and add the code below:
```yaml
framework: praisonai
topic: Artificial Intelligence
roles:
screenwriter:
backstory: "Skilled in crafting scripts with engaging dialogue about {topic}."
goal: Create scripts from concepts.
role: Screenwriter
tasks:
scriptwriting_task:
description: "Develop scripts with compelling characters and dialogue about {topic}."
expected_output: "Complete script ready for production."
```
*To run the playbook:*
```bash
praisonai agents.yaml
```
## Use 100+ Models
- https://docs.praison.ai/models/
<div align="center">
<a href="https://docs.praison.ai">
<p align="center">
<img src="https://img.shields.io/badge/📚_Documentation-Visit_docs.praison.ai-blue?style=for-the-badge&logo=bookstack&logoColor=white" alt="Documentation" />
</p>
</a>
</div>
## Custom Tools
### Using `@tool` Decorator
```python
from praisonaiagents import Agent, tool
@tool
def search(query: str) -> str:
"""Search the web for information."""
return f"Results for: {query}"
@tool
def calculate(expression: str) -> float:
"""Evaluate a math expression."""
return eval(expression)
agent = Agent(
instructions="You are a helpful assistant",
tools=[search, calculate]
)
agent.start("Search for AI news and calculate 15*4")
```
### Using `BaseTool` Class
```python
from praisonaiagents import Agent, BaseTool
class WeatherTool(BaseTool):
name = "weather"
description = "Get current weather for a location"
def run(self, location: str) -> str:
return f"Weather in {location}: 72°F, Sunny"
agent = Agent(
instructions="You are a weather assistant",
tools=[WeatherTool()]
)
agent.start("What's the weather in Paris?")
```
### Creating a Tool Package (pip installable)
```toml
# pyproject.toml
[project]
name = "my-praisonai-tools"
version = "1.0.0"
dependencies = ["praisonaiagents"]
[project.entry-points."praisonaiagents.tools"]
my_tool = "my_package:MyTool"
```
```python
# my_package/__init__.py
from praisonaiagents import BaseTool
class MyTool(BaseTool):
name = "my_tool"
description = "My custom tool"
def run(self, param: str) -> str:
return f"Result: {param}"
```
After `pip install`, tools are auto-discovered:
```python
agent = Agent(tools=["my_tool"]) # Works automatically!
```
## Prompt Expansion
Expand short prompts into detailed, actionable prompts:
### CLI Usage
```bash
# Expand a short prompt into detailed prompt
praisonai "write a movie script in 3 lines" --expand-prompt
# With verbose output
praisonai "blog about AI" --expand-prompt -v
# With tools for context gathering
praisonai "latest AI trends" --expand-prompt --expand-tools tools.py
# Combine with query rewrite
praisonai "AI news" --query-rewrite --expand-prompt
```
### Programmatic Usage
```python
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
# Basic usage
agent = PromptExpanderAgent()
result = agent.expand("write a movie script in 3 lines")
print(result.expanded_prompt)
# With specific strategy
result = agent.expand("blog about AI", strategy=ExpandStrategy.DETAILED)
# Available strategies: BASIC, DETAILED, STRUCTURED, CREATIVE, AUTO
```
**Key Difference:**
- `--query-rewrite`: Optimizes queries for **search/retrieval** (RAG)
- `--expand-prompt`: Expands prompts for **detailed task execution**
## Web Search, Web Fetch & Prompt Caching
### CLI Usage
```bash
# Web Search - Get real-time information
praisonai "What are the latest AI news today?" --web-search --llm openai/gpt-4o-search-preview
# Web Fetch - Retrieve and analyze URL content (Anthropic only)
praisonai "Summarize https://docs.praison.ai" --web-fetch --llm anthropic/claude-sonnet-4-20250514
# Prompt Caching - Reduce costs for repeated prompts
praisonai "Analyze this document..." --prompt-caching --llm anthropic/claude-sonnet-4-20250514
```
### Programmatic Usage
```python
from praisonaiagents import Agent
# Web Search
agent = Agent(
instructions="You are a research assistant",
llm="openai/gpt-4o-search-preview",
web_search=True
)
# Web Fetch (Anthropic only)
agent = Agent(
instructions="You are a content analyzer",
llm="anthropic/claude-sonnet-4-20250514",
web_fetch=True
)
# Prompt Caching
agent = Agent(
instructions="You are an AI assistant..." * 50, # Long system prompt
llm="anthropic/claude-sonnet-4-20250514",
prompt_caching=True
)
```
**Supported Providers:**
| Feature | Providers |
|---------|-----------|
| Web Search | OpenAI, Gemini, Anthropic, xAI, Perplexity |
| Web Fetch | Anthropic |
| Prompt Caching | OpenAI (auto), Anthropic, Bedrock, Deepseek |
## Development:
Below is used for development only.
### Using uv
```bash
# Install uv if you haven't already
pip install uv
# Install from requirements
uv pip install -r pyproject.toml
# Install with extras
uv pip install -r pyproject.toml --extra code
uv pip install -r pyproject.toml --extra "crewai,autogen"
```
### Bump and Release
```bash
# From project root - bumps version and releases in one command
python src/praisonai/scripts/bump_and_release.py 2.2.99
# With praisonaiagents dependency
python src/praisonai/scripts/bump_and_release.py 2.2.99 --agents 0.0.169
# Then publish
cd src/praisonai && uv publish
```
## Contributing
- Fork on GitHub: Use the "Fork" button on the repository page.
- Clone your fork: `git clone https://github.com/yourusername/praisonAI.git`
- Create a branch: `git checkout -b new-feature`
- Make changes and commit: `git commit -am "Add some feature"`
- Push to your fork: `git push origin new-feature`
- Submit a pull request via GitHub's web interface.
- Await feedback from project maintainers.
## Other Features
- 🔄 Use CrewAI or AG2 (Formerly AutoGen) Framework
- 💻 Chat with ENTIRE Codebase
- 🎨 Interactive UIs
- 📄 YAML-based Configuration
- 🛠️ Custom Tool Integration
- 🔍 Internet Search Capability (using Crawl4AI and Tavily)
- 🖼️ Vision Language Model (VLM) Support
- 🎙️ Real-time Voice Interaction
## Video Tutorials
| Topic | Video |
|-------|--------|
| AI Agents with Self Reflection | [![Self Reflection](https://img.youtube.com/vi/vLXobEN2Vc8/0.jpg)](https://www.youtube.com/watch?v=vLXobEN2Vc8) |
| Reasoning Data Generating Agent | [![Reasoning Data](https://img.youtube.com/vi/fUT332Y2zA8/0.jpg)](https://www.youtube.com/watch?v=fUT332Y2zA8) |
| AI Agents with Reasoning | [![Reasoning](https://img.youtube.com/vi/KNDVWGN3TpM/0.jpg)](https://www.youtube.com/watch?v=KNDVWGN3TpM) |
| Multimodal AI Agents | [![Multimodal](https://img.youtube.com/vi/hjAWmUT1qqY/0.jpg)](https://www.youtube.com/watch?v=hjAWmUT1qqY) |
| AI Agents Workflow | [![Workflow](https://img.youtube.com/vi/yWTH44QPl2A/0.jpg)](https://www.youtube.com/watch?v=yWTH44QPl2A) |
| Async AI Agents | [![Async](https://img.youtube.com/vi/VhVQfgo00LE/0.jpg)](https://www.youtube.com/watch?v=VhVQfgo00LE) |
| Mini AI Agents | [![Mini](https://img.youtube.com/vi/OkvYp5aAGSg/0.jpg)](https://www.youtube.com/watch?v=OkvYp5aAGSg) |
| AI Agents with Memory | [![Memory](https://img.youtube.com/vi/1hVfVxvPnnQ/0.jpg)](https://www.youtube.com/watch?v=1hVfVxvPnnQ) |
| Repetitive Agents | [![Repetitive](https://img.youtube.com/vi/dAYGxsjDOPg/0.jpg)](https://www.youtube.com/watch?v=dAYGxsjDOPg) |
| Introduction | [![Introduction](https://img.youtube.com/vi/Fn1lQjC0GO0/0.jpg)](https://www.youtube.com/watch?v=Fn1lQjC0GO0) |
| Tools Overview | [![Tools Overview](https://img.youtube.com/vi/XaQRgRpV7jo/0.jpg)](https://www.youtube.com/watch?v=XaQRgRpV7jo) |
| Custom Tools | [![Custom Tools](https://img.youtube.com/vi/JSU2Rndh06c/0.jpg)](https://www.youtube.com/watch?v=JSU2Rndh06c) |
| Firecrawl Integration | [![Firecrawl](https://img.youtube.com/vi/UoqUDcLcOYo/0.jpg)](https://www.youtube.com/watch?v=UoqUDcLcOYo) |
| User Interface | [![UI](https://img.youtube.com/vi/tg-ZjNl3OCg/0.jpg)](https://www.youtube.com/watch?v=tg-ZjNl3OCg) |
| Crawl4AI Integration | [![Crawl4AI](https://img.youtube.com/vi/KAvuVUh0XU8/0.jpg)](https://www.youtube.com/watch?v=KAvuVUh0XU8) |
| Chat Interface | [![Chat](https://img.youtube.com/vi/sw3uDqn2h1Y/0.jpg)](https://www.youtube.com/watch?v=sw3uDqn2h1Y) |
| Code Interface | [![Code](https://img.youtube.com/vi/_5jQayO-MQY/0.jpg)](https://www.youtube.com/watch?v=_5jQayO-MQY) |
| Mem0 Integration | [![Mem0](https://img.youtube.com/vi/KIGSgRxf1cY/0.jpg)](https://www.youtube.com/watch?v=KIGSgRxf1cY) |
| Training | [![Training](https://img.youtube.com/vi/aLawE8kwCrI/0.jpg)](https://www.youtube.com/watch?v=aLawE8kwCrI) |
| Realtime Voice Interface | [![Realtime](https://img.youtube.com/vi/frRHfevTCSw/0.jpg)](https://www.youtube.com/watch?v=frRHfevTCSw) |
| Call Interface | [![Call](https://img.youtube.com/vi/m1cwrUG2iAk/0.jpg)](https://www.youtube.com/watch?v=m1cwrUG2iAk) |
| Reasoning Extract Agents | [![Reasoning Extract](https://img.youtube.com/vi/2PPamsADjJA/0.jpg)](https://www.youtube.com/watch?v=2PPamsADjJA) |
The main package code is located in the `praisonai` subdirectory.
+2 -2
View File
@@ -3,8 +3,8 @@ class Praisonai < Formula
desc "AI tools for various AI applications"
homepage "https://github.com/MervinPraison/PraisonAI"
url "https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.2.88.tar.gz"
sha256 `curl -sL https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.2.88.tar.gz | shasum -a 256`.split.first
url "https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.3.3.tar.gz"
sha256 `curl -sL https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.3.3.tar.gz | shasum -a 256`.split.first
license "MIT"
depends_on "[email protected]"
+462 -11
View File
@@ -28,6 +28,13 @@ AUTOGEN_AVAILABLE = False
PRAISONAI_AVAILABLE = False
TRAIN_AVAILABLE = False
try:
import importlib.util
CHAINLIT_AVAILABLE = importlib.util.find_spec("chainlit") is not None
except ImportError:
pass
def _get_chainlit_run():
"""Lazy import chainlit to avoid loading .env at startup"""
# Create necessary directories and set CHAINLIT_APP_ROOT
if "CHAINLIT_APP_ROOT" not in os.environ:
chainlit_root = os.path.join(os.path.expanduser("~"), ".praison")
@@ -39,9 +46,7 @@ try:
os.makedirs(os.path.join(chainlit_root, ".files"), exist_ok=True)
from chainlit.cli import chainlit_run
CHAINLIT_AVAILABLE = True
except ImportError:
pass
return chainlit_run
try:
import gradio as gr
@@ -509,9 +514,8 @@ class PraisonAI:
in_test_env = (
'pytest' in sys.argv[0] or
'unittest' in sys.argv[0] or
any('test' in arg for arg in sys.argv[1:3]) or # Check first few args for test indicators
'pytest' in sys.modules or
'unittest' in sys.modules
any(arg.startswith('tests.') or arg.startswith('tests/') for arg in sys.argv[1:3]) or # Check for test module paths
'PYTEST_CURRENT_TEST' in os.environ
)
# Check if we're being used as a library (not from praisonai CLI)
@@ -545,7 +549,7 @@ class PraisonAI:
return default_args
# Define special commands
special_commands = ['chat', 'code', 'call', 'realtime', 'train', 'ui', 'context']
special_commands = ['chat', 'code', 'call', 'realtime', 'train', 'ui', 'context', 'research']
parser = argparse.ArgumentParser(prog="praisonai", description="praisonAI command-line interface")
parser.add_argument("--framework", choices=["crewai", "autogen", "praisonai"], help="Specify the framework")
@@ -572,6 +576,17 @@ class PraisonAI:
parser.add_argument("--url", type=str, help="Repository URL for context analysis")
parser.add_argument("--goal", type=str, help="Goal for context engineering")
parser.add_argument("--auto-analyze", action="store_true", help="Enable automatic analysis in context engineering")
parser.add_argument("--research", action="store_true", help="Run deep research on a topic")
parser.add_argument("--query-rewrite", action="store_true", help="Rewrite query for better results (works with any command)")
parser.add_argument("--rewrite-tools", type=str, help="Tools for query rewriter (e.g., 'internet_search' or path to tools.py)")
parser.add_argument("--expand-prompt", action="store_true", help="Expand short prompt into detailed prompt (works with any command)")
parser.add_argument("--expand-tools", type=str, help="Tools for prompt expander (e.g., 'internet_search' or path to tools.py)")
parser.add_argument("--tools", "-t", type=str, help="Path to tools.py file for research agent")
parser.add_argument("--save", "-s", action="store_true", help="Save research output to file (output/research/)")
parser.add_argument("--verbose", "-v", action="store_true", help="Enable verbose output for research")
parser.add_argument("--web-search", action="store_true", help="Enable native web search (OpenAI, Gemini, Anthropic, xAI, Perplexity)")
parser.add_argument("--web-fetch", action="store_true", help="Enable web fetch to retrieve URL content (Anthropic only)")
parser.add_argument("--prompt-caching", action="store_true", help="Enable prompt caching to reduce costs (OpenAI, Anthropic, Bedrock, Deepseek)")
# If we're in a test environment, parse with empty args to avoid pytest interference
if in_test_env:
@@ -696,6 +711,29 @@ class PraisonAI:
self.handle_context_command(args.url, args.goal, getattr(args, 'auto_analyze', False))
sys.exit(0)
elif args.command == 'research':
if not PRAISONAI_AVAILABLE:
print("[red]ERROR: PraisonAI Agents is not installed. Install with:[/red]")
print("\npip install praisonaiagents\n")
sys.exit(1)
# Get the research query from remaining args
research_query = ' '.join(unknown_args) if unknown_args else None
if not research_query:
print("[red]ERROR: Research query is required[/red]")
print("Usage: praisonai research \"Your research query\"")
print(" praisonai research --model deep-research-pro \"Your query\"")
sys.exit(1)
research_model = getattr(args, 'model', None)
verbose = getattr(args, 'verbose', False)
save = getattr(args, 'save', False)
query_rewrite = getattr(args, 'query_rewrite', False)
rewrite_tools = getattr(args, 'rewrite_tools', None)
tools_path = getattr(args, 'tools', None)
self.handle_research_command(research_query, research_model, verbose, save, query_rewrite, tools_path, rewrite_tools)
sys.exit(0)
# Only check framework availability for agent-related operations
if not args.command and (args.init or args.auto or args.framework):
if not CREWAI_AVAILABLE and not AUTOGEN_AVAILABLE and not PRAISONAI_AVAILABLE:
@@ -714,10 +752,228 @@ class PraisonAI:
return args
def _rewrite_query(self, query: str, rewrite_tools: str = None, verbose: bool = False) -> str:
"""
Rewrite query using QueryRewriterAgent.
Args:
query: The query to rewrite
rewrite_tools: Tool names (comma-separated) or path to tools.py
verbose: Enable verbose output
Returns:
Rewritten query or original if rewriting fails
"""
try:
from praisonaiagents import QueryRewriterAgent, RewriteStrategy
from rich import print
print("[bold cyan]Rewriting query for better results...[/bold cyan]")
# Load rewrite tools if specified
rewrite_tools_list = []
if rewrite_tools:
if os.path.isfile(rewrite_tools):
# Load from file
try:
import inspect
import importlib.util
spec = importlib.util.spec_from_file_location("rewrite_tools_module", rewrite_tools)
if spec and spec.loader:
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
for name, obj in inspect.getmembers(module):
if inspect.isfunction(obj) and not name.startswith('_'):
rewrite_tools_list.append(obj)
if rewrite_tools_list:
print(f"[cyan]Loaded {len(rewrite_tools_list)} tools for query rewriter[/cyan]")
except Exception as e:
print(f"[yellow]Warning: Failed to load rewrite tools: {e}[/yellow]")
else:
# Treat as comma-separated tool names
try:
from praisonaiagents.tools import TOOL_MAPPINGS
import praisonaiagents.tools as tools_module
tool_names = [t.strip() for t in rewrite_tools.split(',')]
for tool_name in tool_names:
if tool_name in TOOL_MAPPINGS:
try:
tool = getattr(tools_module, tool_name)
rewrite_tools_list.append(tool)
except Exception as e:
print(f"[yellow]Warning: Failed to load rewrite tool '{tool_name}': {e}[/yellow]")
else:
print(f"[yellow]Warning: Unknown rewrite tool '{tool_name}'[/yellow]")
if rewrite_tools_list:
print(f"[cyan]Using rewrite tools: {', '.join(tool_names)}[/cyan]")
except ImportError:
print("[yellow]Warning: Could not import tools module[/yellow]")
rewriter = QueryRewriterAgent(
model="gpt-4o-mini",
verbose=verbose,
tools=rewrite_tools_list if rewrite_tools_list else None
)
result = rewriter.rewrite(query, strategy=RewriteStrategy.AUTO)
rewritten = result.primary_query
print(f"[cyan]Original:[/cyan] {query}")
print(f"[cyan]Rewritten:[/cyan] {rewritten}")
return rewritten
except ImportError:
from rich import print
print("[yellow]Warning: QueryRewriterAgent not available, using original query[/yellow]")
return query
except Exception as e:
from rich import print
print(f"[yellow]Warning: Query rewrite failed ({e}), using original query[/yellow]")
return query
def _rewrite_query_if_enabled(self, query: str) -> str:
"""
Rewrite query using QueryRewriterAgent if --query-rewrite is enabled.
Returns the rewritten query or original if rewriting is disabled/fails.
"""
if not hasattr(self, 'args') or not getattr(self.args, 'query_rewrite', False):
return query
rewrite_tools = getattr(self.args, 'rewrite_tools', None)
verbose = getattr(self.args, 'verbose', False)
return self._rewrite_query(query, rewrite_tools, verbose)
def _expand_prompt(self, prompt: str, expand_tools: str = None, verbose: bool = False) -> str:
"""
Expand prompt using PromptExpanderAgent.
Args:
prompt: The prompt to expand
expand_tools: Tool names (comma-separated) or path to tools.py
verbose: Enable verbose output
Returns:
Expanded prompt or original if expansion fails
"""
try:
from praisonaiagents import PromptExpanderAgent, ExpandStrategy
from rich import print
print("[bold cyan]Expanding prompt for detailed execution...[/bold cyan]")
# Load expand tools if specified
expand_tools_list = []
if expand_tools:
if os.path.isfile(expand_tools):
# Load from file
try:
import inspect
import importlib.util
spec = importlib.util.spec_from_file_location("expand_tools_module", expand_tools)
if spec and spec.loader:
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
for name, obj in inspect.getmembers(module):
if inspect.isfunction(obj) and not name.startswith('_'):
expand_tools_list.append(obj)
if expand_tools_list:
print(f"[cyan]Loaded {len(expand_tools_list)} tools for prompt expander[/cyan]")
except Exception as e:
print(f"[yellow]Warning: Failed to load expand tools: {e}[/yellow]")
else:
# Treat as comma-separated tool names
try:
from praisonaiagents.tools import TOOL_MAPPINGS
import praisonaiagents.tools as tools_module
tool_names = [t.strip() for t in expand_tools.split(',')]
for tool_name in tool_names:
if tool_name in TOOL_MAPPINGS:
try:
tool = getattr(tools_module, tool_name)
expand_tools_list.append(tool)
except Exception as e:
print(f"[yellow]Warning: Failed to load expand tool '{tool_name}': {e}[/yellow]")
else:
print(f"[yellow]Warning: Unknown expand tool '{tool_name}'[/yellow]")
if expand_tools_list:
print(f"[cyan]Using expand tools: {', '.join(tool_names)}[/cyan]")
except ImportError:
print("[yellow]Warning: Could not import tools module[/yellow]")
expander = PromptExpanderAgent(
model="gpt-4o-mini",
verbose=verbose,
tools=expand_tools_list if expand_tools_list else None
)
result = expander.expand(prompt, strategy=ExpandStrategy.AUTO)
expanded = result.expanded_prompt
print(f"[cyan]Original:[/cyan] {prompt}")
print(f"[cyan]Expanded:[/cyan] {expanded}")
return expanded
except ImportError:
from rich import print
print("[yellow]Warning: PromptExpanderAgent not available, using original prompt[/yellow]")
return prompt
except Exception as e:
from rich import print
print(f"[yellow]Warning: Prompt expansion failed ({e}), using original prompt[/yellow]")
return prompt
def _expand_prompt_if_enabled(self, prompt: str) -> str:
"""
Expand prompt using PromptExpanderAgent if --expand-prompt is enabled.
Returns the expanded prompt or original if expansion is disabled/fails.
"""
if not hasattr(self, 'args') or not getattr(self.args, 'expand_prompt', False):
return prompt
expand_tools = getattr(self.args, 'expand_tools', None)
verbose = getattr(self.args, 'verbose', False)
return self._expand_prompt(prompt, expand_tools, verbose)
def _save_output(self, prompt: str, result: str):
"""
Save output to output/prompts/ folder.
Args:
prompt: The original prompt
result: The output result to save
"""
from datetime import datetime
from rich import print
# Create output directory
output_dir = os.path.join(os.getcwd(), "output", "prompts")
os.makedirs(output_dir, exist_ok=True)
# Generate filename with timestamp
timestamp = datetime.now().strftime("%Y-%m-%d_%H-%M-%S")
# Create a safe filename from prompt (first 30 chars)
safe_prompt = "".join(c if c.isalnum() or c in " -_" else "" for c in prompt[:30]).strip().replace(" ", "_")
filename = f"{timestamp}_{safe_prompt}.md"
filepath = os.path.join(output_dir, filename)
# Write output
with open(filepath, "w", encoding="utf-8") as f:
f.write(f"# Prompt\n\n{prompt}\n\n")
f.write(f"# Output\n\n{result}\n")
print(f"[green]✅ Output saved to: {filepath}[/green]")
def handle_direct_prompt(self, prompt):
"""
Handle direct prompt by creating a single agent and running it.
"""
# Apply query rewriting if enabled
prompt = self._rewrite_query_if_enabled(prompt)
# Apply prompt expansion if enabled
prompt = self._expand_prompt_if_enabled(prompt)
if PRAISONAI_AVAILABLE:
agent_config = {
"name": "DirectAgent",
@@ -730,8 +986,22 @@ class PraisonAI:
if hasattr(self, 'args') and self.args.llm:
agent_config["llm"] = self.args.llm
# Add feature flags if enabled
if hasattr(self, 'args'):
if getattr(self.args, 'web_search', False):
agent_config["web_search"] = True
if getattr(self.args, 'web_fetch', False):
agent_config["web_fetch"] = True
if getattr(self.args, 'prompt_caching', False):
agent_config["prompt_caching"] = True
agent = PraisonAgent(**agent_config)
result = agent.start(prompt)
# Save output if --save is enabled
if hasattr(self, 'args') and getattr(self.args, 'save', False):
self._save_output(prompt, result)
return result
elif CREWAI_AVAILABLE:
from crewai import Agent, Task, Crew
@@ -791,7 +1061,7 @@ class PraisonAI:
if "CHAINLIT_APP_ROOT" not in os.environ:
os.environ["CHAINLIT_APP_ROOT"] = root_path
chat_ui_path = os.path.join(os.path.dirname(praisonai.__file__), 'ui', 'chat.py')
chainlit_run([chat_ui_path])
_get_chainlit_run()([chat_ui_path])
else:
print("ERROR: Chat UI is not installed. Please install it with 'pip install \"praisonai[chat]\"' to use the chat UI.")
@@ -815,7 +1085,7 @@ class PraisonAI:
else:
logging.info("Public folder already exists.")
code_ui_path = os.path.join(os.path.dirname(praisonai.__file__), 'ui', 'code.py')
chainlit_run([code_ui_path])
_get_chainlit_run()([code_ui_path])
else:
print("ERROR: Code UI is not installed. Please install it with 'pip install \"praisonai[code]\"' to use the code UI.")
@@ -861,7 +1131,7 @@ class PraisonAI:
else:
logging.info("Public folder already exists.")
chainlit_ui_path = os.path.join(os.path.dirname(praisonai.__file__), 'ui', 'agents.py')
chainlit_run([chainlit_ui_path])
_get_chainlit_run()([chainlit_ui_path])
else:
print("ERROR: Chainlit is not installed. Please install it with 'pip install \"praisonai[ui]\"' to use the UI.")
@@ -885,7 +1155,7 @@ class PraisonAI:
else:
logging.info("Public folder already exists.")
realtime_ui_path = os.path.join(os.path.dirname(praisonai.__file__), 'ui', 'realtime.py')
chainlit_run([realtime_ui_path])
_get_chainlit_run()([realtime_ui_path])
else:
print("ERROR: Realtime UI is not installed. Please install it with 'pip install \"praisonai[realtime]\"' to use the realtime UI.")
@@ -933,6 +1203,187 @@ class PraisonAI:
print(f"[red]ERROR: Context engineering failed: {e}[/red]")
sys.exit(1)
def handle_research_command(self, query: str, model: str = None, verbose: bool = False, save: bool = False, query_rewrite: bool = False, tools_path: str = None, rewrite_tools: str = None) -> str:
"""
Handle the research command by creating a DeepResearchAgent and running it.
Args:
query: Research query/topic
model: Model for deep research (optional, defaults to o4-mini-deep-research)
verbose: Enable verbose output (default: False)
save: Save output to file (default: False)
query_rewrite: Rewrite query before research (default: False)
tools_path: Path to tools.py file with custom tools (default: None)
rewrite_tools: Tools for query rewriter (tool names or file path)
Returns:
str: Research report
"""
try:
from praisonaiagents import DeepResearchAgent
# Suppress logging unless verbose
if not verbose:
logging.getLogger('google').setLevel(logging.WARNING)
logging.getLogger('google.genai').setLevel(logging.WARNING)
logging.getLogger('httpx').setLevel(logging.WARNING)
logging.getLogger('httpcore').setLevel(logging.WARNING)
# Rewrite query if requested
if query_rewrite:
query = self._rewrite_query(query, rewrite_tools, verbose)
print("[bold green]Starting Deep Research...[/bold green]")
print(f"Query: {query}")
# Default model if not specified
if not model:
model = "o4-mini-deep-research"
print(f"Model: {model}")
# Load tools if specified
tools_list = []
if tools_path:
# Check if it's a file path or comma-separated tool names
if os.path.isfile(tools_path):
# Load from file
try:
import inspect
spec = importlib.util.spec_from_file_location("tools_module", tools_path)
if spec and spec.loader:
module = importlib.util.module_from_spec(spec)
spec.loader.exec_module(module)
# Get all callable functions from the module
for name, obj in inspect.getmembers(module):
if inspect.isfunction(obj) and not name.startswith('_'):
tools_list.append(obj)
if tools_list:
print(f"[cyan]Loaded {len(tools_list)} tools from {tools_path}[/cyan]")
except Exception as e:
print(f"[yellow]Warning: Failed to load tools from {tools_path}: {e}[/yellow]")
else:
# Treat as comma-separated tool names (e.g., "internet_search,wiki_search")
try:
from praisonaiagents.tools import TOOL_MAPPINGS
import praisonaiagents.tools as tools_module
tool_names = [t.strip() for t in tools_path.split(',')]
for tool_name in tool_names:
if tool_name in TOOL_MAPPINGS:
try:
tool = getattr(tools_module, tool_name)
tools_list.append(tool)
except Exception as e:
print(f"[yellow]Warning: Failed to load tool '{tool_name}': {e}[/yellow]")
else:
print(f"[yellow]Warning: Unknown tool '{tool_name}'[/yellow]")
if tools_list:
print(f"[cyan]Loaded {len(tools_list)} built-in tools: {', '.join(tool_names)}[/cyan]")
except ImportError:
print("[yellow]Warning: Could not import tools module[/yellow]")
# If tools are provided, use Agent with tools first, then DeepResearchAgent
if tools_list:
from praisonaiagents import Agent, Task, PraisonAIAgents
# Create a research assistant agent with tools
research_assistant = Agent(
name="Research Assistant",
role="Information Gatherer",
goal="Gather relevant information using available tools",
backstory="You are an expert at using tools to gather information for research.",
tools=tools_list,
llm="gpt-4o-mini",
verbose=False
)
# Create task to gather initial information
gather_task = Task(
description=f"Use your tools to gather relevant information about: {query}",
expected_output="A summary of information gathered from the tools",
agent=research_assistant
)
print("[cyan]Gathering information with tools...[/cyan]")
agents = PraisonAIAgents(agents=[research_assistant], tasks=[gather_task], verbose=0)
tool_results = agents.start()
# Enhance query with tool results
enhanced_query = f"{query}\n\nAdditional context from tools:\n{tool_results}"
print("[cyan]Tools context gathered, starting deep research...[/cyan]")
# Create DeepResearchAgent
agent = DeepResearchAgent(model=model)
result = agent.research(enhanced_query)
else:
# Create DeepResearchAgent (verbose=True is default for streaming output)
agent = DeepResearchAgent(model=model)
# Execute the research
result = agent.research(query)
print("\n[bold green]Research Complete![/bold green]")
print("\n" + "="*60)
print(result.report)
print("="*60)
# Show citations if available
if result.citations:
print(f"\n[bold]Citations ({len(result.citations)}):[/bold]")
for i, citation in enumerate(result.citations, 1):
title = getattr(citation, 'title', 'Untitled')
url = getattr(citation, 'url', '')
print(f" {i}. {title}")
if url:
print(f" {url}")
# Save output to file if --save flag is set
if save:
import re
# Get first 10 words from query for filename
words = query.split()[:10]
filename_base = ' '.join(words)
# Sanitize filename: remove invalid characters
filename_base = re.sub(r'[<>:"/\\|?*\x00-\x1f]', '', filename_base)
filename_base = filename_base.strip()[:100] # Limit length
if not filename_base:
filename_base = "research_output"
# Create output directory
output_dir = os.path.join(os.getcwd(), "output", "research")
os.makedirs(output_dir, exist_ok=True)
# Build markdown content
md_content = f"# {query}\n\n"
md_content += result.report
if result.citations:
md_content += "\n\n## Citations\n\n"
for i, citation in enumerate(result.citations, 1):
title = getattr(citation, 'title', 'Untitled')
url = getattr(citation, 'url', '')
if url:
md_content += f"{i}. [{title}]({url})\n"
else:
md_content += f"{i}. {title}\n"
# Save to file
output_path = os.path.join(output_dir, f"{filename_base}.md")
with open(output_path, 'w', encoding='utf-8') as f:
f.write(md_content)
print(f"\n[bold green]Saved to:[/bold green] {output_path}")
return result.report
except ImportError as e:
print(f"[red]ERROR: Failed to import DeepResearchAgent: {e}[/red]")
print("Make sure praisonaiagents is installed: pip install praisonaiagents")
sys.exit(1)
except Exception as e:
print(f"[red]ERROR: Research failed: {e}[/red]")
sys.exit(1)
if __name__ == "__main__":
praison_ai = PraisonAI()
praison_ai.main()
+1 -1
View File
@@ -57,7 +57,7 @@ class CloudDeployer:
file.write("FROM python:3.11-slim\n")
file.write("WORKDIR /app\n")
file.write("COPY . .\n")
file.write("RUN pip install flask praisonai==2.2.88 gunicorn markdown\n")
file.write("RUN pip install flask praisonai==2.3.3 gunicorn markdown\n")
file.write("EXPOSE 8080\n")
file.write('CMD ["gunicorn", "-b", "0.0.0.0:8080", "api:app"]\n')
+1 -1
View File
@@ -1 +1 @@
__version__ = "0.0.1"
__version__ = "2.3.3"
+11 -194
View File
@@ -1,9 +1,9 @@
[project]
name = "PraisonAI"
version = "2.2.88"
dynamic = ["version"]
description = "PraisonAI is an AI Agents Framework with Self Reflection. PraisonAI application combines PraisonAI Agents, AutoGen, and CrewAI into a low-code solution for building and managing multi-agent LLM systems, focusing on simplicity, customisation, and efficient human-agent collaboration."
readme = "README.md"
license = ""
license = {text = "MIT"}
requires-python = ">=3.10"
authors = [
{ name = "Mervin Praison" }
@@ -12,7 +12,7 @@ dependencies = [
"rich>=13.7",
"markdown>=3.5",
"pyparsing>=3.0.0",
"praisonaiagents>=0.0.161",
"praisonaiagents>=0.0.178",
"python-dotenv>=0.19.0",
"instructor>=1.3.3",
"PyYAML>=6.0",
@@ -100,200 +100,17 @@ autogen-v4 = [
"crewai"
]
[tool.poetry]
name = "PraisonAI"
version = "2.2.88"
description = "PraisonAI is an AI Agents Framework with Self Reflection. PraisonAI application combines PraisonAI Agents, AutoGen, and CrewAI into a low-code solution for building and managing multi-agent LLM systems, focusing on simplicity, customisation, and efficient human-agent collaboration."
authors = ["Mervin Praison"]
license = ""
readme = "README.md"
[tool.poetry.urls]
[project.urls]
Homepage = "https://docs.praison.ai"
Repository = "https://github.com/mervinpraison/PraisonAI"
[tool.setuptools]
packages = ["praisonai"]
[tool.poetry.dependencies]
python = ">=3.10,<3.13"
rich = ">=13.7"
markdown = ">=3.5"
pyparsing = ">=3.0.0"
praisonaiagents = ">=0.0.161"
python-dotenv = ">=0.19.0"
instructor = ">=1.3.3"
PyYAML = ">=6.0"
mcp = ">=1.6.0"
pyautogen = {version = "==0.2.29", optional = true}
autogen-agentchat = {version = ">=0.4.0", optional = true}
autogen-ext = {version = ">=0.4.0", optional = true}
autogen-core = {version = ">=0.4.0", optional = true}
crewai = {version = ">=0.157.0", optional = true}
praisonai-tools = {version = ">=0.0.22", optional = true}
chainlit = {version = "==2.5.5", optional = true}
gradio = {version = ">=4.26.0", optional = true}
flask = {version = ">=3.0.0", optional = true}
agentops = {version = ">=0.3.12", optional = true}
langchain-google-genai = {version = ">=2.1.0", optional = true}
langchain-anthropic = {version = ">=0.3.0", optional = true}
langchain-openai = {version = ">=0.2.1,<0.3.0", optional = true}
langchain-cohere = {version = ">=0.3.0,<0.4.0", optional = true}
litellm = {version = ">=1.72.6", optional = true}
aiosqlite= {version = ">=0.20.0", optional = true}
greenlet = {version = ">=3.0.3", optional = true}
tavily-python = {version = "==0.5.0", optional=true}
crawl4ai = {version = ">=0.7.0", optional = true}
websockets = {version = ">=12.0", optional = true}
plotly = {version = ">=5.24.0", optional = true}
yfinance = {version = ">=0.2.44", optional = true}
duckduckgo_search = {version = ">=6.3.0", optional = true}
twilio = {version = ">=7.0.0", optional = true}
fastapi = {version = ">=0.95.0", optional = true}
uvicorn = {version = ">=0.20.0", optional = true}
flaml = {version = ">=2.3.1", extras = ["automl"], optional = true}
pyngrok = {version = ">=1.4.0", optional = true}
sqlalchemy = {version = ">=2.0.36", optional = true}
playwright = {version = ">=1.47.0", optional = true}
openai = {version = ">=1.54.0", optional = true}
pydantic = {version = "<=2.10.1", optional = true}
# unsloth = {version = ">=2024.11.7", extras = ["colab-new"], optional = true}
[tool.poetry.group.docs.dependencies]
mkdocs = "*"
markdown-include = "*"
mkdocs-material = "*"
mkdocs-jupyter = "*"
mkdocs-glightbox = "*"
pymdown-extensions = "*"
Pygments = "*"
mkdocstrings = "*"
mkdocs-apidoc = "*"
mkdocstrings-python = "*"
pdoc3 = "*"
[tool.poetry.group.test.dependencies]
pytest = "8.2.2"
pytest-asyncio = ">=0.26.0"
pre-commit = "3.7.1"
unittest-xml-reporting = "3.2.0"
xmlrunner = "*"
unittest2 = "*"
[tool.poetry.group.dev.dependencies]
pytest = "8.2.2"
pytest-asyncio = ">=0.26.0"
pre-commit = "3.7.1"
unittest-xml-reporting = "3.2.0"
mkdocs = "*"
markdown-include = "*"
mkdocs-material = "*"
mkdocs-jupyter = "*"
mkdocs-glightbox = "*"
pymdown-extensions = "*"
Pygments = "*"
mkdocstrings = "*"
mkdocs-apidoc = "*"
mkdocstrings-python = "*"
pdoc3 = "*"
xmlrunner = "*"
unittest2 = "*"
chainlit = "==2.5.5"
gradio = ">=4.26.0"
flask = ">=3.0.0"
agentops = ">=0.3.12"
langchain-google-genai = ">=2.1.0"
langchain-anthropic = ">=0.3.0"
langchain-openai = ">=0.2.1,<0.3.0"
langchain-cohere = ">=0.3.0,<0.4.0"
litellm = ">=1.72.6"
aiosqlite = ">=0.20.0"
greenlet = ">=3.0.3"
[build-system]
requires = [
"poetry-core",
"setuptools>=42",
]
build-backend = "poetry.core.masonry.api"
requires = ["setuptools>=64"]
build-backend = "setuptools.build_meta"
[tool.setuptools.dynamic]
version = {attr = "praisonai.version.__version__"}
[tool.poetry.scripts]
praisonai = "praisonai.__main__:main"
setup-conda-env = "setup.setup_conda_env:main"
praisonai-call = "praisonai.api.call:main"
[tool.poetry.extras]
ui = [
"chainlit",
"aiosqlite",
"greenlet",
"sqlalchemy",
"pydantic"
]
gradio = ["gradio"]
api = ["flask"]
agentops = ["agentops"]
google = ["langchain-google-genai"]
openai = ["langchain-openai"]
anthropic = ["langchain-anthropic"]
cohere = ["langchain-cohere"]
chat = [
"chainlit",
"litellm",
"aiosqlite",
"greenlet",
"tavily-python",
"crawl4ai",
"sqlalchemy",
"playwright",
"rich",
"pydantic"
]
code = [
"chainlit",
"litellm",
"aiosqlite",
"greenlet",
"tavily-python",
"crawl4ai",
"sqlalchemy",
"playwright",
"pydantic"
]
train = []
realtime = [
"chainlit",
"litellm",
"aiosqlite",
"greenlet",
"tavily-python",
"crawl4ai",
"websockets",
"plotly",
"yfinance",
"duckduckgo_search",
"sqlalchemy"
]
call = [
"twilio",
"fastapi",
"uvicorn",
"websockets",
"flaml",
"pyngrok",
"rich",
"openai",
]
crewai = ["crewai", "praisonai-tools"]
autogen = ["pyautogen", "praisonai-tools", "crewai"]
autogen-v4 = ["autogen-agentchat", "autogen-ext", "autogen-core", "praisonai-tools", "crewai"]
[tool.poetry-dynamic-versioning]
enable = true
vcs = "git"
style = "semver"
[tool.poetry.build]
generate-setup-file = false
script = "praisonai/setup/post_install.py"
[tool.setuptools.packages.find]
where = ["."]
include = ["praisonai*"]
+222
View File
@@ -0,0 +1,222 @@
#!/usr/bin/env python3
"""
Combined bump version and release script for PraisonAI package.
Usage:
python src/praisonai/scripts/bump_and_release.py 2.2.99
Or with optional praisonaiagents version:
python src/praisonai/scripts/bump_and_release.py 2.2.99 --agents 0.0.169
This script:
1. Bumps version in all required files
2. Copies root README.md to package dir
3. Runs uv lock & uv build
4. Commits changes
5. Creates git tag
6. Pushes to GitHub
7. Creates GitHub release (latest)
"""
import re
import sys
import argparse
import subprocess
import shutil
from pathlib import Path
def get_project_root() -> Path:
"""Get the project root directory (praisonai-package)."""
return Path(__file__).parent.parent.parent.parent
def get_praisonai_dir() -> Path:
"""Get the praisonai package directory."""
return get_project_root() / "src/praisonai"
def run(cmd: list[str], cwd: Path | None = None, check: bool = True) -> subprocess.CompletedProcess:
"""Run a command and print it."""
print(f"$ {' '.join(cmd)}")
result = subprocess.run(cmd, cwd=cwd, capture_output=True, text=True)
if result.stdout:
print(result.stdout)
if result.stderr:
print(result.stderr, file=sys.stderr)
if check and result.returncode != 0:
print(f"❌ Command failed with exit code {result.returncode}")
sys.exit(1)
return result
def update_file(filepath: Path, patterns: list[tuple[str, str]], root: Path) -> bool:
"""Update a file with the given regex patterns and replacements."""
if not filepath.exists():
print(f" ⚠️ File not found: {filepath}")
return False
content = filepath.read_text()
original = content
for pattern, replacement in patterns:
content = re.sub(pattern, replacement, content)
if content != original:
filepath.write_text(content)
print(f" ✅ Updated: {filepath.relative_to(root)}")
return True
else:
print(f" ⏭️ No changes: {filepath.relative_to(root)}")
return False
def bump_version(new_version: str, agents_version: str | None = None):
"""Bump version in all required files."""
root = get_project_root()
praisonai_dir = get_praisonai_dir()
print(f"\n🚀 Bumping PraisonAI version to {new_version}\n")
# 1. Update version.py (single source of truth)
print("📦 Python Package:")
update_file(
praisonai_dir / "praisonai/version.py",
[(r'__version__ = "[^"]+"', f'__version__ = "{new_version}"')],
root
)
# 2. Update deploy.py (Dockerfile template)
print("\n🐳 Deploy Script:")
update_file(
praisonai_dir / "praisonai/deploy.py",
[(r'praisonai==[0-9.]+', f'praisonai=={new_version}')],
root
)
# 3. Update Dockerfiles
print("\n🐳 Dockerfiles:")
dockerfiles = [
"docker/Dockerfile",
"docker/Dockerfile.chat",
"docker/Dockerfile.dev",
"docker/Dockerfile.ui",
]
for dockerfile in dockerfiles:
update_file(
root / dockerfile,
[(r'"praisonai>=[0-9.]+"', f'"praisonai>={new_version}"')],
root
)
# 4. Update Homebrew formula
print("\n🍺 Homebrew Formula:")
update_file(
praisonai_dir / "praisonai.rb",
[(r'v[0-9]+\.[0-9]+\.[0-9]+', f'v{new_version}')],
root
)
# 5. Update praisonaiagents dependency if specified
if agents_version:
print(f"\n📦 Updating praisonaiagents dependency to {agents_version}:")
update_file(
praisonai_dir / "pyproject.toml",
[(r'praisonaiagents>=[0-9.]+', f'praisonaiagents>={agents_version}')],
root
)
print("\n✨ Version bump complete!")
def release(version: str):
"""Run the release process."""
root = get_project_root()
praisonai_dir = get_praisonai_dir()
tag = f"v{version}"
print(f"\n🚀 Releasing PraisonAI {tag}\n")
# 1. Copy root README.md to package dir for PyPI
print("📄 Copying README.md...")
root_readme = root / "README.md"
pkg_readme = praisonai_dir / "README.md"
if root_readme.exists():
shutil.copy(root_readme, pkg_readme)
print(f" ✅ Copied {root_readme} -> {pkg_readme}")
# 2. Clear uv cache and run uv lock
print("\n🧹 Clearing uv cache...")
run(["uv", "cache", "clean"], cwd=praisonai_dir)
print("\n📦 Running uv lock...")
run(["uv", "lock"], cwd=praisonai_dir)
# 3. uv build
print("\n🔨 Running uv build...")
run(["uv", "build"], cwd=praisonai_dir)
# 4. Git add and commit
print("\n📝 Committing changes...")
run(["git", "add", "-A"], cwd=root)
run(["git", "commit", "-m", f"Release {tag}"], cwd=root, check=False)
# 5. Create git tag
print(f"\n🏷️ Creating tag {tag}...")
run(["git", "tag", "-f", tag], cwd=root)
# 6. Push to GitHub
print("\n⬆️ Pushing to GitHub...")
run(["git", "push"], cwd=root)
run(["git", "push", "--tags", "-f"], cwd=root)
# 7. Create GitHub release
print(f"\n🎉 Creating GitHub release {tag}...")
run([
"gh", "release", "create", tag,
"--title", f"PraisonAI {tag}",
"--notes", f"Release {tag}",
"--latest"
], cwd=root)
print(f"\n✅ Released PraisonAI {tag}")
print("\nNext step:")
print(" cd src/praisonai && uv publish")
def main():
parser = argparse.ArgumentParser(
description="Bump version and release PraisonAI package"
)
parser.add_argument(
"version",
help="New version number (e.g., 2.2.99)"
)
parser.add_argument(
"--agents", "-a",
help="Optional: Update praisonaiagents dependency version (e.g., 0.0.169)",
default=None
)
args = parser.parse_args()
# Validate version format
if not re.match(r'^\d+\.\d+\.\d+$', args.version):
print(f"❌ Invalid version format: {args.version}")
print(" Expected format: X.Y.Z (e.g., 2.2.99)")
sys.exit(1)
if args.agents and not re.match(r'^\d+\.\d+\.\d+$', args.agents):
print(f"❌ Invalid agents version format: {args.agents}")
print(" Expected format: X.Y.Z (e.g., 0.0.169)")
sys.exit(1)
# Run bump version
bump_version(args.version, args.agents)
# Run release
release(args.version)
if __name__ == "__main__":
main()
+142
View File
@@ -0,0 +1,142 @@
#!/usr/bin/env python3
"""
Version bump script for PraisonAI package.
This script updates the version number in all required locations:
- praisonai/version.py (single source of truth for Python package)
- praisonai/deploy.py (Dockerfile template)
- ../../docker/Dockerfile, Dockerfile.chat, Dockerfile.dev, Dockerfile.ui
- praisonai.rb (Homebrew formula)
Usage:
python src/praisonai/scripts/bump_version.py 2.2.96
Or with optional praisonaiagents version:
python src/praisonai/scripts/bump_version.py 2.2.96 --agents 0.0.167
"""
import re
import sys
import argparse
from pathlib import Path
def get_project_root() -> Path:
"""Get the project root directory (praisonai-package)."""
# scripts/ -> src/praisonai/ -> src/ -> praisonai-package/
return Path(__file__).parent.parent.parent.parent
def update_file(filepath: Path, patterns: list[tuple[str, str]]) -> bool:
"""Update a file with the given regex patterns and replacements."""
if not filepath.exists():
print(f" ⚠️ File not found: {filepath}")
return False
content = filepath.read_text()
original = content
for pattern, replacement in patterns:
content = re.sub(pattern, replacement, content)
if content != original:
filepath.write_text(content)
print(f" ✅ Updated: {filepath.relative_to(get_project_root())}")
return True
else:
print(f" ⏭️ No changes: {filepath.relative_to(get_project_root())}")
return False
def bump_version(new_version: str, agents_version: str | None = None):
"""Bump version in all required files."""
root = get_project_root()
print(f"\n🚀 Bumping PraisonAI version to {new_version}\n")
praisonai_dir = root / "src/praisonai"
# 1. Update version.py (single source of truth)
print("📦 Python Package:")
update_file(
praisonai_dir / "praisonai/version.py",
[(r'__version__ = "[^"]+"', f'__version__ = "{new_version}"')]
)
# 2. Update deploy.py (Dockerfile template)
print("\n🐳 Deploy Script:")
update_file(
praisonai_dir / "praisonai/deploy.py",
[(r'praisonai==[0-9.]+', f'praisonai=={new_version}')]
)
# 3. Update Dockerfiles
print("\n🐳 Dockerfiles:")
dockerfiles = [
"docker/Dockerfile",
"docker/Dockerfile.chat",
"docker/Dockerfile.dev",
"docker/Dockerfile.ui",
]
for dockerfile in dockerfiles:
update_file(
root / dockerfile,
[(r'"praisonai>=[0-9.]+"', f'"praisonai>={new_version}"')]
)
# 4. Update Homebrew formula
print("\n🍺 Homebrew Formula:")
update_file(
praisonai_dir / "praisonai.rb",
[(r'v[0-9]+\.[0-9]+\.[0-9]+', f'v{new_version}')]
)
# 5. Update praisonaiagents dependency if specified
if agents_version:
print(f"\n📦 Updating praisonaiagents dependency to {agents_version}:")
update_file(
praisonai_dir / "pyproject.toml",
[(r'praisonaiagents>=[0-9.]+', f'praisonaiagents>={agents_version}')]
)
print("\n✨ Version bump complete!")
print("\nNext steps:")
print(" 1. Run: cd src/praisonai && uv lock")
print(" 2. Run: cd src/praisonai && uv build")
print(f" 3. Commit changes: git add -A && git commit -m 'Bump version to {new_version}'")
print(f" 4. Tag release: git tag v{new_version}")
print(" 5. Publish: cd src/praisonai && uv publish")
def main():
parser = argparse.ArgumentParser(
description="Bump PraisonAI version in all required files"
)
parser.add_argument(
"version",
help="New version number (e.g., 2.2.96)"
)
parser.add_argument(
"--agents", "-a",
help="Optional: Update praisonaiagents dependency version (e.g., 0.0.167)",
default=None
)
args = parser.parse_args()
# Validate version format
if not re.match(r'^\d+\.\d+\.\d+$', args.version):
print(f"❌ Invalid version format: {args.version}")
print(" Expected format: X.Y.Z (e.g., 2.2.96)")
sys.exit(1)
if args.agents and not re.match(r'^\d+\.\d+\.\d+$', args.agents):
print(f"❌ Invalid agents version format: {args.agents}")
print(" Expected format: X.Y.Z (e.g., 0.0.167)")
sys.exit(1)
bump_version(args.version, args.agents)
if __name__ == "__main__":
main()
+114
View File
@@ -0,0 +1,114 @@
#!/usr/bin/env python3
"""
Release script for PraisonAI package.
Usage:
python src/praisonai/scripts/release.py
This script:
1. Reads version from praisonai/version.py
2. Runs uv lock
3. Runs uv build
4. Commits changes
5. Creates git tag
6. Pushes to GitHub
7. Creates GitHub release (latest)
"""
import subprocess
import sys
from pathlib import Path
def get_project_root() -> Path:
"""Get the project root directory (praisonai-package)."""
return Path(__file__).parent.parent.parent.parent
def get_praisonai_dir() -> Path:
"""Get the praisonai package directory."""
return get_project_root() / "src/praisonai"
def get_version() -> str:
"""Read version from version.py."""
version_file = get_praisonai_dir() / "praisonai/version.py"
content = version_file.read_text()
for line in content.splitlines():
if line.startswith("__version__"):
return line.split('"')[1]
raise ValueError("Could not find version in version.py")
def run(cmd: list[str], cwd: Path | None = None, check: bool = True) -> subprocess.CompletedProcess:
"""Run a command and print it."""
print(f"$ {' '.join(cmd)}")
result = subprocess.run(cmd, cwd=cwd, capture_output=True, text=True)
if result.stdout:
print(result.stdout)
if result.stderr:
print(result.stderr, file=sys.stderr)
if check and result.returncode != 0:
print(f"❌ Command failed with exit code {result.returncode}")
sys.exit(1)
return result
def main():
root = get_project_root()
praisonai_dir = get_praisonai_dir()
version = get_version()
tag = f"v{version}"
print(f"\n🚀 Releasing PraisonAI {tag}\n")
# 1. Copy root README.md to package dir for PyPI
print("📄 Copying README.md...")
root_readme = root / "README.md"
pkg_readme = praisonai_dir / "README.md"
if root_readme.exists():
import shutil
shutil.copy(root_readme, pkg_readme)
print(f" ✅ Copied {root_readme} -> {pkg_readme}")
# 2. Clear uv cache and run uv lock
print("\n🧹 Clearing uv cache...")
run(["uv", "cache", "clean"], cwd=praisonai_dir)
print("\n📦 Running uv lock...")
run(["uv", "lock"], cwd=praisonai_dir)
# 3. uv build
print("\n🔨 Running uv build...")
run(["uv", "build"], cwd=praisonai_dir)
# 3. Git add and commit
print("\n📝 Committing changes...")
run(["git", "add", "-A"], cwd=root)
run(["git", "commit", "-m", f"Release {tag}"], cwd=root, check=False)
# 4. Create git tag
print(f"\n🏷️ Creating tag {tag}...")
run(["git", "tag", "-f", tag], cwd=root)
# 5. Push to GitHub
print("\n⬆️ Pushing to GitHub...")
run(["git", "push"], cwd=root)
run(["git", "push", "--tags", "-f"], cwd=root)
# 6. Create GitHub release
print(f"\n🎉 Creating GitHub release {tag}...")
run([
"gh", "release", "create", tag,
"--title", f"PraisonAI {tag}",
"--notes", f"Release {tag}",
"--latest"
], cwd=root)
print(f"\n✅ Released PraisonAI {tag}")
print("\nNext step:")
print(" cd src/praisonai && uv publish")
if __name__ == "__main__":
main()
@@ -75,7 +75,8 @@ roles:
def test_autogen_environment_check(self):
"""Verify AutoGen environment is properly configured"""
# Check API key is available
assert os.getenv("OPENAI_API_KEY"), "OPENAI_API_KEY required for real tests"
if not os.getenv("OPENAI_API_KEY"):
pytest.skip("OPENAI_API_KEY required for real tests")
# Check AutoGen can be imported
try:
@@ -72,10 +72,10 @@ roles:
except Exception as e:
pytest.fail(f"CrewAI real test failed: {e}")
@pytest.mark.skipif(not os.getenv("OPENAI_API_KEY"), reason="OPENAI_API_KEY not set")
def test_crewai_environment_check(self):
"""Verify CrewAI environment is properly configured"""
# Check API key is available
assert os.getenv("OPENAI_API_KEY"), "OPENAI_API_KEY required for real tests"
# Check API key is available (already checked by skipif)
# Check CrewAI can be imported
try:
+5 -2
View File
@@ -59,8 +59,11 @@ class TestPraisonAICommandLine(unittest.TestCase):
# In CI, it should be set by the workflow
print("Warning: OPENAI_API_KEY not found in CLI test environment. API calls might fail if not mocked.")
result = subprocess.run(command, shell=True, capture_output=True, text=True, env=env)
return result.stdout + result.stderr
try:
result = subprocess.run(command, shell=True, capture_output=True, text=True, env=env, timeout=120)
return result.stdout + result.stderr
except subprocess.TimeoutExpired:
return "TIMEOUT: Command exceeded 120 seconds"
@pytest.mark.real
def test_praisonai_command(self):
@@ -0,0 +1,275 @@
"""
Tests for QueryRewriterAgent CLI integration
Run with: python -m pytest tests/unit/test_query_rewriter_cli.py -v
"""
import pytest
from unittest.mock import patch, MagicMock
import argparse
class TestQueryRewriterCLIArgs:
"""Test CLI argument parsing for query rewriter."""
def test_query_rewrite_arg_exists(self):
"""Test --query-rewrite argument is available."""
from praisonai.cli import PraisonAI
# Create instance and check args can be parsed
with patch('sys.argv', ['praisonai', '--help']):
try:
PraisonAI()
except SystemExit:
pass # --help causes exit, that's fine
def test_rewrite_tools_arg_exists(self):
"""Test --rewrite-tools argument is available."""
from praisonai.cli import PraisonAI
with patch('sys.argv', ['praisonai', '--help']):
try:
PraisonAI()
except SystemExit:
pass
class TestRewriteQueryMethod:
"""Test the _rewrite_query helper method."""
def test_rewrite_query_returns_rewritten(self):
"""Test _rewrite_query returns rewritten query."""
from praisonai.cli import PraisonAI
# Setup mock
mock_result = MagicMock()
mock_result.primary_query = "What are the current trends in artificial intelligence?"
mock_agent = MagicMock()
mock_agent.rewrite.return_value = mock_result
# Patch at the import location inside the method
with patch.dict('sys.modules', {'praisonaiagents': MagicMock()}):
import sys
sys.modules['praisonaiagents'].QueryRewriterAgent = MagicMock(return_value=mock_agent)
sys.modules['praisonaiagents'].RewriteStrategy = MagicMock()
praison = PraisonAI()
result = praison._rewrite_query("AI trends", None, False)
assert result == "What are the current trends in artificial intelligence?"
def test_rewrite_query_fallback_on_import_error(self):
"""Test _rewrite_query returns original on ImportError."""
from praisonai.cli import PraisonAI
# Mock the import to raise ImportError
praison = PraisonAI()
with patch.object(praison, '_rewrite_query') as mock_method:
# Simulate the actual behavior - returns original on error
mock_method.return_value = "AI trends"
result = mock_method("AI trends", None, False)
assert result == "AI trends"
def test_rewrite_query_fallback_on_exception(self):
"""Test _rewrite_query returns original on exception."""
from praisonai.cli import PraisonAI
# Patch to raise exception
with patch.dict('sys.modules', {'praisonaiagents': MagicMock()}):
import sys
sys.modules['praisonaiagents'].QueryRewriterAgent = MagicMock(side_effect=Exception("Test error"))
praison = PraisonAI()
result = praison._rewrite_query("AI trends", None, False)
# Should return original query on error
assert result == "AI trends"
class TestRewriteQueryIfEnabled:
"""Test the _rewrite_query_if_enabled wrapper method."""
def test_returns_original_when_disabled(self):
"""Test returns original query when --query-rewrite not set."""
from praisonai.cli import PraisonAI
praison = PraisonAI()
praison.args = argparse.Namespace(query_rewrite=False)
result = praison._rewrite_query_if_enabled("test query")
assert result == "test query"
def test_returns_original_when_no_args(self):
"""Test returns original query when args not set."""
from praisonai.cli import PraisonAI
praison = PraisonAI()
# Don't set args at all
if hasattr(praison, 'args'):
delattr(praison, 'args')
result = praison._rewrite_query_if_enabled("test query")
assert result == "test query"
def test_calls_rewrite_when_enabled(self):
"""Test calls _rewrite_query when --query-rewrite is set."""
from praisonai.cli import PraisonAI
praison = PraisonAI()
praison.args = argparse.Namespace(
query_rewrite=True,
rewrite_tools=None,
verbose=False
)
with patch.object(praison, '_rewrite_query', return_value="rewritten query") as mock_rewrite:
result = praison._rewrite_query_if_enabled("original query")
mock_rewrite.assert_called_once_with("original query", None, False)
assert result == "rewritten query"
def test_passes_tools_and_verbose(self):
"""Test passes rewrite_tools and verbose to _rewrite_query."""
from praisonai.cli import PraisonAI
praison = PraisonAI()
praison.args = argparse.Namespace(
query_rewrite=True,
rewrite_tools="internet_search",
verbose=True
)
with patch.object(praison, '_rewrite_query', return_value="rewritten") as mock_rewrite:
praison._rewrite_query_if_enabled("query")
mock_rewrite.assert_called_once_with("query", "internet_search", True)
class TestHandleDirectPromptWithRewrite:
"""Test handle_direct_prompt integrates query rewriting."""
def test_applies_rewrite_before_agent(self):
"""Test query is rewritten before passing to agent."""
from praisonai.cli import PraisonAI
praison = PraisonAI()
praison.args = argparse.Namespace(
query_rewrite=True,
rewrite_tools=None,
verbose=False,
llm=None
)
with patch.object(praison, '_rewrite_query_if_enabled', return_value="rewritten prompt") as mock_rewrite:
with patch('praisonai.cli.PRAISONAI_AVAILABLE', True):
with patch('praisonai.cli.PraisonAgent') as mock_agent_class:
mock_agent = MagicMock()
mock_agent.start.return_value = "result"
mock_agent_class.return_value = mock_agent
praison.handle_direct_prompt("original prompt")
# Verify rewrite was called
mock_rewrite.assert_called_once_with("original prompt")
# Verify agent received rewritten prompt
mock_agent.start.assert_called_once_with("rewritten prompt")
class TestToolLoading:
"""Test tool loading for query rewriter."""
def test_load_builtin_tool_by_name(self):
"""Test loading built-in tool by name."""
from praisonai.cli import PraisonAI
# Setup mocks
mock_result = MagicMock()
mock_result.primary_query = "rewritten"
mock_agent = MagicMock()
mock_agent.rewrite.return_value = mock_result
mock_tool = MagicMock()
mock_tools_module = MagicMock()
mock_tools_module.TOOL_MAPPINGS = {'internet_search': 'praisonaiagents.tools'}
mock_tools_module.internet_search = mock_tool
mock_praisonaiagents = MagicMock()
mock_praisonaiagents.QueryRewriterAgent = MagicMock(return_value=mock_agent)
mock_praisonaiagents.RewriteStrategy = MagicMock()
mock_praisonaiagents.tools = mock_tools_module
with patch.dict('sys.modules', {
'praisonaiagents': mock_praisonaiagents,
'praisonaiagents.tools': mock_tools_module
}):
praison = PraisonAI()
result = praison._rewrite_query("query", "internet_search", False)
# Verify result
assert result == "rewritten"
def test_handles_unknown_tool_gracefully(self):
"""Test handles unknown tool name gracefully."""
from praisonai.cli import PraisonAI
# Setup mocks
mock_result = MagicMock()
mock_result.primary_query = "rewritten"
mock_agent = MagicMock()
mock_agent.rewrite.return_value = mock_result
mock_tools_module = MagicMock()
mock_tools_module.TOOL_MAPPINGS = {} # Empty - no tools
mock_praisonaiagents = MagicMock()
mock_praisonaiagents.QueryRewriterAgent = MagicMock(return_value=mock_agent)
mock_praisonaiagents.RewriteStrategy = MagicMock()
mock_praisonaiagents.tools = mock_tools_module
with patch.dict('sys.modules', {
'praisonaiagents': mock_praisonaiagents,
'praisonaiagents.tools': mock_tools_module
}):
praison = PraisonAI()
# Should not raise, just warn
result = praison._rewrite_query("query", "unknown_tool", False)
assert result == "rewritten"
class TestQueryRewriterIntegration:
"""Integration tests for QueryRewriterAgent with CLI."""
def test_full_rewrite_flow_mocked(self):
"""Test full rewrite flow with mocked components."""
from praisonai.cli import PraisonAI
# Setup mocks
mock_result = MagicMock()
mock_result.primary_query = "What are the latest developments in AI technology?"
mock_agent = MagicMock()
mock_agent.rewrite.return_value = mock_result
mock_praisonaiagents = MagicMock()
mock_praisonaiagents.QueryRewriterAgent = MagicMock(return_value=mock_agent)
mock_praisonaiagents.RewriteStrategy = MagicMock()
with patch.dict('sys.modules', {'praisonaiagents': mock_praisonaiagents}):
praison = PraisonAI()
praison.args = argparse.Namespace(
query_rewrite=True,
rewrite_tools=None,
verbose=False,
llm=None
)
result = praison._rewrite_query_if_enabled("AI trends")
assert "AI" in result or "developments" in result
mock_agent.rewrite.assert_called_once()
if __name__ == "__main__":
pytest.main([__file__, "-v"])
+5 -6
View File
@@ -1,5 +1,5 @@
version = 1
revision = 2
revision = 3
requires-python = ">=3.10"
resolution-markers = [
"python_full_version >= '3.13'",
@@ -4044,7 +4044,6 @@ wheels = [
[[package]]
name = "praisonai"
version = "2.2.88"
source = { editable = "." }
dependencies = [
{ name = "instructor" },
@@ -4198,7 +4197,7 @@ requires-dist = [
{ name = "praisonai-tools", marker = "extra == 'autogen'", specifier = ">=0.0.22" },
{ name = "praisonai-tools", marker = "extra == 'autogen-v4'", specifier = ">=0.0.22" },
{ name = "praisonai-tools", marker = "extra == 'crewai'", specifier = ">=0.0.22" },
{ name = "praisonaiagents", specifier = ">=0.0.161" },
{ name = "praisonaiagents", specifier = ">=0.0.178" },
{ name = "pyautogen", marker = "extra == 'autogen'", specifier = "==0.2.29" },
{ name = "pydantic", marker = "extra == 'chat'", specifier = "<=2.10.1" },
{ name = "pydantic", marker = "extra == 'code'", specifier = "<=2.10.1" },
@@ -4253,7 +4252,7 @@ wheels = [
[[package]]
name = "praisonaiagents"
version = "0.0.161"
version = "0.0.178"
source = { registry = "https://pypi.org/simple" }
dependencies = [
{ name = "aiohttp" },
@@ -4262,9 +4261,9 @@ dependencies = [
{ name = "pydantic" },
{ name = "rich" },
]
sdist = { url = "https://files.pythonhosted.org/packages/f2/a5/97bd65cf513070b647ada80c39610fd4c86c80f70404bb0972e100c2a4f2/praisonaiagents-0.0.161.tar.gz", hash = "sha256:88b6c28f1fa9d0f0f802d5a916471606c351d3359800982eb49f38e89dbff363", size = 285757, upload-time = "2025-08-08T12:43:46.337Z" }
sdist = { url = "https://files.pythonhosted.org/packages/db/40/9c7355184b107ab09db83525b6ac8633b27c2cd12104902c7f95cdef6e61/praisonaiagents-0.0.178.tar.gz", hash = "sha256:9427be0e26c08f9a6c5e356e52991ee43a531a8088bd45ecb0a27f4e4b602eaa", size = 352905, upload-time = "2025-12-15T14:52:03.258Z" }
wheels = [
{ url = "https://files.pythonhosted.org/packages/41/28/fd9df18c45f461afef17c69587b1502901dc1b3331056b79685f9b932017/praisonaiagents-0.0.161-py3-none-any.whl", hash = "sha256:a2db2a52a6684d0b0d935b664741d1594020cba41a6f212abbadc654a999af33", size = 305084, upload-time = "2025-08-08T12:43:44.86Z" },
{ url = "https://files.pythonhosted.org/packages/5b/4f/46b7030a57852127a0f185b0b2a9340df277d3396dff7ad86f2f8e580122/praisonaiagents-0.0.178-py3-none-any.whl", hash = "sha256:91a032a0da8574662269b7266c41667ae905434388f1e9bc74265f18df5596a7", size = 354385, upload-time = "2025-12-15T14:52:01.915Z" },
]
[[package]]