Merge pull request #73 from MervinPraison/develop

Develop

.env.example

@@ -0,0 +1,6 @@
+OPENAI_MODEL_NAME="gpt-4o"
+OPENAI_API_KEY="Enter your API key"
+OPENAI_API_BASE="https://api.openai.com/v1"
+CHAINLIT_USERNAME=admin
+CHAINLIT_USERNAME=admin
+CHAINLIT_AUTH_SECRET="chainlit create-secret to create"

.github/workflows/python-package.yml

@@ -0,0 +1,40 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "develop" ]
+  pull_request:
+    branches: [ "develop" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    # - name: Lint with flake8
+    #   run: |
+    #     # stop the build if there are Python syntax errors or undefined names
+    #     flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+    #     # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+    #     flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    # - name: Test with pytest
+    #   run: |
+    #     pytest

.github/workflows/python-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.gitignore

@@ -1,23 +1,48 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# production
-/build
-
-# misc
+.vscode
+crewai
+.cache
+__pycache__
+chroma.sqlite3
+test/
+dist/
+.env
+assets/*
+.idea
 .DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
+.pytest_cache
+praisonAI.egg-info
+flagged
+test.yaml
+db
+praisonai_prompt.txt
+watch.sh
+docs.sh
+other
+output
 
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
+.chainlit
+.files
+
+site
+# Ignore Sphinx build directory
+docs/_build/
+docs/source/
+docs/build/
+
+# Ignore Sphinx cache
+docs/_build/doctrees/
+docs/_build/doctrees/*
+docs/_build/doctrees/.doctrees
+
+# Ignore Sphinx logs and local build files
+docs/_build/.buildinfo
+docs/_build/.buildinfo/*
+docs/_build/.buildinfo/.buildinfo
+
+praisonai/doc
+
+# agentops
+trained_agents_data.pkl
+
+# crewAI
+crewAI

.readthedocs.yml

@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+  jobs:
+    post_install:
+    - bash docs/generate_docs.sh
+
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: true
+
+python:
+  install:
+    - requirements: docs/requirements.txt

Dockerfile

@@ -0,0 +1,6 @@
+FROM python:3.11-slim
+WORKDIR /app
+COPY . .
+RUN pip install flask praisonai==0.0.42 gunicorn markdown
+EXPOSE 8080
+CMD ["gunicorn", "-b", "0.0.0.0:8080", "api:app"]

LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,70 +1,258 @@
-# Getting Started with Create React App
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/images/praisonai-logo-large.png">
+    <source media="(prefers-color-scheme: light)" srcset="docs/images/praisonai-logo-black-large.png">
+    <img alt="PraisonAI Logo" src="docs/images/praisonai-logo-black-large.png">
+  </picture>
+</p>
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+# Praison AI
 
-## Available Scripts
+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.
 
-In the project directory, you can run:
+## TL;DR
+```bash
+pip install praisonai
+export OPENAI_API_KEY="Enter your API key"
+praisonai --init create a movie script about dog in moon
+praisonai
+```
 
-### `npm start`
+## Installation
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in your browser.
+```bash
+pip install praisonai
+```
 
-The page will reload when you make changes.\
-You may also see any lint errors in the console.
+## Initialise
 
-### `npm test`
+```bash
+export OPENAI_API_KEY="Enter your API key"
+```
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+Generate your OPENAI API KEY from here: https://platform.openai.com/api-keys
 
-### `npm run build`
+Note: You can use other providers such as Ollama, Mistral ... etc. Details are provided at the bottom.
+    
+```bash
+praisonai --init create a movie script about dog in moon
+```
+This will automatically create agents.yaml file in the current directory.
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+### To initialse with a specific agent framework (Optional):
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
+```bash
+praisonai --framework autogen --init create movie script about cat in mars
+```
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+## Run
 
-### `npm run eject`
+```bash
+praisonai
+```
 
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
+or 
+    
+```bash
+python -m praisonai
+```
 
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+### Specify the agent framework (Optional):
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
+```bash
+praisonai --framework autogen
+```
 
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
+### Full Automatic Mode
 
-## Learn More
+```bash
+praisonai --auto create a movie script about Dog in Moon
+```
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
+## User Interface
 
-To learn React, check out the [React documentation](https://reactjs.org/).
+```bash
+pip install -U "praisonai[ui]"
+export OPENAI_API_KEY="Enter your API key"
+chainlit create-secret
+export CHAINLIT_AUTH_SECRET=xxxxxxxx
+praisonai ui
+```
 
-### Code Splitting
+or 
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
+```
+python -m praisonai ui
+```
 
-### Analyzing the Bundle Size
+## Create Custom Tools
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
+### TL;DR to Create a Custom Tool
 
-### Making a Progressive Web App
+```bash
+pip install praisonai duckduckgo-search
+export OPENAI_API_KEY="Enter your API key"
+praisonai --init research about the latest AI News and prepare a detailed report
+```
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
+- Add `- InternetSearchTool` in the agents.yaml file in the tools section. 
+- Create a file called tools.py and add this code [tools.py](./tools.py)
 
-### Advanced Configuration
+```bash
+praisonai
+```
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
+### Pre-requisite to Create a Custom Tool
+`agents.yaml` file should be present in the current directory. 
 
-### Deployment
+If it doesn't exist, create it by running the command `praisonai --init research about the latest AI News and prepare a detailed report`.
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
+### Step 1 to Create a Custom Tool
 
-### `npm run build` fails to minify
+Create a file called tools.py in the same directory as the agents.yaml file.
 
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+```python
+# example tools.py
+from duckduckgo_search import DDGS
+from praisonai_tools import BaseTool
+
+class InternetSearchTool(BaseTool):
+    name: str = "InternetSearchTool"
+    description: str = "Search Internet for relevant information based on a query or latest news"
+
+    def _run(self, query: str):
+        ddgs = DDGS()
+        results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
+        return results
+```
+
+### Step 2 to Create a Custom Tool
+
+Add the tool to the agents.yaml file as show below under the tools section `- InternetSearchTool`.
+
+```yaml
+framework: crewai
+topic: research about the latest AI News and prepare a detailed report
+roles:
+  research_analyst:
+    backstory: Experienced in gathering and analyzing data related to AI news trends.
+    goal: Analyze AI News trends
+    role: Research Analyst
+    tasks:
+      gather_data:
+        description: Conduct in-depth research on the latest AI News trends from reputable
+          sources.
+        expected_output: Comprehensive report on current AI News trends.
+    tools:
+    - InternetSearchTool
+```
+
+## Agents Playbook 
+
+### Simple Playbook Example
+
+```yaml
+framework: crewai
+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.'
+```
+
+## Include praisonai package in your project
+
+```python
+from praisonai import PraisonAI
+
+def basic(): # Basic Mode
+    praison_ai = PraisonAI(agent_file="agents.yaml")
+    praison_ai.main()
+    
+def advanced(): # Advanced Mode with options
+    praison_ai = PraisonAI(
+        agent_file="agents.yaml",
+        framework="autogen",
+    )
+    praison_ai.main()
+    
+def auto(): # Full Automatic Mode
+    praison_ai = PraisonAI(
+        auto="Create a movie script about car in mars",
+        framework="autogen"
+    )
+    print(praison_ai.framework)
+    praison_ai.main()
+
+if __name__ == "__main__":
+    basic()
+    advanced()
+    auto()
+```
+
+### 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.
+
+## Other Models
+
+```bash
+# Ollama
+OPENAI_API_BASE='http://localhost:11434/v1'
+OPENAI_MODEL_NAME='mistral'
+OPENAI_API_KEY='NA'
+
+# FastChat
+OPENAI_API_BASE="http://localhost:8001/v1"
+OPENAI_MODEL_NAME='oh-2.5m7b-q51'
+OPENAI_API_KEY=NA
+
+# LM Studio
+OPENAI_API_BASE="http://localhost:1234/v1"
+OPENAI_MODEL_NAME=NA
+OPENAI_API_KEY=NA
+
+# Mistral API
+OPENAI_API_BASE=https://api.mistral.ai/v1
+OPENAI_MODEL_NAME="mistral-small"
+OPENAI_API_KEY=your-mistral-api-key
+```
+
+## 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.
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=MervinPraison/PraisonAI&type=Date)](https://docs.praison.ai)

agents-advanced.yaml

@@ -0,0 +1,67 @@
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    llm:  
+      model: "groq/llama3-70b-8192"
+    function_calling_llm: 
+      model: "google/gemini-1.5-flash-001"
+    allow_delegation: False
+    max_execution_time: 
+    max_iter: 
+    max_rpm: 
+    verbose: True
+    cache: True
+    system_template: 
+    prompt_template: 
+    response_template: 
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung
+          diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+        config: 
+          max_iter: 5
+        output_file: "output/data_analysis.txt"
+    tools:
+    - 'InternetSearchTool'
+  medical_writer:
+    backstory: Skilled in translating complex medical information into accessible
+      content.
+    goal: Compile comprehensive content on lung disease causes
+    role: Medical Writer
+    llm:  
+      model: "anthropic/claude-3-haiku-20240307"
+    function_calling_llm: 
+      model: "openai/gpt-4o"
+    tasks:
+      content_creation:
+        description: Create detailed content summarizing the research findings on
+          lung disease causes.
+        expected_output: Document outlining various causes and risk factors of lung
+          diseases.
+        async_execution: True
+        output_file: "output/medical_writer.txt"
+        create_directory: 
+        context: 
+          - data_analysis
+    tools:
+    - ''
+  editor:
+    backstory: Proficient in editing medical content for accuracy and clarity.
+    goal: Review and refine content on lung disease causes
+    role: Editor
+    llm:  
+      model: "cohere/command-r"
+    tasks:
+      content_review:
+        description: Edit and refine the compiled content on lung disease causes for
+          accuracy and coherence.
+        expected_output: Finalized document on lung disease causes ready for dissemination.
+        output_file: "output/editor.txt"
+    tools:
+    - ''
+dependencies: []

agents.yaml

@@ -0,0 +1,38 @@
+framework: autogen
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung
+          diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - 'InternetSearchTool'
+  medical_writer:
+    backstory: Skilled in translating complex medical information into accessible
+      content.
+    goal: Compile comprehensive content on lung disease causes
+    role: Medical Writer
+    tasks:
+      content_creation:
+        description: Create detailed content summarizing the research findings on
+          lung disease causes.
+        expected_output: Document outlining various causes and risk factors of lung
+          diseases.
+    tools:
+    - ''
+  editor:
+    backstory: Proficient in editing medical content for accuracy and clarity.
+    goal: Review and refine content on lung disease causes
+    role: Editor
+    tasks:
+      content_review:
+        description: Edit and refine the compiled content on lung disease causes for
+          accuracy and coherence.
+        expected_output: Finalized document on lung disease causes ready for dissemination.
+    tools:
+    - ''

agents_playbook/agents-scrapewebitetool.yaml

@@ -0,0 +1,42 @@
+framework: crewai
+topic: create a movie about cat in mars based on https://blog.celtx.com/how-to-write-a-good-story/
+roles:
+  story_developer:
+    backstory: Experienced in crafting compelling narratives for a diverse audience.
+    goal: Develop an engaging storyline for a movie about cats in Mars
+    role: Story Developer
+    tasks:
+      storyline_creation:
+        description: Create a captivating storyline for a movie about cats in Mars
+          inspired by the blog post at https://blog.celtx.com/how-to-write-a-good-story/
+        expected_output: Detailed storyline with key plot points, character motivations,
+          and setting descriptions.
+    tools:
+    - 'ScrapeWebsiteTool'
+  screenwriter:
+    backstory: Proficient in translating complex narratives into engaging screenplay
+      format.
+    goal: Transform the storyline into a script
+    role: Screenwriter
+    tasks:
+      script_creation:
+        description: Transform the developed storyline into a script for the movie
+          about cats in Mars.
+        expected_output: Complete script with dialogues, scenes, and stage directions
+          ready for production.
+    tools:
+    - ''
+  director:
+    backstory: Experienced in visual storytelling and bringing scripts to life on
+      screen.
+    goal: Oversee the production of the movie
+    role: Director
+    tasks:
+      movie_production:
+        description: Take the script and lead the team to produce the movie 'Cats
+          in Mars' based on the provided content and script.
+        expected_output: Completed movie ready for distribution with compelling visuals
+          and engaging storytelling.
+    tools:
+    - ''
+dependencies: []

agents_playbook/create-movie-agents.yaml

@@ -0,0 +1,42 @@
+framework: crewai
+topic: create a movie about cat in mars based on https://www.grammarly.com/blog/how-to-write-a-story/
+roles:
+  story_developer:
+    backstory: Experienced in crafting compelling narratives for a diverse audience.
+    goal: Develop an engaging storyline for a movie about cats in Mars
+    role: Story Developer
+    tasks:
+      storyline_creation:
+        description: Create a captivating storyline for a movie about cats in Mars
+          inspired by the blog post at https://www.grammarly.com/blog/how-to-write-a-story/
+        expected_output: Detailed storyline with key plot points, character motivations,
+          and setting descriptions.
+    tools:
+    - 'ScrapeWebsiteTool'
+  screenwriter:
+    backstory: Proficient in translating complex narratives into engaging screenplay
+      format.
+    goal: Transform the storyline into a script
+    role: Screenwriter
+    tasks:
+      script_creation:
+        description: Transform the developed storyline into a script for the movie
+          about cats in Mars.
+        expected_output: Complete script with dialogues, scenes, and stage directions
+          ready for production.
+    tools:
+    - ''
+  director:
+    backstory: Experienced in visual storytelling and bringing scripts to life on
+      screen.
+    goal: Oversee the production of the movie
+    role: Director
+    tasks:
+      movie_production:
+        description: Take the script and lead the team to produce the movie 'Cats
+          in Mars' based on the provided content and script.
+        expected_output: Completed movie ready for distribution with compelling visuals
+          and engaging storytelling.
+    tools:
+    - ''
+dependencies: []

agents_playbook/finance-research.yaml

@@ -0,0 +1,43 @@
+framework: crewai
+topic: research about nvidia growth
+roles:
+  data_collector:
+    backstory: An experienced researcher with the ability to efficiently collect and
+      organize vast amounts of data.
+    goal: Gather information on Nvidia's growth
+    role: Data Collector
+    tasks:
+      data_collection_task:
+        description: Collect data on Nvidia's growth from various sources such as
+          financial reports, news articles, and company announcements.
+        expected_output: A comprehensive document detailing data points on Nvidia's
+          growth over the years.
+    tools:
+    - 'YouSearchTool'
+  data_analyst:
+    backstory: Specializes in extracting insights from large datasets, proficient
+      in quantitative and qualitative analysis.
+    goal: Analyze the collected data to identify trends and patterns
+    role: Data Analyst
+    tasks:
+      data_analysis_task:
+        description: Analyze the collected data to identify key trends and patterns
+          in Nvidia's growth.
+        expected_output: An analytical report summarizing trends, patterns, and key
+          growth metrics of Nvidia.
+    tools:
+    - ''
+  report_preparer:
+    backstory: Experienced in creating detailed reports and presentations, turning
+      analytical data into actionable insights.
+    goal: Generate a final report on Nvidia's growth
+    role: Report Preparer
+    tasks:
+      report_preparation_task:
+        description: Create a detailed report based on the analysis, highlighting
+          Nvidia's growth trajectory.
+        expected_output: A polished, comprehensive report summarizing Nvidia's growth
+          with visual aids and key insights.
+    tools:
+    - ''
+dependencies: []

agents_playbook/internet-research-agents.yaml

@@ -0,0 +1,26 @@
+framework: crewai
+topic: research about the latest AI News and prepare a detailed report
+roles:
+  research_analyst:
+    backstory: Experienced in gathering and analyzing data related to AI news trends.
+    goal: Analyze AI News trends
+    role: Research Analyst
+    tasks:
+      gather_data:
+        description: Conduct in-depth research on the latest AI News trends from reputable
+          sources.
+        expected_output: Comprehensive report on current AI News trends.
+    tools:
+    - 'InternetSearchTool'
+  content_creator:
+    backstory: Skilled in writing informative and engaging content about AI News.
+    goal: Create detailed reports on AI News
+    role: Content Creator
+    tasks:
+      compile_report:
+        description: Compile all gathered data into a detailed report with analysis
+          and insights.
+        expected_output: Well-structured report on the latest AI News with key insights.
+    tools:
+    - ''
+dependencies: []

agents_playbook/medical-research-pubmed-agents.yaml

@@ -0,0 +1,39 @@
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung
+          diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - 'PubmedQueryRun'
+  medical_writer:
+    backstory: Skilled in translating complex medical information into accessible
+      content.
+    goal: Compile comprehensive content on lung disease causes
+    role: Medical Writer
+    tasks:
+      content_creation:
+        description: Create detailed content summarizing the research findings on
+          lung disease causes.
+        expected_output: Document outlining various causes and risk factors of lung
+          diseases.
+    tools:
+    - ''
+  editor:
+    backstory: Proficient in editing medical content for accuracy and clarity.
+    goal: Review and refine content on lung disease causes
+    role: Editor
+    tasks:
+      content_review:
+        description: Edit and refine the compiled content on lung disease causes for
+          accuracy and coherence.
+        expected_output: Finalized document on lung disease causes ready for dissemination.
+    tools:
+    - ''
+dependencies: []

api.py

@@ -0,0 +1,18 @@
+from flask import Flask
+from praisonai import PraisonAI
+import markdown
+
+app = Flask(__name__)
+
+def basic():
+    praison_ai = PraisonAI(agent_file="agents.yaml")
+    return praison_ai.main()
+
+@app.route('/')
+def home():
+    output = basic()
+    html_output = markdown.markdown(output)
+    return f'<html><body>{html_output}</body></html>'
+
+if __name__ == "__main__":
+    app.run(debug=True)

chainlit.md

@@ -0,0 +1 @@
+# Welcome to Praison AI! 🚀🤖

cookbooks/praisonai-googlecolab.ipynb

@@ -0,0 +1,257 @@
+{
+  "nbformat": 4,
+  "nbformat_minor": 0,
+  "metadata": {
+    "colab": {
+      "provenance": [],
+      "gpuType": "T4"
+    },
+    "kernelspec": {
+      "name": "python3",
+      "display_name": "Python 3"
+    },
+    "language_info": {
+      "name": "python"
+    },
+    "accelerator": "GPU"
+  },
+  "cells": [
+    {
+      "cell_type": "code",
+      "source": [
+        "!pip install -Uq praisonai"
+      ],
+      "metadata": {
+        "id": "cW47IVIvdyii"
+      },
+      "execution_count": 2,
+      "outputs": []
+    },
+    {
+      "cell_type": "code",
+      "source": [
+        "import os\n",
+        "import yaml\n",
+        "from praisonai import PraisonAI\n",
+        "from google.colab import userdata\n",
+        "\n",
+        "# Example agent_yaml content\n",
+        "agent_yaml = \"\"\"\n",
+        "framework: \"crewai\"\n",
+        "topic: \"Space Exploration\"\n",
+        "\n",
+        "roles:\n",
+        "  astronomer:\n",
+        "    role: \"Space Researcher\"\n",
+        "    goal: \"Discover new insights about {topic}\"\n",
+        "    backstory: \"You are a curious and dedicated astronomer with a passion for unraveling the mysteries of the cosmos.\"\n",
+        "    tasks:\n",
+        "      investigate_exoplanets:\n",
+        "        description: \"Research and compile information about exoplanets discovered in the last decade.\"\n",
+        "        expected_output: \"A summarized report on exoplanet discoveries, including their size, potential habitability, and distance from Earth.\"\n",
+        "\"\"\"\n",
+        "\n",
+        "# Create a PraisonAI instance with the agent_yaml content\n",
+        "praison_ai = PraisonAI(agent_yaml=agent_yaml)\n",
+        "\n",
+        "# Add OPENAI_API_KEY Secrets to Google Colab on the Left Hand Side 🔑 or Enter Manually Below\n",
+        "os.environ[\"OPENAI_API_KEY\"] = userdata.get('OPENAI_API_KEY') or \"ENTER OPENAI_API_KEY HERE\"\n",
+        "\n",
+        "# Run PraisonAI\n",
+        "result = praison_ai.main()\n",
+        "\n",
+        "# Print the result\n",
+        "print(result)"
+      ],
+      "metadata": {
+        "colab": {
+          "base_uri": "https://localhost:8080/"
+        },
+        "id": "myh-_QCuHfOs",
+        "outputId": "8e35d04d-261c-4379-ef8c-bbe7e6dca89f"
+      },
+      "execution_count": 4,
+      "outputs": [
+        {
+          "output_type": "stream",
+          "name": "stdout",
+          "text": [
+            "\u001b[1m\u001b[95m [2024-07-03 04:39:09][DEBUG]: == Working Agent: Space Researcher\u001b[00m\n",
+            "\u001b[1m\u001b[95m [2024-07-03 04:39:09][INFO]: == Starting Task: Research and compile information about exoplanets discovered in the last decade.\u001b[00m\n",
+            "\n",
+            "\n",
+            "\u001b[1m> Entering new CrewAgentExecutor chain...\u001b[0m\n",
+            "\u001b[32;1m\u001b[1;3mI now can give a great answer.\n",
+            "\n",
+            "Final Answer: \n",
+            "\n",
+            "In the last decade, the field of exoplanet research has experienced a remarkable surge in discoveries, thanks to advancements in technology and dedicated space missions such as Kepler, TESS (Transiting Exoplanet Survey Satellite), and various ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, highlighting their size, potential habitability, and distance from Earth:\n",
+            "\n",
+            "1. **Kepler-452b**\n",
+            "   - **Size:** Approximately 60% larger in diameter than Earth.\n",
+            "   - **Potential Habitability:** Often referred to as \"Earth's Cousin,\" Kepler-452b orbits within the habitable zone of its star, where liquid water could exist. The planet receives a similar amount of energy from its star as Earth does from the Sun.\n",
+            "   - **Distance from Earth:** About 1,402 light-years.\n",
+            "\n",
+            "2. **Proxima Centauri b**\n",
+            "   - **Size:** Slightly larger than Earth, with a minimum mass of 1.17 Earth masses.\n",
+            "   - **Potential Habitability:** Located in the habitable zone of Proxima Centauri, the closest known star to the Sun. Potential for liquid water exists, but its habitability is uncertain due to stellar flare activity.\n",
+            "   - **Distance from Earth:** 4.24 light-years.\n",
+            "\n",
+            "3. **TRAPPIST-1 System**\n",
+            "   - **Size:** The system contains seven Earth-sized planets. TRAPPIST-1e, f, and g are within the star's habitable zone.\n",
+            "   - **Potential Habitability:** TRAPPIST-1e is considered the most promising candidate for habitability, as it has a rocky composition and is located in the middle of the habitable zone.\n",
+            "   - **Distance from Earth:** About 39 light-years.\n",
+            "\n",
+            "4. **LHS 1140 b**\n",
+            "   - **Size:** About 1.4 times the size of Earth with a mass of around 6.6 Earth masses.\n",
+            "   - **Potential Habitability:** Resides in the habitable zone of its red dwarf star. The planet is likely rocky and has an atmosphere that could support life.\n",
+            "   - **Distance from Earth:** Approximately 40 light-years.\n",
+            "\n",
+            "5. **K2-18b**\n",
+            "   - **Size:** About 2.6 times the size of Earth with a mass of 8.6 Earth masses.\n",
+            "   - **Potential Habitability:** This exoplanet lies within the habitable zone and has been detected to have water vapor in its atmosphere. It is considered one of the most promising candidates for habitability outside our solar system.\n",
+            "   - **Distance from Earth:** Roughly 124 light-years.\n",
+            "\n",
+            "6. **Gliese 667 Cc**\n",
+            "   - **Size:** At least 4.5 times the mass of Earth.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of its host star, Gliese 667 C. Its orbit allows for the possibility of liquid water on its surface.\n",
+            "   - **Distance from Earth:** About 23.62 light-years.\n",
+            "\n",
+            "7. **HD 40307 g**\n",
+            "   - **Size:** A super-Earth with at least 7 Earth masses.\n",
+            "   - **Potential Habitability:** Located in the habitable zone of its star, this planet could potentially support liquid water and therefore life.\n",
+            "   - **Distance from Earth:** Approximately 42 light-years.\n",
+            "\n",
+            "8. **Ross 128 b**\n",
+            "   - **Size:** Similar to Earth, with a minimum mass of 1.35 Earth masses.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of the relatively quiet red dwarf star Ross 128. The planet has mild temperatures that could allow for liquid water.\n",
+            "   - **Distance from Earth:** About 11 light-years.\n",
+            "\n",
+            "9. **Teegarden's Star b**\n",
+            "   - **Size:** Comparable to Earth.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of Teegarden's Star, a cool red dwarf. Conditions could be suitable for liquid water.\n",
+            "   - **Distance from Earth:** Approximately 12 light-years.\n",
+            "\n",
+            "10. **Barnard's Star b**\n",
+            "    - **Size:** A super-Earth with a mass of about 3.2 Earth masses.\n",
+            "    - **Potential Habitability:** Located just outside the traditional habitable zone, but still within a range where liquid water could exist under certain conditions.\n",
+            "    - **Distance from Earth:** About 6 light-years.\n",
+            "\n",
+            "These discoveries highlight the diverse and intriguing nature of exoplanets found in the last decade. Each of these planets adds valuable information to our understanding of planetary formation, potential habitability, and the search for extraterrestrial life. Continued advancements in detection methods and technologies promise to further expand our knowledge in the years to come.\u001b[0m\n",
+            "\n",
+            "\u001b[1m> Finished chain.\u001b[0m\n",
+            "\u001b[1m\u001b[92m [2024-07-03 04:39:25][DEBUG]: == [Space Researcher] Task output: In the last decade, the field of exoplanet research has experienced a remarkable surge in discoveries, thanks to advancements in technology and dedicated space missions such as Kepler, TESS (Transiting Exoplanet Survey Satellite), and various ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, highlighting their size, potential habitability, and distance from Earth:\n",
+            "\n",
+            "1. **Kepler-452b**\n",
+            "   - **Size:** Approximately 60% larger in diameter than Earth.\n",
+            "   - **Potential Habitability:** Often referred to as \"Earth's Cousin,\" Kepler-452b orbits within the habitable zone of its star, where liquid water could exist. The planet receives a similar amount of energy from its star as Earth does from the Sun.\n",
+            "   - **Distance from Earth:** About 1,402 light-years.\n",
+            "\n",
+            "2. **Proxima Centauri b**\n",
+            "   - **Size:** Slightly larger than Earth, with a minimum mass of 1.17 Earth masses.\n",
+            "   - **Potential Habitability:** Located in the habitable zone of Proxima Centauri, the closest known star to the Sun. Potential for liquid water exists, but its habitability is uncertain due to stellar flare activity.\n",
+            "   - **Distance from Earth:** 4.24 light-years.\n",
+            "\n",
+            "3. **TRAPPIST-1 System**\n",
+            "   - **Size:** The system contains seven Earth-sized planets. TRAPPIST-1e, f, and g are within the star's habitable zone.\n",
+            "   - **Potential Habitability:** TRAPPIST-1e is considered the most promising candidate for habitability, as it has a rocky composition and is located in the middle of the habitable zone.\n",
+            "   - **Distance from Earth:** About 39 light-years.\n",
+            "\n",
+            "4. **LHS 1140 b**\n",
+            "   - **Size:** About 1.4 times the size of Earth with a mass of around 6.6 Earth masses.\n",
+            "   - **Potential Habitability:** Resides in the habitable zone of its red dwarf star. The planet is likely rocky and has an atmosphere that could support life.\n",
+            "   - **Distance from Earth:** Approximately 40 light-years.\n",
+            "\n",
+            "5. **K2-18b**\n",
+            "   - **Size:** About 2.6 times the size of Earth with a mass of 8.6 Earth masses.\n",
+            "   - **Potential Habitability:** This exoplanet lies within the habitable zone and has been detected to have water vapor in its atmosphere. It is considered one of the most promising candidates for habitability outside our solar system.\n",
+            "   - **Distance from Earth:** Roughly 124 light-years.\n",
+            "\n",
+            "6. **Gliese 667 Cc**\n",
+            "   - **Size:** At least 4.5 times the mass of Earth.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of its host star, Gliese 667 C. Its orbit allows for the possibility of liquid water on its surface.\n",
+            "   - **Distance from Earth:** About 23.62 light-years.\n",
+            "\n",
+            "7. **HD 40307 g**\n",
+            "   - **Size:** A super-Earth with at least 7 Earth masses.\n",
+            "   - **Potential Habitability:** Located in the habitable zone of its star, this planet could potentially support liquid water and therefore life.\n",
+            "   - **Distance from Earth:** Approximately 42 light-years.\n",
+            "\n",
+            "8. **Ross 128 b**\n",
+            "   - **Size:** Similar to Earth, with a minimum mass of 1.35 Earth masses.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of the relatively quiet red dwarf star Ross 128. The planet has mild temperatures that could allow for liquid water.\n",
+            "   - **Distance from Earth:** About 11 light-years.\n",
+            "\n",
+            "9. **Teegarden's Star b**\n",
+            "   - **Size:** Comparable to Earth.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of Teegarden's Star, a cool red dwarf. Conditions could be suitable for liquid water.\n",
+            "   - **Distance from Earth:** Approximately 12 light-years.\n",
+            "\n",
+            "10. **Barnard's Star b**\n",
+            "    - **Size:** A super-Earth with a mass of about 3.2 Earth masses.\n",
+            "    - **Potential Habitability:** Located just outside the traditional habitable zone, but still within a range where liquid water could exist under certain conditions.\n",
+            "    - **Distance from Earth:** About 6 light-years.\n",
+            "\n",
+            "These discoveries highlight the diverse and intriguing nature of exoplanets found in the last decade. Each of these planets adds valuable information to our understanding of planetary formation, potential habitability, and the search for extraterrestrial life. Continued advancements in detection methods and technologies promise to further expand our knowledge in the years to come.\n",
+            "\n",
+            "\u001b[00m\n",
+            "### Task Output ###\n",
+            "In the last decade, the field of exoplanet research has experienced a remarkable surge in discoveries, thanks to advancements in technology and dedicated space missions such as Kepler, TESS (Transiting Exoplanet Survey Satellite), and various ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, highlighting their size, potential habitability, and distance from Earth:\n",
+            "\n",
+            "1. **Kepler-452b**\n",
+            "   - **Size:** Approximately 60% larger in diameter than Earth.\n",
+            "   - **Potential Habitability:** Often referred to as \"Earth's Cousin,\" Kepler-452b orbits within the habitable zone of its star, where liquid water could exist. The planet receives a similar amount of energy from its star as Earth does from the Sun.\n",
+            "   - **Distance from Earth:** About 1,402 light-years.\n",
+            "\n",
+            "2. **Proxima Centauri b**\n",
+            "   - **Size:** Slightly larger than Earth, with a minimum mass of 1.17 Earth masses.\n",
+            "   - **Potential Habitability:** Located in the habitable zone of Proxima Centauri, the closest known star to the Sun. Potential for liquid water exists, but its habitability is uncertain due to stellar flare activity.\n",
+            "   - **Distance from Earth:** 4.24 light-years.\n",
+            "\n",
+            "3. **TRAPPIST-1 System**\n",
+            "   - **Size:** The system contains seven Earth-sized planets. TRAPPIST-1e, f, and g are within the star's habitable zone.\n",
+            "   - **Potential Habitability:** TRAPPIST-1e is considered the most promising candidate for habitability, as it has a rocky composition and is located in the middle of the habitable zone.\n",
+            "   - **Distance from Earth:** About 39 light-years.\n",
+            "\n",
+            "4. **LHS 1140 b**\n",
+            "   - **Size:** About 1.4 times the size of Earth with a mass of around 6.6 Earth masses.\n",
+            "   - **Potential Habitability:** Resides in the habitable zone of its red dwarf star. The planet is likely rocky and has an atmosphere that could support life.\n",
+            "   - **Distance from Earth:** Approximately 40 light-years.\n",
+            "\n",
+            "5. **K2-18b**\n",
+            "   - **Size:** About 2.6 times the size of Earth with a mass of 8.6 Earth masses.\n",
+            "   - **Potential Habitability:** This exoplanet lies within the habitable zone and has been detected to have water vapor in its atmosphere. It is considered one of the most promising candidates for habitability outside our solar system.\n",
+            "   - **Distance from Earth:** Roughly 124 light-years.\n",
+            "\n",
+            "6. **Gliese 667 Cc**\n",
+            "   - **Size:** At least 4.5 times the mass of Earth.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of its host star, Gliese 667 C. Its orbit allows for the possibility of liquid water on its surface.\n",
+            "   - **Distance from Earth:** About 23.62 light-years.\n",
+            "\n",
+            "7. **HD 40307 g**\n",
+            "   - **Size:** A super-Earth with at least 7 Earth masses.\n",
+            "   - **Potential Habitability:** Located in the habitable zone of its star, this planet could potentially support liquid water and therefore life.\n",
+            "   - **Distance from Earth:** Approximately 42 light-years.\n",
+            "\n",
+            "8. **Ross 128 b**\n",
+            "   - **Size:** Similar to Earth, with a minimum mass of 1.35 Earth masses.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of the relatively quiet red dwarf star Ross 128. The planet has mild temperatures that could allow for liquid water.\n",
+            "   - **Distance from Earth:** About 11 light-years.\n",
+            "\n",
+            "9. **Teegarden's Star b**\n",
+            "   - **Size:** Comparable to Earth.\n",
+            "   - **Potential Habitability:** Orbits within the habitable zone of Teegarden's Star, a cool red dwarf. Conditions could be suitable for liquid water.\n",
+            "   - **Distance from Earth:** Approximately 12 light-years.\n",
+            "\n",
+            "10. **Barnard's Star b**\n",
+            "    - **Size:** A super-Earth with a mass of about 3.2 Earth masses.\n",
+            "    - **Potential Habitability:** Located just outside the traditional habitable zone, but still within a range where liquid water could exist under certain conditions.\n",
+            "    - **Distance from Earth:** About 6 light-years.\n",
+            "\n",
+            "These discoveries highlight the diverse and intriguing nature of exoplanets found in the last decade. Each of these planets adds valuable information to our understanding of planetary formation, potential habitability, and the search for extraterrestrial life. Continued advancements in detection methods and technologies promise to further expand our knowledge in the years to come.\n"
+          ]
+        }
+      ]
+    }
+  ]
+}

docs/CNAME

@@ -0,0 +1 @@
+docs.praison.ai

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.md

@@ -0,0 +1,6 @@
+# API Reference
+::: praisonai
+::: praisonai.auto
+::: praisonai.agents_generator
+::: praisonai.cli
+::: praisonai.deploy

docs/api/praisonai/agents_generator.html

@@ -0,0 +1,522 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.agents_generator API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.agents_generator</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="praisonai.agents_generator.disable_crewai_telemetry"><code class="name flex">
+<span>def <span class="ident">disable_crewai_telemetry</span></span>(<span>)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.agents_generator.noop"><code class="name flex">
+<span>def <span class="ident">noop</span></span>(<span>*args, **kwargs)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="praisonai.agents_generator.AgentsGenerator"><code class="flex name class">
+<span>class <span class="ident">AgentsGenerator</span></span>
+<span>(</span><span>agent_file, framework, config_list, log_level=None, agent_callback=None, task_callback=None)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Initialize the AgentsGenerator object.</p>
+<h2 id="parameters">Parameters</h2>
+<p>agent_file (str): The path to the agent file.
+framework (str): The framework to be used for the agents.
+config_list (list): A list of configurations for the agents.
+log_level (int, optional): The logging level to use. Defaults to logging.INFO.
+agent_callback (callable, optional): A callback function to be executed after each agent step.
+task_callback (callable, optional): A callback function to be executed after each tool run.</p>
+<h2 id="attributes">Attributes</h2>
+<dl>
+<dt><strong><code>agent_file</code></strong> :&ensp;<code>str</code></dt>
+<dd>The path to the agent file.</dd>
+<dt><strong><code>framework</code></strong> :&ensp;<code>str</code></dt>
+<dd>The framework to be used for the agents.</dd>
+<dt><strong><code>config_list</code></strong> :&ensp;<code>list</code></dt>
+<dd>A list of configurations for the agents.</dd>
+<dt><strong><code>log_level</code></strong> :&ensp;<code>int</code></dt>
+<dd>The logging level to use.</dd>
+<dt><strong><code>agent_callback</code></strong> :&ensp;<code>callable</code>, optional</dt>
+<dd>A callback function to be executed after each agent step.</dd>
+<dt><strong><code>task_callback</code></strong> :&ensp;<code>callable</code>, optional</dt>
+<dd>A callback function to be executed after each tool run.</dd>
+</dl></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class AgentsGenerator:
+    def __init__(self, agent_file, framework, config_list, log_level=None, agent_callback=None, task_callback=None):
+        &#34;&#34;&#34;
+        Initialize the AgentsGenerator object.
+
+        Parameters:
+            agent_file (str): The path to the agent file.
+            framework (str): The framework to be used for the agents.
+            config_list (list): A list of configurations for the agents.
+            log_level (int, optional): The logging level to use. Defaults to logging.INFO.
+            agent_callback (callable, optional): A callback function to be executed after each agent step.
+            task_callback (callable, optional): A callback function to be executed after each tool run.
+
+        Attributes:
+            agent_file (str): The path to the agent file.
+            framework (str): The framework to be used for the agents.
+            config_list (list): A list of configurations for the agents.
+            log_level (int): The logging level to use.
+            agent_callback (callable, optional): A callback function to be executed after each agent step.
+            task_callback (callable, optional): A callback function to be executed after each tool run.
+        &#34;&#34;&#34;
+        self.agent_file = agent_file
+        self.framework = framework
+        self.config_list = config_list
+        self.log_level = log_level
+        self.agent_callback = agent_callback
+        self.task_callback = task_callback
+        self.log_level = log_level or logging.getLogger().getEffectiveLevel()
+        if self.log_level == logging.NOTSET:
+            self.log_level = os.environ.get(&#39;LOGLEVEL&#39;, &#39;INFO&#39;).upper()
+        
+        logging.basicConfig(level=self.log_level, format=&#39;%(asctime)s - %(levelname)s - %(message)s&#39;)
+        self.logger = logging.getLogger(__name__)
+        self.logger.setLevel(self.log_level)
+        
+    def is_function_or_decorated(self, obj):
+        &#34;&#34;&#34;
+        Checks if the given object is a function or has a __call__ method.
+
+        Parameters:
+            obj (object): The object to be checked.
+
+        Returns:
+            bool: True if the object is a function or has a __call__ method, False otherwise.
+        &#34;&#34;&#34;
+        return inspect.isfunction(obj) or hasattr(obj, &#39;__call__&#39;)
+
+    def load_tools_from_module(self, module_path):
+        &#34;&#34;&#34;
+        Loads tools from a specified module path.
+
+        Parameters:
+            module_path (str): The path to the module containing the tools.
+
+        Returns:
+            dict: A dictionary containing the names of the tools as keys and the corresponding functions or objects as values.
+
+        Raises:
+            FileNotFoundError: If the specified module path does not exist.
+        &#34;&#34;&#34;
+        spec = importlib.util.spec_from_file_location(&#34;tools_module&#34;, module_path)
+        module = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(module)
+        return {name: obj for name, obj in inspect.getmembers(module, self.is_function_or_decorated)}
+    
+    def load_tools_from_module_class(self, module_path):
+        &#34;&#34;&#34;
+        Loads tools from a specified module path containing classes that inherit from BaseTool or are part of langchain_community.tools package.
+
+        Parameters:
+            module_path (str): The path to the module containing the tools.
+
+        Returns:
+            dict: A dictionary containing the names of the tools as keys and the corresponding initialized instances of the classes as values.
+
+        Raises:
+            FileNotFoundError: If the specified module path does not exist.
+        &#34;&#34;&#34;
+        spec = importlib.util.spec_from_file_location(&#34;tools_module&#34;, module_path)
+        module = importlib.util.module_from_spec(spec)
+        spec.loader.exec_module(module)
+        return {name: obj() for name, obj in inspect.getmembers(module, lambda x: inspect.isclass(x) and (x.__module__.startswith(&#39;langchain_community.tools&#39;) or issubclass(x, BaseTool)) and x is not BaseTool)}
+
+    def load_tools_from_package(self, package_path):
+        &#34;&#34;&#34;
+        Loads tools from a specified package path containing modules with functions or classes.
+
+        Parameters:
+            package_path (str): The path to the package containing the tools.
+
+        Returns:
+            dict: A dictionary containing the names of the tools as keys and the corresponding initialized instances of the classes as values.
+
+        Raises:
+            FileNotFoundError: If the specified package path does not exist.
+
+        This function iterates through all the .py files in the specified package path, excluding those that start with &#34;__&#34;. For each file, it imports the corresponding module and checks if it contains any functions or classes that can be loaded as tools. The function then returns a dictionary containing the names of the tools as keys and the corresponding initialized instances of the classes as values.
+        &#34;&#34;&#34;
+        tools_dict = {}
+        for module_file in os.listdir(package_path):
+            if module_file.endswith(&#39;.py&#39;) and not module_file.startswith(&#39;__&#39;):
+                module_name = f&#34;{package_path.name}.{module_file[:-3]}&#34;  # Remove .py for import
+                module = importlib.import_module(module_name)
+                for name, obj in inspect.getmembers(module, self.is_function_or_decorated):
+                    tools_dict[name] = obj
+        return tools_dict
+
+    def generate_crew_and_kickoff(self):
+        &#34;&#34;&#34;
+        Generates a crew of agents and initiates tasks based on the provided configuration.
+
+        Parameters:
+            agent_file (str): The path to the agent file.
+            framework (str): The framework to be used for the agents.
+            config_list (list): A list of configurations for the agents.
+
+        Returns:
+            str: The output of the tasks performed by the crew of agents.
+
+        Raises:
+            FileNotFoundError: If the specified agent file does not exist.
+
+        This function first loads the agent configuration from the specified file. It then initializes the tools required for the agents based on the specified framework. If the specified framework is &#34;autogen&#34;, it loads the LLM configuration dynamically and creates an AssistantAgent for each role in the configuration. It then adds tools to the agents if specified in the configuration. Finally, it prepares tasks for the agents based on the configuration and initiates the tasks using the crew of agents. If the specified framework is not &#34;autogen&#34;, it creates a crew of agents and initiates tasks based on the configuration.
+        &#34;&#34;&#34;
+        if self.agent_file == &#39;/app/api:app&#39; or self.agent_file == &#39;api:app&#39;:
+            self.agent_file = &#39;agents.yaml&#39;
+        try:
+            with open(self.agent_file, &#39;r&#39;) as f:
+                config = yaml.safe_load(f)
+        except FileNotFoundError:
+            print(f&#34;File not found: {self.agent_file}&#34;)
+            return
+
+        topic = config[&#39;topic&#39;]
+        tools_dict = {
+            &#39;CodeDocsSearchTool&#39;: CodeDocsSearchTool(),
+            &#39;CSVSearchTool&#39;: CSVSearchTool(),
+            &#39;DirectorySearchTool&#39;: DirectorySearchTool(),
+            &#39;DOCXSearchTool&#39;: DOCXSearchTool(),
+            &#39;DirectoryReadTool&#39;: DirectoryReadTool(),
+            &#39;FileReadTool&#39;: FileReadTool(),
+            # &#39;GithubSearchTool&#39;: GithubSearchTool(),
+            # &#39;SeperDevTool&#39;: SeperDevTool(),
+            &#39;TXTSearchTool&#39;: TXTSearchTool(),
+            &#39;JSONSearchTool&#39;: JSONSearchTool(),
+            &#39;MDXSearchTool&#39;: MDXSearchTool(),
+            &#39;PDFSearchTool&#39;: PDFSearchTool(),
+            # &#39;PGSearchTool&#39;: PGSearchTool(),
+            &#39;RagTool&#39;: RagTool(),
+            &#39;ScrapeElementFromWebsiteTool&#39;: ScrapeElementFromWebsiteTool(),
+            &#39;ScrapeWebsiteTool&#39;: ScrapeWebsiteTool(),
+            &#39;WebsiteSearchTool&#39;: WebsiteSearchTool(),
+            &#39;XMLSearchTool&#39;: XMLSearchTool(),
+            &#39;YoutubeChannelSearchTool&#39;: YoutubeChannelSearchTool(),
+            &#39;YoutubeVideoSearchTool&#39;: YoutubeVideoSearchTool(),
+        }
+        root_directory = os.getcwd()
+        tools_py_path = os.path.join(root_directory, &#39;tools.py&#39;)
+        tools_dir_path = Path(root_directory) / &#39;tools&#39;
+        
+        if os.path.isfile(tools_py_path):
+            tools_dict.update(self.load_tools_from_module_class(tools_py_path))
+            self.logger.debug(&#34;tools.py exists in the root directory. Loading tools.py and skipping tools folder.&#34;)
+        elif tools_dir_path.is_dir():
+            tools_dict.update(self.load_tools_from_module_class(tools_dir_path))
+            self.logger.debug(&#34;tools folder exists in the root directory&#34;)
+        
+        framework = self.framework or config.get(&#39;framework&#39;)
+
+        agents = {}
+        tasks = []
+        if framework == &#34;autogen&#34;:
+            # Load the LLM configuration dynamically
+            # print(self.config_list)
+            llm_config = {&#34;config_list&#34;: self.config_list}
+            
+            if agentops_exists:
+                agentops.init(os.environ.get(&#34;AGENTOPS_API_KEY&#34;), tags=[&#34;autogen&#34;])
+            # Assuming the user proxy agent is set up as per your requirements
+            user_proxy = autogen.UserProxyAgent(
+                name=&#34;User&#34;,
+                human_input_mode=&#34;NEVER&#34;,
+                is_termination_msg=lambda x: (x.get(&#34;content&#34;) or &#34;&#34;).rstrip().rstrip(&#34;.&#34;).lower().endswith(&#34;terminate&#34;) or &#34;TERMINATE&#34; in (x.get(&#34;content&#34;) or &#34;&#34;),
+                code_execution_config={
+                    &#34;work_dir&#34;: &#34;coding&#34;,
+                    &#34;use_docker&#34;: False,
+                },
+                # additional setup for the user proxy agent
+            )
+            
+            for role, details in config[&#39;roles&#39;].items():
+                agent_name = details[&#39;role&#39;].format(topic=topic).replace(&#34;{topic}&#34;, topic)
+                agent_goal = details[&#39;goal&#39;].format(topic=topic)
+                # Creating an AssistantAgent for each role dynamically
+                agents[role] = autogen.AssistantAgent(
+                    name=agent_name,
+                    llm_config=llm_config,
+                    system_message=details[&#39;backstory&#39;].format(topic=topic)+&#34;. Must Reply \&#34;TERMINATE\&#34; in the end when everything is done.&#34;,
+                )
+                for tool in details.get(&#39;tools&#39;, []):
+                    if tool in tools_dict:
+                        try:
+                            tool_class = globals()[f&#39;autogen_{type(tools_dict[tool]).__name__}&#39;]
+                            print(f&#34;Found {tool_class.__name__} for {tool}&#34;)
+                        except KeyError:
+                            print(f&#34;Warning: autogen_{type(tools_dict[tool]).__name__} function not found. Skipping this tool.&#34;)
+                            continue
+                        tool_class(agents[role], user_proxy)
+
+                # Preparing tasks for initiate_chats
+                for task_name, task_details in details.get(&#39;tasks&#39;, {}).items():
+                    description_filled = task_details[&#39;description&#39;].format(topic=topic)
+                    expected_output_filled = task_details[&#39;expected_output&#39;].format(topic=topic)
+                    
+                    chat_task = {
+                        &#34;recipient&#34;: agents[role],
+                        &#34;message&#34;: description_filled,
+                        &#34;summary_method&#34;: &#34;last_msg&#34;, 
+                        # Additional fields like carryover can be added based on dependencies
+                    }
+                    tasks.append(chat_task)
+            response = user_proxy.initiate_chats(tasks)
+            result = &#34;### Output ###\n&#34;+response[-1].summary if hasattr(response[-1], &#39;summary&#39;) else &#34;&#34;
+            if agentops_exists:
+                agentops.end_session(&#34;Success&#34;)
+        else: # framework=crewai
+            if agentops_exists:
+                agentops.init(os.environ.get(&#34;AGENTOPS_API_KEY&#34;), tags=[&#34;crewai&#34;])
+            for role, details in config[&#39;roles&#39;].items():
+                role_filled = details[&#39;role&#39;].format(topic=topic)
+                goal_filled = details[&#39;goal&#39;].format(topic=topic)
+                backstory_filled = details[&#39;backstory&#39;].format(topic=topic)
+                
+                # Adding tools to the agent if exists
+                agent_tools = [tools_dict[tool] for tool in details.get(&#39;tools&#39;, []) if tool in tools_dict]
+                
+                llm_model = details.get(&#39;llm&#39;)  # Get the llm configuration
+                if llm_model:
+                    llm = PraisonAIModel(
+                        model=llm_model.get(&#34;model&#34;, os.environ.get(&#34;MODEL_NAME&#34;, &#34;openai/gpt-4o&#34;)),
+                    ).get_model()
+                else:
+                    llm = PraisonAIModel().get_model()
+
+                function_calling_llm_model = details.get(&#39;function_calling_llm&#39;)
+                if function_calling_llm_model:
+                    function_calling_llm = PraisonAIModel(
+                        model=function_calling_llm_model.get(&#34;model&#34;, os.environ.get(&#34;MODEL_NAME&#34;, &#34;openai/gpt-4o&#34;)),
+                    ).get_model()
+                else:
+                    function_calling_llm = PraisonAIModel().get_model()
+                
+                agent = Agent(
+                    role=role_filled, 
+                    goal=goal_filled, 
+                    backstory=backstory_filled, 
+                    tools=agent_tools, 
+                    allow_delegation=details.get(&#39;allow_delegation&#39;, False),
+                    llm=llm,
+                    function_calling_llm=function_calling_llm,
+                    max_iter=details.get(&#39;max_iter&#39;, 15),
+                    max_rpm=details.get(&#39;max_rpm&#39;),
+                    max_execution_time=details.get(&#39;max_execution_time&#39;),
+                    verbose=details.get(&#39;verbose&#39;, True),
+                    cache=details.get(&#39;cache&#39;, True),
+                    system_template=details.get(&#39;system_template&#39;),
+                    prompt_template=details.get(&#39;prompt_template&#39;),
+                    response_template=details.get(&#39;response_template&#39;),
+                )
+                
+                # Set agent callback if provided
+                if self.agent_callback:
+                    agent.step_callback = self.agent_callback
+
+                agents[role] = agent
+
+                for task_name, task_details in details.get(&#39;tasks&#39;, {}).items():
+                    description_filled = task_details[&#39;description&#39;].format(topic=topic)
+                    expected_output_filled = task_details[&#39;expected_output&#39;].format(topic=topic)
+
+                    task = Task(description=description_filled, expected_output=expected_output_filled, agent=agent)
+                    
+                    # Set tool callback if provided
+                    if self.task_callback:
+                        task.callback = self.task_callback
+
+                    tasks.append(task)
+            
+            crew = Crew(
+                agents=list(agents.values()),
+                tasks=tasks,
+                verbose=2
+            )
+            
+            self.logger.debug(&#34;Final Crew Configuration:&#34;)
+            self.logger.debug(f&#34;Agents: {crew.agents}&#34;)
+            self.logger.debug(f&#34;Tasks: {crew.tasks}&#34;)
+
+            response = crew.kickoff()
+            result = f&#34;### Task Output ###\n{response}&#34;
+            if agentops_exists:
+                agentops.end_session(&#34;Success&#34;)
+        return result</code></pre>
+</details>
+<h3>Methods</h3>
+<dl>
+<dt id="praisonai.agents_generator.AgentsGenerator.generate_crew_and_kickoff"><code class="name flex">
+<span>def <span class="ident">generate_crew_and_kickoff</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Generates a crew of agents and initiates tasks based on the provided configuration.</p>
+<h2 id="parameters">Parameters</h2>
+<p>agent_file (str): The path to the agent file.
+framework (str): The framework to be used for the agents.
+config_list (list): A list of configurations for the agents.</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>str</code></dt>
+<dd>The output of the tasks performed by the crew of agents.</dd>
+</dl>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code>FileNotFoundError</code></dt>
+<dd>If the specified agent file does not exist.</dd>
+</dl>
+<p>This function first loads the agent configuration from the specified file. It then initializes the tools required for the agents based on the specified framework. If the specified framework is "autogen", it loads the LLM configuration dynamically and creates an AssistantAgent for each role in the configuration. It then adds tools to the agents if specified in the configuration. Finally, it prepares tasks for the agents based on the configuration and initiates the tasks using the crew of agents. If the specified framework is not "autogen", it creates a crew of agents and initiates tasks based on the configuration.</p></div>
+</dd>
+<dt id="praisonai.agents_generator.AgentsGenerator.is_function_or_decorated"><code class="name flex">
+<span>def <span class="ident">is_function_or_decorated</span></span>(<span>self, obj)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Checks if the given object is a function or has a <strong>call</strong> method.</p>
+<h2 id="parameters">Parameters</h2>
+<p>obj (object): The object to be checked.</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>bool</code></dt>
+<dd>True if the object is a function or has a <strong>call</strong> method, False otherwise.</dd>
+</dl></div>
+</dd>
+<dt id="praisonai.agents_generator.AgentsGenerator.load_tools_from_module"><code class="name flex">
+<span>def <span class="ident">load_tools_from_module</span></span>(<span>self, module_path)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Loads tools from a specified module path.</p>
+<h2 id="parameters">Parameters</h2>
+<p>module_path (str): The path to the module containing the tools.</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>dict</code></dt>
+<dd>A dictionary containing the names of the tools as keys and the corresponding functions or objects as values.</dd>
+</dl>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code>FileNotFoundError</code></dt>
+<dd>If the specified module path does not exist.</dd>
+</dl></div>
+</dd>
+<dt id="praisonai.agents_generator.AgentsGenerator.load_tools_from_module_class"><code class="name flex">
+<span>def <span class="ident">load_tools_from_module_class</span></span>(<span>self, module_path)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Loads tools from a specified module path containing classes that inherit from BaseTool or are part of langchain_community.tools package.</p>
+<h2 id="parameters">Parameters</h2>
+<p>module_path (str): The path to the module containing the tools.</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>dict</code></dt>
+<dd>A dictionary containing the names of the tools as keys and the corresponding initialized instances of the classes as values.</dd>
+</dl>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code>FileNotFoundError</code></dt>
+<dd>If the specified module path does not exist.</dd>
+</dl></div>
+</dd>
+<dt id="praisonai.agents_generator.AgentsGenerator.load_tools_from_package"><code class="name flex">
+<span>def <span class="ident">load_tools_from_package</span></span>(<span>self, package_path)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Loads tools from a specified package path containing modules with functions or classes.</p>
+<h2 id="parameters">Parameters</h2>
+<p>package_path (str): The path to the package containing the tools.</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>dict</code></dt>
+<dd>A dictionary containing the names of the tools as keys and the corresponding initialized instances of the classes as values.</dd>
+</dl>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code>FileNotFoundError</code></dt>
+<dd>If the specified package path does not exist.</dd>
+</dl>
+<p>This function iterates through all the .py files in the specified package path, excluding those that start with "__". For each file, it imports the corresponding module and checks if it contains any functions or classes that can be loaded as tools. The function then returns a dictionary containing the names of the tools as keys and the corresponding initialized instances of the classes as values.</p></div>
+</dd>
+</dl>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai" href="index.html">praisonai</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="praisonai.agents_generator.disable_crewai_telemetry" href="#praisonai.agents_generator.disable_crewai_telemetry">disable_crewai_telemetry</a></code></li>
+<li><code><a title="praisonai.agents_generator.noop" href="#praisonai.agents_generator.noop">noop</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="praisonai.agents_generator.AgentsGenerator" href="#praisonai.agents_generator.AgentsGenerator">AgentsGenerator</a></code></h4>
+<ul class="">
+<li><code><a title="praisonai.agents_generator.AgentsGenerator.generate_crew_and_kickoff" href="#praisonai.agents_generator.AgentsGenerator.generate_crew_and_kickoff">generate_crew_and_kickoff</a></code></li>
+<li><code><a title="praisonai.agents_generator.AgentsGenerator.is_function_or_decorated" href="#praisonai.agents_generator.AgentsGenerator.is_function_or_decorated">is_function_or_decorated</a></code></li>
+<li><code><a title="praisonai.agents_generator.AgentsGenerator.load_tools_from_module" href="#praisonai.agents_generator.AgentsGenerator.load_tools_from_module">load_tools_from_module</a></code></li>
+<li><code><a title="praisonai.agents_generator.AgentsGenerator.load_tools_from_module_class" href="#praisonai.agents_generator.AgentsGenerator.load_tools_from_module_class">load_tools_from_module_class</a></code></li>
+<li><code><a title="praisonai.agents_generator.AgentsGenerator.load_tools_from_package" href="#praisonai.agents_generator.AgentsGenerator.load_tools_from_package">load_tools_from_package</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/auto.html

@@ -0,0 +1,622 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.auto API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.auto</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="praisonai.auto.AutoGenerator"><code class="flex name class">
+<span>class <span class="ident">AutoGenerator</span></span>
+<span>(</span><span>topic='Movie Story writing about AI', agent_file='test.yaml', framework='crewai', config_list: Optional[List[Dict]] = None)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Initialize the AutoGenerator class with the specified topic, agent file, and framework.
+Note: autogen framework is different from this AutoGenerator class.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>topic</code></strong> :&ensp;<code>str</code>, optional</dt>
+<dd>The topic for the generated team structure. Defaults to "Movie Story writing about AI".</dd>
+<dt><strong><code>agent_file</code></strong> :&ensp;<code>str</code>, optional</dt>
+<dd>The name of the YAML file to save the generated team structure. Defaults to "test.yaml".</dd>
+<dt><strong><code>framework</code></strong> :&ensp;<code>str</code>, optional</dt>
+<dd>The framework for the generated team structure. Defaults to "crewai".</dd>
+<dt><strong><code>config_list</code></strong> :&ensp;<code>Optional[List[Dict]]</code>, optional</dt>
+<dd>A list containing the configuration details for the OpenAI API.
+If None, it defaults to using environment variables or hardcoded values.</dd>
+</dl>
+<h2 id="attributes">Attributes</h2>
+<dl>
+<dt><strong><code>config_list</code></strong> :&ensp;<code>list</code></dt>
+<dd>A list containing the configuration details for the OpenAI API.</dd>
+<dt><strong><code>topic</code></strong> :&ensp;<code>str</code></dt>
+<dd>The specified topic for the generated team structure.</dd>
+<dt><strong><code>agent_file</code></strong> :&ensp;<code>str</code></dt>
+<dd>The specified name of the YAML file to save the generated team structure.</dd>
+<dt><strong><code>framework</code></strong> :&ensp;<code>str</code></dt>
+<dd>The specified framework for the generated team structure.</dd>
+<dt><strong><code>client</code></strong> :&ensp;<code>instructor.Client</code></dt>
+<dd>An instance of the instructor.Client class initialized with the specified OpenAI API configuration.</dd>
+</dl></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class AutoGenerator:
+    def __init__(self, topic=&#34;Movie Story writing about AI&#34;, agent_file=&#34;test.yaml&#34;, framework=&#34;crewai&#34;, config_list: Optional[List[Dict]] = None):
+        &#34;&#34;&#34;
+        Initialize the AutoGenerator class with the specified topic, agent file, and framework.
+        Note: autogen framework is different from this AutoGenerator class.
+
+        Args:
+            topic (str, optional): The topic for the generated team structure. Defaults to &#34;Movie Story writing about AI&#34;.
+            agent_file (str, optional): The name of the YAML file to save the generated team structure. Defaults to &#34;test.yaml&#34;.
+            framework (str, optional): The framework for the generated team structure. Defaults to &#34;crewai&#34;.
+            config_list (Optional[List[Dict]], optional): A list containing the configuration details for the OpenAI API. 
+                                                          If None, it defaults to using environment variables or hardcoded values.
+        Attributes:
+            config_list (list): A list containing the configuration details for the OpenAI API.
+            topic (str): The specified topic for the generated team structure.
+            agent_file (str): The specified name of the YAML file to save the generated team structure.
+            framework (str): The specified framework for the generated team structure.
+            client (instructor.Client): An instance of the instructor.Client class initialized with the specified OpenAI API configuration.
+        &#34;&#34;&#34;
+        self.config_list = config_list or [
+            {
+                &#39;model&#39;: os.environ.get(&#34;OPENAI_MODEL_NAME&#34;, &#34;gpt-4o&#34;),
+                &#39;base_url&#39;: os.environ.get(&#34;OPENAI_API_BASE&#34;, &#34;https://api.openai.com/v1&#34;),
+                &#39;api_key&#39;: os.environ.get(&#34;OPENAI_API_KEY&#34;)
+            }
+        ]
+        self.topic = topic
+        self.agent_file = agent_file
+        self.framework = framework or &#34;crewai&#34;
+        self.client = instructor.patch(
+            OpenAI(
+                base_url=self.config_list[0][&#39;base_url&#39;],
+                api_key=os.getenv(&#34;OPENAI_API_KEY&#34;),
+            ),
+            mode=instructor.Mode.JSON,
+        )
+
+    def generate(self):
+        &#34;&#34;&#34;
+        Generates a team structure for the specified topic.
+
+        Args:
+            None
+
+        Returns:
+            str: The full path of the YAML file containing the generated team structure.
+
+        Raises:
+            Exception: If the generation process fails.
+
+        Usage:
+            generator = AutoGenerator(framework=&#34;crewai&#34;, topic=&#34;Create a movie script about Cat in Mars&#34;)
+            path = generator.generate()
+            print(path)
+        &#34;&#34;&#34;
+        response = self.client.chat.completions.create(
+            model=self.config_list[0][&#39;model&#39;],
+            response_model=TeamStructure,
+            max_retries=10,
+            messages=[
+                {&#34;role&#34;: &#34;system&#34;, &#34;content&#34;: &#34;You are a helpful assistant designed to output complex team structures.&#34;},
+                {&#34;role&#34;: &#34;user&#34;, &#34;content&#34;: self.get_user_content()}
+            ]
+        )
+        json_data = json.loads(response.model_dump_json())
+        self.convert_and_save(json_data)
+        full_path = os.path.abspath(self.agent_file)
+        return full_path
+
+    def convert_and_save(self, json_data):
+        &#34;&#34;&#34;Converts the provided JSON data into the desired YAML format and saves it to a file.
+
+        Args:
+            json_data (dict): The JSON data representing the team structure.
+            topic (str, optional): The topic to be inserted into the YAML. Defaults to &#34;Artificial Intelligence&#34;.
+            agent_file (str, optional): The name of the YAML file to save. Defaults to &#34;test.yaml&#34;.
+        &#34;&#34;&#34;
+
+        yaml_data = {
+            &#34;framework&#34;: self.framework,
+            &#34;topic&#34;: self.topic,
+            &#34;roles&#34;: {},
+            &#34;dependencies&#34;: []
+        }
+
+        for role_id, role_details in json_data[&#39;roles&#39;].items():
+            yaml_data[&#39;roles&#39;][role_id] = {
+                &#34;backstory&#34;: &#34;&#34; + role_details[&#39;backstory&#39;],
+                &#34;goal&#34;: role_details[&#39;goal&#39;],
+                &#34;role&#34;: role_details[&#39;role&#39;],
+                &#34;tasks&#34;: {},
+                # &#34;tools&#34;: role_details.get(&#39;tools&#39;, []),
+                &#34;tools&#34;: [&#39;&#39;]
+            }
+
+            for task_id, task_details in role_details[&#39;tasks&#39;].items():
+                yaml_data[&#39;roles&#39;][role_id][&#39;tasks&#39;][task_id] = {
+                    &#34;description&#34;: &#34;&#34; + task_details[&#39;description&#39;],
+                    &#34;expected_output&#34;: &#34;&#34; + task_details[&#39;expected_output&#39;]
+                }
+
+        # Save to YAML file, maintaining the order
+        with open(self.agent_file, &#39;w&#39;) as f:
+            yaml.dump(yaml_data, f, allow_unicode=True, sort_keys=False)
+
+    def get_user_content(self):
+        &#34;&#34;&#34;
+        Generates a prompt for the OpenAI API to generate a team structure.
+
+        Args:
+            None
+
+        Returns:
+            str: The prompt for the OpenAI API.
+
+        Usage:
+            generator = AutoGenerator(framework=&#34;crewai&#34;, topic=&#34;Create a movie script about Cat in Mars&#34;)
+            prompt = generator.get_user_content()
+            print(prompt)
+        &#34;&#34;&#34;
+        user_content = &#34;&#34;&#34;Generate a team structure for  \&#34;&#34;&#34;&#34; + self.topic + &#34;&#34;&#34;\&#34; task. 
+No Input data will be provided to the team.
+The team will work in sequence. First role will pass the output to the next role, and so on.
+The last role will generate the final output.
+Think step by step.
+With maximum 3 roles, each with 1 task. Include role goals, backstories, task descriptions, and expected outputs.
+List of Available Tools: CodeDocsSearchTool, CSVSearchTool, DirectorySearchTool, DOCXSearchTool, DirectoryReadTool, FileReadTool, TXTSearchTool, JSONSearchTool, MDXSearchTool, PDFSearchTool, RagTool, ScrapeElementFromWebsiteTool, ScrapeWebsiteTool, WebsiteSearchTool, XMLSearchTool, YoutubeChannelSearchTool, YoutubeVideoSearchTool.
+Only use Available Tools. Do Not use any other tools. 
+Example Below: 
+Use below example to understand the structure of the output. 
+The final role you create should satisfy the provided task: &#34;&#34;&#34; + self.topic + &#34;&#34;&#34;.
+{
+&#34;roles&#34;: {
+&#34;narrative_designer&#34;: {
+&#34;role&#34;: &#34;Narrative Designer&#34;,
+&#34;goal&#34;: &#34;Create AI storylines&#34;,
+&#34;backstory&#34;: &#34;Skilled in narrative development for AI, with a focus on story resonance.&#34;,
+&#34;tools&#34;: [&#34;ScrapeWebsiteTool&#34;],
+&#34;tasks&#34;: {
+&#34;story_concept_development&#34;: {
+&#34;description&#34;: &#34;Craft a unique AI story concept with depth and engagement using concept from this page the content https://www.asthebirdfliesblog.com/posts/how-to-write-book-story-development .&#34;,
+&#34;expected_output&#34;: &#34;Document with narrative arcs, character bios, and settings.&#34;
+}
+}
+},
+&#34;scriptwriter&#34;: {
+&#34;role&#34;: &#34;Scriptwriter&#34;,
+&#34;goal&#34;: &#34;Write scripts from AI concepts&#34;,
+&#34;backstory&#34;: &#34;Expert in dialogue and script structure, translating concepts into scripts.&#34;,
+&#34;tasks&#34;: {
+&#34;scriptwriting_task&#34;: {
+&#34;description&#34;: &#34;Turn narrative concepts into scripts, including dialogue and scenes.&#34;,
+&#34;expected_output&#34;: &#34;Production-ready script with dialogue and scene details.&#34;
+}
+}
+}
+}
+}
+        &#34;&#34;&#34;
+        return user_content</code></pre>
+</details>
+<h3>Methods</h3>
+<dl>
+<dt id="praisonai.auto.AutoGenerator.convert_and_save"><code class="name flex">
+<span>def <span class="ident">convert_and_save</span></span>(<span>self, json_data)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Converts the provided JSON data into the desired YAML format and saves it to a file.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>json_data</code></strong> :&ensp;<code>dict</code></dt>
+<dd>The JSON data representing the team structure.</dd>
+<dt><strong><code>topic</code></strong> :&ensp;<code>str</code>, optional</dt>
+<dd>The topic to be inserted into the YAML. Defaults to "Artificial Intelligence".</dd>
+<dt><strong><code>agent_file</code></strong> :&ensp;<code>str</code>, optional</dt>
+<dd>The name of the YAML file to save. Defaults to "test.yaml".</dd>
+</dl></div>
+</dd>
+<dt id="praisonai.auto.AutoGenerator.generate"><code class="name flex">
+<span>def <span class="ident">generate</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Generates a team structure for the specified topic.</p>
+<h2 id="args">Args</h2>
+<p>None</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>str</code></dt>
+<dd>The full path of the YAML file containing the generated team structure.</dd>
+</dl>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code>Exception</code></dt>
+<dd>If the generation process fails.</dd>
+</dl>
+<h2 id="usage">Usage</h2>
+<p>generator = AutoGenerator(framework="crewai", topic="Create a movie script about Cat in Mars")
+path = generator.generate()
+print(path)</p></div>
+</dd>
+<dt id="praisonai.auto.AutoGenerator.get_user_content"><code class="name flex">
+<span>def <span class="ident">get_user_content</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Generates a prompt for the OpenAI API to generate a team structure.</p>
+<h2 id="args">Args</h2>
+<p>None</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>str</code></dt>
+<dd>The prompt for the OpenAI API.</dd>
+</dl>
+<h2 id="usage">Usage</h2>
+<p>generator = AutoGenerator(framework="crewai", topic="Create a movie script about Cat in Mars")
+prompt = generator.get_user_content()
+print(prompt)</p></div>
+</dd>
+</dl>
+</dd>
+<dt id="praisonai.auto.RoleDetails"><code class="flex name class">
+<span>class <span class="ident">RoleDetails</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Usage docs: <a href="https://docs.pydantic.dev/2.8/concepts/models/">https://docs.pydantic.dev/2.8/concepts/models/</a></p>
+<p>A base class for creating Pydantic models.</p>
+<h2 id="attributes">Attributes</h2>
+<dl>
+<dt><strong><code>__class_vars__</code></strong></dt>
+<dd>The names of classvars defined on the model.</dd>
+<dt><strong><code>__private_attributes__</code></strong></dt>
+<dd>Metadata about the private attributes of the model.</dd>
+<dt><strong><code>__signature__</code></strong></dt>
+<dd>The signature for instantiating the model.</dd>
+<dt><strong><code>__pydantic_complete__</code></strong></dt>
+<dd>Whether model building is completed, or if there are still undefined fields.</dd>
+<dt><strong><code>__pydantic_core_schema__</code></strong></dt>
+<dd>The pydantic-core schema used to build the SchemaValidator and SchemaSerializer.</dd>
+<dt><strong><code>__pydantic_custom_init__</code></strong></dt>
+<dd>Whether the model has a custom <code>__init__</code> function.</dd>
+<dt><strong><code>__pydantic_decorators__</code></strong></dt>
+<dd>Metadata containing the decorators defined on the model.
+This replaces <code>Model.__validators__</code> and <code>Model.__root_validators__</code> from Pydantic V1.</dd>
+<dt><strong><code>__pydantic_generic_metadata__</code></strong></dt>
+<dd>Metadata for generic models; contains data used for a similar purpose to
+<strong>args</strong>, <strong>origin</strong>, <strong>parameters</strong> in typing-module generics. May eventually be replaced by these.</dd>
+<dt><strong><code>__pydantic_parent_namespace__</code></strong></dt>
+<dd>Parent namespace of the model, used for automatic rebuilding of models.</dd>
+<dt><strong><code>__pydantic_post_init__</code></strong></dt>
+<dd>The name of the post-init method for the model, if defined.</dd>
+<dt><strong><code>__pydantic_root_model__</code></strong></dt>
+<dd>Whether the model is a <code>RootModel</code>.</dd>
+<dt><strong><code>__pydantic_serializer__</code></strong></dt>
+<dd>The pydantic-core SchemaSerializer used to dump instances of the model.</dd>
+<dt><strong><code>__pydantic_validator__</code></strong></dt>
+<dd>The pydantic-core SchemaValidator used to validate instances of the model.</dd>
+<dt><strong><code>__pydantic_extra__</code></strong></dt>
+<dd>An instance attribute with the values of extra fields from validation when
+<code>model_config['extra'] == 'allow'</code>.</dd>
+<dt><strong><code>__pydantic_fields_set__</code></strong></dt>
+<dd>An instance attribute with the names of fields explicitly set.</dd>
+<dt><strong><code>__pydantic_private__</code></strong></dt>
+<dd>Instance attribute with the values of private attributes set on the model instance.</dd>
+</dl>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
+validated to form a valid model.</p>
+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class RoleDetails(BaseModel):
+    role: str
+    goal: str
+    backstory: str
+    tasks: Dict[str, TaskDetails]
+    tools: List[str]</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.main.BaseModel</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="praisonai.auto.RoleDetails.backstory"><code class="name">var <span class="ident">backstory</span> : str</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.RoleDetails.goal"><code class="name">var <span class="ident">goal</span> : str</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.RoleDetails.model_computed_fields"><code class="name">var <span class="ident">model_computed_fields</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.RoleDetails.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.RoleDetails.model_fields"><code class="name">var <span class="ident">model_fields</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.RoleDetails.role"><code class="name">var <span class="ident">role</span> : str</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.RoleDetails.tasks"><code class="name">var <span class="ident">tasks</span> : Dict[str, <a title="praisonai.auto.TaskDetails" href="#praisonai.auto.TaskDetails">TaskDetails</a>]</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.RoleDetails.tools"><code class="name">var <span class="ident">tools</span> : List[str]</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</dd>
+<dt id="praisonai.auto.TaskDetails"><code class="flex name class">
+<span>class <span class="ident">TaskDetails</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Usage docs: <a href="https://docs.pydantic.dev/2.8/concepts/models/">https://docs.pydantic.dev/2.8/concepts/models/</a></p>
+<p>A base class for creating Pydantic models.</p>
+<h2 id="attributes">Attributes</h2>
+<dl>
+<dt><strong><code>__class_vars__</code></strong></dt>
+<dd>The names of classvars defined on the model.</dd>
+<dt><strong><code>__private_attributes__</code></strong></dt>
+<dd>Metadata about the private attributes of the model.</dd>
+<dt><strong><code>__signature__</code></strong></dt>
+<dd>The signature for instantiating the model.</dd>
+<dt><strong><code>__pydantic_complete__</code></strong></dt>
+<dd>Whether model building is completed, or if there are still undefined fields.</dd>
+<dt><strong><code>__pydantic_core_schema__</code></strong></dt>
+<dd>The pydantic-core schema used to build the SchemaValidator and SchemaSerializer.</dd>
+<dt><strong><code>__pydantic_custom_init__</code></strong></dt>
+<dd>Whether the model has a custom <code>__init__</code> function.</dd>
+<dt><strong><code>__pydantic_decorators__</code></strong></dt>
+<dd>Metadata containing the decorators defined on the model.
+This replaces <code>Model.__validators__</code> and <code>Model.__root_validators__</code> from Pydantic V1.</dd>
+<dt><strong><code>__pydantic_generic_metadata__</code></strong></dt>
+<dd>Metadata for generic models; contains data used for a similar purpose to
+<strong>args</strong>, <strong>origin</strong>, <strong>parameters</strong> in typing-module generics. May eventually be replaced by these.</dd>
+<dt><strong><code>__pydantic_parent_namespace__</code></strong></dt>
+<dd>Parent namespace of the model, used for automatic rebuilding of models.</dd>
+<dt><strong><code>__pydantic_post_init__</code></strong></dt>
+<dd>The name of the post-init method for the model, if defined.</dd>
+<dt><strong><code>__pydantic_root_model__</code></strong></dt>
+<dd>Whether the model is a <code>RootModel</code>.</dd>
+<dt><strong><code>__pydantic_serializer__</code></strong></dt>
+<dd>The pydantic-core SchemaSerializer used to dump instances of the model.</dd>
+<dt><strong><code>__pydantic_validator__</code></strong></dt>
+<dd>The pydantic-core SchemaValidator used to validate instances of the model.</dd>
+<dt><strong><code>__pydantic_extra__</code></strong></dt>
+<dd>An instance attribute with the values of extra fields from validation when
+<code>model_config['extra'] == 'allow'</code>.</dd>
+<dt><strong><code>__pydantic_fields_set__</code></strong></dt>
+<dd>An instance attribute with the names of fields explicitly set.</dd>
+<dt><strong><code>__pydantic_private__</code></strong></dt>
+<dd>Instance attribute with the values of private attributes set on the model instance.</dd>
+</dl>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
+validated to form a valid model.</p>
+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class TaskDetails(BaseModel):
+    description: str
+    expected_output: str</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.main.BaseModel</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="praisonai.auto.TaskDetails.description"><code class="name">var <span class="ident">description</span> : str</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.TaskDetails.expected_output"><code class="name">var <span class="ident">expected_output</span> : str</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.TaskDetails.model_computed_fields"><code class="name">var <span class="ident">model_computed_fields</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.TaskDetails.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.TaskDetails.model_fields"><code class="name">var <span class="ident">model_fields</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</dd>
+<dt id="praisonai.auto.TeamStructure"><code class="flex name class">
+<span>class <span class="ident">TeamStructure</span></span>
+<span>(</span><span>**data: Any)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Usage docs: <a href="https://docs.pydantic.dev/2.8/concepts/models/">https://docs.pydantic.dev/2.8/concepts/models/</a></p>
+<p>A base class for creating Pydantic models.</p>
+<h2 id="attributes">Attributes</h2>
+<dl>
+<dt><strong><code>__class_vars__</code></strong></dt>
+<dd>The names of classvars defined on the model.</dd>
+<dt><strong><code>__private_attributes__</code></strong></dt>
+<dd>Metadata about the private attributes of the model.</dd>
+<dt><strong><code>__signature__</code></strong></dt>
+<dd>The signature for instantiating the model.</dd>
+<dt><strong><code>__pydantic_complete__</code></strong></dt>
+<dd>Whether model building is completed, or if there are still undefined fields.</dd>
+<dt><strong><code>__pydantic_core_schema__</code></strong></dt>
+<dd>The pydantic-core schema used to build the SchemaValidator and SchemaSerializer.</dd>
+<dt><strong><code>__pydantic_custom_init__</code></strong></dt>
+<dd>Whether the model has a custom <code>__init__</code> function.</dd>
+<dt><strong><code>__pydantic_decorators__</code></strong></dt>
+<dd>Metadata containing the decorators defined on the model.
+This replaces <code>Model.__validators__</code> and <code>Model.__root_validators__</code> from Pydantic V1.</dd>
+<dt><strong><code>__pydantic_generic_metadata__</code></strong></dt>
+<dd>Metadata for generic models; contains data used for a similar purpose to
+<strong>args</strong>, <strong>origin</strong>, <strong>parameters</strong> in typing-module generics. May eventually be replaced by these.</dd>
+<dt><strong><code>__pydantic_parent_namespace__</code></strong></dt>
+<dd>Parent namespace of the model, used for automatic rebuilding of models.</dd>
+<dt><strong><code>__pydantic_post_init__</code></strong></dt>
+<dd>The name of the post-init method for the model, if defined.</dd>
+<dt><strong><code>__pydantic_root_model__</code></strong></dt>
+<dd>Whether the model is a <code>RootModel</code>.</dd>
+<dt><strong><code>__pydantic_serializer__</code></strong></dt>
+<dd>The pydantic-core SchemaSerializer used to dump instances of the model.</dd>
+<dt><strong><code>__pydantic_validator__</code></strong></dt>
+<dd>The pydantic-core SchemaValidator used to validate instances of the model.</dd>
+<dt><strong><code>__pydantic_extra__</code></strong></dt>
+<dd>An instance attribute with the values of extra fields from validation when
+<code>model_config['extra'] == 'allow'</code>.</dd>
+<dt><strong><code>__pydantic_fields_set__</code></strong></dt>
+<dd>An instance attribute with the names of fields explicitly set.</dd>
+<dt><strong><code>__pydantic_private__</code></strong></dt>
+<dd>Instance attribute with the values of private attributes set on the model instance.</dd>
+</dl>
+<p>Create a new model by parsing and validating input data from keyword arguments.</p>
+<p>Raises [<code>ValidationError</code>][pydantic_core.ValidationError] if the input data cannot be
+validated to form a valid model.</p>
+<p><code>self</code> is explicitly positional-only to allow <code>self</code> as a field name.</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class TeamStructure(BaseModel):
+    roles: Dict[str, RoleDetails]</code></pre>
+</details>
+<h3>Ancestors</h3>
+<ul class="hlist">
+<li>pydantic.main.BaseModel</li>
+</ul>
+<h3>Class variables</h3>
+<dl>
+<dt id="praisonai.auto.TeamStructure.model_computed_fields"><code class="name">var <span class="ident">model_computed_fields</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.TeamStructure.model_config"><code class="name">var <span class="ident">model_config</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.TeamStructure.model_fields"><code class="name">var <span class="ident">model_fields</span></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.auto.TeamStructure.roles"><code class="name">var <span class="ident">roles</span> : Dict[str, <a title="praisonai.auto.RoleDetails" href="#praisonai.auto.RoleDetails">RoleDetails</a>]</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai" href="index.html">praisonai</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="praisonai.auto.AutoGenerator" href="#praisonai.auto.AutoGenerator">AutoGenerator</a></code></h4>
+<ul class="">
+<li><code><a title="praisonai.auto.AutoGenerator.convert_and_save" href="#praisonai.auto.AutoGenerator.convert_and_save">convert_and_save</a></code></li>
+<li><code><a title="praisonai.auto.AutoGenerator.generate" href="#praisonai.auto.AutoGenerator.generate">generate</a></code></li>
+<li><code><a title="praisonai.auto.AutoGenerator.get_user_content" href="#praisonai.auto.AutoGenerator.get_user_content">get_user_content</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="praisonai.auto.RoleDetails" href="#praisonai.auto.RoleDetails">RoleDetails</a></code></h4>
+<ul class="">
+<li><code><a title="praisonai.auto.RoleDetails.backstory" href="#praisonai.auto.RoleDetails.backstory">backstory</a></code></li>
+<li><code><a title="praisonai.auto.RoleDetails.goal" href="#praisonai.auto.RoleDetails.goal">goal</a></code></li>
+<li><code><a title="praisonai.auto.RoleDetails.model_computed_fields" href="#praisonai.auto.RoleDetails.model_computed_fields">model_computed_fields</a></code></li>
+<li><code><a title="praisonai.auto.RoleDetails.model_config" href="#praisonai.auto.RoleDetails.model_config">model_config</a></code></li>
+<li><code><a title="praisonai.auto.RoleDetails.model_fields" href="#praisonai.auto.RoleDetails.model_fields">model_fields</a></code></li>
+<li><code><a title="praisonai.auto.RoleDetails.role" href="#praisonai.auto.RoleDetails.role">role</a></code></li>
+<li><code><a title="praisonai.auto.RoleDetails.tasks" href="#praisonai.auto.RoleDetails.tasks">tasks</a></code></li>
+<li><code><a title="praisonai.auto.RoleDetails.tools" href="#praisonai.auto.RoleDetails.tools">tools</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="praisonai.auto.TaskDetails" href="#praisonai.auto.TaskDetails">TaskDetails</a></code></h4>
+<ul class="">
+<li><code><a title="praisonai.auto.TaskDetails.description" href="#praisonai.auto.TaskDetails.description">description</a></code></li>
+<li><code><a title="praisonai.auto.TaskDetails.expected_output" href="#praisonai.auto.TaskDetails.expected_output">expected_output</a></code></li>
+<li><code><a title="praisonai.auto.TaskDetails.model_computed_fields" href="#praisonai.auto.TaskDetails.model_computed_fields">model_computed_fields</a></code></li>
+<li><code><a title="praisonai.auto.TaskDetails.model_config" href="#praisonai.auto.TaskDetails.model_config">model_config</a></code></li>
+<li><code><a title="praisonai.auto.TaskDetails.model_fields" href="#praisonai.auto.TaskDetails.model_fields">model_fields</a></code></li>
+</ul>
+</li>
+<li>
+<h4><code><a title="praisonai.auto.TeamStructure" href="#praisonai.auto.TeamStructure">TeamStructure</a></code></h4>
+<ul class="">
+<li><code><a title="praisonai.auto.TeamStructure.model_computed_fields" href="#praisonai.auto.TeamStructure.model_computed_fields">model_computed_fields</a></code></li>
+<li><code><a title="praisonai.auto.TeamStructure.model_config" href="#praisonai.auto.TeamStructure.model_config">model_config</a></code></li>
+<li><code><a title="praisonai.auto.TeamStructure.model_fields" href="#praisonai.auto.TeamStructure.model_fields">model_fields</a></code></li>
+<li><code><a title="praisonai.auto.TeamStructure.roles" href="#praisonai.auto.TeamStructure.roles">roles</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/cli.html

@@ -0,0 +1,405 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.cli API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.cli</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="praisonai.cli.PraisonAI"><code class="flex name class">
+<span>class <span class="ident">PraisonAI</span></span>
+<span>(</span><span>agent_file='agents.yaml', framework='', auto=False, init=False)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Initialize the PraisonAI object with default parameters.</p>
+<h2 id="parameters">Parameters</h2>
+<p>agent_file (str): The default agent file to use. Defaults to "agents.yaml".
+framework (str): The default framework to use. Defaults to "crewai".
+auto (bool): A flag indicating whether to enable auto mode. Defaults to False.
+init (bool): A flag indicating whether to enable initialization mode. Defaults to False.</p>
+<h2 id="attributes">Attributes</h2>
+<dl>
+<dt><strong><code>config_list</code></strong> :&ensp;<code>list</code></dt>
+<dd>A list of configuration dictionaries for the OpenAI API.</dd>
+<dt><strong><code>agent_file</code></strong> :&ensp;<code>str</code></dt>
+<dd>The agent file to use.</dd>
+<dt><strong><code>framework</code></strong> :&ensp;<code>str</code></dt>
+<dd>The framework to use.</dd>
+<dt><strong><code>auto</code></strong> :&ensp;<code>bool</code></dt>
+<dd>A flag indicating whether to enable auto mode.</dd>
+<dt><strong><code>init</code></strong> :&ensp;<code>bool</code></dt>
+<dd>A flag indicating whether to enable initialization mode.</dd>
+</dl></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class PraisonAI:
+    def __init__(self, agent_file=&#34;agents.yaml&#34;, framework=&#34;&#34;, auto=False, init=False):
+        &#34;&#34;&#34;
+        Initialize the PraisonAI object with default parameters.
+
+        Parameters:
+            agent_file (str): The default agent file to use. Defaults to &#34;agents.yaml&#34;.
+            framework (str): The default framework to use. Defaults to &#34;crewai&#34;.
+            auto (bool): A flag indicating whether to enable auto mode. Defaults to False.
+            init (bool): A flag indicating whether to enable initialization mode. Defaults to False.
+
+        Attributes:
+            config_list (list): A list of configuration dictionaries for the OpenAI API.
+            agent_file (str): The agent file to use.
+            framework (str): The framework to use.
+            auto (bool): A flag indicating whether to enable auto mode.
+            init (bool): A flag indicating whether to enable initialization mode.
+        &#34;&#34;&#34;
+        self.config_list = [
+            {
+                &#39;model&#39;: os.environ.get(&#34;OPENAI_MODEL_NAME&#34;, &#34;gpt-4o&#34;),
+                &#39;base_url&#39;: os.environ.get(&#34;OPENAI_API_BASE&#34;, &#34;https://api.openai.com/v1&#34;),
+                &#39;api_key&#39;: os.environ.get(&#34;OPENAI_API_KEY&#34;)
+            }
+        ]
+        self.agent_file = agent_file
+        self.framework = framework
+        self.auto = auto
+        self.init = init
+
+    def main(self):
+        &#34;&#34;&#34;
+        The main function of the PraisonAI object. It parses the command-line arguments,
+        initializes the necessary attributes, and then calls the appropriate methods based on the
+        provided arguments.
+
+        Args:
+            self (PraisonAI): An instance of the PraisonAI class.
+    
+        Returns:
+            Any: Depending on the arguments provided, the function may return a result from the
+            AgentsGenerator, a deployment result from the CloudDeployer, or a message indicating
+            the successful creation of a file.
+        &#34;&#34;&#34;
+        args = self.parse_args()
+        if args is None:
+            agents_generator = AgentsGenerator(self.agent_file, self.framework, self.config_list)
+            result = agents_generator.generate_crew_and_kickoff()
+            return result
+        if args.deploy:
+            from .deploy import CloudDeployer
+            deployer = CloudDeployer()
+            deployer.run_commands()
+            return
+        invocation_cmd = &#34;praisonai&#34;
+        version_string = f&#34;PraisonAI version {__version__}&#34;
+        
+        self.framework = args.framework or self.framework 
+        
+        if args.agent_file:
+            if args.agent_file.startswith(&#34;tests.test&#34;): # Argument used for testing purposes. eg: python -m unittest tests.test 
+                print(&#34;test&#34;)
+            else:
+                self.agent_file = args.agent_file
+        
+        
+        if args.auto or args.init:
+            temp_topic = &#39; &#39;.join(args.auto) if args.auto else &#39; &#39;.join(args.init)
+            self.topic = temp_topic
+        elif self.auto or self.init:  # Use the auto attribute if args.auto is not provided
+            self.topic = self.auto
+            
+        if args.auto or self.auto:
+            self.agent_file = &#34;test.yaml&#34;
+            generator = AutoGenerator(topic=self.topic , framework=self.framework, agent_file=self.agent_file)
+            self.agent_file = generator.generate()
+            agents_generator = AgentsGenerator(self.agent_file, self.framework, self.config_list)
+            result = agents_generator.generate_crew_and_kickoff()
+            return result
+        elif args.init or self.init:
+            self.agent_file = &#34;agents.yaml&#34;
+            generator = AutoGenerator(topic=self.topic , framework=self.framework, agent_file=self.agent_file)
+            self.agent_file = generator.generate()
+            print(&#34;File {} created successfully&#34;.format(self.agent_file))
+            return &#34;File {} created successfully&#34;.format(self.agent_file)
+        
+        if args.ui:
+            if args.ui == &#34;gradio&#34;:
+                self.create_gradio_interface()
+            elif args.ui == &#34;chainlit&#34;:
+                self.create_chainlit_interface()
+            else:
+                # Modify below code to allow default ui
+                agents_generator = AgentsGenerator(self.agent_file, self.framework, self.config_list)
+                result = agents_generator.generate_crew_and_kickoff()
+                return result
+        else:
+            agents_generator = AgentsGenerator(self.agent_file, self.framework, self.config_list)
+            result = agents_generator.generate_crew_and_kickoff()
+            return result
+            
+    def parse_args(self):
+        &#34;&#34;&#34;
+        Parse the command-line arguments for the PraisonAI CLI.
+
+        Args:
+            self (PraisonAI): An instance of the PraisonAI class.
+
+        Returns:
+            argparse.Namespace: An object containing the parsed command-line arguments.
+
+        Raises:
+            argparse.ArgumentError: If the arguments provided are invalid.
+
+        Example:
+            &gt;&gt;&gt; args = praison_ai.parse_args()
+            &gt;&gt;&gt; print(args.agent_file)  # Output: &#39;agents.yaml&#39;
+        &#34;&#34;&#34;
+        parser = argparse.ArgumentParser(prog=&#34;praisonai&#34;, description=&#34;praisonAI command-line interface&#34;)
+        parser.add_argument(&#34;--framework&#34;, choices=[&#34;crewai&#34;, &#34;autogen&#34;], help=&#34;Specify the framework&#34;)
+        parser.add_argument(&#34;--ui&#34;, choices=[&#34;chainlit&#34;, &#34;gradio&#34;], help=&#34;Specify the UI framework (gradio or chainlit).&#34;)
+        parser.add_argument(&#34;--auto&#34;, nargs=argparse.REMAINDER, help=&#34;Enable auto mode and pass arguments for it&#34;)
+        parser.add_argument(&#34;--init&#34;, nargs=argparse.REMAINDER, help=&#34;Enable auto mode and pass arguments for it&#34;)
+        parser.add_argument(&#34;agent_file&#34;, nargs=&#34;?&#34;, help=&#34;Specify the agent file&#34;)
+        parser.add_argument(&#34;--deploy&#34;, action=&#34;store_true&#34;, help=&#34;Deploy the application&#34;)  # New argument
+        args, unknown_args = parser.parse_known_args()
+
+        if unknown_args and unknown_args[0] == &#39;-b&#39; and unknown_args[1] == &#39;api:app&#39;:
+            args.agent_file = &#39;agents.yaml&#39;
+        if args.agent_file == &#39;api:app&#39; or args.agent_file == &#39;/app/api:app&#39;:
+            args.agent_file = &#39;agents.yaml&#39;
+        if args.agent_file == &#39;ui&#39;:
+            args.ui = &#39;chainlit&#39;
+
+        return args
+
+    def create_gradio_interface(self):
+        &#34;&#34;&#34;
+        Create a Gradio interface for generating agents and performing tasks.
+
+        Args:
+            self (PraisonAI): An instance of the PraisonAI class.
+
+        Returns:
+            None: This method does not return any value. It launches the Gradio interface.
+
+        Raises:
+            None: This method does not raise any exceptions.
+
+        Example:
+            &gt;&gt;&gt; praison_ai.create_gradio_interface()
+        &#34;&#34;&#34;
+        if GRADIO_AVAILABLE:
+            def generate_crew_and_kickoff_interface(auto_args, framework):
+                &#34;&#34;&#34;
+                Generate a crew and kick off tasks based on the provided auto arguments and framework.
+
+                Args:
+                    auto_args (list): Topic.
+                    framework (str): The framework to use for generating agents.
+
+                Returns:
+                    str: A string representing the result of generating the crew and kicking off tasks.
+
+                Raises:
+                    None: This method does not raise any exceptions.
+
+                Example:
+                    &gt;&gt;&gt; result = generate_crew_and_kickoff_interface(&#34;Create a movie about Cat in Mars&#34;, &#34;crewai&#34;)
+                    &gt;&gt;&gt; print(result)
+                &#34;&#34;&#34;
+                self.framework = framework
+                self.agent_file = &#34;test.yaml&#34;
+                generator = AutoGenerator(topic=auto_args , framework=self.framework)
+                self.agent_file = generator.generate()
+                agents_generator = AgentsGenerator(self.agent_file, self.framework, self.config_list)
+                result = agents_generator.generate_crew_and_kickoff()
+                return result
+
+            gr.Interface(
+                fn=generate_crew_and_kickoff_interface,
+                inputs=[gr.Textbox(lines=2, label=&#34;Auto Args&#34;), gr.Dropdown(choices=[&#34;crewai&#34;, &#34;autogen&#34;], label=&#34;Framework&#34;)],
+                outputs=&#34;textbox&#34;,
+                title=&#34;Praison AI Studio&#34;,
+                description=&#34;Create Agents and perform tasks&#34;,
+                theme=&#34;default&#34;
+            ).launch()
+        else:
+            print(&#34;ERROR: Gradio is not installed. Please install it with &#39;pip install gradio&#39; to use this feature.&#34;) 
+        
+    def create_chainlit_interface(self):
+        &#34;&#34;&#34;
+        Create a Chainlit interface for generating agents and performing tasks.
+
+        This function sets up a Chainlit application that listens for messages.
+        When a message is received, it runs PraisonAI with the provided message as the topic.
+        The generated agents are then used to perform tasks.
+
+        Returns:
+            None: This function does not return any value. It starts the Chainlit application.
+        &#34;&#34;&#34;
+        if CHAINLIT_AVAILABLE:
+            import praisonai
+            os.environ[&#34;CHAINLIT_PORT&#34;] = &#34;8082&#34;
+            # Get the path to the &#39;public&#39; folder within the package
+            public_folder = os.path.join(os.path.dirname(praisonai.__file__), &#39;public&#39;)
+            if not os.path.exists(&#34;public&#34;):  # Check if the folder exists in the current directory
+                if os.path.exists(public_folder):
+                    shutil.copytree(public_folder, &#39;public&#39;, dirs_exist_ok=True)
+                    logging.info(&#34;Public folder copied successfully!&#34;)
+                else:
+                    logging.info(&#34;Public folder not found in the package.&#34;)
+            else:
+                logging.info(&#34;Public folder already exists.&#34;)
+            chainlit_ui_path = os.path.join(os.path.dirname(praisonai.__file__), &#39;chainlit_ui.py&#39;)
+            chainlit_run([chainlit_ui_path])
+        else:
+            print(&#34;ERROR: Chainlit is not installed. Please install it with &#39;pip install chainlit&#39; to use the UI.&#34;)        </code></pre>
+</details>
+<h3>Methods</h3>
+<dl>
+<dt id="praisonai.cli.PraisonAI.create_chainlit_interface"><code class="name flex">
+<span>def <span class="ident">create_chainlit_interface</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Create a Chainlit interface for generating agents and performing tasks.</p>
+<p>This function sets up a Chainlit application that listens for messages.
+When a message is received, it runs PraisonAI with the provided message as the topic.
+The generated agents are then used to perform tasks.</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>None</code></dt>
+<dd>This function does not return any value. It starts the Chainlit application.</dd>
+</dl></div>
+</dd>
+<dt id="praisonai.cli.PraisonAI.create_gradio_interface"><code class="name flex">
+<span>def <span class="ident">create_gradio_interface</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Create a Gradio interface for generating agents and performing tasks.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>self</code></strong> :&ensp;<code><a title="praisonai.cli.PraisonAI" href="#praisonai.cli.PraisonAI">PraisonAI</a></code></dt>
+<dd>An instance of the PraisonAI class.</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>None</code></dt>
+<dd>This method does not return any value. It launches the Gradio interface.</dd>
+</dl>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code>None</code></dt>
+<dd>This method does not raise any exceptions.</dd>
+</dl>
+<h2 id="example">Example</h2>
+<pre><code class="language-python-repl">&gt;&gt;&gt; praison_ai.create_gradio_interface()
+</code></pre></div>
+</dd>
+<dt id="praisonai.cli.PraisonAI.main"><code class="name flex">
+<span>def <span class="ident">main</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>The main function of the PraisonAI object. It parses the command-line arguments,
+initializes the necessary attributes, and then calls the appropriate methods based on the
+provided arguments.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>self</code></strong> :&ensp;<code><a title="praisonai.cli.PraisonAI" href="#praisonai.cli.PraisonAI">PraisonAI</a></code></dt>
+<dd>An instance of the PraisonAI class.</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>Any</code></dt>
+<dd>Depending on the arguments provided, the function may return a result from the</dd>
+</dl>
+<p>AgentsGenerator, a deployment result from the CloudDeployer, or a message indicating
+the successful creation of a file.</p></div>
+</dd>
+<dt id="praisonai.cli.PraisonAI.parse_args"><code class="name flex">
+<span>def <span class="ident">parse_args</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Parse the command-line arguments for the PraisonAI CLI.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>self</code></strong> :&ensp;<code><a title="praisonai.cli.PraisonAI" href="#praisonai.cli.PraisonAI">PraisonAI</a></code></dt>
+<dd>An instance of the PraisonAI class.</dd>
+</dl>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>argparse.Namespace</code></dt>
+<dd>An object containing the parsed command-line arguments.</dd>
+</dl>
+<h2 id="raises">Raises</h2>
+<dl>
+<dt><code>argparse.ArgumentError</code></dt>
+<dd>If the arguments provided are invalid.</dd>
+</dl>
+<h2 id="example">Example</h2>
+<pre><code class="language-python-repl">&gt;&gt;&gt; args = praison_ai.parse_args()
+&gt;&gt;&gt; print(args.agent_file)  # Output: 'agents.yaml'
+</code></pre></div>
+</dd>
+</dl>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai" href="index.html">praisonai</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="praisonai.cli.PraisonAI" href="#praisonai.cli.PraisonAI">PraisonAI</a></code></h4>
+<ul class="">
+<li><code><a title="praisonai.cli.PraisonAI.create_chainlit_interface" href="#praisonai.cli.PraisonAI.create_chainlit_interface">create_chainlit_interface</a></code></li>
+<li><code><a title="praisonai.cli.PraisonAI.create_gradio_interface" href="#praisonai.cli.PraisonAI.create_gradio_interface">create_gradio_interface</a></code></li>
+<li><code><a title="praisonai.cli.PraisonAI.main" href="#praisonai.cli.PraisonAI.main">main</a></code></li>
+<li><code><a title="praisonai.cli.PraisonAI.parse_args" href="#praisonai.cli.PraisonAI.parse_args">parse_args</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/deploy.html

@@ -0,0 +1,279 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.deploy API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.deploy</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="praisonai.deploy.CloudDeployer"><code class="flex name class">
+<span>class <span class="ident">CloudDeployer</span></span>
+</code></dt>
+<dd>
+<div class="desc"><p>A class for deploying a cloud-based application.</p>
+<h2 id="attributes">Attributes</h2>
+<p>None</p>
+<h2 id="methods">Methods</h2>
+<p><strong>init</strong>(self):
+Loads environment variables from .env file or system and sets them.</p>
+<p>Loads environment variables from .env file or system and sets them.</p>
+<h2 id="parameters">Parameters</h2>
+<p>self: An instance of the CloudDeployer class.</p>
+<h2 id="returns">Returns</h2>
+<p>None</p>
+<h2 id="raises">Raises</h2>
+<p>None</p></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class CloudDeployer:
+    &#34;&#34;&#34;
+    A class for deploying a cloud-based application.
+
+    Attributes:
+        None
+
+    Methods:
+        __init__(self):
+            Loads environment variables from .env file or system and sets them.
+
+    &#34;&#34;&#34;
+    def __init__(self):
+        &#34;&#34;&#34;
+        Loads environment variables from .env file or system and sets them.
+
+        Parameters:
+            self: An instance of the CloudDeployer class.
+
+        Returns:
+            None
+
+        Raises:
+            None
+
+        &#34;&#34;&#34;
+        # Load environment variables from .env file or system
+        load_dotenv()
+        self.set_environment_variables()
+
+    def create_dockerfile(self):
+        &#34;&#34;&#34;
+        Creates a Dockerfile for the application.
+
+        Parameters:
+            self: An instance of the CloudDeployer class.
+
+        Returns:
+            None
+
+        Raises:
+            None
+
+        This method creates a Dockerfile in the current directory with the specified content.
+        The Dockerfile is used to build a Docker image for the application.
+        The content of the Dockerfile includes instructions to use the Python 3.11-slim base image,
+        set the working directory to /app, copy the current directory contents into the container,
+        install the required Python packages (flask, praisonai, gunicorn, and markdown),
+        expose port 8080, and run the application using Gunicorn.
+        &#34;&#34;&#34;
+        with open(&#34;Dockerfile&#34;, &#34;w&#34;) as file:
+            file.write(&#34;FROM python:3.11-slim\n&#34;)
+            file.write(&#34;WORKDIR /app\n&#34;)
+            file.write(&#34;COPY . .\n&#34;)
+            file.write(&#34;RUN pip install flask praisonai==0.0.42 gunicorn markdown\n&#34;)
+            file.write(&#34;EXPOSE 8080\n&#34;)
+            file.write(&#39;CMD [&#34;gunicorn&#34;, &#34;-b&#34;, &#34;0.0.0.0:8080&#34;, &#34;api:app&#34;]\n&#39;)
+            
+    def create_api_file(self):
+        &#34;&#34;&#34;
+        Creates an API file for the application.
+
+        Parameters:
+            self (CloudDeployer): An instance of the CloudDeployer class.
+
+        Returns:
+            None
+
+        This method creates an API file named &#34;api.py&#34; in the current directory. The file contains a basic Flask application that uses the PraisonAI library to run a simple agent and returns the output as an HTML page. The application listens on the root path (&#34;/&#34;) and uses the Markdown library to format the output.
+        &#34;&#34;&#34;
+        with open(&#34;api.py&#34;, &#34;w&#34;) as file:
+            file.write(&#34;from flask import Flask\n&#34;)
+            file.write(&#34;from praisonai import PraisonAI\n&#34;)
+            file.write(&#34;import markdown\n\n&#34;)
+            file.write(&#34;app = Flask(__name__)\n\n&#34;)
+            file.write(&#34;def basic():\n&#34;)
+            file.write(&#34;    praison_ai = PraisonAI(agent_file=\&#34;agents.yaml\&#34;)\n&#34;)
+            file.write(&#34;    return praison_ai.main()\n\n&#34;)
+            file.write(&#34;@app.route(&#39;/&#39;)\n&#34;)
+            file.write(&#34;def home():\n&#34;)
+            file.write(&#34;    output = basic()\n&#34;)
+            file.write(&#34;    html_output = markdown.markdown(output)\n&#34;)
+            file.write(&#34;    return f&#39;&lt;html&gt;&lt;body&gt;{html_output}&lt;/body&gt;&lt;/html&gt;&#39;\n\n&#34;)
+            file.write(&#34;if __name__ == \&#34;__main__\&#34;:\n&#34;)
+            file.write(&#34;    app.run(debug=True)\n&#34;)
+    
+    def set_environment_variables(self):
+        &#34;&#34;&#34;Sets environment variables with fallback to .env values or defaults.&#34;&#34;&#34;
+        os.environ[&#34;OPENAI_MODEL_NAME&#34;] = os.getenv(&#34;OPENAI_MODEL_NAME&#34;, &#34;gpt-4o&#34;)
+        os.environ[&#34;OPENAI_API_KEY&#34;] = os.getenv(&#34;OPENAI_API_KEY&#34;, &#34;Enter your API key&#34;)
+        os.environ[&#34;OPENAI_API_BASE&#34;] = os.getenv(&#34;OPENAI_API_BASE&#34;, &#34;https://api.openai.com/v1&#34;)
+
+    def run_commands(self):
+        &#34;&#34;&#34;
+        Sets environment variables with fallback to .env values or defaults.
+
+        Parameters:
+            None
+
+        Returns:
+            None
+
+        Raises:
+            None
+
+        This method sets environment variables for the application. It uses the `os.environ` dictionary to set the following environment variables:
+
+        - `OPENAI_MODEL_NAME`: The name of the OpenAI model to use. If not specified in the .env file, it defaults to &#34;gpt-4o&#34;.
+        - `OPENAI_API_KEY`: The API key for accessing the OpenAI API. If not specified in the .env file, it defaults to &#34;Enter your API key&#34;.
+        - `OPENAI_API_BASE`: The base URL for the OpenAI API. If not specified in the .env file, it defaults to &#34;https://api.openai.com/v1&#34;.
+        &#34;&#34;&#34;
+        self.create_api_file()
+        self.create_dockerfile()
+        &#34;&#34;&#34;Runs a sequence of shell commands for deployment, continues on error.&#34;&#34;&#34;
+        commands = [
+            &#34;yes | gcloud auth configure-docker us-central1-docker.pkg.dev&#34;,
+            &#34;gcloud artifacts repositories create praisonai-repository --repository-format=docker --location=us-central1&#34;,
+            &#34;docker build --platform linux/amd64 -t gcr.io/$(gcloud config get-value project)/praisonai-app:latest .&#34;,
+            &#34;docker tag gcr.io/$(gcloud config get-value project)/praisonai-app:latest us-central1-docker.pkg.dev/$(gcloud config get-value project)/praisonai-repository/praisonai-app:latest&#34;,
+            &#34;docker push us-central1-docker.pkg.dev/$(gcloud config get-value project)/praisonai-repository/praisonai-app:latest&#34;,
+            &#34;gcloud run deploy praisonai-service --image us-central1-docker.pkg.dev/$(gcloud config get-value project)/praisonai-repository/praisonai-app:latest --platform managed --region us-central1 --allow-unauthenticated --set-env-vars OPENAI_MODEL_NAME=${OPENAI_MODEL_NAME},OPENAI_API_KEY=${OPENAI_API_KEY},OPENAI_API_BASE=${OPENAI_API_BASE}&#34;
+        ]
+
+        for cmd in commands:
+            try:
+                subprocess.run(cmd, shell=True, check=True)
+            except subprocess.CalledProcessError as e:
+                print(f&#34;ERROR: Command &#39;{e.cmd}&#39; failed with exit status {e.returncode}&#34;)
+                print(f&#34;Continuing with the next command...&#34;)</code></pre>
+</details>
+<h3>Methods</h3>
+<dl>
+<dt id="praisonai.deploy.CloudDeployer.create_api_file"><code class="name flex">
+<span>def <span class="ident">create_api_file</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Creates an API file for the application.</p>
+<h2 id="parameters">Parameters</h2>
+<p>self (CloudDeployer): An instance of the CloudDeployer class.</p>
+<h2 id="returns">Returns</h2>
+<p>None
+This method creates an API file named "api.py" in the current directory. The file contains a basic Flask application that uses the PraisonAI library to run a simple agent and returns the output as an HTML page. The application listens on the root path ("/") and uses the Markdown library to format the output.</p></div>
+</dd>
+<dt id="praisonai.deploy.CloudDeployer.create_dockerfile"><code class="name flex">
+<span>def <span class="ident">create_dockerfile</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Creates a Dockerfile for the application.</p>
+<h2 id="parameters">Parameters</h2>
+<p>self: An instance of the CloudDeployer class.</p>
+<h2 id="returns">Returns</h2>
+<p>None</p>
+<h2 id="raises">Raises</h2>
+<p>None
+This method creates a Dockerfile in the current directory with the specified content.
+The Dockerfile is used to build a Docker image for the application.
+The content of the Dockerfile includes instructions to use the Python 3.11-slim base image,
+set the working directory to /app, copy the current directory contents into the container,
+install the required Python packages (flask, praisonai, gunicorn, and markdown),
+expose port 8080, and run the application using Gunicorn.</p></div>
+</dd>
+<dt id="praisonai.deploy.CloudDeployer.run_commands"><code class="name flex">
+<span>def <span class="ident">run_commands</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Sets environment variables with fallback to .env values or defaults.</p>
+<h2 id="parameters">Parameters</h2>
+<p>None</p>
+<h2 id="returns">Returns</h2>
+<p>None</p>
+<h2 id="raises">Raises</h2>
+<p>None
+This method sets environment variables for the application. It uses the <code>os.environ</code> dictionary to set the following environment variables:</p>
+<ul>
+<li><code>OPENAI_MODEL_NAME</code>: The name of the OpenAI model to use. If not specified in the .env file, it defaults to "gpt-4o".</li>
+<li><code>OPENAI_API_KEY</code>: The API key for accessing the OpenAI API. If not specified in the .env file, it defaults to "Enter your API key".</li>
+<li><code>OPENAI_API_BASE</code>: The base URL for the OpenAI API. If not specified in the .env file, it defaults to "https://api.openai.com/v1".</li>
+</ul></div>
+</dd>
+<dt id="praisonai.deploy.CloudDeployer.set_environment_variables"><code class="name flex">
+<span>def <span class="ident">set_environment_variables</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Sets environment variables with fallback to .env values or defaults.</p></div>
+</dd>
+</dl>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai" href="index.html">praisonai</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="praisonai.deploy.CloudDeployer" href="#praisonai.deploy.CloudDeployer">CloudDeployer</a></code></h4>
+<ul class="">
+<li><code><a title="praisonai.deploy.CloudDeployer.create_api_file" href="#praisonai.deploy.CloudDeployer.create_api_file">create_api_file</a></code></li>
+<li><code><a title="praisonai.deploy.CloudDeployer.create_dockerfile" href="#praisonai.deploy.CloudDeployer.create_dockerfile">create_dockerfile</a></code></li>
+<li><code><a title="praisonai.deploy.CloudDeployer.run_commands" href="#praisonai.deploy.CloudDeployer.run_commands">run_commands</a></code></li>
+<li><code><a title="praisonai.deploy.CloudDeployer.set_environment_variables" href="#praisonai.deploy.CloudDeployer.set_environment_variables">set_environment_variables</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/inbuilt_tools/autogen_tools.html

@@ -0,0 +1,209 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.inbuilt_tools.autogen_tools API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.inbuilt_tools.autogen_tools</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_BaseTool"><code class="name flex">
+<span>def <span class="ident">autogen_BaseTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_CSVSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_CSVSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_CodeDocsSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_CodeDocsSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_DDGS"><code class="name flex">
+<span>def <span class="ident">autogen_DDGS</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_DOCXSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_DOCXSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_DirectoryReadTool"><code class="name flex">
+<span>def <span class="ident">autogen_DirectoryReadTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_DirectorySearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_DirectorySearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_FileReadTool"><code class="name flex">
+<span>def <span class="ident">autogen_FileReadTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_InternetSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_InternetSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_JSONSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_JSONSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_MDXSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_MDXSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_PDFSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_PDFSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_RagTool"><code class="name flex">
+<span>def <span class="ident">autogen_RagTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_ScrapeElementFromWebsiteTool"><code class="name flex">
+<span>def <span class="ident">autogen_ScrapeElementFromWebsiteTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_ScrapeWebsiteTool"><code class="name flex">
+<span>def <span class="ident">autogen_ScrapeWebsiteTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_TXTSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_TXTSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_WebsiteSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_WebsiteSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_XMLSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_XMLSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_YoutubeChannelSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_YoutubeChannelSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.autogen_YoutubeVideoSearchTool"><code class="name flex">
+<span>def <span class="ident">autogen_YoutubeVideoSearchTool</span></span>(<span>assistant, user_proxy)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt id="praisonai.inbuilt_tools.autogen_tools.create_autogen_tool_function"><code class="name flex">
+<span>def <span class="ident">create_autogen_tool_function</span></span>(<span>tool_name)</span>
+</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai.inbuilt_tools" href="index.html">praisonai.inbuilt_tools</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_BaseTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_BaseTool">autogen_BaseTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_CSVSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_CSVSearchTool">autogen_CSVSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_CodeDocsSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_CodeDocsSearchTool">autogen_CodeDocsSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_DDGS" href="#praisonai.inbuilt_tools.autogen_tools.autogen_DDGS">autogen_DDGS</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_DOCXSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_DOCXSearchTool">autogen_DOCXSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_DirectoryReadTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_DirectoryReadTool">autogen_DirectoryReadTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_DirectorySearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_DirectorySearchTool">autogen_DirectorySearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_FileReadTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_FileReadTool">autogen_FileReadTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_InternetSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_InternetSearchTool">autogen_InternetSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_JSONSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_JSONSearchTool">autogen_JSONSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_MDXSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_MDXSearchTool">autogen_MDXSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_PDFSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_PDFSearchTool">autogen_PDFSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_RagTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_RagTool">autogen_RagTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_ScrapeElementFromWebsiteTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_ScrapeElementFromWebsiteTool">autogen_ScrapeElementFromWebsiteTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_ScrapeWebsiteTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_ScrapeWebsiteTool">autogen_ScrapeWebsiteTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_TXTSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_TXTSearchTool">autogen_TXTSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_WebsiteSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_WebsiteSearchTool">autogen_WebsiteSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_XMLSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_XMLSearchTool">autogen_XMLSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_YoutubeChannelSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_YoutubeChannelSearchTool">autogen_YoutubeChannelSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.autogen_YoutubeVideoSearchTool" href="#praisonai.inbuilt_tools.autogen_tools.autogen_YoutubeVideoSearchTool">autogen_YoutubeVideoSearchTool</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools.create_autogen_tool_function" href="#praisonai.inbuilt_tools.autogen_tools.create_autogen_tool_function">create_autogen_tool_function</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/inbuilt_tools/index.html

@@ -0,0 +1,67 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.inbuilt_tools API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.inbuilt_tools</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+<h2 class="section-title" id="header-submodules">Sub-modules</h2>
+<dl>
+<dt><code class="name"><a title="praisonai.inbuilt_tools.autogen_tools" href="autogen_tools.html">praisonai.inbuilt_tools.autogen_tools</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai" href="../index.html">praisonai</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-submodules">Sub-modules</a></h3>
+<ul>
+<li><code><a title="praisonai.inbuilt_tools.autogen_tools" href="autogen_tools.html">praisonai.inbuilt_tools.autogen_tools</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/inc/index.html

@@ -0,0 +1,67 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.inc API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.inc</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+<h2 class="section-title" id="header-submodules">Sub-modules</h2>
+<dl>
+<dt><code class="name"><a title="praisonai.inc.models" href="models.html">praisonai.inc.models</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai" href="../index.html">praisonai</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-submodules">Sub-modules</a></h3>
+<ul>
+<li><code><a title="praisonai.inc.models" href="models.html">praisonai.inc.models</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/inc/models.html

@@ -0,0 +1,196 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.inc.models API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.inc.models</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-classes">Classes</h2>
+<dl>
+<dt id="praisonai.inc.models.PraisonAIModel"><code class="flex name class">
+<span>class <span class="ident">PraisonAIModel</span></span>
+<span>(</span><span>model=None, api_key_var=None, base_url=None)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Initializes the PraisonAIModel with the provided parameters or environment variables.</p>
+<h2 id="args">Args</h2>
+<dl>
+<dt><strong><code>model</code></strong> :&ensp;<code>str</code>, optional</dt>
+<dd>The name of the OpenAI model. Defaults to None.</dd>
+<dt><strong><code>api_key_var</code></strong> :&ensp;<code>str</code>, optional</dt>
+<dd>The OpenAI API key. Defaults to None.</dd>
+<dt><strong><code>base_url</code></strong> :&ensp;<code>str</code>, optional</dt>
+<dd>The base URL for the OpenAI API. Defaults to None.</dd>
+</dl></div>
+<details class="source">
+<summary>
+<span>Expand source code</span>
+</summary>
+<pre><code class="python">class PraisonAIModel:
+    def __init__(self, model=None, api_key_var=None, base_url=None):
+        &#34;&#34;&#34;
+        Initializes the PraisonAIModel with the provided parameters or environment variables.
+
+        Args:
+            model (str, optional): The name of the OpenAI model. Defaults to None.
+            api_key_var (str, optional): The OpenAI API key. Defaults to None.
+            base_url (str, optional): The base URL for the OpenAI API. Defaults to None.
+        &#34;&#34;&#34;
+        self.model =  model or os.getenv(&#34;OPENAI_MODEL_NAME&#34;, &#34;gpt-4o&#34;)
+        if self.model.startswith(&#34;openai/&#34;):
+            self.api_key_var = &#34;OPENAI_API_KEY&#34;
+            self.base_url = base_url or &#34;https://api.openai.com/v1&#34;
+            self.model_name = self.model.replace(&#34;openai/&#34;, &#34;&#34;)
+        elif self.model.startswith(&#34;groq/&#34;):
+            self.api_key_var = &#34;GROQ_API_KEY&#34;
+            self.base_url = base_url or &#34;https://api.groq.com/openai/v1&#34;
+            self.model_name = self.model.replace(&#34;groq/&#34;, &#34;&#34;)
+        elif self.model.startswith(&#34;cohere/&#34;):
+            self.api_key_var = &#34;COHERE_API_KEY&#34;
+            self.base_url = &#34;&#34;
+            self.model_name = self.model.replace(&#34;cohere/&#34;, &#34;&#34;)
+        elif self.model.startswith(&#34;ollama/&#34;):
+            self.api_key_var = &#34;OLLAMA_API_KEY&#34;
+            self.base_url = base_url or &#34;http://localhost:11434/v1&#34;
+            self.model_name = self.model.replace(&#34;ollama/&#34;, &#34;&#34;)
+        elif self.model.startswith(&#34;anthropic/&#34;):
+            self.api_key_var = &#34;ANTHROPIC_API_KEY&#34;
+            self.base_url = &#34;&#34;
+            self.model_name = self.model.replace(&#34;anthropic/&#34;, &#34;&#34;)
+        elif self.model.startswith(&#34;google/&#34;):
+            self.api_key_var = &#34;GOOGLE_API_KEY&#34;
+            self.base_url = &#34;&#34;
+            self.model_name = self.model.replace(&#34;google/&#34;, &#34;&#34;)
+        else: 
+            self.api_key_var = api_key_var or &#34;OPENAI_API_KEY&#34; 
+            self.base_url = base_url or os.environ.get(&#34;OPENAI_API_BASE&#34;, &#34;https://api.openai.com/v1&#34;)
+            self.model_name = self.model
+        logger.debug(f&#34;Initialized PraisonAIModel with model {self.model_name}, api_key_var {self.api_key_var}, and base_url {self.base_url}&#34;)
+        self.api_key = os.environ.get(self.api_key_var, &#34;nokey&#34;)
+
+    def get_model(self):
+        &#34;&#34;&#34;
+        Returns an instance of the langchain Chat client with the configured parameters.
+
+        Returns:
+            Chat: An instance of the langchain Chat client.
+        &#34;&#34;&#34;
+        if self.model.startswith(&#34;google/&#34;):
+            if GOOGLE_GENAI_AVAILABLE:
+                return ChatGoogleGenerativeAI(
+                    model=self.model_name,
+                    google_api_key=self.api_key
+                )
+            else:
+                raise ImportError(
+                    &#34;Required Langchain Integration &#39;langchain-google-genai&#39; not found. &#34;
+                    &#34;Please install with &#39;pip install langchain-google-genai&#39;&#34;
+                )
+        elif self.model.startswith(&#34;cohere/&#34;):
+            if COHERE_AVAILABLE:
+                return ChatCohere(
+                    model=self.model_name,
+                    cohere_api_key=self.api_key,
+                )
+            else:
+                raise ImportError(
+                    &#34;Required Langchain Integration &#39;langchain-cohere&#39; not found. &#34;
+                    &#34;Please install with &#39;pip install langchain-cohere&#39;&#34;
+                )
+        elif self.model.startswith(&#34;anthropic/&#34;):
+            if ANTHROPIC_AVAILABLE:
+                return ChatAnthropic(
+                    model=self.model_name,
+                    anthropic_api_key=self.api_key,
+                )
+            else:
+                raise ImportError(
+                    &#34;Required Langchain Integration &#39;langchain-anthropic&#39; not found. &#34;
+                    &#34;Please install with &#39;pip install langchain-anthropic&#39;&#34;
+                )
+        elif OPENAI_AVAILABLE:
+            return ChatOpenAI(
+                model=self.model_name,
+                api_key=self.api_key,
+                base_url=self.base_url,
+            )
+        else:
+            raise ImportError(
+                &#34;Required Langchain Integration &#39;langchain-openai&#39; not found. &#34;
+                &#34;Please install with &#39;pip install langchain-openai&#39;&#34;
+            )</code></pre>
+</details>
+<h3>Methods</h3>
+<dl>
+<dt id="praisonai.inc.models.PraisonAIModel.get_model"><code class="name flex">
+<span>def <span class="ident">get_model</span></span>(<span>self)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>Returns an instance of the langchain Chat client with the configured parameters.</p>
+<h2 id="returns">Returns</h2>
+<dl>
+<dt><code>Chat</code></dt>
+<dd>An instance of the langchain Chat client.</dd>
+</dl></div>
+</dd>
+</dl>
+</dd>
+</dl>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai.inc" href="index.html">praisonai.inc</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-classes">Classes</a></h3>
+<ul>
+<li>
+<h4><code><a title="praisonai.inc.models.PraisonAIModel" href="#praisonai.inc.models.PraisonAIModel">PraisonAIModel</a></code></h4>
+<ul class="">
+<li><code><a title="praisonai.inc.models.PraisonAIModel.get_model" href="#praisonai.inc.models.PraisonAIModel.get_model">get_model</a></code></li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/index.html

@@ -0,0 +1,97 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Package <code>praisonai</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+<h2 class="section-title" id="header-submodules">Sub-modules</h2>
+<dl>
+<dt><code class="name"><a title="praisonai.agents_generator" href="agents_generator.html">praisonai.agents_generator</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt><code class="name"><a title="praisonai.auto" href="auto.html">praisonai.auto</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt><code class="name"><a title="praisonai.cli" href="cli.html">praisonai.cli</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt><code class="name"><a title="praisonai.deploy" href="deploy.html">praisonai.deploy</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt><code class="name"><a title="praisonai.inbuilt_tools" href="inbuilt_tools/index.html">praisonai.inbuilt_tools</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt><code class="name"><a title="praisonai.inc" href="inc/index.html">praisonai.inc</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt><code class="name"><a title="praisonai.test" href="test.html">praisonai.test</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+<dt><code class="name"><a title="praisonai.version" href="version.html">praisonai.version</a></code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3><a href="#header-submodules">Sub-modules</a></h3>
+<ul>
+<li><code><a title="praisonai.agents_generator" href="agents_generator.html">praisonai.agents_generator</a></code></li>
+<li><code><a title="praisonai.auto" href="auto.html">praisonai.auto</a></code></li>
+<li><code><a title="praisonai.cli" href="cli.html">praisonai.cli</a></code></li>
+<li><code><a title="praisonai.deploy" href="deploy.html">praisonai.deploy</a></code></li>
+<li><code><a title="praisonai.inbuilt_tools" href="inbuilt_tools/index.html">praisonai.inbuilt_tools</a></code></li>
+<li><code><a title="praisonai.inc" href="inc/index.html">praisonai.inc</a></code></li>
+<li><code><a title="praisonai.test" href="test.html">praisonai.test</a></code></li>
+<li><code><a title="praisonai.version" href="version.html">praisonai.version</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/test.html

@@ -0,0 +1,73 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.test API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.test</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+<h2 class="section-title" id="header-functions">Functions</h2>
+<dl>
+<dt id="praisonai.test.generate_crew_and_kickoff"><code class="name flex">
+<span>def <span class="ident">generate_crew_and_kickoff</span></span>(<span>agent_file)</span>
+</code></dt>
+<dd>
+<div class="desc"><p>This function generates a crew of agents and kicks off tasks based on the configuration provided in a YAML file.</p>
+<p>Parameters:
+agent_file (str): The path to the YAML file containing the configuration for the agents and tasks.</p>
+<p>Returns:
+str: The result of the last task executed by the crew.</p></div>
+</dd>
+</dl>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai" href="index.html">praisonai</a></code></li>
+</ul>
+</li>
+<li><h3><a href="#header-functions">Functions</a></h3>
+<ul class="">
+<li><code><a title="praisonai.test.generate_crew_and_kickoff" href="#praisonai.test.generate_crew_and_kickoff">generate_crew_and_kickoff</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/api/praisonai/version.html

@@ -0,0 +1,55 @@
+<!doctype html>
+<html lang="en">
+<head>
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
+<meta name="generator" content="pdoc3 0.11.1">
+<title>praisonai.version API documentation</title>
+<meta name="description" content="">
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
+<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
+<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
+<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
+<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
+<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
+<script>window.addEventListener('DOMContentLoaded', () => {
+hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
+hljs.highlightAll();
+})</script>
+</head>
+<body>
+<main>
+<article id="content">
+<header>
+<h1 class="title">Module <code>praisonai.version</code></h1>
+</header>
+<section id="section-intro">
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+<section>
+</section>
+</article>
+<nav id="sidebar">
+<div class="toc">
+<ul></ul>
+</div>
+<ul id="index">
+<li><h3>Super-module</h3>
+<ul>
+<li><code><a title="praisonai" href="index.html">praisonai</a></code></li>
+</ul>
+</li>
+</ul>
+</nav>
+</main>
+<footer id="footer">
+<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.1</a>.</p>
+</footer>
+</body>
+</html>

docs/auto.md

@@ -0,0 +1,6 @@
+# Auto
+## Full Automatic Mode
+
+```bash
+praisonai --auto create a movie script about Dog in Moon
+```

docs/conf.py

@@ -0,0 +1,28 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'PraisonAI'
+copyright = '2024, Mervin Praison'
+author = 'Mervin Praison'
+release = '7'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon', 'sphinx_rtd_theme']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']

docs/contributing.md

@@ -0,0 +1,10 @@
+# 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.
+

docs/deploy.md

@@ -0,0 +1,31 @@
+# Deploy 
+
+## Google Cloud
+
+```bash
+gcloud init
+gcloud services enable run.googleapis.com
+gcloud services enable containerregistry.googleapis.com
+gcloud services enable cloudbuild.googleapis.com
+
+export OPENAI_MODEL_NAME="gpt-4o"
+export OPENAI_API_KEY="Enter your API key"
+export OPENAI_API_BASE="https://api.openai.com/v1"
+
+yes | gcloud auth configure-docker us-central1-docker.pkg.dev 
+gcloud artifacts repositories create praisonai-repository --repository-format=docker --location=us-central1
+
+PROJECT_ID=$(gcloud config get-value project)
+TAG="latest"
+docker build --platform linux/amd64 -t gcr.io/${PROJECT_ID}/praisonai-app:${TAG} .
+docker tag gcr.io/${PROJECT_ID}/praisonai-app:${TAG} us-central1-docker.pkg.dev/${PROJECT_ID}/praisonai-repository/praisonai-app:${TAG}
+docker push us-central1-docker.pkg.dev/${PROJECT_ID}/praisonai-repository/praisonai-app:${TAG}
+
+gcloud run deploy praisonai-service \
+    --image us-central1-docker.pkg.dev/${PROJECT_ID}/praisonai-repository/praisonai-app:${TAG} \
+    --platform managed \
+    --region us-central1 \
+    --allow-unauthenticated \
+    --set-env-vars OPENAI_MODEL_NAME=${OPENAI_MODEL_NAME},OPENAI_API_KEY=${OPENAI_API_KEY},OPENAI_API_BASE=${OPENAI_API_BASE}
+```
+

docs/developers/agents-playbook.md

@@ -0,0 +1,60 @@
+# Agents Playbook 
+
+## Simple Playbook Example
+
+```yaml
+framework: crewai
+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.'
+```
+
+## Detailed Playbook Example
+
+```yaml
+framework: crewai
+topic: Artificial Intelligence
+roles:
+  movie_concept_creator:
+    backstory: 'Creative thinker with a deep understanding of cinematic storytelling,
+      capable of using AI-generated storylines to create unique and compelling movie
+      ideas.'
+    goal: Generate engaging movie concepts using AI storylines
+    role: Movie Concept Creator
+    tasks:
+      movie_concept_development:
+        description: 'Develop movie concepts from AI-generated storylines, ensuring
+          they are engaging and have strong narrative arcs.'
+        expected_output: 'Well-structured movie concept document with character
+          bios, settings, and plot outlines.'
+  screenwriter:
+    backstory: 'Expert in writing engaging dialogue and script structure, able to
+      turn movie concepts into production-ready scripts.'
+    goal: Write compelling scripts based on movie concepts
+    role: Screenwriter
+    tasks:
+      scriptwriting_task:
+        description: 'Turn movie concepts into polished scripts with well-developed
+          characters, strong dialogue, and effective scene transitions.'
+        expected_output: 'Production-ready script with a beginning, middle, and
+          end, along with character development and engaging dialogues.'
+  editor:
+    backstory: 'Adept at identifying inconsistencies, improving language usage,
+      and maintaining the overall flow of the script.'
+    goal: Refine the scripts and ensure continuity of the movie storyline
+    role: Editor
+    tasks:
+      editing_task:
+        description: 'Review, edit, and refine the scripts to ensure they are cohesive
+          and follow a well-structured narrative.'
+        expected_output: 'A polished final draft of the script with no inconsistencies,
+          strong character development, and effective dialogue.'
+dependencies: []
+```

docs/developers/googlecolab-tools.md

@@ -0,0 +1,208 @@
+---
+jupyter:
+  accelerator: GPU
+  colab:
+    gpuType: T4
+  kernelspec:
+    display_name: Python 3
+    name: python3
+  language_info:
+    name: python
+  nbformat: 4
+  nbformat_minor: 0
+---
+
+``` python
+!pip install -Uq praisonai duckduckgo_search
+```
+
+``` python
+from duckduckgo_search import DDGS
+from praisonai_tools import BaseTool
+
+class InternetSearchTool(BaseTool):
+    name: str = "InternetSearchTool"
+    description: str = "Search Internet for relevant information based on a query or latest news"
+
+    def _run(self, query: str):
+        ddgs = DDGS()
+        results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
+        return results
+```
+
+``` python
+import os
+import yaml
+from praisonai import PraisonAI
+from google.colab import userdata
+
+# Example agent_yaml content
+agent_yaml = """
+framework: "crewai"
+topic: "Space Exploration"
+
+roles:
+  astronomer:
+    role: "Space Researcher"
+    goal: "Discover new insights about {topic}"
+    backstory: "You are a curious and dedicated astronomer with a passion for unraveling the mysteries of the cosmos."
+    tasks:
+      investigate_exoplanets:
+        description: "Research and compile information about exoplanets discovered in the last decade."
+        expected_output: "A summarized report on exoplanet discoveries, including their size, potential habitability, and distance from Earth."
+    tools:
+      - "InternetSearchTool"
+"""
+
+# Create a PraisonAI instance with the agent_yaml content
+praison_ai = PraisonAI(agent_yaml=agent_yaml)
+
+# Add OPENAI_API_KEY Secrets to Google Colab on the Left Hand Side 🔑 or Enter Manually Below
+os.environ["OPENAI_API_KEY"] = userdata.get('OPENAI_API_KEY') or "ENTER OPENAI_API_KEY HERE"
+
+# Run PraisonAI
+result = praison_ai.main()
+
+# Print the result
+print(result)
+```
+
+
+     [2024-07-03 04:53:48][DEBUG]: == Working Agent: Space Researcher
+     [2024-07-03 04:53:48][INFO]: == Starting Task: Research and compile information about exoplanets discovered in the last decade.
+
+
+    > Entering new CrewAgentExecutor chain...
+    I now can give a great answer.
+
+    Final Answer: 
+
+    Over the last decade, the field of exoplanet research has experienced significant advancements, leading to the discovery of thousands of exoplanets. These discoveries have been made possible through missions like NASA's Kepler and TESS (Transiting Exoplanet Survey Satellite), as well as ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, including their size, potential habitability, and distance from Earth:
+
+    1. **Kepler-452b**
+       - **Size**: Approximately 1.6 times the radius of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, where liquid water could exist. It is often referred to as Earth's "cousin."
+       - **Distance from Earth**: About 1,400 light-years
+
+    2. **Proxima Centauri b**
+       - **Size**: About 1.17 times the mass of Earth
+       - **Potential Habitability**: Located in the habitable zone of Proxima Centauri, the closest star to the Sun. It has the potential to have liquid water.
+       - **Distance from Earth**: 4.24 light-years
+
+    3. **TRAPPIST-1 System**
+       - **Size**: The system includes seven Earth-sized planets
+       - **Potential Habitability**: Three of the planets (TRAPPIST-1e, TRAPPIST-1f, and TRAPPIST-1g) are located in the habitable zone and could potentially support liquid water.
+       - **Distance from Earth**: Approximately 39 light-years
+
+    4. **LHS 1140b**
+       - **Size**: About 1.4 times the size of Earth and 6.6 times its mass
+       - **Potential Habitability**: Located in the habitable zone of its star. It has a thick atmosphere and conditions that could support life.
+       - **Distance from Earth**: About 40 light-years
+
+    5. **Kepler-186f**
+       - **Size**: Similar to Earth in size
+       - **Potential Habitability**: The first Earth-sized planet discovered in the habitable zone of another star. It has potential for liquid water on its surface.
+       - **Distance from Earth**: About 500 light-years
+
+    6. **K2-18b**
+       - **Size**: Approximately 2.6 times the radius of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, with evidence of water vapor in its atmosphere.
+       - **Distance from Earth**: About 124 light-years
+
+    7. **GJ 357 d**
+       - **Size**: About 6.1 times the mass of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, with the potential to have liquid water on its surface.
+       - **Distance from Earth**: About 31 light-years
+
+    These discoveries highlight the diversity of exoplanets in terms of size, composition, and potential habitability. The search for exoplanets is crucial for understanding the potential for life beyond Earth and the formation and evolution of planetary systems. Ongoing and future missions, such as the James Webb Space Telescope, are expected to provide even more detailed information about these distant worlds.
+
+    The continuous exploration and study of exoplanets will undoubtedly lead to new insights and perhaps even the discovery of life beyond our solar system.
+
+
+
+    > Finished chain.
+     [2024-07-03 04:53:58][DEBUG]: == [Space Researcher] Task output: Over the last decade, the field of exoplanet research has experienced significant advancements, leading to the discovery of thousands of exoplanets. These discoveries have been made possible through missions like NASA's Kepler and TESS (Transiting Exoplanet Survey Satellite), as well as ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, including their size, potential habitability, and distance from Earth:
+
+    1. **Kepler-452b**
+       - **Size**: Approximately 1.6 times the radius of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, where liquid water could exist. It is often referred to as Earth's "cousin."
+       - **Distance from Earth**: About 1,400 light-years
+
+    2. **Proxima Centauri b**
+       - **Size**: About 1.17 times the mass of Earth
+       - **Potential Habitability**: Located in the habitable zone of Proxima Centauri, the closest star to the Sun. It has the potential to have liquid water.
+       - **Distance from Earth**: 4.24 light-years
+
+    3. **TRAPPIST-1 System**
+       - **Size**: The system includes seven Earth-sized planets
+       - **Potential Habitability**: Three of the planets (TRAPPIST-1e, TRAPPIST-1f, and TRAPPIST-1g) are located in the habitable zone and could potentially support liquid water.
+       - **Distance from Earth**: Approximately 39 light-years
+
+    4. **LHS 1140b**
+       - **Size**: About 1.4 times the size of Earth and 6.6 times its mass
+       - **Potential Habitability**: Located in the habitable zone of its star. It has a thick atmosphere and conditions that could support life.
+       - **Distance from Earth**: About 40 light-years
+
+    5. **Kepler-186f**
+       - **Size**: Similar to Earth in size
+       - **Potential Habitability**: The first Earth-sized planet discovered in the habitable zone of another star. It has potential for liquid water on its surface.
+       - **Distance from Earth**: About 500 light-years
+
+    6. **K2-18b**
+       - **Size**: Approximately 2.6 times the radius of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, with evidence of water vapor in its atmosphere.
+       - **Distance from Earth**: About 124 light-years
+
+    7. **GJ 357 d**
+       - **Size**: About 6.1 times the mass of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, with the potential to have liquid water on its surface.
+       - **Distance from Earth**: About 31 light-years
+
+    These discoveries highlight the diversity of exoplanets in terms of size, composition, and potential habitability. The search for exoplanets is crucial for understanding the potential for life beyond Earth and the formation and evolution of planetary systems. Ongoing and future missions, such as the James Webb Space Telescope, are expected to provide even more detailed information about these distant worlds.
+
+    The continuous exploration and study of exoplanets will undoubtedly lead to new insights and perhaps even the discovery of life beyond our solar system.
+
+
+    ### Task Output ###
+    Over the last decade, the field of exoplanet research has experienced significant advancements, leading to the discovery of thousands of exoplanets. These discoveries have been made possible through missions like NASA's Kepler and TESS (Transiting Exoplanet Survey Satellite), as well as ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, including their size, potential habitability, and distance from Earth:
+
+    1. **Kepler-452b**
+       - **Size**: Approximately 1.6 times the radius of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, where liquid water could exist. It is often referred to as Earth's "cousin."
+       - **Distance from Earth**: About 1,400 light-years
+
+    2. **Proxima Centauri b**
+       - **Size**: About 1.17 times the mass of Earth
+       - **Potential Habitability**: Located in the habitable zone of Proxima Centauri, the closest star to the Sun. It has the potential to have liquid water.
+       - **Distance from Earth**: 4.24 light-years
+
+    3. **TRAPPIST-1 System**
+       - **Size**: The system includes seven Earth-sized planets
+       - **Potential Habitability**: Three of the planets (TRAPPIST-1e, TRAPPIST-1f, and TRAPPIST-1g) are located in the habitable zone and could potentially support liquid water.
+       - **Distance from Earth**: Approximately 39 light-years
+
+    4. **LHS 1140b**
+       - **Size**: About 1.4 times the size of Earth and 6.6 times its mass
+       - **Potential Habitability**: Located in the habitable zone of its star. It has a thick atmosphere and conditions that could support life.
+       - **Distance from Earth**: About 40 light-years
+
+    5. **Kepler-186f**
+       - **Size**: Similar to Earth in size
+       - **Potential Habitability**: The first Earth-sized planet discovered in the habitable zone of another star. It has potential for liquid water on its surface.
+       - **Distance from Earth**: About 500 light-years
+
+    6. **K2-18b**
+       - **Size**: Approximately 2.6 times the radius of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, with evidence of water vapor in its atmosphere.
+       - **Distance from Earth**: About 124 light-years
+
+    7. **GJ 357 d**
+       - **Size**: About 6.1 times the mass of Earth
+       - **Potential Habitability**: Located in the habitable zone of its star, with the potential to have liquid water on its surface.
+       - **Distance from Earth**: About 31 light-years
+
+    These discoveries highlight the diversity of exoplanets in terms of size, composition, and potential habitability. The search for exoplanets is crucial for understanding the potential for life beyond Earth and the formation and evolution of planetary systems. Ongoing and future missions, such as the James Webb Space Telescope, are expected to provide even more detailed information about these distant worlds.
+
+    The continuous exploration and study of exoplanets will undoubtedly lead to new insights and perhaps even the discovery of life beyond our solar system.
+:::
+:::

docs/developers/googlecolab.md

@@ -0,0 +1,228 @@
+---
+jupyter:
+  accelerator: GPU
+  colab:
+    gpuType: T4
+  kernelspec:
+    display_name: Python 3
+    name: python3
+  language_info:
+    name: python
+  nbformat: 4
+  nbformat_minor: 0
+---
+
+
+``` python
+!pip install -Uq praisonai
+```
+
+``` python
+import os
+import yaml
+from praisonai import PraisonAI
+from google.colab import userdata
+
+# Example agent_yaml content
+agent_yaml = """
+framework: "crewai"
+topic: "Space Exploration"
+
+roles:
+  astronomer:
+    role: "Space Researcher"
+    goal: "Discover new insights about {topic}"
+    backstory: "You are a curious and dedicated astronomer with a passion for unraveling the mysteries of the cosmos."
+    tasks:
+      investigate_exoplanets:
+        description: "Research and compile information about exoplanets discovered in the last decade."
+        expected_output: "A summarized report on exoplanet discoveries, including their size, potential habitability, and distance from Earth."
+"""
+
+# Create a PraisonAI instance with the agent_yaml content
+praison_ai = PraisonAI(agent_yaml=agent_yaml)
+
+# Add OPENAI_API_KEY Secrets to Google Colab on the Left Hand Side 🔑 or Enter Manually Below
+os.environ["OPENAI_API_KEY"] = userdata.get('OPENAI_API_KEY') or "ENTER OPENAI_API_KEY HERE"
+
+# Run PraisonAI
+result = praison_ai.main()
+
+# Print the result
+print(result)
+```
+
+
+     [2024-07-03 04:39:09][DEBUG]: == Working Agent: Space Researcher
+     [2024-07-03 04:39:09][INFO]: == Starting Task: Research and compile information about exoplanets discovered in the last decade.
+
+
+    > Entering new CrewAgentExecutor chain...
+    I now can give a great answer.
+
+    Final Answer: 
+
+    In the last decade, the field of exoplanet research has experienced a remarkable surge in discoveries, thanks to advancements in technology and dedicated space missions such as Kepler, TESS (Transiting Exoplanet Survey Satellite), and various ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, highlighting their size, potential habitability, and distance from Earth:
+
+    1. **Kepler-452b**
+       - **Size:** Approximately 60% larger in diameter than Earth.
+       - **Potential Habitability:** Often referred to as "Earth's Cousin," Kepler-452b orbits within the habitable zone of its star, where liquid water could exist. The planet receives a similar amount of energy from its star as Earth does from the Sun.
+       - **Distance from Earth:** About 1,402 light-years.
+
+    2. **Proxima Centauri b**
+       - **Size:** Slightly larger than Earth, with a minimum mass of 1.17 Earth masses.
+       - **Potential Habitability:** Located in the habitable zone of Proxima Centauri, the closest known star to the Sun. Potential for liquid water exists, but its habitability is uncertain due to stellar flare activity.
+       - **Distance from Earth:** 4.24 light-years.
+
+    3. **TRAPPIST-1 System**
+       - **Size:** The system contains seven Earth-sized planets. TRAPPIST-1e, f, and g are within the star's habitable zone.
+       - **Potential Habitability:** TRAPPIST-1e is considered the most promising candidate for habitability, as it has a rocky composition and is located in the middle of the habitable zone.
+       - **Distance from Earth:** About 39 light-years.
+
+    4. **LHS 1140 b**
+       - **Size:** About 1.4 times the size of Earth with a mass of around 6.6 Earth masses.
+       - **Potential Habitability:** Resides in the habitable zone of its red dwarf star. The planet is likely rocky and has an atmosphere that could support life.
+       - **Distance from Earth:** Approximately 40 light-years.
+
+    5. **K2-18b**
+       - **Size:** About 2.6 times the size of Earth with a mass of 8.6 Earth masses.
+       - **Potential Habitability:** This exoplanet lies within the habitable zone and has been detected to have water vapor in its atmosphere. It is considered one of the most promising candidates for habitability outside our solar system.
+       - **Distance from Earth:** Roughly 124 light-years.
+
+    6. **Gliese 667 Cc**
+       - **Size:** At least 4.5 times the mass of Earth.
+       - **Potential Habitability:** Orbits within the habitable zone of its host star, Gliese 667 C. Its orbit allows for the possibility of liquid water on its surface.
+       - **Distance from Earth:** About 23.62 light-years.
+
+    7. **HD 40307 g**
+       - **Size:** A super-Earth with at least 7 Earth masses.
+       - **Potential Habitability:** Located in the habitable zone of its star, this planet could potentially support liquid water and therefore life.
+       - **Distance from Earth:** Approximately 42 light-years.
+
+    8. **Ross 128 b**
+       - **Size:** Similar to Earth, with a minimum mass of 1.35 Earth masses.
+       - **Potential Habitability:** Orbits within the habitable zone of the relatively quiet red dwarf star Ross 128. The planet has mild temperatures that could allow for liquid water.
+       - **Distance from Earth:** About 11 light-years.
+
+    9. **Teegarden's Star b**
+       - **Size:** Comparable to Earth.
+       - **Potential Habitability:** Orbits within the habitable zone of Teegarden's Star, a cool red dwarf. Conditions could be suitable for liquid water.
+       - **Distance from Earth:** Approximately 12 light-years.
+
+    10. **Barnard's Star b**
+        - **Size:** A super-Earth with a mass of about 3.2 Earth masses.
+        - **Potential Habitability:** Located just outside the traditional habitable zone, but still within a range where liquid water could exist under certain conditions.
+        - **Distance from Earth:** About 6 light-years.
+
+    These discoveries highlight the diverse and intriguing nature of exoplanets found in the last decade. Each of these planets adds valuable information to our understanding of planetary formation, potential habitability, and the search for extraterrestrial life. Continued advancements in detection methods and technologies promise to further expand our knowledge in the years to come.
+
+    > Finished chain.
+     [2024-07-03 04:39:25][DEBUG]: == [Space Researcher] Task output: In the last decade, the field of exoplanet research has experienced a remarkable surge in discoveries, thanks to advancements in technology and dedicated space missions such as Kepler, TESS (Transiting Exoplanet Survey Satellite), and various ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, highlighting their size, potential habitability, and distance from Earth:
+
+    1. **Kepler-452b**
+       - **Size:** Approximately 60% larger in diameter than Earth.
+       - **Potential Habitability:** Often referred to as "Earth's Cousin," Kepler-452b orbits within the habitable zone of its star, where liquid water could exist. The planet receives a similar amount of energy from its star as Earth does from the Sun.
+       - **Distance from Earth:** About 1,402 light-years.
+
+    2. **Proxima Centauri b**
+       - **Size:** Slightly larger than Earth, with a minimum mass of 1.17 Earth masses.
+       - **Potential Habitability:** Located in the habitable zone of Proxima Centauri, the closest known star to the Sun. Potential for liquid water exists, but its habitability is uncertain due to stellar flare activity.
+       - **Distance from Earth:** 4.24 light-years.
+
+    3. **TRAPPIST-1 System**
+       - **Size:** The system contains seven Earth-sized planets. TRAPPIST-1e, f, and g are within the star's habitable zone.
+       - **Potential Habitability:** TRAPPIST-1e is considered the most promising candidate for habitability, as it has a rocky composition and is located in the middle of the habitable zone.
+       - **Distance from Earth:** About 39 light-years.
+
+    4. **LHS 1140 b**
+       - **Size:** About 1.4 times the size of Earth with a mass of around 6.6 Earth masses.
+       - **Potential Habitability:** Resides in the habitable zone of its red dwarf star. The planet is likely rocky and has an atmosphere that could support life.
+       - **Distance from Earth:** Approximately 40 light-years.
+
+    5. **K2-18b**
+       - **Size:** About 2.6 times the size of Earth with a mass of 8.6 Earth masses.
+       - **Potential Habitability:** This exoplanet lies within the habitable zone and has been detected to have water vapor in its atmosphere. It is considered one of the most promising candidates for habitability outside our solar system.
+       - **Distance from Earth:** Roughly 124 light-years.
+
+    6. **Gliese 667 Cc**
+       - **Size:** At least 4.5 times the mass of Earth.
+       - **Potential Habitability:** Orbits within the habitable zone of its host star, Gliese 667 C. Its orbit allows for the possibility of liquid water on its surface.
+       - **Distance from Earth:** About 23.62 light-years.
+
+    7. **HD 40307 g**
+       - **Size:** A super-Earth with at least 7 Earth masses.
+       - **Potential Habitability:** Located in the habitable zone of its star, this planet could potentially support liquid water and therefore life.
+       - **Distance from Earth:** Approximately 42 light-years.
+
+    8. **Ross 128 b**
+       - **Size:** Similar to Earth, with a minimum mass of 1.35 Earth masses.
+       - **Potential Habitability:** Orbits within the habitable zone of the relatively quiet red dwarf star Ross 128. The planet has mild temperatures that could allow for liquid water.
+       - **Distance from Earth:** About 11 light-years.
+
+    9. **Teegarden's Star b**
+       - **Size:** Comparable to Earth.
+       - **Potential Habitability:** Orbits within the habitable zone of Teegarden's Star, a cool red dwarf. Conditions could be suitable for liquid water.
+       - **Distance from Earth:** Approximately 12 light-years.
+
+    10. **Barnard's Star b**
+        - **Size:** A super-Earth with a mass of about 3.2 Earth masses.
+        - **Potential Habitability:** Located just outside the traditional habitable zone, but still within a range where liquid water could exist under certain conditions.
+        - **Distance from Earth:** About 6 light-years.
+
+    These discoveries highlight the diverse and intriguing nature of exoplanets found in the last decade. Each of these planets adds valuable information to our understanding of planetary formation, potential habitability, and the search for extraterrestrial life. Continued advancements in detection methods and technologies promise to further expand our knowledge in the years to come.
+
+
+    ### Task Output ###
+    In the last decade, the field of exoplanet research has experienced a remarkable surge in discoveries, thanks to advancements in technology and dedicated space missions such as Kepler, TESS (Transiting Exoplanet Survey Satellite), and various ground-based observatories. Here is a summarized report on some of the notable exoplanet discoveries, highlighting their size, potential habitability, and distance from Earth:
+
+    1. **Kepler-452b**
+       - **Size:** Approximately 60% larger in diameter than Earth.
+       - **Potential Habitability:** Often referred to as "Earth's Cousin," Kepler-452b orbits within the habitable zone of its star, where liquid water could exist. The planet receives a similar amount of energy from its star as Earth does from the Sun.
+       - **Distance from Earth:** About 1,402 light-years.
+
+    2. **Proxima Centauri b**
+       - **Size:** Slightly larger than Earth, with a minimum mass of 1.17 Earth masses.
+       - **Potential Habitability:** Located in the habitable zone of Proxima Centauri, the closest known star to the Sun. Potential for liquid water exists, but its habitability is uncertain due to stellar flare activity.
+       - **Distance from Earth:** 4.24 light-years.
+
+    3. **TRAPPIST-1 System**
+       - **Size:** The system contains seven Earth-sized planets. TRAPPIST-1e, f, and g are within the star's habitable zone.
+       - **Potential Habitability:** TRAPPIST-1e is considered the most promising candidate for habitability, as it has a rocky composition and is located in the middle of the habitable zone.
+       - **Distance from Earth:** About 39 light-years.
+
+    4. **LHS 1140 b**
+       - **Size:** About 1.4 times the size of Earth with a mass of around 6.6 Earth masses.
+       - **Potential Habitability:** Resides in the habitable zone of its red dwarf star. The planet is likely rocky and has an atmosphere that could support life.
+       - **Distance from Earth:** Approximately 40 light-years.
+
+    5. **K2-18b**
+       - **Size:** About 2.6 times the size of Earth with a mass of 8.6 Earth masses.
+       - **Potential Habitability:** This exoplanet lies within the habitable zone and has been detected to have water vapor in its atmosphere. It is considered one of the most promising candidates for habitability outside our solar system.
+       - **Distance from Earth:** Roughly 124 light-years.
+
+    6. **Gliese 667 Cc**
+       - **Size:** At least 4.5 times the mass of Earth.
+       - **Potential Habitability:** Orbits within the habitable zone of its host star, Gliese 667 C. Its orbit allows for the possibility of liquid water on its surface.
+       - **Distance from Earth:** About 23.62 light-years.
+
+    7. **HD 40307 g**
+       - **Size:** A super-Earth with at least 7 Earth masses.
+       - **Potential Habitability:** Located in the habitable zone of its star, this planet could potentially support liquid water and therefore life.
+       - **Distance from Earth:** Approximately 42 light-years.
+
+    8. **Ross 128 b**
+       - **Size:** Similar to Earth, with a minimum mass of 1.35 Earth masses.
+       - **Potential Habitability:** Orbits within the habitable zone of the relatively quiet red dwarf star Ross 128. The planet has mild temperatures that could allow for liquid water.
+       - **Distance from Earth:** About 11 light-years.
+
+    9. **Teegarden's Star b**
+       - **Size:** Comparable to Earth.
+       - **Potential Habitability:** Orbits within the habitable zone of Teegarden's Star, a cool red dwarf. Conditions could be suitable for liquid water.
+       - **Distance from Earth:** Approximately 12 light-years.
+
+    10. **Barnard's Star b**
+        - **Size:** A super-Earth with a mass of about 3.2 Earth masses.
+        - **Potential Habitability:** Located just outside the traditional habitable zone, but still within a range where liquid water could exist under certain conditions.
+        - **Distance from Earth:** About 6 light-years.
+
+    These discoveries highlight the diverse and intriguing nature of exoplanets found in the last decade. Each of these planets adds valuable information to our understanding of planetary formation, potential habitability, and the search for extraterrestrial life. Continued advancements in detection methods and technologies promise to further expand our knowledge in the years to come.

docs/developers/test.md

@@ -0,0 +1,5 @@
+# Test
+    
+```bash
+python -m unittest tests.test 
+```

docs/developers/wrapper-tools.md

@@ -0,0 +1,43 @@
+# Integrate with Tools
+
+```python
+from praisonai import PraisonAI
+from duckduckgo_search import DDGS
+from praisonai_tools import BaseTool
+
+class InternetSearchTool(BaseTool):
+    name: str = "InternetSearchTool"
+    description: str = "Search Internet for relevant information based on a query or latest news"
+
+    def _run(self, query: str):
+        ddgs = DDGS()
+        results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
+        return results
+
+# Example agent_yaml content
+agent_yaml = """
+framework: "crewai"
+topic: "Space Exploration"
+
+roles:
+  astronomer:
+    role: "Space Researcher"
+    goal: "Discover new insights about {topic}"
+    backstory: "You are a curious and dedicated astronomer with a passion for unraveling the mysteries of the cosmos."
+    tasks:
+      investigate_exoplanets:
+        description: "Research and compile information about exoplanets discovered in the last decade."
+        expected_output: "A summarized report on exoplanet discoveries, including their size, potential habitability, and distance from Earth."
+    tools:
+      - "InternetSearchTool"
+"""
+
+# Create a PraisonAI instance with the agent_yaml content
+praison_ai = PraisonAI(agent_yaml=agent_yaml)
+
+# Run PraisonAI
+result = praison_ai.main()
+
+# Print the result
+print(result)
+```

docs/developers/wrapper.md

@@ -0,0 +1,79 @@
+# Include praisonai package in your project
+
+## Option 1: Using RAW YAML
+
+```python
+from praisonai import PraisonAI
+
+# Example agent_yaml content
+agent_yaml = """
+framework: "crewai"
+topic: "Space Exploration"
+
+roles:
+  astronomer:
+    role: "Space Researcher"
+    goal: "Discover new insights about {topic}"
+    backstory: "You are a curious and dedicated astronomer with a passion for unraveling the mysteries of the cosmos."
+    tasks:
+      investigate_exoplanets:
+        description: "Research and compile information about exoplanets discovered in the last decade."
+        expected_output: "A summarized report on exoplanet discoveries, including their size, potential habitability, and distance from Earth."
+"""
+
+# Create a PraisonAI instance with the agent_yaml content
+praison_ai = PraisonAI(agent_yaml=agent_yaml)
+
+# Run PraisonAI
+result = praison_ai.main()
+
+# Print the result
+print(result)
+```
+
+## Option 2: Using separate agents.yaml file
+
+
+Note: Please create agents.yaml file before hand. 
+
+```python
+from praisonai import PraisonAI
+
+def basic(): # Basic Mode
+    praison_ai = PraisonAI(agent_file="agents.yaml")
+    praison_ai.main()
+
+if __name__ == "__main__":
+    basic()
+```
+
+## Other options
+
+```python
+from praisonai import PraisonAI
+
+def basic(): # Basic Mode
+    praison_ai = PraisonAI(agent_file="agents.yaml")
+    praison_ai.main()
+    
+def advanced(): # Advanced Mode with options
+    praison_ai = PraisonAI(
+        agent_file="agents.yaml",
+        framework="autogen",
+    )
+    praison_ai.main()
+    
+def auto(): # Full Automatic Mode
+    praison_ai = PraisonAI(
+        auto="Create a movie script about car in mars",
+        framework="autogen"
+    )
+    print(praison_ai.framework)
+    praison_ai.main()
+
+if __name__ == "__main__":
+    basic()
+    advanced()
+    auto()
+```
+

docs/firecrawl.md

@@ -0,0 +1,42 @@
+# Firecrawl PraisonAI Integration
+
+## Firecrawl running in Localhost:3002
+
+```python
+from firecrawl import FirecrawlApp
+from praisonai_tools import BaseTool
+import re
+
+class WebPageScraperTool(BaseTool):
+    name: str = "Web Page Scraper Tool"
+    description: str = "Scrape and extract information from a given web page URL."
+
+    def _run(self, url: str) -> str:
+        app = FirecrawlApp(api_url='http://localhost:3002')
+        response = app.scrape_url(url=url)
+        content = response["content"]
+        # Remove all content above the line "========================================================"
+        if "========================================================" in content:
+            content = content.split("========================================================", 1)[1]
+
+        # Remove all menu items and similar patterns
+        content = re.sub(r'\*\s+\[.*?\]\(.*?\)', '', content)
+        content = re.sub(r'\[Skip to the content\]\(.*?\)', '', content)
+        content = re.sub(r'\[.*?\]\(.*?\)', '', content)
+        content = re.sub(r'\s*Menu\s*', '', content)
+        content = re.sub(r'\s*Search\s*', '', content)
+        content = re.sub(r'Categories\s*', '', content)
+
+        # Remove all URLs
+        content = re.sub(r'http\S+', '', content)
+        
+        # Remove empty lines or lines with only whitespace
+        content = '\n'.join([line for line in content.split('\n') if line.strip()])
+
+        # Limit to the first 1000 words
+        words = content.split()
+        if len(words) > 1000:
+            content = ' '.join(words[:1000])
+        
+        return content
+```

docs/framework/autogen.md

@@ -0,0 +1,19 @@
+# AutoGen Low Code with Praison AI
+
+Low Code solution to run AutoGen
+
+```bash
+pip install praisonai
+```
+
+```bash
+export OPENAI_API_KEY=xxxxxxxxxx
+```
+
+```bash
+praisonai --framework autogen --init Create a Movie Script About Cat in Mars
+```
+
+```bash
+praisonai --framework autogen
+```

docs/framework/crewai.md

@@ -0,0 +1,19 @@
+# CrewAI Low Code with PraisonAI
+
+Low Code solution to run CrewAI
+
+```bash
+pip install praisonai
+```
+
+```bash
+export OPENAI_API_KEY=xxxxxxxxxx
+```
+
+```bash
+praisonai --framework crewai --init Create a Movie Script About Cat in Mars
+```
+
+```bash
+praisonai --framework crewai
+```

docs/generate_docs.sh

@@ -0,0 +1,11 @@
+#!/bin/sh
+set -e  # Exit if any command fails
+
+# Install necessary packages
+pip install pdoc3 mkdocs mkdocs-material duckduckgo_search
+
+# Generate HTML documentation with pdoc
+pdoc --html --skip-errors -o docs/api praisonai --force
+
+# Build the MkDocs site
+mkdocs build

docs/generate_from_readme.sh

@@ -0,0 +1,64 @@
+#!/bin/bash
+
+# Ensure we are in the docs folder
+cd "$(dirname "$0")"
+
+# Define the sections and their corresponding filenames
+sections=(
+  "Praison AI:index.md"
+  "TL;DR:tldr.md"
+  "Installation:installation.md"
+  "Initialise:initialise.md"
+  "Run:run.md"
+  "Create Custom Tools:create_custom_tools.md"
+  "Test:test.md"
+  "Agents Playbook:agents_playbook.md"
+  "Include praisonai package in your project:include_package.md"
+  "Deploy:deploy.md"
+  "Other Models:other_models.md"
+  "Contributing:contributing.md"
+)
+
+# Function to extract section content
+extract_section() {
+  section_name="$1"
+  input_file="$2"
+  output_file="$3"
+  
+  # Escape special characters in section name for use in regex
+  section_name_escaped=$(echo "$section_name" | sed 's/[.[\*^$(){}?+|]/\\&/g')
+  
+  # Extract content
+  if command -v gsed > /dev/null; then
+    gsed -n "/## $section_name_escaped/,/## /{p;}" "$input_file" | gsed '$d' >> "$output_file"
+  else
+    sed -n "/## $section_name_escaped/,/## /{p;}" "$input_file" | sed '$d' >> "$output_file"
+  fi
+}
+
+# Extract content above the first section from README.md
+if command -v gsed > /dev/null; then
+  gsed -n '1,/^## /{p;}' ../README.md | gsed '$d' > index.md
+else
+  sed -n '1,/^## /{p;}' ../README.md | sed '$d' > index.md
+fi
+
+# Create the files and add content
+for section in "${sections[@]}"; do
+  section_name="${section%%:*}"
+  filename="${section##*:}"
+  if [[ "$filename" == "index.md" ]]; then
+    extract_section "$section_name" ../README.md index.md
+  elif [[ "$section_name" == "TL;DR" ]]; then
+    extract_section "$section_name" ../README.md index.md
+  else
+    extract_section "$section_name" ../README.md "$filename"
+  fi
+done
+
+# Special handling for the last section (Contributing)
+if command -v gsed > /dev/null; then
+  gsed -n "/## Contributing/,\$p" ../README.md > "contributing.md"
+else
+  sed -n "/## Contributing/,\$p" ../README.md > "contributing.md"
+fi

docs/home.md

@@ -0,0 +1,52 @@
+# Home
+
+## Installation
+
+```bash
+pip install praisonai
+```
+
+## Initialise
+
+```bash
+export OPENAI_API_KEY="Enter your API key"
+```
+
+Generate your OPENAI API KEY from here: https://platform.openai.com/api-keys
+
+Note: You can use other providers such as Ollama, Mistral ... etc. Details are provided at the bottom.
+    
+```bash
+praisonai --init create a movie script about dog in moon
+```
+This will automatically create agents.yaml file in the current directory.
+
+### To initialse with a specific agent framework (Optional):
+
+```bash
+praisonai --framework autogen --init create movie script about cat in mars
+```
+
+## Run
+
+```bash
+praisonai
+```
+
+or 
+    
+```bash
+python -m praisonai
+```
+
+### Specify the agent framework (Optional):
+
+```bash
+praisonai --framework autogen
+```
+
+### Full Automatic Mode
+
+```bash
+praisonai --auto create a movie script about Dog in Moon
+```

docs/index.md

@@ -0,0 +1,26 @@
+# Praison AI
+
+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.
+
+## Prerequisite:
+### Export API KEY
+
+```bash
+export OPENAI_API_KEY="Enter your API key"
+```
+
+## Installation
+
+```bash
+pip install praisonai
+```
+
+## Automatically Create Agents to Perform a Task
+
+```bash
+praisonai --init create a movie script about dog in moon
+```
+## Run
+```bash
+praisonai
+```

docs/index.rst

@@ -0,0 +1,20 @@
+.. PraisonAI documentation master file, created by
+   sphinx-quickstart on Mon Jun 10 12:11:57 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to PraisonAI's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/initialise.md

@@ -0,0 +1,14 @@
+# Initialise
+
+```bash
+export OPENAI_API_KEY="Enter your API key"
+```
+
+Generate your OPENAI API KEY from here: https://platform.openai.com/api-keys
+
+Note: You can use other providers such as Ollama, Mistral ... etc. Details are provided at the bottom.
+    
+```bash
+praisonai --init create a movie script about dog in moon
+```
+This will automatically create agents.yaml file in the current directory.

docs/installation.md

@@ -0,0 +1,5 @@
+# Installation
+
+```bash
+pip install praisonai
+```

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/models.md

@@ -0,0 +1,67 @@
+# Models in PraisonAI
+
+- [OpenAI](models/openai.md)
+- [Groq](models/groq.md)
+- [Google Gemini](models/google.md)
+- [Anthropic Claude](models/anthropic.md)
+- [Cohere](models/cohere.md)
+- [Mistral](models/mistral.md)
+- [Ollama](models/ollama.md)
+- [Other Models](models/other.md)
+
+
+## Example agents.yaml
+
+This uses Multi-Agents with Multi-LLMs.
+
+```yaml
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    llm:  
+      model: "groq/llama3-70b-8192"
+    function_calling_llm: 
+      model: "google/gemini-1.5-flash-001"
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung
+          diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - 'InternetSearchTool'
+  medical_writer:
+    backstory: Skilled in translating complex medical information into accessible
+      content.
+    goal: Compile comprehensive content on lung disease causes
+    role: Medical Writer
+    llm:  
+      model: "anthropic/claude-3-haiku-20240307"
+    function_calling_llm: 
+      model: "openai/gpt-4o"
+    tasks:
+      content_creation:
+        description: Create detailed content summarizing the research findings on
+          lung disease causes.
+        expected_output: Document outlining various causes and risk factors of lung
+          diseases.
+    tools:
+    - ''
+  editor:
+    backstory: Proficient in editing medical content for accuracy and clarity.
+    goal: Review and refine content on lung disease causes
+    role: Editor
+    llm:  
+      model: "cohere/command-r"
+    tasks:
+      content_review:
+        description: Edit and refine the compiled content on lung disease causes for
+          accuracy and coherence.
+        expected_output: Finalized document on lung disease causes ready for dissemination.
+    tools:
+    - ''
+dependencies: []
+```

docs/models/anthropic.md

@@ -0,0 +1,31 @@
+# Add Anthropic to Praison AI
+
+```bash
+pip install langchain-anthropic
+```
+```bash
+export ANTHROPIC_API_KEY=xxxxxxxxxx
+```
+
+### agents.yaml file
+
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    llm:  
+      model: "anthropic/claude-3-haiku-20240307"
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```

docs/models/cohere.md

@@ -0,0 +1,31 @@
+# Add COHERE to Praison AI
+
+```bash
+pip install langchain-cohere
+```
+```bash
+export COHERE_API_KEY=xxxxxxxxxx
+```
+
+### agents.yaml file
+
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    llm:  
+      model: "cohere/command-r"
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```

docs/models/google.md

@@ -0,0 +1,31 @@
+# Add Google Gemini to Praison AI
+
+```bash
+pip install langchain-google-genai
+```
+```bash
+export GOOGLE_API_KEY=xxxxxxxxxx
+```
+
+### agents.yaml file
+
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    llm:  
+      model: "google/gemini-1.5-flash-001"
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```

docs/models/groq.md

@@ -0,0 +1,28 @@
+# Add GROQ to Praison AI
+
+```bash
+export GROQ_API_KEY=xxxxxxxxxx
+```
+
+### agents.yaml file
+
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    llm:  
+      model: "groq/llama3-70b-8192"
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```

docs/models/mistral.md

@@ -0,0 +1,32 @@
+# 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 
+
+## Using Single Agent
+
+```bash
+export OPENAI_API_KEY=xxxxxxxxxx
+export OPENAI_MODEL_NAME=mistral-large
+export OPENAI_API_BASE="https://api.mistral.ai/v1"
+```
+
+### agents.yaml file
+
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```

docs/models/ollama.md

@@ -0,0 +1,24 @@
+# Add Ollama to Praison AI
+
+### agents.yaml file
+
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    llm:  
+      model: "ollama/llama3"
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```

docs/models/openai.md

@@ -0,0 +1,85 @@
+# Add OPENAI ChatGPT to Praison AI
+
+## Using Single Agent
+
+```bash
+export OPENAI_API_KEY=xxxxxxxxxx
+export OPENAI_MODEL_NAME=gpt-4o
+```
+
+### agents.yaml file
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```
+
+You can also mention the model name in the agents.yaml file
+
+### agents.yaml file
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    llm:  
+      model: "gpt-4o"
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```
+
+
+## Using Multi Agents
+
+```bash
+pip install langchain-openai
+```
+```bash
+export OPENAI_API_KEY=xxxxxxxxxx
+```
+
+### agents.yaml file
+
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    llm:  
+      model: "openai/gpt-4o"
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```

docs/models/openrouter.md

@@ -0,0 +1,28 @@
+# Add OpenRouter to Praison AI
+
+```bash
+export OPENROUTER_API_KEY=xxxxxxxxxx
+```
+
+### agents.yaml file
+
+```yaml
+framework: crewai
+topic: create movie script about cat in mars
+roles:
+  researcher:
+    backstory: Skilled in finding and organizing information, with a focus on research
+      efficiency.
+    goal: Gather information about Mars and cats
+    role: Researcher
+    llm:  
+      model: "openrouter/anthropic/claude-3.5-sonnet"
+    tasks:
+      gather_research:
+        description: Research and gather information about Mars, its environment,
+          and cats, including their behavior and characteristics.
+        expected_output: Document with research findings, including interesting facts
+          and information.
+    tools:
+    - ''
+```

docs/models/other.md

@@ -0,0 +1,24 @@
+# Other Models
+
+```bash
+# Ollama
+OPENAI_API_BASE='http://localhost:11434/v1'
+OPENAI_MODEL_NAME='mistral'
+OPENAI_API_KEY='NA'
+
+# FastChat
+OPENAI_API_BASE="http://localhost:8001/v1"
+OPENAI_MODEL_NAME='oh-2.5m7b-q51'
+OPENAI_API_KEY=NA
+
+# LM Studio
+OPENAI_API_BASE="http://localhost:1234/v1"
+OPENAI_MODEL_NAME=NA
+OPENAI_API_KEY=NA
+
+# Mistral API
+OPENAI_API_BASE=https://api.mistral.ai/v1
+OPENAI_MODEL_NAME="mistral-small"
+OPENAI_API_KEY=your-mistral-api-key
+```
+

docs/monitoring/agentops.md

@@ -0,0 +1,13 @@
+# AgentOps PraisonAI Monitoring
+
+```bash
+pip install "praisonai[agentops]"
+```
+
+```bash
+export AGENTOPS_API_KEY=xxxxxxxx
+```
+
+## Dashboard
+
+![PraisonAI AgentOps Monitoring](../images/praisonai-agentops-monitoring.png)

docs/requirements.in

@@ -0,0 +1,12 @@
+sphinx
+sphinx_rtd_theme
+sphinx-autodoc-typehints
+mkdocs
+markdown-include
+mkdocs-material
+mkdocs-jupyter
+pymdown-extensions
+Pygments
+pdoc3
+xmlrunner
+unittest2

docs/requirements.txt

@@ -0,0 +1,24 @@
+sphinx
+sphinx_rtd_theme
+sphinx-autodoc-typehints
+mkdocs
+markdown-include
+mkdocs-material
+mkdocs-jupyter
+mkdocs-glightbox
+pymdown-extensions
+Pygments
+mkdocstrings 
+mkdocs-apidoc 
+mkdocstrings-python
+mkdocs-jupyter
+pdoc3
+rich
+pyautogen
+crewai
+gradio
+duckduckgo_search
+praisonai_tools
+open-interpreter
+xmlrunner
+unittest2

docs/run.md

@@ -0,0 +1,23 @@
+# Run
+
+```bash
+praisonai
+```
+
+or 
+    
+```bash
+python -m praisonai
+```
+
+## Specify the agent framework (Optional):
+
+```bash
+praisonai --framework autogen
+```
+
+## Full Automatic Mode
+
+```bash
+praisonai --auto create a movie script about Dog in Moon
+```

docs/tldr.md

@@ -0,0 +1,20 @@
+# TL;DR
+
+## Run throught Terminal
+
+```bash
+pip install praisonai
+export OPENAI_API_KEY="Enter your API key"
+praisonai --init create a movie script about dog in moon
+praisonai
+```
+
+## User Interface
+
+```bash
+pip install -U "praisonai[ui]"
+export OPENAI_API_KEY="Enter your API key"
+chainlit create-secret
+export CHAINLIT_AUTH_SECRET=xxxxxxxx
+praisonai ui
+```

docs/tools.md

@@ -0,0 +1,43 @@
+# Tools
+
+## Inbuild Tools
+
+- CodeDocsSearchTool
+- CSVSearchTool
+- DirectorySearchTool
+- DirectoryReadTool
+- DOCXSearchTool
+- FileReadTool
+- GithubSearchTool
+- SerperDevTool
+- TXTSearchTool
+- JSONSearchTool
+- MDXSearchTool
+- PDFSearchTool
+- PGSearchTool
+- RagTool
+- ScrapeElementFromWebsiteTool
+- ScrapeWebsiteTool
+- SeleniumScrapingTool
+- WebsiteSearchTool
+- XMLSearchTool
+- YoutubeChannelSearchTool
+- YoutubeVideoSearchTool
+
+## Example Usage
+
+```yaml
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - WebsiteSearchTool
+```

docs/tools/crawl4ai.md

@@ -0,0 +1,72 @@
+# Crawl4AI Praison AI Integration
+
+## Install
+
+```bash
+pip install "crawl4ai @ git+https://github.com/unclecode/crawl4ai.git" transformers torch nltk
+```
+
+```bash
+pip install praisonai
+export OPENAI_API_KEY=xxxxxxxxx
+```
+
+## tools.py
+
+```python
+import os
+from crawl4ai import WebCrawler
+from crawl4ai.extraction_strategy import LLMExtractionStrategy
+from pydantic import BaseModel, Field
+
+class OpenAIModelFee(BaseModel):
+    model_name: str = Field(..., description="Name of the OpenAI model.")
+    input_fee: str = Field(..., description="Fee for input token for the OpenAI model.")
+    output_fee: str = Field(..., description="Fee for output token ßfor the OpenAI model.")
+
+url = 'https://openai.com/api/pricing/'
+crawler = WebCrawler()
+crawler.warmup()
+
+result = crawler.run(
+        url=url,
+        word_count_threshold=1,
+        extraction_strategy= LLMExtractionStrategy(
+            provider= "openai/gpt-4o", api_token = os.getenv('OPENAI_API_KEY'), 
+            schema=OpenAIModelFee.schema(),
+            extraction_type="schema",
+            instruction="""From the crawled content, extract all mentioned model names along with their fees for input and output tokens. 
+            Do not miss any models in the entire content. One extracted model JSON format should look like this: 
+            {"model_name": "GPT-4", "input_fee": "US$10.00 / 1M tokens", "output_fee": "US$30.00 / 1M tokens"}."""
+        ),            
+        bypass_cache=True,
+    )
+
+print(result.extracted_content)
+```
+
+## agents.yaml
+
+```yaml
+framework: crewai
+topic: extract model pricing from websites
+roles:
+  web_scraper:
+    backstory: An expert in web scraping with a deep understanding of extracting structured
+      data from online sources. https://openai.com/api/pricing/ https://www.anthropic.com/pricing https://cohere.com/pricing
+    goal: Gather model pricing data from various websites
+    role: Web Scraper
+    tasks:
+      scrape_model_pricing:
+        description: Scrape model pricing information from the provided list of websites.
+        expected_output: Raw HTML or JSON containing model pricing data.
+    tools:
+    - 'ModelFeeTool'
+dependencies: []
+```
+
+## Run
+
+```bash
+praisonai
+```

docs/tools/custom.md

@@ -0,0 +1,137 @@
+# Create Custom Tools
+
+Sure! Let's go through the steps to install and set up the PraisonAI tool.
+
+Quickstart: Use [PraisonAI Tools Creator GPT](../tools/gpt.md) to get started quickly.
+
+## Step 1: Install the `praisonai` Package
+
+First, you need to install the `praisonai` package. Open your terminal and run the following command:
+
+```bash
+pip install praisonai
+```
+
+## Step 2: Create the `InternetSearchTool`
+
+Next, create a file named `tools.py` and add the following code to define the `InternetSearchTool`:
+
+```python
+from duckduckgo_search import DDGS
+from praisonai_tools import BaseTool
+
+class InternetSearchTool(BaseTool):
+    name: str = "Internet Search Tool"
+    description: str = "Search Internet for relevant information based on a query or latest news"
+
+    def _run(self, query: str):
+        ddgs = DDGS()
+        results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
+        return results
+```
+
+## Step 3: Define the Agent Configuration
+
+Create a file named `agents.yaml` and add the following content to configure the agent:
+
+```yaml
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - InternetSearchTool
+```
+
+## Step 4: Run the PraisonAI Tool
+
+To run the PraisonAI tool, simply type the following command in your terminal:
+
+```bash
+praisonai
+```
+
+If you want to run the `autogen` framework, use:
+
+```bash
+praisonai --framework autogen
+```
+
+## Prerequisites
+
+Ensure you have the `duckduckgo_search` package installed. If not, you can install it using:
+
+```bash
+pip install duckduckgo_search
+```
+
+That's it! You should now have the PraisonAI tool installed and configured.
+
+## Other information
+
+### TL;DR to Create a Custom Tool
+
+```bash
+pip install praisonai duckduckgo-search
+export OPENAI_API_KEY="Enter your API key"
+praisonai --init research about the latest AI News and prepare a detailed report
+```
+
+- Add `- InternetSearchTool` in the agents.yaml file in the tools section. 
+- Create a file called tools.py and add this code [tools.py](tools.py)
+
+```bash
+praisonai
+```
+
+### Pre-requisite to Create a Custom Tool
+`agents.yaml` file should be present in the current directory. 
+
+If it doesn't exist, create it by running the command `praisonai --init research about the latest AI News and prepare a detailed report`.
+
+#### Step 1 to Create a Custom Tool
+
+Create a file called tools.py in the same directory as the agents.yaml file.
+
+```python
+# example tools.py
+from duckduckgo_search import DDGS
+from praisonai_tools import BaseTool
+
+class InternetSearchTool(BaseTool):
+    name: str = "InternetSearchTool"
+    description: str = "Search Internet for relevant information based on a query or latest news"
+
+    def _run(self, query: str):
+        ddgs = DDGS()
+        results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
+        return results
+```
+
+#### Step 2 to Create a Custom Tool
+
+Add the tool to the agents.yaml file as show below under the tools section `- InternetSearchTool`.
+
+```yaml
+framework: crewai
+topic: research about the latest AI News and prepare a detailed report
+roles:
+  research_analyst:
+    backstory: Experienced in gathering and analyzing data related to AI news trends.
+    goal: Analyze AI News trends
+    role: Research Analyst
+    tasks:
+      gather_data:
+        description: Conduct in-depth research on the latest AI News trends from reputable
+          sources.
+        expected_output: Comprehensive report on current AI News trends.
+    tools:
+    - InternetSearchTool
+```

docs/tools/duckduckgo.md

@@ -0,0 +1,22 @@
+# DuckDuckGo Praison AI Integration
+
+```bash
+pip install duckduckgo_search
+```
+
+Create a file called tools.py in the same directory as the agents.yaml file.
+
+```python
+# example tools.py
+from duckduckgo_search import DDGS
+from praisonai_tools import BaseTool
+
+class InternetSearchTool(BaseTool):
+    name: str = "InternetSearchTool"
+    description: str = "Search Internet for relevant information based on a query or latest news"
+
+    def _run(self, query: str):
+        ddgs = DDGS()
+        results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
+        return results
+```

docs/tools/gpt.md

@@ -0,0 +1,3 @@
+# PraisonAI Tools Creator GPT
+
+Use [PraisonAI Tools Creator GPT](https://chatgpt.com/g/g-LrJH1K6Ao-praisonai-tools-creator) to get started quickly.

docs/tools/langchain.md

@@ -0,0 +1,69 @@
+# Langchain Tools
+
+## Integrate Langchain Direct Tools
+
+```bash
+pip install youtube_search praisonai langchain_community langchain
+```
+
+```python
+# tools.py
+from langchain_community.tools import YouTubeSearchTool
+```
+
+```yaml
+# agents.yaml
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung
+          diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - 'YouTubeSearchTool'
+```
+
+## Integrate Langchain with Wrappers
+
+```bash
+pip install wikipedia langchain_community
+```
+
+```python
+# tools.py
+from langchain_community.utilities import WikipediaAPIWrapper
+class WikipediaSearchTool(BaseTool):
+    name: str = "WikipediaSearchTool"
+    description: str = "Search Wikipedia for relevant information based on a query."
+
+    def _run(self, query: str):
+        api_wrapper = WikipediaAPIWrapper(top_k_results=4, doc_content_chars_max=100)
+        results = api_wrapper.load(query=query)
+        return results
+```
+
+```yaml
+# agents.yaml
+framework: crewai
+topic: research about nvidia growth
+roles:
+  data_collector:
+    backstory: An experienced researcher with the ability to efficiently collect and
+      organize vast amounts of data.
+    goal: Gather information on Nvidia's growth by providing the Ticket Symbol to YahooFinanceNewsTool
+    role: Data Collector
+    tasks:
+      data_collection_task:
+        description: Collect data on Nvidia's growth from various sources such as
+          financial reports, news articles, and company announcements.
+        expected_output: A comprehensive document detailing data points on Nvidia's
+          growth over the years.
+    tools:
+    - 'WikipediaSearchTool'
+```

docs/tools/reddit.md

@@ -0,0 +1,32 @@
+# Reddit PraisonAI Integration
+
+```bash
+export REDDIT_USER_AGENT=[USER]
+export REDDIT_CLIENT_SECRET=xxxxxx
+export REDDIT_CLIENT_ID=xxxxxx
+```
+
+tools.py
+
+```python
+from langchain_community.tools.reddit_search.tool import RedditSearchRun
+```
+
+agents.yaml
+
+```yaml
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung
+          diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - 'RedditSearchRun'
+```

docs/tools/tavily.md

@@ -0,0 +1,15 @@
+# Tavily PraisonAI Integration
+
+```python
+from praisonai_tools import BaseTool
+from langchain.utilities.tavily_search import TavilySearchAPIWrapper
+
+class TavilyTool(BaseTool):
+    name: str = "TavilyTool"
+    description: str = "Search Tavily for relevant information based on a query."
+
+    def _run(self, query: str):
+        api_wrapper = TavilySearchAPIWrapper()
+        results = api_wrapper.results(query=query, max_results=5)
+        return results
+```

docs/tools/wikipedia.md

@@ -0,0 +1,38 @@
+# Wikipedia PraisonAI Integration
+
+```bash
+pip install wikipedia langchain_community
+```
+
+```python
+# tools.py
+from langchain_community.utilities import WikipediaAPIWrapper
+class WikipediaSearchTool(BaseTool):
+    name: str = "WikipediaSearchTool"
+    description: str = "Search Wikipedia for relevant information based on a query."
+
+    def _run(self, query: str):
+        api_wrapper = WikipediaAPIWrapper(top_k_results=4, doc_content_chars_max=100)
+        results = api_wrapper.load(query=query)
+        return results
+```
+
+```yaml
+# agents.yaml
+framework: crewai
+topic: research about nvidia growth
+roles:
+  data_collector:
+    backstory: An experienced researcher with the ability to efficiently collect and
+      organize vast amounts of data.
+    goal: Gather information on Nvidia's growth by providing the Ticket Symbol to YahooFinanceNewsTool
+    role: Data Collector
+    tasks:
+      data_collection_task:
+        description: Collect data on Nvidia's growth from various sources such as
+          financial reports, news articles, and company announcements.
+        expected_output: A comprehensive document detailing data points on Nvidia's
+          growth over the years.
+    tools:
+    - 'WikipediaSearchTool'
+```

docs/tools/you.com.md

@@ -0,0 +1,36 @@
+# You.com PraisonAI Integration
+
+```bash
+export YDC_API_KEY=xxxxxxxxxxxx
+```
+tools.py
+```python
+from langchain_community.utilities.you import YouSearchAPIWrapper
+class YouSearchTool(BaseTool):
+    name: str = "You Search Tool"
+    description: str = "Search You.com for relevant information based on a query."
+
+    def _run(self, query: str):
+        api_wrapper = YouSearchAPIWrapper()
+        results = api_wrapper.results(query=query, max_results=5)
+        return results
+```
+
+agents.yaml
+
+```yaml
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung
+          diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - 'YouSearchTool'
+```

docs/tools/youtube.md

@@ -0,0 +1,28 @@
+# YouTube Search PraisonAI Integration
+
+```bash
+pip install youtube_search praisonai langchain_community langchain
+```
+
+```python
+# tools.py
+from langchain_community.tools import YouTubeSearchTool
+```
+
+```yaml
+# agents.yaml
+framework: crewai
+topic: research about the causes of lung disease
+roles:
+  research_analyst:
+    backstory: Experienced in analyzing scientific data related to respiratory health.
+    goal: Analyze data on lung diseases
+    role: Research Analyst
+    tasks:
+      data_analysis:
+        description: Gather and analyze data on the causes and risk factors of lung
+          diseases.
+        expected_output: Report detailing key findings on lung disease causes.
+    tools:
+    - 'YouTubeSearchTool'
+```

docs/ui.md

@@ -0,0 +1,83 @@
+# PraisonAI User Interface (UI)
+
+## Chainlit
+```bash
+pip install -U "praisonai[ui]"
+export OPENAI_API_KEY="Enter your API key"
+chainlit create-secret
+export CHAINLIT_AUTH_SECRET=xxxxxxxx
+praisonai ui
+```
+
+or 
+
+```bash
+python -m praisonai ui
+```
+
+Default Username: admin
+Default Password: admin
+
+### To Change Username and Password
+
+create .env file in the root folder of the project
+Add below Variables and required Username/Password
+```
+CHAINLIT_USERNAME=admin
+CHAINLIT_USERNAME=admin
+```
+
+## Gradio
+```bash
+pip install "praisonai[gradio]"
+export OPENAI_API_KEY="Enter your API key"
+praisonai --ui gradio
+```
+
+## Streamlit
+
+```bash
+git clone https://github.com/leporejoseph/PraisonAi-Streamlit
+cd PraisonAi-Streamlit
+pip install -r requirements.txt
+streamlit run app.py
+```
+
+## Using Chainlit (with Pictures)
+
+## Run Automatically
+
+### Install Required Package
+![Install Required Package](images/ui-step-1.png)
+
+### User Interface
+![User Interface](images/ui-step-2.png)
+
+### Select Auto Mode
+![Select Auto Mode](images/ui-step-4.png)
+
+### Configure Agent Settings
+![Configure Agent Settings](images/ui-step-3.png)
+
+### Define a Task to Auto Generate Agents and Run
+![Define a Task](images/ui-step-5.png)
+
+### Output
+![Output](images/ui-step-6.png)
+
+## Run Manually
+
+### Select Manual Mode
+![Select Manual Mode](images/ui-step-7.png)
+
+### Modify Agents and Tools
+![Modify Agents and Tools](images/ui-step-10.png)
+
+## Review Generated Agents
+![Review Generated Agents](images/ui-step-9.png)
+
+### Run Agents
+![Run Agents](images/ui-step-8.png)
+
+### Manual Model Output
+![Manual Model Output](images/ui-step-11.png)

example.py

@@ -0,0 +1,25 @@
+from praisonai import PraisonAI
+
+def basic():
+    praison_ai = PraisonAI(agent_file="agents.yaml")
+    praison_ai.main()
+    
+def advanced():
+    praison_ai = PraisonAI(
+        agent_file="agents.yaml",
+        framework="autogen",
+    )
+    praison_ai.main()
+    
+def auto():
+    praison_ai = PraisonAI(
+        auto="Create a movie script about car in mars",
+        framework="autogen"
+    )
+    print(praison_ai.framework)
+    praison_ai.main()
+
+if __name__ == "__main__":
+    basic()
+    advanced()
+    auto()