Merge branch 'master' into add-documentation-for-caching-types

.env.template

@@ -2,6 +2,8 @@ PINECONE_API_KEY=your-pinecone-api-key
 PINECONE_ENV=your-pinecone-region
 OPENAI_API_KEY=your-openai-api-key
 ELEVENLABS_API_KEY=your-elevenlabs-api-key
+ELEVENLABS_VOICE_1_ID=your-voice-id
+ELEVENLABS_VOICE_2_ID=your-voice-id
 SMART_LLM_MODEL=gpt-4
 FAST_LLM_MODEL=gpt-3.5-turbo
 GOOGLE_API_KEY=
@@ -10,6 +12,8 @@ USE_AZURE=False
 OPENAI_AZURE_API_BASE=your-base-url-for-azure
 OPENAI_AZURE_API_VERSION=api-version-for-azure
 OPENAI_AZURE_DEPLOYMENT_ID=deployment-id-for-azure
+OPENAI_AZURE_CHAT_DEPLOYMENT_ID=deployment-id-for-azure-chat
+OPENAI_AZURE_EMBEDDINGS_DEPLOYMENT_ID=deployment-id-for-azure-embeddigs
 IMAGE_PROVIDER=dalle
 HUGGINGFACE_API_TOKEN=
 USE_MAC_OS_TTS=False

.github/PULL_REQUEST_TEMPLATE.md

@@ -23,10 +23,10 @@ By following these guidelines, your PRs are more likely to be merged quickly aft
 
 ### PR Quality Checklist
 - [ ] My pull request is atomic and focuses on a single change.
-- [ ] I have thouroughly tested my changes with multiple different prompts.
+- [ ] I have thoroughly tested my changes with multiple different prompts.
 - [ ] I have considered potential risks and mitigations for my changes.
 - [ ] I have documented my changes clearly and comprehensively.
-- [ ] I have not snuck in any "extra" small tweaks changes <!-- Submit these as seperate Pull Reqests, they are the easiest to merge! -->
+- [ ] I have not snuck in any "extra" small tweaks changes <!-- Submit these as separate Pull Reqests, they are the easiest to merge! -->
 
 <!-- If you haven't added tests, please explain why. If you have, check the appropriate box. If you've ensured your PR is atomic and well-documented, check the corresponding boxes. -->
 

.github/workflows/unit_tests.yml

@@ -0,0 +1,40 @@
+name: Unit Tests
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: [3.8]
+
+    steps:
+    - name: Check out repository
+      uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt
+
+    - name: Run unittest tests with coverage
+      run: |
+        coverage run --source=scripts -m unittest discover tests
+
+    - name: Generate coverage report
+      run: |
+        coverage report
+        coverage xml

.gitignore

@@ -7,9 +7,15 @@ package-lock.json
 auto_gpt_workspace/*
 *.mpeg
 .env
-venv/*
+*venv/*
 outputs/*
 ai_settings.yaml
 .vscode
+.idea/*
 auto-gpt.json
 log.txt
+
+# Coverage reports
+.coverage
+coverage.xml
+htmlcov/

CONTRIBUTING.md

@@ -6,7 +6,7 @@ To contribute to this GitHub project, you can follow these steps:
 2. Clone the repository to your local machine using the following command:
 
 ```
-git clone https://github.com/Torantulino/Auto-GPT
+git clone https://github.com/<YOUR-GITHUB-USERNAME>/Auto-GPT
 ```
 3. Create a new branch for your changes using the following command:
 

README.md

@@ -1,13 +1,15 @@
 # Auto-GPT: An Autonomous GPT-4 Experiment
+
 ![GitHub Repo stars](https://img.shields.io/github/stars/Torantulino/auto-gpt?style=social)
 ![Twitter Follow](https://img.shields.io/twitter/follow/siggravitas?style=social)
 [![](https://dcbadge.vercel.app/api/server/PQ7VX6TY4t?style=flat)](https://discord.gg/PQ7VX6TY4t)
+[![Unit Tests](https://github.com/Torantulino/Auto-GPT/actions/workflows/unit_tests.yml/badge.svg)](https://github.com/Torantulino/Auto-GPT/actions/workflows/unit_tests.yml)
 
-Auto-GPT is an experimental open-source application showcasing the capabilities of the GPT-4 language model. This program, driven by GPT-4, autonomously develops and manages businesses to increase net worth. As one of the first examples of GPT-4 running fully autonomously, Auto-GPT pushes the boundaries of what is possible with AI.
+Auto-GPT is an experimental open-source application showcasing the capabilities of the GPT-4 language model. This program, driven by GPT-4, chains together LLM "thoughts", to autonomously achieve whatever goal you set. As one of the first examples of GPT-4 running fully autonomously, Auto-GPT pushes the boundaries of what is possible with AI.
 
 ### Demo (30/03/2023):
-https://user-images.githubusercontent.com/22963551/228855501-2f5777cf-755b-4407-a643-c7299e5b6419.mp4
 
+https://user-images.githubusercontent.com/22963551/228855501-2f5777cf-755b-4407-a643-c7299e5b6419.mp4
 
 <h2 align="center"> 💖 Help Fund Auto-GPT's Development 💖</h2>
 <p align="center">
@@ -26,11 +28,10 @@ Your support is greatly appreciated
 &nbsp;&nbsp;<a href="https://github.com/SpacingLily"><img src="https://github.com/SpacingLily.png" width="50px" alt="SpacingLily" /></a>&nbsp;&nbsp;<a href="https://github.com/merwanehamadi"><img src="https://github.com/merwanehamadi.png" width="50px" alt="merwanehamadi" /></a>&nbsp;&nbsp;<a href="https://github.com/m"><img src="https://github.com/m.png" width="50px" alt="m" /></a>&nbsp;&nbsp;<a href="https://github.com/zkonduit"><img src="https://github.com/zkonduit.png" width="50px" alt="zkonduit" /></a>&nbsp;&nbsp;<a href="https://github.com/maxxflyer"><img src="https://github.com/maxxflyer.png" width="50px" alt="maxxflyer" /></a>&nbsp;&nbsp;<a href="https://github.com/tekelsey"><img src="https://github.com/tekelsey.png" width="50px" alt="tekelsey" /></a>&nbsp;&nbsp;<a href="https://github.com/digisomni"><img src="https://github.com/digisomni.png" width="50px" alt="digisomni" /></a>&nbsp;&nbsp;<a href="https://github.com/nocodeclarity"><img src="https://github.com/nocodeclarity.png" width="50px" alt="nocodeclarity" /></a>&nbsp;&nbsp;<a href="https://github.com/tjarmain"><img src="https://github.com/tjarmain.png" width="50px" alt="tjarmain" /></a>
 </p>
 
-
 ## Table of Contents
 
 - [Auto-GPT: An Autonomous GPT-4 Experiment](#auto-gpt-an-autonomous-gpt-4-experiment)
-    - [Demo (30/03/2023):](#demo-30032023)
+  - [Demo (30/03/2023):](#demo-30032023)
   - [💖 Help Fund Auto-GPT's Development](#-help-fund-auto-gpts-development)
   - [Table of Contents](#table-of-contents)
   - [🚀 Features](#-features)
@@ -47,7 +48,6 @@ Your support is greatly appreciated
   - [🛡 Disclaimer](#-disclaimer)
   - [🐦 Connect with Us on Twitter](#-connect-with-us-on-twitter)
 
-
 ## 🚀 Features
 
 - 🌐 Internet access for searches and information gathering
@@ -57,11 +57,13 @@ Your support is greatly appreciated
 - 🗃️ File storage and summarization with GPT-3.5
 
 ## 📋 Requirements
+
 - [Python 3.8 or later](https://www.tutorialspoint.com/how-to-install-python-in-windows)
-- OpenAI API key
+- [OpenAI API key](https://platform.openai.com/account/api-keys)
 - [PINECONE API key](https://www.pinecone.io/)
 
 Optional:
+
 - ElevenLabs Key (If you want the AI to speak)
 
 ## 💾 Installation
@@ -70,46 +72,60 @@ To install Auto-GPT, follow these steps:
 
 0. Make sure you have all the **requirements** above, if not, install/get them.
 
-*The following commands should be executed in a CMD, Bash or Powershell window. To do this, go to a folder on your computer, click in the folder path at the top and type CMD, then press enter.*
+_The following commands should be executed in a CMD, Bash or Powershell window. To do this, go to a folder on your computer, click in the folder path at the top and type CMD, then press enter._
 
 1. Clone the repository:
-For this step you need Git installed, but you can just download the zip file instead by clicking the button at the top of this page ☝️
+   For this step you need Git installed, but you can just download the zip file instead by clicking the button at the top of this page ☝️
+
 ```
 git clone https://github.com/Torantulino/Auto-GPT.git
 ```
 
 2. Navigate to the project directory:
-*(Type this into your CMD window, you're aiming to navigate the CMD window to the repository you just downloaded)*
+   _(Type this into your CMD window, you're aiming to navigate the CMD window to the repository you just downloaded)_
+
 ```
 cd 'Auto-GPT'
 ```
 
 3. Install the required dependencies:
-*(Again, type this into your CMD window)*
+   _(Again, type this into your CMD window)_
+
 ```
 pip install -r requirements.txt
 ```
 
 4. Rename `.env.template` to `.env` and fill in your `OPENAI_API_KEY`. If you plan to use Speech Mode, fill in your `ELEVEN_LABS_API_KEY` as well.
   - Obtain your OpenAI API key from: https://platform.openai.com/account/api-keys.
   - Obtain your ElevenLabs API key from: https://elevenlabs.io. You can view your xi-api-key using the "Profile" tab on the website.
-  - If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and provide the `OPENAI_AZURE_API_BASE`, `OPENAI_AZURE_API_VERSION` and `OPENAI_AZURE_DEPLOYMENT_ID` values as explained here: https://pypi.org/project/openai/ in the `Microsoft Azure Endpoints` section
+  - If you want to use GPT on an Azure instance, set `USE_AZURE` to `True` and provide the `OPENAI_AZURE_API_BASE`, `OPENAI_AZURE_API_VERSION` and `OPENAI_AZURE_DEPLOYMENT_ID` values as explained here: https://pypi.org/project/openai/ in the `Microsoft Azure Endpoints` section. Additionally you need separate deployments for both embeddings and chat. Add their ID values to `OPENAI_AZURE_CHAT_DEPLOYMENT_ID` and `OPENAI_AZURE_EMBEDDINGS_DEPLOYMENT_ID` respectively
 
 ## 🔧 Usage
 
 1. Run the `main.py` Python script in your terminal:
-*(Type this into your CMD window)*
+   _(Type this into your CMD window)_
+
 ```
 python scripts/main.py
 ```
+
 2. After each of AUTO-GPT's actions, type "NEXT COMMAND" to authorise them to continue.
 3. To exit the program, type "exit" and press Enter.
 
+### Logs
+You will find activity and error logs in the folder ```./logs```
+
+To output debug logs:
+```
+python scripts/main.py --debug
+```
+
 ## 🗣️ Speech Mode
+
 Use this to use TTS for Auto-GPT
+
 ```
 python scripts/main.py --speak
-
 ```
 
 ## 🔍 Google API Keys Configuration
@@ -125,18 +141,22 @@ To use the `google_official_search` command, you need to set up your Google API
 6. Copy the API key and set it as an environment variable named `GOOGLE_API_KEY` on your machine. See setting up environment variables below.
 7. Go to the [Custom Search Engine](https://cse.google.com/cse/all) page and click "Add".
 8. Set up your search engine by following the prompts. You can choose to search the entire web or specific sites.
-9.  Once you've created your search engine, click on "Control Panel" and then "Basics". Copy the "Search engine ID" and set it as an environment variable named `CUSTOM_SEARCH_ENGINE_ID` on your machine. See setting up environment variables below.
+9. Once you've created your search engine, click on "Control Panel" and then "Basics". Copy the "Search engine ID" and set it as an environment variable named `CUSTOM_SEARCH_ENGINE_ID` on your machine. See setting up environment variables below.
 
-*Remember that your free daily custom search quota allows only up to 100 searches. To increase this limit, you need to assign a billing account to the project to profit from up to 10K daily searches.*
+_Remember that your free daily custom search quota allows only up to 100 searches. To increase this limit, you need to assign a billing account to the project to profit from up to 10K daily searches._
 
 ### Setting up environment variables
-   For Windows Users:
+
+For Windows Users:
+
 ```
 setx GOOGLE_API_KEY "YOUR_GOOGLE_API_KEY"
 setx CUSTOM_SEARCH_ENGINE_ID "YOUR_CUSTOM_SEARCH_ENGINE_ID"
 
 ```
+
 For macOS and Linux users:
+
 ```
 export GOOGLE_API_KEY="YOUR_GOOGLE_API_KEY"
 export CUSTOM_SEARCH_ENGINE_ID="YOUR_CUSTOM_SEARCH_ENGINE_ID"
@@ -148,12 +168,15 @@ export CUSTOM_SEARCH_ENGINE_ID="YOUR_CUSTOM_SEARCH_ENGINE_ID"
 Install docker desktop.
 
 Run:
+
 ```
 docker run -d --name redis-stack-server -p 6379:6379 redis/redis-stack-server:latest
 ```
+
 See https://hub.docker.com/r/redis/redis-stack-server for setting a password and additional configuration.
 
 Set the following environment variables:
+
 ```
 MEMORY_BACKEND=redis
 REDIS_HOST=localhost
@@ -173,9 +196,9 @@ To persist memory stored in Redis.
 
 You can specify the memory index for redis using the following:
 
-````
+```
 MEMORY_INDEX=whatever
-````
+```
 
 ## 🌲 Pinecone API Key Setup
 
@@ -187,23 +210,27 @@ Pinecone enables the storage of vast amounts of vector-based memory, allowing fo
 
 ### Setting up environment variables
 
-Simply set them in the `.env` file. 
+Simply set them in the `.env` file.
 
 Alternatively, you can set them from the command line (advanced):
 
 For Windows Users:
+
 ```
 setx PINECONE_API_KEY "YOUR_PINECONE_API_KEY"
 setx PINECONE_ENV "Your pinecone region" # something like: us-east4-gcp
 
 ```
+
 For macOS and Linux users:
+
 ```
 export PINECONE_API_KEY="YOUR_PINECONE_API_KEY"
 export PINECONE_ENV="Your pinecone region" # something like: us-east4-gcp
 
 ```
 
+
 ## Setting Your Cache Type
 
 By default Auto-GPT is going to use LocalCache instead of redis or Pinecone.
@@ -218,36 +245,45 @@ To switch to either, change the `MEMORY_BACKEND` env variable to the value that
 
 1. View memory usage by using the `--debug` flag :)
 
-
 ## 💀 Continuous Mode ⚠️
+
 Run the AI **without** user authorisation, 100% automated.
 Continuous mode is not recommended.
 It is potentially dangerous and may cause your AI to run forever or carry out actions you would not usually authorise.
 Use at your own risk.
+
 1. Run the `main.py` Python script in your terminal:
+
 ```
 python scripts/main.py --continuous
 
 ```
+
 2. To exit the program, press Ctrl + C
 
 ## GPT3.5 ONLY Mode
+
 If you don't have access to the GPT4 api, this mode will allow you to use Auto-GPT!
+
 ```
 python scripts/main.py --gpt3only
 ```
+
 It is recommended to use a virtual machine for tasks that require high security measures to prevent any potential harm to the main computer's system and data.
 
 ## 🖼 Image Generation
+
 By default, Auto-GPT uses DALL-e for image generation. To use Stable Diffusion, a [HuggingFace API Token](https://huggingface.co/settings/tokens) is required.
 
 Once you have a token, set these variables in your `.env`:
+
 ```
 IMAGE_PROVIDER=sd
 HUGGINGFACE_API_TOKEN="YOUR_HUGGINGFACE_API_TOKEN"
 ```
 
 ## ⚠️ Limitations
+
 This experiment aims to showcase the potential of GPT-4 but comes with some limitations:
 
 1. Not a polished application or product, just an experiment
@@ -276,3 +312,22 @@ Stay up-to-date with the latest news, updates, and insights about Auto-GPT by fo
 
 We look forward to connecting with you and hearing your thoughts, ideas, and experiences with Auto-GPT. Join us on Twitter and let's explore the future of AI together!
 
+<p align="center">
+  <a href="https://star-history.com/#Torantulino/auto-gpt&Date">
+    <img src="https://api.star-history.com/svg?repos=Torantulino/auto-gpt&type=Date" alt="Star History Chart">
+  </a>
+</p>
+
+## Run tests
+
+To run tests, run the following command:
+
+```
+python -m unittest discover tests
+```
+
+To run tests and see coverage, run the following command:
+
+```
+coverage run -m unittest discover tests
+```

main.py

@@ -0,0 +1 @@
+from scripts.main import main

requirements.txt

@@ -15,3 +15,4 @@ pinecone-client==2.2.1
 redis
 orjson
 Pillow
+coverage