diff --git a/docs/api.md b/docs/api.mdx similarity index 91% rename from docs/api.md rename to docs/api.mdx index 311cf544..d2b636ad 100644 --- a/docs/api.md +++ b/docs/api.mdx @@ -1,4 +1,7 @@ -# API Reference +--- +title: "API Reference" +description: "Complete API reference for PraisonAI, including core modules, installation options, and framework-specific features" +--- ## Core Modules diff --git a/docs/auto.md b/docs/auto.mdx similarity index 63% rename from docs/auto.md rename to docs/auto.mdx index 3c1edf94..2b8df464 100644 --- a/docs/auto.md +++ b/docs/auto.mdx @@ -1,12 +1,18 @@ -# Auto Generation Mode +--- +title: "Auto Generation Mode" +description: "Guide to PraisonAI's automatic agent generation feature, supporting both CrewAI and AutoGen frameworks for automated task execution" +--- -PraisonAI supports automatic agent generation with both CrewAI and AutoGen frameworks. +PraisonAI supports automatic agent generation with PraisonAI Agents, CrewAI and AutoGen frameworks. ## Installation Choose your preferred framework: ```bash +# For PraisonAI Agents +pip install praisonai + # For CrewAI pip install "praisonai[crewai]" @@ -19,11 +25,16 @@ pip install "praisonai[crewai,autogen]" ## Usage -### With CrewAI (Default) +### With PraisonAI Agents ```bash praisonai --auto "create a movie script about Dog in Moon" ``` +### With CrewAI +```bash +praisonai --framework crewai --auto "create a movie script about Dog in Moon" +``` + ### With AutoGen ```bash praisonai --framework autogen --auto "create a movie script about Dog in Moon" diff --git a/docs/call.md b/docs/call.mdx similarity index 94% rename from docs/call.md rename to docs/call.mdx index 77e084ee..26415129 100644 --- a/docs/call.md +++ b/docs/call.mdx @@ -1,4 +1,7 @@ -# PraisonAI Call +--- +title: "PraisonAI Call" +description: "Guide to PraisonAI's voice-based interaction feature enabling AI customer service through phone calls, including setup and tool integration" +--- diff --git a/docs/contributing.md b/docs/contributing.mdx similarity index 72% rename from docs/contributing.md rename to docs/contributing.mdx index d1f42857..a7503cc1 100644 --- a/docs/contributing.md +++ b/docs/contributing.mdx @@ -1,4 +1,7 @@ -# Contributing +--- +title: "Contributing" +description: "Guide for contributing to PraisonAI through GitHub, including forking, cloning, and submitting pull requests" +--- - Fork on GitHub: Use the "Fork" button on the repository page. - Clone your fork: `git clone https://github.com/yourusername/praisonAI.git` diff --git a/docs/deploy.md b/docs/deploy.mdx similarity index 89% rename from docs/deploy.md rename to docs/deploy.mdx index 091d02f0..f4c1f52c 100644 --- a/docs/deploy.md +++ b/docs/deploy.mdx @@ -1,4 +1,7 @@ -# Deploy +--- +title: "Deploy" +description: "Guide for deploying PraisonAI to cloud platforms, with detailed instructions for Google Cloud deployment" +--- ## Google Cloud diff --git a/docs/developers/agents-playbook.md b/docs/developers/agents-playbook.mdx similarity index 92% rename from docs/developers/agents-playbook.md rename to docs/developers/agents-playbook.mdx index 9f8611e3..116f42d4 100644 --- a/docs/developers/agents-playbook.md +++ b/docs/developers/agents-playbook.mdx @@ -1,3 +1,8 @@ +--- +title: "Agents Playbook" +description: "Examples and templates for creating PraisonAI agent playbooks, from simple to detailed configurations with multiple roles and tasks" +--- + # Agents Playbook ## Simple Playbook Example diff --git a/docs/developers/googlecolab-tools.md b/docs/developers/googlecolab-tools.mdx similarity index 98% rename from docs/developers/googlecolab-tools.md rename to docs/developers/googlecolab-tools.mdx index 19b9146f..7a2192f8 100644 --- a/docs/developers/googlecolab-tools.md +++ b/docs/developers/googlecolab-tools.mdx @@ -1,4 +1,9 @@ --- +title: "Google Colab Tools" +description: "Guide for implementing and using custom tools in PraisonAI with Google Colab, including examples of internet search and data processing tools" +--- + +``` jupyter: accelerator: GPU colab: @@ -10,7 +15,7 @@ jupyter: name: python nbformat: 4 nbformat_minor: 0 ---- +``` ``` python !pip install -Uq praisonai duckduckgo_search diff --git a/docs/developers/googlecolab.md b/docs/developers/googlecolab.mdx similarity index 98% rename from docs/developers/googlecolab.md rename to docs/developers/googlecolab.mdx index 0e1c886c..d0626572 100644 --- a/docs/developers/googlecolab.md +++ b/docs/developers/googlecolab.mdx @@ -1,4 +1,9 @@ --- +title: "Google Colab Integration" +description: "Guide for using PraisonAI in Google Colab environments, with example code and configurations for agent-based tasks" +--- + +``` jupyter: accelerator: GPU colab: @@ -10,7 +15,7 @@ jupyter: name: python nbformat: 4 nbformat_minor: 0 ---- +``` ``` python diff --git a/docs/developers/test.md b/docs/developers/test.md deleted file mode 100644 index 0e07cddf..00000000 --- a/docs/developers/test.md +++ /dev/null @@ -1,5 +0,0 @@ -# Test - -```bash -python -m unittest tests.test -``` \ No newline at end of file diff --git a/docs/developers/test.mdx b/docs/developers/test.mdx new file mode 100644 index 00000000..833b2e96 --- /dev/null +++ b/docs/developers/test.mdx @@ -0,0 +1,10 @@ +--- +title: "Test" +description: "Instructions for running and writing tests for PraisonAI components, including unit tests and test automation" +--- + +# Test + +```bash +python -m unittest tests.test +``` \ No newline at end of file diff --git a/docs/developers/wrapper-tools.md b/docs/developers/wrapper-tools.mdx similarity index 88% rename from docs/developers/wrapper-tools.md rename to docs/developers/wrapper-tools.mdx index 98aacd0c..279fa49f 100644 --- a/docs/developers/wrapper-tools.md +++ b/docs/developers/wrapper-tools.mdx @@ -1,3 +1,8 @@ +--- +title: "Integrate with Tools" +description: "Guide for integrating external tools and APIs with PraisonAI, including examples of custom tool creation and implementation" +--- + # Integrate with Tools ```python diff --git a/docs/developers/wrapper.md b/docs/developers/wrapper.mdx similarity index 90% rename from docs/developers/wrapper.md rename to docs/developers/wrapper.mdx index a629d9bf..1e0d3001 100644 --- a/docs/developers/wrapper.md +++ b/docs/developers/wrapper.mdx @@ -1,3 +1,8 @@ +--- +title: "PraisonAI Package Integration" +description: "Guide for integrating the PraisonAI package into your Python projects, including YAML configuration and different execution modes" +--- + # Include praisonai package in your project ## Option 1: Using RAW YAML diff --git a/docs/firecrawl.md b/docs/firecrawl.mdx similarity index 89% rename from docs/firecrawl.md rename to docs/firecrawl.mdx index ca0eb6f0..0bc26796 100644 --- a/docs/firecrawl.md +++ b/docs/firecrawl.mdx @@ -1,3 +1,8 @@ +--- +title: "Firecrawl PraisonAI Integration" +description: "Guide for integrating Firecrawl web scraping capabilities with PraisonAI, including custom tool implementation for web page content extraction" +--- + # Firecrawl PraisonAI Integration diff --git a/docs/framework/autogen.md b/docs/framework/autogen.mdx similarity index 79% rename from docs/framework/autogen.md rename to docs/framework/autogen.mdx index 6340523b..3ade691e 100644 --- a/docs/framework/autogen.md +++ b/docs/framework/autogen.mdx @@ -1,3 +1,8 @@ +--- +title: "AutoGen with PraisonAI" +description: "Guide for using AutoGen framework with PraisonAI, including installation, setup, and multi-agent conversation capabilities" +--- + # AutoGen with PraisonAI Low-code solution to run AutoGen with integrated tools and features. diff --git a/docs/framework/crewai.md b/docs/framework/crewai.mdx similarity index 79% rename from docs/framework/crewai.md rename to docs/framework/crewai.mdx index 60609f4b..9694f93f 100644 --- a/docs/framework/crewai.md +++ b/docs/framework/crewai.mdx @@ -1,3 +1,8 @@ +--- +title: "CrewAI with PraisonAI" +description: "Guide for using CrewAI framework with PraisonAI, including installation, setup, and execution of agent-based tasks" +--- + # CrewAI with PraisonAI Low-code solution to run CrewAI with integrated tools and features. diff --git a/docs/framework/praisonaiagents.mdx b/docs/framework/praisonaiagents.mdx new file mode 100644 index 00000000..eae0fdbd --- /dev/null +++ b/docs/framework/praisonaiagents.mdx @@ -0,0 +1,206 @@ +--- +title: "PraisonAI Agents" +description: "Guide for using PraisonAI Agents framework, a lightweight package for creating and managing AI agents with advanced capabilities" +--- + +A lightweight package dedicated to creating and managing AI agents with advanced capabilities. + +## Installation + +```bash +pip install praisonaiagents +export OPENAI_API_KEY=xxxxxxxxxxxxxxxxxxxxxx +``` + +## Quick Start + +Create `app.py` and add the following code: + +```python +from praisonaiagents import Agent, Task, PraisonAIAgents + +# 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 +) + +# Create tasks +research_task = Task( + description="Research the latest developments in AI and data science", + expected_output="A comprehensive report on recent AI trends and breakthroughs", + agent=researcher +) + +writing_task = Task( + description="Create an engaging blog post about the research findings", + expected_output="A well-structured blog post explaining AI developments", + agent=writer, + context=[research_task] # This task depends on research_task output +) + +# Create and run the agents +agents = PraisonAIAgents( + agents=[researcher, writer], + tasks=[research_task, writing_task], + verbose=True +) + +result = agents.start() +print(result) +``` + +## Agent Configuration + +### Core Attributes +- `name`: Agent's identifier +- `role`: Agent's function/expertise +- `goal`: Individual objective +- `backstory`: Context and personality +- `llm`: Language model (default: OpenAI's GPT-4) +- `verbose`: Enable detailed logs (default: False) +- `markdown`: Enable markdown formatting (default: True) + +### Optional Attributes +- `tools`: List of available tools +- `memory`: Enable conversation history (default: True) +- `max_iter`: Maximum iterations (default: 20) +- `max_rpm`: Rate limit for API calls +- `allow_delegation`: Enable task delegation (default: False) + +## Task Configuration + +### Core Attributes +- `description`: Task details +- `expected_output`: Desired outcome +- `agent`: Assigned agent + +### Optional Attributes +- `context`: Dependencies on other tasks +- `tools`: Task-specific tools +- `async_execution`: Run asynchronously (default: False) +- `output_file`: Save output to file +- `callback`: Post-task function + +## Advanced Features + +### Tool Integration +```python +from duckduckgo_search import DDGS + +def search_tool(query: str) -> list: + """ + Perform a web search using DuckDuckGo and return relevant results. + + Args: + query (str): The search query string to look up information about. + + Returns: + list: A list of dictionaries containing search results with the following keys: + - title (str): The title of the search result + - url (str): The URL of the search result + - snippet (str): A brief excerpt or description of the search result + """ + results = [] + ddgs = DDGS() + for result in ddgs.text(keywords=query, max_results=10): + results.append({ + "title": result.get("title", ""), + "url": result.get("href", ""), + "snippet": result.get("body", ""), + }) + return results + +agent = Agent( + name="Researcher", + tools=[search_tool] +) +``` + +### Custom Callbacks +```python +def task_completed(output): + print(f"Task completed: {output.description}") + print(f"Output: {output.raw}") + +task = Task( + description="Analysis task", + callback=task_completed +) +``` + +## Error Handling + +The framework includes built-in error handling for: +- API rate limits +- Token limits +- Task timeouts +- Tool execution failures + +## Best Practices + +1. **Agent Design** + - Give clear, specific roles and goals + - Provide detailed backstories + - Use appropriate tools for tasks + +2. **Task Management** + - Break complex tasks into subtasks + - Set clear dependencies + - Use async execution for independent tasks + +3. **Resource Optimization** + - Enable caching when appropriate + - Set reasonable max_iter limits + - Use rate limiting for API calls + +4. **Error Handling** + - Implement task callbacks + - Set appropriate timeouts + - Monitor execution logs + +### Parallel Execution (Upcoming) +```python +task1 = Task( + description="Research task 1", + async_execution=True +) + +task2 = Task( + description="Research task 2", + async_execution=True +) + +final_task = Task( + description="Compile results", + context=[task1, task2] # Waits for both tasks +) +``` + +### Memory Management (Upcoming) +```python +agent = Agent( + name="Analyst", + memory=True, # Enable memory + memory_config={ + "type": "short_term", + "max_tokens": 4000 + } +) +``` diff --git a/docs/home.md b/docs/home.mdx similarity index 96% rename from docs/home.md rename to docs/home.mdx index e9669b8a..91e7c67c 100644 --- a/docs/home.md +++ b/docs/home.mdx @@ -1,3 +1,8 @@ +--- +title: "Praison AI" +description: "Home page for PraisonAI documentation, featuring installation options, user interfaces, and quick start guides for multi-agent LLM systems" +--- + # Home diff --git a/docs/images/praisonai-logo-large-dark.png b/docs/images/praisonai-logo-large-dark.png new file mode 100644 index 00000000..5fda586b Binary files /dev/null and b/docs/images/praisonai-logo-large-dark.png differ diff --git a/docs/images/praisonai-logo-large-light.png b/docs/images/praisonai-logo-large-light.png new file mode 100644 index 00000000..00129ea5 Binary files /dev/null and b/docs/images/praisonai-logo-large-light.png differ diff --git a/docs/images/praisonai-logo-light.png b/docs/images/praisonai-logo-light.png new file mode 100644 index 00000000..f5d1eb07 Binary files /dev/null and b/docs/images/praisonai-logo-light.png differ diff --git a/docs/index.md b/docs/index.mdx similarity index 76% rename from docs/index.md rename to docs/index.mdx index 03bd7aaa..f97f7ace 100644 --- a/docs/index.md +++ b/docs/index.mdx @@ -1,14 +1,43 @@ -# Praison AI +--- +title: "Praison AI" +description: "Comprehensive guide to PraisonAI - an AI Agents Framework with Self Reflection, combining PraisonAI Agents, AutoGen, and CrewAI for building multi-agent LLM systems" +--- + + + +
+ PraisonAI Logo in Light Mode + PraisonAI Logo in Dark Mode +
- +
+ + Total Downloads + + + Latest Stable Version + + + License + +
-PraisonAI Logo -

-Total Downloads -Latest Stable Version -License -

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. @@ -134,14 +163,20 @@ Advanced logging: export LOGLEVEL=debug ``` -
- - - - PraisonAI Architecture - +
+ PraisonAI Architecture in Light Mode + PraisonAI Architecture in Dark Mode
+ ## Different User Interfaces: | Interface | Description | URL | diff --git a/docs/initialise.md b/docs/initialise.mdx similarity index 72% rename from docs/initialise.md rename to docs/initialise.mdx index 5ad98f4d..d549592a 100644 --- a/docs/initialise.md +++ b/docs/initialise.mdx @@ -1,4 +1,7 @@ -# Initialise +--- +title: "Initialise" +description: "Instructions for initializing PraisonAI with API keys and creating the initial agents configuration file" +--- ```bash export OPENAI_API_KEY="Enter your API key" diff --git a/docs/installation.md b/docs/installation.mdx similarity index 78% rename from docs/installation.md rename to docs/installation.mdx index e62e77c4..d7b9e85c 100644 --- a/docs/installation.md +++ b/docs/installation.mdx @@ -1,4 +1,7 @@ -# Installation +--- +title: "Installation" +description: "Guide for installing PraisonAI and its various components including framework support and additional features" +--- ## Basic Installation ```bash @@ -7,6 +10,12 @@ pip install praisonai ## Framework-specific Installation +### PraisonAI Agents Support (Default) + +```bash +pip install praisonai +``` + ### CrewAI Support ```bash pip install "praisonai[crewai]" diff --git a/docs/introduction.md b/docs/introduction.mdx similarity index 92% rename from docs/introduction.md rename to docs/introduction.mdx index 00bece1a..8c9bfbbe 100644 --- a/docs/introduction.md +++ b/docs/introduction.mdx @@ -1,10 +1,8 @@ --- -title: 'Introduction to PraisonAI' +title: 'Introduction' description: 'Get started with PraisonAI, an intelligent AI-powered tool' --- -# Introduction to PraisonAI - Welcome to PraisonAI documentation! PraisonAI is a low-code, centralized 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. ## Key Features diff --git a/mint.json b/docs/mint.json similarity index 91% rename from mint.json rename to docs/mint.json index 412c8192..9e30c298 100644 --- a/mint.json +++ b/docs/mint.json @@ -1,10 +1,10 @@ { "name": "PraisonAI Documentation", "logo": { - "light": "/docs/images/praisonai-logo-black-large.png", - "dark": "/docs/images/praisonai-logo-large.png" + "light": "/images/praisonai-logo-large-dark.png", + "dark": "/images/praisonai-logo-large-light.png" }, - "favicon": "/docs/images/favicon.png", + "favicon": "/images/praisonai-android-chrome-192x192.png", "colors": { "primary": "#0069ED", "light": "#4D9CFF", @@ -45,6 +45,7 @@ "group": "Core Concepts", "pages": [ "train", + "framework/praisonaiagents", "framework/crewai", "framework/autogen" ] diff --git a/docs/models.md b/docs/models.mdx similarity index 92% rename from docs/models.md rename to docs/models.mdx index b5700546..cafb2642 100644 --- a/docs/models.md +++ b/docs/models.mdx @@ -1,4 +1,7 @@ -# Models in PraisonAI +--- +title: "Models in PraisonAI" +description: "Overview of supported language models in PraisonAI, including OpenAI, Groq, Google Gemini, Anthropic Claude, and configuration examples" +--- | PraisonAI Chat | PraisonAI Code | PraisonAI (Multi-Agents) | | --- | --- | --- | diff --git a/docs/models/anthropic.md b/docs/models/anthropic.mdx similarity index 86% rename from docs/models/anthropic.md rename to docs/models/anthropic.mdx index 60331500..a38005aa 100644 --- a/docs/models/anthropic.md +++ b/docs/models/anthropic.mdx @@ -1,3 +1,8 @@ +--- +title: "Anthropic" +description: "Instructions for integrating Anthropic's Claude models with PraisonAI, including API setup and agent configuration" +--- + # Add Anthropic to Praison AI ```bash diff --git a/docs/models/cohere.md b/docs/models/cohere.mdx similarity index 86% rename from docs/models/cohere.md rename to docs/models/cohere.mdx index 69b9f782..82b5e2ef 100644 --- a/docs/models/cohere.md +++ b/docs/models/cohere.mdx @@ -1,3 +1,8 @@ +--- +title: "Cohere" +description: "Guide for integrating Cohere's language models with PraisonAI, including API setup and configuration examples" +--- + # Add COHERE to Praison AI ```bash diff --git a/docs/models/google.md b/docs/models/google.mdx similarity index 86% rename from docs/models/google.md rename to docs/models/google.mdx index 874b32d1..f2d4326e 100644 --- a/docs/models/google.md +++ b/docs/models/google.mdx @@ -1,3 +1,8 @@ +--- +title: "Google Gemini" +description: "Instructions for integrating Google's Gemini models with PraisonAI, including API setup and configuration details" +--- + # Add Google Gemini to Praison AI ```bash diff --git a/docs/models/groq.md b/docs/models/groq.mdx similarity index 85% rename from docs/models/groq.md rename to docs/models/groq.mdx index 2f387696..f93f869f 100644 --- a/docs/models/groq.md +++ b/docs/models/groq.mdx @@ -1,3 +1,8 @@ +--- +title: "Groq" +description: "Guide for integrating Groq's high-performance language models with PraisonAI, including API setup and configuration" +--- + # Add GROQ to Praison AI ```bash diff --git a/docs/models/mistral.md b/docs/models/mistral.mdx similarity index 87% rename from docs/models/mistral.md rename to docs/models/mistral.mdx index 490928d7..755239c1 100644 --- a/docs/models/mistral.md +++ b/docs/models/mistral.mdx @@ -1,3 +1,8 @@ +--- +title: "Mistral" +description: "Guide for integrating Mistral AI's language models with PraisonAI, including API configuration and usage instructions" +--- + # Add Mistral to Praison AI Note: If you want to use Mistral via Ollama, please refer to Ollama document. This is for using Mistral from https://mistral.ai diff --git a/docs/models/ollama.md b/docs/models/ollama.mdx similarity index 84% rename from docs/models/ollama.md rename to docs/models/ollama.mdx index 5d6ecb13..6d79b896 100644 --- a/docs/models/ollama.md +++ b/docs/models/ollama.mdx @@ -1,3 +1,8 @@ +--- +title: "Ollama" +description: "Instructions for integrating Ollama's open-source language models with PraisonAI, including configuration and usage examples" +--- + # Add Ollama to Praison AI ### agents.yaml file diff --git a/docs/models/openai.md b/docs/models/openai.mdx similarity index 93% rename from docs/models/openai.md rename to docs/models/openai.mdx index e45fd950..7ed11e69 100644 --- a/docs/models/openai.md +++ b/docs/models/openai.mdx @@ -1,3 +1,8 @@ +--- +title: "OpenAI ChatGPT" +description: "Guide for integrating OpenAI's ChatGPT models with PraisonAI, including configuration for both single and multi-agent setups" +--- + # Add OPENAI ChatGPT to Praison AI ## Using Single Agent diff --git a/docs/models/openrouter.md b/docs/models/openrouter.mdx similarity index 84% rename from docs/models/openrouter.md rename to docs/models/openrouter.mdx index fe4ea210..e7093826 100644 --- a/docs/models/openrouter.md +++ b/docs/models/openrouter.mdx @@ -1,3 +1,8 @@ +--- +title: "OpenRouter" +description: "Guide for integrating OpenRouter's unified API access to various language models with PraisonAI, including setup and configuration" +--- + # Add OpenRouter to Praison AI ```bash diff --git a/docs/models/other.md b/docs/models/other.mdx similarity index 79% rename from docs/models/other.md rename to docs/models/other.mdx index 16792878..81c18f5f 100644 --- a/docs/models/other.md +++ b/docs/models/other.mdx @@ -1,4 +1,7 @@ -# Other Models +--- +title: "Other Models" +description: "Configuration examples for various other language models with PraisonAI, including Ollama, FastChat, LM Studio, and Mistral API" +--- ```bash # Ollama diff --git a/docs/monitoring/agentops.md b/docs/monitoring/agentops.mdx similarity index 54% rename from docs/monitoring/agentops.md rename to docs/monitoring/agentops.mdx index 21f0d688..a7b6ce77 100644 --- a/docs/monitoring/agentops.md +++ b/docs/monitoring/agentops.mdx @@ -1,3 +1,8 @@ +--- +title: "AgentOps PraisonAI Monitoring" +description: "Guide for setting up and using AgentOps monitoring with PraisonAI, including installation and dashboard configuration" +--- + # AgentOps PraisonAI Monitoring ```bash diff --git a/docs/run.md b/docs/run.mdx similarity index 63% rename from docs/run.md rename to docs/run.mdx index 0120d7d4..8d121396 100644 --- a/docs/run.md +++ b/docs/run.mdx @@ -1,4 +1,7 @@ -# Run +--- +title: "Run" +description: "Instructions for running PraisonAI from the command line, including framework selection and automatic mode" +--- ```bash praisonai diff --git a/docs/tldr.md b/docs/tldr.mdx similarity index 63% rename from docs/tldr.md rename to docs/tldr.mdx index 0875455b..b9c37c34 100644 --- a/docs/tldr.md +++ b/docs/tldr.mdx @@ -1,10 +1,13 @@ -# TL;DR +--- +title: "TL;DR" +description: "Quick start guide for PraisonAI with CrewAI, AutoGen, and UI setup instructions" +--- -## Quick Start with CrewAI (Default) +## Quick Start with PraisonAI Agents ```bash # Install with CrewAI support -pip install "praisonai[crewai]" +pip install praisonai # Set your API key export OPENAI_API_KEY="Enter your API key" @@ -14,6 +17,20 @@ praisonai --init "create a movie script about dog in moon" praisonai ``` +## Quick Start with CrewAI + +```bash +# Install with CrewAI support +pip install "praisonai[crewai]" + +# Set your API key +export OPENAI_API_KEY="Enter your API key" + +# Initialize and run +praisonai --framework crewai --init "create a movie script about dog in moon" +praisonai --framework crewai +``` + ## Quick Start with AutoGen ```bash diff --git a/docs/tools.md b/docs/tools.mdx similarity index 89% rename from docs/tools.md rename to docs/tools.mdx index 2c3af5ac..652726e8 100644 --- a/docs/tools.md +++ b/docs/tools.mdx @@ -1,4 +1,7 @@ -# Tools +--- +title: "Tools" +description: "Overview of PraisonAI's built-in tools for data search, analysis, and web scraping capabilities" +--- diff --git a/docs/tools/composio.md b/docs/tools/composio.mdx similarity index 87% rename from docs/tools/composio.md rename to docs/tools/composio.mdx index 53ca666b..ed94935a 100644 --- a/docs/tools/composio.md +++ b/docs/tools/composio.mdx @@ -1,3 +1,8 @@ +--- +title: "Composio PraisonAI Integration" +description: "Guide for integrating Composio's extensive tool ecosystem with PraisonAI agents, enabling access to GitHub, Gmail, and other external services" +--- + # Composio PraisonAI Integration [Composio](https://composio.dev/) allows AI agents and LLMs to easily integrate with 100+ tools (GitHub, Gmail, CodeExecution and more) to perform actions and subscribe to triggers. This example will show how to integrate Composio with PraisonAI agents to let them seamlessly interact with external apps. diff --git a/docs/tools/crawl4ai.md b/docs/tools/crawl4ai.mdx similarity index 92% rename from docs/tools/crawl4ai.md rename to docs/tools/crawl4ai.mdx index 23b37558..ba8b82c3 100644 --- a/docs/tools/crawl4ai.md +++ b/docs/tools/crawl4ai.mdx @@ -1,3 +1,8 @@ +--- +title: "Crawl4AI PraisonAI Integration" +description: "Guide for integrating Crawl4AI web scraping capabilities with PraisonAI agents, enabling structured data extraction from websites" +--- + # Crawl4AI Praison AI Integration diff --git a/docs/tools/custom.md b/docs/tools/custom.mdx similarity index 95% rename from docs/tools/custom.md rename to docs/tools/custom.mdx index e0b914ff..b3fadfd0 100644 --- a/docs/tools/custom.md +++ b/docs/tools/custom.mdx @@ -1,3 +1,8 @@ +--- +title: "Create Custom Tools" +description: "Step-by-step guide for creating and implementing custom tools in PraisonAI, including examples and configuration instructions" +--- + # Create Custom Tools diff --git a/docs/tools/duckduckgo.md b/docs/tools/duckduckgo.mdx similarity index 78% rename from docs/tools/duckduckgo.md rename to docs/tools/duckduckgo.mdx index 4349549d..5e121aef 100644 --- a/docs/tools/duckduckgo.md +++ b/docs/tools/duckduckgo.mdx @@ -1,3 +1,8 @@ +--- +title: "DuckDuckGo PraisonAI Integration" +description: "Guide for integrating DuckDuckGo search capabilities with PraisonAI agents for web search functionality" +--- + # DuckDuckGo Praison AI Integration ```bash diff --git a/docs/tools/googlecalendar.md b/docs/tools/googlecalendar.mdx similarity index 97% rename from docs/tools/googlecalendar.md rename to docs/tools/googlecalendar.mdx index 6e8a12c1..7e20cad6 100644 --- a/docs/tools/googlecalendar.md +++ b/docs/tools/googlecalendar.mdx @@ -1,3 +1,8 @@ +--- +title: "Google Calendar Tools" +description: "Comprehensive guide for integrating Google Calendar functionality with PraisonAI agents, including event management and scheduling features" +--- + # Google Calendar Tools diff --git a/docs/tools/gpt.md b/docs/tools/gpt.md deleted file mode 100644 index 6a1343a9..00000000 --- a/docs/tools/gpt.md +++ /dev/null @@ -1,3 +0,0 @@ -# PraisonAI Tools Creator GPT - -Use [PraisonAI Tools Creator GPT](https://chatgpt.com/g/g-LrJH1K6Ao-praisonai-tools-creator) to get started quickly. diff --git a/docs/tools/gpt.mdx b/docs/tools/gpt.mdx new file mode 100644 index 00000000..47804a26 --- /dev/null +++ b/docs/tools/gpt.mdx @@ -0,0 +1,8 @@ +--- +title: "PraisonAI Tools Creator GPT" +description: "Guide for using the PraisonAI Tools Creator GPT to quickly develop and implement custom tools for PraisonAI" +--- + +# PraisonAI Tools Creator GPT + +Use [PraisonAI Tools Creator GPT](https://chatgpt.com/g/g-LrJH1K6Ao-praisonai-tools-creator) to get started quickly. diff --git a/docs/tools/langchain.md b/docs/tools/langchain.mdx similarity index 91% rename from docs/tools/langchain.md rename to docs/tools/langchain.mdx index 90671da7..bb0ad56a 100644 --- a/docs/tools/langchain.md +++ b/docs/tools/langchain.mdx @@ -1,3 +1,8 @@ +--- +title: "Langchain Tools" +description: "Guide for integrating Langchain tools and utilities with PraisonAI, including direct tool integration and wrapper implementations" +--- + # Langchain Tools ## Integrate Langchain Direct Tools diff --git a/docs/tools/mem0.md b/docs/tools/mem0.mdx similarity index 93% rename from docs/tools/mem0.md rename to docs/tools/mem0.mdx index 2ef46de6..865a51e2 100644 --- a/docs/tools/mem0.md +++ b/docs/tools/mem0.mdx @@ -1,3 +1,8 @@ +--- +title: "Mem0 and PraisonAI Integration" +description: "Guide for integrating Mem0 (formerly EmbedChain) memory management system with PraisonAI, including tools for storing, retrieving, and managing memories" +--- + # Mem0 and PaisonAI Integration diff --git a/docs/tools/reddit.md b/docs/tools/reddit.mdx similarity index 81% rename from docs/tools/reddit.md rename to docs/tools/reddit.mdx index c7427d64..e859886a 100644 --- a/docs/tools/reddit.md +++ b/docs/tools/reddit.mdx @@ -1,3 +1,8 @@ +--- +title: "Reddit PraisonAI Integration" +description: "Guide for integrating Reddit search capabilities with PraisonAI agents, including API setup and configuration" +--- + # Reddit PraisonAI Integration ```bash diff --git a/docs/tools/tavily.md b/docs/tools/tavily.mdx similarity index 73% rename from docs/tools/tavily.md rename to docs/tools/tavily.mdx index 3564385b..25a80ad8 100644 --- a/docs/tools/tavily.md +++ b/docs/tools/tavily.mdx @@ -1,3 +1,8 @@ +--- +title: "Tavily PraisonAI Integration" +description: "Guide for integrating Tavily's search API with PraisonAI agents for enhanced web search capabilities" +--- + # Tavily PraisonAI Integration ```python diff --git a/docs/tools/wikipedia.md b/docs/tools/wikipedia.mdx similarity index 87% rename from docs/tools/wikipedia.md rename to docs/tools/wikipedia.mdx index 372ddd62..d9b84f19 100644 --- a/docs/tools/wikipedia.md +++ b/docs/tools/wikipedia.mdx @@ -1,3 +1,8 @@ +--- +title: "Wikipedia PraisonAI Integration" +description: "Guide for integrating Wikipedia search capabilities with PraisonAI agents using the Wikipedia API wrapper" +--- + # Wikipedia PraisonAI Integration ```bash diff --git a/docs/tools/you.com.md b/docs/tools/you.com.mdx similarity index 85% rename from docs/tools/you.com.md rename to docs/tools/you.com.mdx index 07d430b4..04f87c40 100644 --- a/docs/tools/you.com.md +++ b/docs/tools/you.com.mdx @@ -1,3 +1,8 @@ +--- +title: "You.com PraisonAI Integration" +description: "Guide for integrating You.com search capabilities with PraisonAI agents using the You.com Search API" +--- + # You.com PraisonAI Integration ```bash diff --git a/docs/tools/youtube.md b/docs/tools/youtube.mdx similarity index 80% rename from docs/tools/youtube.md rename to docs/tools/youtube.mdx index 26ad39f2..24ed871d 100644 --- a/docs/tools/youtube.md +++ b/docs/tools/youtube.mdx @@ -1,3 +1,8 @@ +--- +title: "YouTube Search PraisonAI Integration" +description: "Guide for integrating YouTube search capabilities with PraisonAI agents using the YouTube Search API" +--- + # YouTube Search PraisonAI Integration ```bash diff --git a/docs/train.md b/docs/train.mdx similarity index 91% rename from docs/train.md rename to docs/train.mdx index 59488df6..153b2469 100644 --- a/docs/train.md +++ b/docs/train.mdx @@ -1,4 +1,7 @@ -# PraisonAI Train +--- +title: "PraisonAI Train" +description: "Guide for training and deploying models with PraisonAI, including Hugging Face and Ollama integration with detailed configuration options" +--- diff --git a/docs/ui/chat.md b/docs/ui/chat.mdx similarity index 96% rename from docs/ui/chat.md rename to docs/ui/chat.mdx index daa52814..4601b219 100644 --- a/docs/ui/chat.md +++ b/docs/ui/chat.mdx @@ -1,4 +1,7 @@ -# PraisonAI Chat +--- +title: "PraisonAI Chat" +description: "Guide to PraisonAI's chat interface with support for 100+ LLMs, internet search, vision models, and custom database configurations" +--- diff --git a/docs/ui/code.md b/docs/ui/code.mdx similarity index 96% rename from docs/ui/code.md rename to docs/ui/code.mdx index 066b4399..b48ebdf8 100644 --- a/docs/ui/code.md +++ b/docs/ui/code.mdx @@ -1,4 +1,7 @@ -# PraisonAI Code +--- +title: "PraisonAI Code" +description: "Guide to PraisonAI's code interface for interacting with your codebase using AI, including file management, model configuration, and advanced features" +--- diff --git a/docs/ui/realtime.md b/docs/ui/realtime.mdx similarity index 90% rename from docs/ui/realtime.md rename to docs/ui/realtime.mdx index 4acd1a29..cb378d76 100644 --- a/docs/ui/realtime.md +++ b/docs/ui/realtime.mdx @@ -1,4 +1,7 @@ -# Realtime Voice Interface +--- +title: "Realtime Voice Interface" +description: "Guide to PraisonAI's real-time voice interaction feature with text-to-speech, voice input processing, and financial data integration" +--- diff --git a/docs/ui/ui.md b/docs/ui/ui.mdx similarity index 91% rename from docs/ui/ui.md rename to docs/ui/ui.mdx index 09d7c4d9..7dd2861e 100644 --- a/docs/ui/ui.md +++ b/docs/ui/ui.mdx @@ -1,4 +1,7 @@ -# PraisonAI User Interface (UI) +--- +title: "PraisonAI User Interface (UI)" +description: "Comprehensive guide to PraisonAI's user interfaces, including Chainlit, Gradio, and Streamlit integrations with step-by-step setup instructions" +--- @@ -10,7 +13,8 @@ | **Chat** | Chat with 100+ LLMs, single AI Agent | [https://docs.praison.ai/ui/chat](https://docs.praison.ai/ui/chat) | | **Code** | Chat with entire Codebase, single AI Agent | [https://docs.praison.ai/ui/code](https://docs.praison.ai/ui/code) | -## Chainlit```bash +## Chainlit +```bash pip install -U "praisonai[ui]" export OPENAI_API_KEY="Enter your API key" chainlit create-secret @@ -90,7 +94,3 @@ streamlit run app.py ### Manual Model Output ![Manual Model Output](../images/ui-step-11.png) - -## PraisonAI Call - -To use the PraisonAI Call feature: