PraisonAI 2.0.12__cp311-cp311-macosx_15_0_arm64.whl → 2.0.53__cp311-cp311-macosx_15_0_arm64.whl

praisonai/ui/realtime.py

@@ -186,11 +186,42 @@ try:
     if custom_tools_module:
         # Update the tools list with custom tools
         if hasattr(custom_tools_module, 'tools') and isinstance(custom_tools_module.tools, list):
-            tools.extend(custom_tools_module.tools)
+            # Only add tools that have proper function definitions
+            for tool in custom_tools_module.tools:
+                if isinstance(tool, tuple) and len(tool) == 2:
+                    tool_def, handler = tool
+                    if isinstance(tool_def, dict) and "type" in tool_def and tool_def["type"] == "function":
+                        # Convert class/function to proper tool definition
+                        if "function" in tool_def:
+                            func = tool_def["function"]
+                            if hasattr(func, "__name__"):
+                                tool_def = {
+                                    "name": func.__name__,
+                                    "description": func.__doc__ or f"Execute {func.__name__}",
+                                    "parameters": {
+                                        "type": "object",
+                                        "properties": {},
+                                        "required": []
+                                    }
+                                }
+                                tools.append((tool_def, handler))
+                    else:
+                        # Tool definition is already properly formatted
+                        tools.append(tool)
         else:
+            # Process individual functions/classes
             for name, obj in custom_tools_module.__dict__.items():
                 if callable(obj) and not name.startswith("__"):
-                    tools.append(({"type": "function", "function": obj}, obj))
+                    tool_def = {
+                        "name": name,
+                        "description": obj.__doc__ or f"Execute {name}",
+                        "parameters": {
+                            "type": "object",
+                            "properties": {},
+                            "required": []
+                        }
+                    }
+                    tools.append((tool_def, obj))
 
 except Exception as e:
     logger.warning(f"Error importing custom tools: {str(e)}. Continuing without custom tools.")
@@ -198,7 +229,7 @@ except Exception as e:
 @cl.on_chat_start
 async def start():
     initialize_db()
-    model_name = load_setting("model_name") or os.getenv("MODEL_NAME", "gpt-4o-mini")
+    model_name = load_setting("model_name") or os.getenv("MODEL_NAME", "gpt-4o-mini-realtime-preview")
     cl.user_session.set("model_name", model_name)
     cl.user_session.set("message_history", [])  # Initialize message history
     logger.debug(f"Model name: {model_name}")
@@ -207,7 +238,7 @@ async def start():
     #         TextInput(
     #             id="model_name",
     #             label="Enter the Model Name",
-    #             placeholder="e.g., gpt-4o-mini",
+    #             placeholder="e.g., gpt-4o-mini-realtime-preview",
     #             initial=model_name
     #         )
     #     ]
@@ -287,14 +318,30 @@ async def setup_openai_realtime():
         logger.error(event)
         await cl.Message(content=f"Error: {event}", author="System").send()
 
+    # Register event handlers
     openai_realtime.on('conversation.updated', handle_conversation_updated)
     openai_realtime.on('conversation.item.completed', handle_item_completed)
     openai_realtime.on('conversation.interrupted', handle_conversation_interrupt)
     openai_realtime.on('error', handle_error)
 
     cl.user_session.set("openai_realtime", openai_realtime)
-    coros = [openai_realtime.add_tool(tool_def, tool_handler) for tool_def, tool_handler in tools]
-    await asyncio.gather(*coros)
+    
+    # Filter out invalid tools and add valid ones
+    valid_tools = []
+    for tool_def, tool_handler in tools:
+        try:
+            if isinstance(tool_def, dict) and "name" in tool_def:
+                valid_tools.append((tool_def, tool_handler))
+            else:
+                logger.warning(f"Skipping invalid tool definition: {tool_def}")
+        except Exception as e:
+            logger.warning(f"Error processing tool: {e}")
+    
+    if valid_tools:
+        coros = [openai_realtime.add_tool(tool_def, tool_handler) for tool_def, tool_handler in valid_tools]
+        await asyncio.gather(*coros)
+    else:
+        logger.warning("No valid tools found to add")
 
 @cl.on_settings_update
 async def setup_agent(settings):
@@ -330,11 +377,19 @@ async def setup_agent(settings):
 async def on_audio_start():
     try:
         openai_realtime: RealtimeClient = cl.user_session.get("openai_realtime")
-        await openai_realtime.connect()
+        if not openai_realtime:
+            await setup_openai_realtime()
+            openai_realtime = cl.user_session.get("openai_realtime")
+        
+        if not openai_realtime.is_connected():
+            await openai_realtime.connect()
+            
         logger.info("Connected to OpenAI realtime")
         return True
     except Exception as e:
-        await cl.ErrorMessage(content=f"Failed to connect to OpenAI realtime: {e}").send()
+        error_msg = f"Failed to connect to OpenAI realtime: {str(e)}"
+        logger.error(error_msg)
+        await cl.ErrorMessage(content=error_msg).send()
         return False
 
 @cl.on_audio_chunk
@@ -368,14 +423,14 @@ def auth_callback(username: str, password: str):
 @cl.on_chat_resume
 async def on_chat_resume(thread: ThreadDict):
     logger.info(f"Resuming chat: {thread['id']}")
-    model_name = load_setting("model_name") or os.getenv("MODEL_NAME") or "gpt-4o-mini"
+    model_name = load_setting("model_name") or os.getenv("MODEL_NAME") or "gpt-4o-mini-realtime-preview"
     logger.debug(f"Model name: {model_name}")
     settings = cl.ChatSettings(
         [
             TextInput(
                 id="model_name",
                 label="Enter the Model Name",
-                placeholder="e.g., gpt-4o-mini",
+                placeholder="e.g., gpt-4o-mini-realtime-preview",
                 initial=model_name
             )
         ]

praisonai/ui/sql_alchemy.py

@@ -9,7 +9,8 @@ import os
 import aiofiles
 import aiohttp
 
-from chainlit.data.base import BaseDataLayer, BaseStorageClient
+from chainlit.data.base import BaseDataLayer
+from chainlit.data.storage_clients.base import EXPIRY_TIME, BaseStorageClient
 from chainlit.data.utils import queue_until_user_message
 from chainlit.element import ElementDict
 from chainlit.logger import logger

praisonai/ui/tools.md

@@ -0,0 +1,133 @@
+# Understanding Tool Integration in AI Agents - A Beginner's Guide
+
+## Overview
+This guide explains how to properly integrate tools (functions) that an AI agent can use, making them both understandable to the OpenAI API and executable by your code.
+
+## Key Components
+
+### 1. Tool Definition Structure
+```python
+# Example tool definition in tools.py
+def search_tool(query: str) -> list:
+    """
+    Perform a web search using DuckDuckGo.
+
+    Args:
+        query (str): The search query string.
+
+    Returns:
+        list: Search results with title, url, and snippet.
+    """
+    # Function implementation...
+```
+
+### 2. Tool Dictionary Format
+```python
+tools_dict = {
+    'search_tool': {
+        'type': 'function',
+        'function': {
+            'name': 'search_tool',
+            'description': '...', 
+            'parameters': {
+                'type': 'object',
+                'properties': {
+                    'query': {'type': 'string'}
+                }
+            }
+        },
+        'callable': search_tool  # The actual Python function
+    }
+}
+```
+
+## The Two-Part System
+
+### Part 1: OpenAI API Communication
+```python
+# task_tools: What OpenAI understands
+task_tools = []
+tool_def = tools_dict[tool_name].copy()
+callable_func = tool_def.pop("callable")  # Remove the Python function
+task_tools.append(tool_def)  # Add clean JSON-serializable definition
+```
+
+### Part 2: Function Execution
+```python
+# role_tools: What your code executes
+role_tools = []
+role_tools.append(callable_func)  # Store the actual function
+agent.tools = role_tools  # Give agent access to executable functions
+```
+
+## Putting It All Together
+
+```python
+# Initialize empty lists
+role_tools = []  # For executable functions
+task_tools = []  # For OpenAI API definitions
+
+# Process each tool
+for tool_name in tools_list:
+    if tool_name in tools_dict:
+        # 1. Get the tool definition
+        tool_def = tools_dict[tool_name].copy()
+        
+        # 2. Separate the callable function
+        callable_func = tool_def.pop("callable")
+        
+        # 3. Store the function for execution
+        role_tools.append(callable_func)
+        
+        # 4. Store the API definition
+        task_tools.append(tool_def)
+        
+        # 5. Give agent access to functions
+        agent.tools = role_tools
+
+# Create task with API definitions
+task = Task(
+    description="...",
+    tools=task_tools,  # OpenAI API will use these
+    agent=agent,       # Agent has access to callable functions
+    # ... other parameters ...
+)
+```
+
+## Why This Works
+
+1. **API Communication**
+   - OpenAI API receives clean JSON tool definitions
+   - No Python functions that would cause serialization errors
+
+2. **Function Execution**
+   - Agent has access to actual Python functions
+   - Can execute tools when OpenAI decides to use them
+
+3. **Separation of Concerns**
+   - `task_tools`: Describes what tools can do (for OpenAI)
+   - `role_tools`: Actually does the work (for Python)
+
+## Common Errors and Solutions
+
+1. **"Invalid type for 'tools[0]'"**
+   - Cause: Sending null or invalid tool definition to OpenAI
+   - Solution: Use proper tool definition format in `task_tools`
+
+2. **"Object of type function is not JSON serializable"**
+   - Cause: Trying to send Python function to OpenAI API
+   - Solution: Remove callable function from API definition
+
+3. **"Tool is not callable"**
+   - Cause: Agent doesn't have access to executable functions
+   - Solution: Set `agent.tools = role_tools`
+
+## Best Practices
+
+1. Always initialize both `task_tools` and `role_tools` lists
+2. Make clean copies of tool definitions to avoid modifying originals
+3. Keep tool definitions JSON-serializable for API communication
+4. Ensure agents have access to callable functions
+5. Document tool parameters and return values clearly
+
+This structure maintains clean separation between API communication and actual function execution, making your AI agent system both reliable and maintainable.

{praisonai-2.0.12.dist-info → praisonai-2.0.53.dist-info}/METADATA

@@ -1,7 +1,7 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: PraisonAI
-Version: 2.0.12
-Summary: PraisonAI application combines AutoGen and CrewAI or similar frameworks into a low-code solution for building and managing multi-agent LLM systems, focusing on simplicity, customization, and efficient human-agent collaboration.
+Version: 2.0.53
+Summary: 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.
 Author: Mervin Praison
 Requires-Python: >=3.10,<3.13
 Classifier: Programming Language :: Python :: 3
@@ -21,43 +21,68 @@ Provides-Extra: google
 Provides-Extra: gradio
 Provides-Extra: openai
 Provides-Extra: realtime
-Provides-Extra: train
 Provides-Extra: ui
 Requires-Dist: PyYAML (>=6.0)
 Requires-Dist: agentops (>=0.3.12) ; extra == "agentops"
-Requires-Dist: aiosqlite (>=0.20.0) ; extra == "chat" or extra == "code" or extra == "realtime"
-Requires-Dist: chainlit (==2.0rc1) ; extra == "ui" or extra == "chat" or extra == "code" or extra == "realtime"
-Requires-Dist: crawl4ai (==0.3.4) ; extra == "chat" or extra == "code" or extra == "realtime"
-Requires-Dist: crewai (>=0.32.0) ; extra == "crewai" or extra == "autogen"
+Requires-Dist: aiosqlite (>=0.20.0) ; extra == "chat"
+Requires-Dist: aiosqlite (>=0.20.0) ; extra == "code"
+Requires-Dist: aiosqlite (>=0.20.0) ; extra == "realtime"
+Requires-Dist: aiosqlite (>=0.20.0) ; extra == "ui"
+Requires-Dist: chainlit (==2.0.3) ; extra == "chat"
+Requires-Dist: chainlit (==2.0.3) ; extra == "code"
+Requires-Dist: chainlit (==2.0.3) ; extra == "realtime"
+Requires-Dist: chainlit (==2.0.3) ; extra == "ui"
+Requires-Dist: crawl4ai (==0.3.4) ; extra == "chat"
+Requires-Dist: crawl4ai (==0.3.4) ; extra == "code"
+Requires-Dist: crawl4ai (==0.3.4) ; extra == "realtime"
+Requires-Dist: crewai (>=0.32.0) ; extra == "crewai"
+Requires-Dist: crewai ; extra == "autogen"
 Requires-Dist: duckduckgo_search (>=6.3.0) ; extra == "realtime"
 Requires-Dist: fastapi (>=0.95.0) ; extra == "call"
 Requires-Dist: flaml[automl] (>=2.3.1) ; extra == "call"
 Requires-Dist: flask (>=3.0.0) ; extra == "api"
 Requires-Dist: gradio (>=4.26.0) ; extra == "gradio"
-Requires-Dist: greenlet (>=3.0.3) ; extra == "chat" or extra == "code" or extra == "realtime"
+Requires-Dist: greenlet (>=3.0.3) ; extra == "chat"
+Requires-Dist: greenlet (>=3.0.3) ; extra == "code"
+Requires-Dist: greenlet (>=3.0.3) ; extra == "realtime"
+Requires-Dist: greenlet (>=3.0.3) ; extra == "ui"
 Requires-Dist: instructor (>=1.3.3)
 Requires-Dist: langchain-anthropic (>=0.1.13) ; extra == "anthropic"
 Requires-Dist: langchain-cohere (>=0.1.4) ; extra == "cohere"
 Requires-Dist: langchain-google-genai (>=1.0.4) ; extra == "google"
 Requires-Dist: langchain-openai (>=0.1.7) ; extra == "openai"
-Requires-Dist: litellm (>=1.41.8) ; extra == "chat" or extra == "code" or extra == "realtime"
+Requires-Dist: litellm (>=1.41.8) ; extra == "chat"
+Requires-Dist: litellm (>=1.41.8) ; extra == "code"
+Requires-Dist: litellm (>=1.41.8) ; extra == "realtime"
 Requires-Dist: markdown (>=3.5)
 Requires-Dist: openai (>=1.54.0) ; extra == "call"
-Requires-Dist: playwright (>=1.47.0) ; extra == "chat" or extra == "code"
+Requires-Dist: playwright (>=1.47.0) ; extra == "chat"
+Requires-Dist: playwright (>=1.47.0) ; extra == "code"
 Requires-Dist: plotly (>=5.24.0) ; extra == "realtime"
-Requires-Dist: praisonai-tools (>=0.0.7) ; extra == "crewai" or extra == "autogen"
-Requires-Dist: praisonaiagents (>=0.0.4)
+Requires-Dist: praisonai-tools (>=0.0.7) ; extra == "autogen"
+Requires-Dist: praisonai-tools (>=0.0.7) ; extra == "crewai"
+Requires-Dist: praisonaiagents (>=0.0.44)
 Requires-Dist: pyautogen (>=0.2.19) ; extra == "autogen"
-Requires-Dist: pydantic (<=2.10.1) ; extra == "chat" or extra == "code"
+Requires-Dist: pydantic (<=2.10.1) ; extra == "chat"
+Requires-Dist: pydantic (<=2.10.1) ; extra == "code"
+Requires-Dist: pydantic (<=2.10.1) ; extra == "ui"
 Requires-Dist: pyngrok (>=1.4.0) ; extra == "call"
 Requires-Dist: pyparsing (>=3.0.0)
 Requires-Dist: python-dotenv (>=0.19.0)
-Requires-Dist: rich (>=13.7) ; extra == "chat" or extra == "call"
-Requires-Dist: sqlalchemy (>=2.0.36) ; extra == "chat" or extra == "code" or extra == "realtime"
-Requires-Dist: tavily-python (==0.5.0) ; extra == "chat" or extra == "code" or extra == "realtime"
+Requires-Dist: rich (>=13.7)
+Requires-Dist: rich ; extra == "call"
+Requires-Dist: rich ; extra == "chat"
+Requires-Dist: sqlalchemy (>=2.0.36) ; extra == "chat"
+Requires-Dist: sqlalchemy (>=2.0.36) ; extra == "code"
+Requires-Dist: sqlalchemy (>=2.0.36) ; extra == "realtime"
+Requires-Dist: sqlalchemy (>=2.0.36) ; extra == "ui"
+Requires-Dist: tavily-python (==0.5.0) ; extra == "chat"
+Requires-Dist: tavily-python (==0.5.0) ; extra == "code"
+Requires-Dist: tavily-python (==0.5.0) ; extra == "realtime"
 Requires-Dist: twilio (>=7.0.0) ; extra == "call"
 Requires-Dist: uvicorn (>=0.20.0) ; extra == "call"
-Requires-Dist: websockets (>=12.0) ; extra == "realtime" or extra == "call"
+Requires-Dist: websockets (>=12.0) ; extra == "call"
+Requires-Dist: websockets (>=12.0) ; extra == "realtime"
 Requires-Dist: yfinance (>=0.2.44) ; extra == "realtime"
 Project-URL: Homepage, https://docs.praison.ai
 Project-URL: Repository, https://github.com/mervinpraison/PraisonAI
@@ -85,7 +110,142 @@ Description-Content-Type: text/markdown
 
 </div>
 
-Praison AI, leveraging both AutoGen and CrewAI or any other agent framework, represents a low-code, centralised framework designed to simplify the creation and orchestration of multi-agent systems for various LLM applications, emphasizing ease of use, customization, and human-agent interaction.
+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.
+
+<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
+- 🔄 Use CrewAI or AutoGen Framework
+- 💯 100+ LLM Support
+- 💻 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
+
+## Using No Code
+
+### Auto Mode:
+```bash
+pip install praisonai
+export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx
+praisonai --auto create a movie script about Robots in Mars
+```
+
+### Initialise Mode:
+```bash
+pip install praisonai
+export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx
+praisonai --init create a movie script about Robots in Mars
+praisonai
+```
+
+## Using Coding
+
+Light weight package dedicated for coding:
+```bash
+pip install praisonaiagents
+```
+
+```bash
+export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx
+```
+
+Create app.py file and add the code below:
+```python
+from praisonaiagents import Agent, Task, PraisonAIAgents
+
+# 1. Create agents
+researcher = Agent(
+    name="Researcher",
+    role="Senior Research Analyst",
+    goal="Uncover cutting-edge developments in AI and data science",
+    backstory="""You are an expert at a technology research group, 
+    skilled in identifying trends and analyzing complex data.""",
+    verbose=True,
+    llm="gpt-4o",
+    markdown=True
+)
+writer = Agent(
+    name="Writer",
+    role="Tech Content Strategist",
+    goal="Craft compelling content on tech advancements",
+    backstory="""You are a content strategist known for 
+    making complex tech topics interesting and easy to understand.""",
+    llm="gpt-4o",
+    markdown=True
+)
+
+# 2. Define Tasks
+task1 = Task(
+    name="research_task",
+    description="""Analyze 2024's AI advancements. 
+    Find major trends, new technologies, and their effects.""",
+    expected_output="""A detailed report on 2024 AI advancements""",
+    agent=researcher
+)
+
+task2 = Task(
+    name="writing_task",
+    description="""Create a blog post about major AI advancements using the insights you have.
+    Make it interesting, clear, and suited for tech enthusiasts. 
+    It should be at least 4 paragraphs long.""",
+    expected_output="A blog post of at least 4 paragraphs",
+    agent=writer,
+)
+
+agents = PraisonAIAgents(
+    agents=[researcher, writer],
+    tasks=[task1, task2],
+    verbose=False,
+    process="hierarchical",
+    manager_llm="gpt-4o"
+)
+
+result = agents.start()
+```
+
+Run:
+```bash
+python app.py
+```
+
+## 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
+```
+
+## Logging
+```bash
+export LOGLEVEL=info
+```
+
+Advanced logging:
+```bash
+export LOGLEVEL=debug
+```
 
 <div align="center">
   <picture>
@@ -195,18 +355,7 @@ When installing with `pip install "praisonai[autogen]"`, you get:
 - Multi-agent conversation capabilities
 - Code execution environment
 
-## Key Features
 
-- 🤖 Automated AI Agents Creation
-- 🔄 Use CrewAI or AutoGen Framework
-- 💯 100+ LLM Support
-- 💻 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
 
 ## TL;DR Multi Agents
 
@@ -418,33 +567,7 @@ if __name__ == "__main__":
 
 ## Commands to Install Dependencies:
 
-1. **Install all dependencies, including dev dependencies:**
-
-   ```sh
-   poetry install
-   ```
-
-2. **Install only documentation dependencies:**
-
-   ```sh
-   poetry install --with docs
-   ```
-
-3. **Install only test dependencies:**
-
-   ```sh
-   poetry install --with test
-   ```
-
-4. **Install only dev dependencies:**
-
-   ```sh
-   poetry install --with dev
-   ```
-
-This configuration ensures that your development dependencies are correctly categorized and installed as needed.
-
-### Using uv (Fast Python Package Installer)
+### Using uv
 ```bash
 # Install uv if you haven't already
 pip install uv
@@ -496,3 +619,55 @@ Praison AI is an open-sourced software licensed under the **[MIT license](https:
 
 Praison AI is an open-sourced software licensed under the **[MIT license](https://opensource.org/licenses/MIT)**.
 
+## Local Docker Development with Live Reload
+
+To facilitate local development with live reload, you can use Docker. Follow the steps below:
+
+1. **Create a `Dockerfile.dev`**:
+    ```dockerfile
+    FROM python:3.11-slim
+
+    WORKDIR /app
+
+    COPY . .
+
+    RUN pip install flask praisonai==2.0.18 watchdog
+
+    EXPOSE 5555
+
+    ENV FLASK_ENV=development
+
+    CMD ["flask", "run", "--host=0.0.0.0"]
+    ```
+
+2. **Create a `docker-compose.yml`**:
+    ```yaml
+    version: '3.8'
+
+    services:
+      app:
+        build:
+          context: .
+          dockerfile: Dockerfile.dev
+        volumes:
+          - .:/app
+        ports:
+          - "5555:5555"
+        environment:
+          FLASK_ENV: development
+        command: flask run --host=0.0.0.0
+
+      watch:
+        image: alpine:latest
+        volumes:
+          - .:/app
+        command: sh -c "apk add --no-cache inotify-tools && while inotifywait -r -e modify,create,delete /app; do kill -HUP 1; done"
+    ```
+
+3. **Run Docker Compose**:
+    ```bash
+    docker-compose up
+    ```
+
+This setup will allow you to develop locally with live reload, making it easier to test and iterate on your code.
+