Merge pull request #28 from jbexta/0.4.0

0.4.0

Author: jbexta

README.md

@@ -1,17 +1,13 @@
 <h1 align="center">💬 Agent Pilot</h1>
 
-
 <p align="center">️
   <img src="docs/demo.png" width="600px" alt="AgentPilot desktop demo" />
 <br><br>
-Create, manage, and chat with AI agents using your own keys, models and local data.
-<br><br>
-Agent Pilot provides a seamless experience, whether you want to chat with a single LLM, or a complex multi-member workflow.
-<br><br>
-Branching conversations are supported, edit and resend messages as needed.
-<br><br>
-Combine models from different providers under one chat, and configure their interaction with each other in a low-code environment.
+A versatile workflow automation system. Create, organize, and execute complex AI-driven tasks.
+Agent Pilot provides a seamless experience, whether you want to chat with a single LLM or a complex multi-member workflow.
 <br><br>
+With an intuitive and feature-rich interface, users can effortlessly design AI workflows and chat with them in real-time.
+Branching chats are supported, allowing flexible interactions and iterative refinement.
 </p>
 
 <div align="center">
@@ -20,9 +16,6 @@ Combine models from different providers under one chat, and configure their inte
 [![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/AgentPilotAI)](https://twitter.com/AgentPilotAI)
 </div>
 
-> [!NOTE]  
-> This project is under development, each release is stableish but may contain unfinished features or bugs, and this readme may not be accurate.
-
 <p align="center">
   <img src="docs/demo.gif" align="center" height="255px" alt="AgentPilot gif demo" style="margin-right: 20px;" />
   <img src="docs/Screenshot3.png" align="center" height="250px" alt="AgentPilot gif demo" style="margin-right: 20px;" />
@@ -70,7 +63,7 @@ Building from source: [How to build from source](docs/guides/how_to_build.md) <b
 
 ###  👤 Create Agents
 Create new agents, edit their configuration and organise them into folders.<br>
-Multi-member workflows can be saved as a single agent ~~and nested infinitely (coming soon)~~.
+Multi-member workflows can be saved as a single agent and nested infinitely.
 
 ### 📝 Manage Chats
 View, continue and delete previous workflow chats and organise them into folders.<br>
@@ -81,24 +74,59 @@ Branching works with all plugins and multi-member chats.<br>
 
 ### 👥 Graph Workflows
 Seamlessly add other members or blocks to a workflow and configure how they interact with each other.<br>
-Workflow behaviour can be modified with a plugin.
+Members aligned vertically are executed in parallel.
 
-### 🔠 Blocks
-Manage a collection of nestable blocks available to use in any workflow, 
-allowing reusability and consistency across multiple agents.<br>
-You can use blocks in text by using the block name in curly braces, e.g. `{block-name}`.
+Available members:
+- **User** - This is you and will await your input.
+- **Agent** - Gets an LLM response with integrated tools and messages.
 - **Text** - A simple text block that can nest other blocks.
-- **Code** - A code block that is executed and gets the output.
-- **Prompt** - A prompt block that gets an LLM response.
-- **Metaprompt** - Used by the system for AI enhancement.
+- **Code** - Gets the output of any given code.
+- **Prompt** - Gets an LLM response from a single prompt.
+- **Module** - Runs or retrieves a method or variable from any module.
+- **Workflow** - Any combination of the above types.
+
+### 📦 Blocks
+Manage a collection of nestable blocks available to use in any workflow or text field, 
+allowing reusability and consistency.<br>
+By default a block is a simple text block, but it can be any of the above member types, even a multi-member workflow.<br>
+These can be quickly dropped into any workflow, or used in text fields (such as system message) by using the block name in curly braces, e.g. `{block-name}`.
+
+### 🔨 Tools
+Create and manage tools which can be assigned to agents.<br>
+Tools share the same functionality as blocks, except by default they are a single Code member.<br> 
+They can also be an entire workflow, this allows your agents to not only run code but an entire workflow if you wish.<br>
+Configure their parameters, which can be accesed from all workflow member types.
+These parameters can be modified at runtime and re-executed, this creates a branch point which you can cycle through.
+
+### 💻 Modules
+Modules are python files which are imported at runtime.<br>
+These are useful for things like toolkits, daemons, memory, custom pages or anything that needs persistence.
+
+### 📐 Customizable UI
+Includes a flexible and powerful set of base classes for building complex hierarchical configuration interfaces. 
+The entire app is built on this framework.
+Developers can modify or create configuration pages easily, even while the app is running.
 
-### 🔨 Tools 
-Create, edit and delete tools, configure their parameters, code, language and environment.<br>
-Tools can be added to an Agent or used individually as a workflow component.<br>
+### 💻 Code Interpreter
+Open Interpreter is integrated into Agent Pilot, and can either be used standalone as a plugin 
+or used to execute code in 9 languages (Python, Shell, AppleScript, HTML, JavaScript, PowerShell, R, React, Ruby)
+
+Code can be executed in multiple ways:
+- From any 'Code' member in any workflow (Chat, Block, Tool).
+- From a message with the role 'Code'
+
+You should always understand the code that is being run, any code you execute is your own responsibility.
+
+For code messages, auto-run can be enabled in the settings.
+To see code messages in action talk to the pre-configured Open Interpreter agent.
 
 ### 🪄 AI Generation
-Various aspects of Agent Pilot use AI to enhance the user experience, including:
-- **Text input** - An AI generated prompt replaces the user's input.
+Blocks under the 'System Blocks' folder are used for generating or enhancing fields.
+Claude's prompt generator is included by default, you can tweak it or create your own.
+- **Prompt** - AI enhanced user input
+- **Agent** - AI generated agent (Coming soon)
+- - **System message** - AI generated system message (Coming soon)
+- **Page** - AI generated page (Coming soon)
 
 ### 🔌 Plugins
 Agent Pilot supports the following plugins:
@@ -113,66 +141,57 @@ Agent Pilot supports the following plugins:
 
 - [Create a plugin](/)
 
-### 💻 Code Interpreter
-Open Interpreter is integrated into Agent Pilot, and can either be used standalone as a plugin 
-or utilised by any Agent or context block to execute code.
-<br>
-Code auto-run can be enabled in the settings, but use this with caution, you should always
-understand the code that is being run, any code you execute is your own responsibility.<br>
-Try something like "Split this image into quarters" and see the power of Open Interpreter
-
 ### 👄 Voice
-Agents can be linked to a text-to-speech service, combine with a personality context block and make your agent come to life!<br>
+**Coming back soon**<br>
+~~Agents can be linked to a text-to-speech service, combine with a personality context block and make your agent come to life!~~<br>
 
-**Supported TTS services:**<br>
-- Amazon Polly<br>
-- Elevenlabs (expensive)<br>
-- FakeYou (celebrities and characters but too slow for realtime)<br>
-- Uberduck (celebrities and characters are discontinued)
+### 🔠 Models
+LiteLLM is integrated and supports the following providers:<br>
 
-**Supported LLM providers using LiteLLM:**<br>
+- AI21
+- AWS Bedrock
+- AWS Sagemaker
+- Aleph Alpha
 - Anthropic
-- Mistral
-- Perplexity AI
-- Groq
-- OpenAI
-- Replicate
+- Anyscale
 - Azure OpenAI
+- Baseten
+- Cloudflare
+- Cohere
+- Custom API Servers
+- DeepInfra
+- DeepSeek
+- Gemini
+- Github
+- Groq
 - Huggingface
+- Mistral
+- NLP Cloud
+- Nvidia NIM
 - Ollama
-- VertexAI Google
+- OpenAI
+- OpenRouter
 - PaLM API Google
-- Voyage
-- AWS Sagemaker
-- AWS Bedrock
-- Anyscale
-- VLLM
-- DeepInfra
-- AI21
-- NLP Cloud
-- Cohere
+- Perplexity AI
+- Petals
+- Replicate
 - Together AI
-- Cloudflare
-- Aleph Alpha
-- Baseten
-- OpenRouter
-- Custom API Server
-- Petals<br>
-(Anthropic, Mistral, Perplexity, OpenRouter & OpenAI have been tested)
+- VLLM
+- VertexAI Google
+- Voyage
 
 ## Contributions
 Contributions to Agent Pilot are welcome and appreciated. Please feel free to submit a pull request.
 
 ## Known Issues
 - Changing the config of an OpenAI Assistant won't reload the assistant, for now close and reopen the chat.
-- Some others
 - Be careful using auto run code and open interpreter, any chat you open, if code is the last message it will start auto running, I'll add a flag to remember if the countdown has been stopped.
-- Flickering when response is generating and scrolled up the page.
 - Sometimes the scroll position jumps if the user is scrolled up and an AI response has finished generating.
 - Windows exe must have console visible due to a strange bug.
 - Issue on linux, creating venv does not install pip 
 - Numeric tool parameters get stuck at -99999 
 - When editing a previous message with markdown, to resend you have to press the resend button twice (because the first click makes the bubble lose focus, which blocks the event button click event)
+- Multiple async groups (vertically aligned members) in the same workflow causes an issue.
 
 If you find this project useful please consider showing support by giving a star or leaving a tip :)
 <br><br>