2023-12-24 04:20:59 -08:00
# AutoGen Studio
Autogenstudio Updates [CSV support, Workflow Export, Skill Editing, Windows Testing ] (#1475)
* support groupchat, other QOL fixes
* remove gallery success toast
* Fix #1328. Add CSVLoader component and related support for rendering CSV files. Add download link in the modal for appropriate file types including CSV, Code, and PDF.
* add name and description field to session datamodel
* Update website/blog/2023-12-01-AutoGenStudio/index.mdx
Co-authored-by: Chi Wang <wang.chi@microsoft.com>
* sanitize llmconfig, remove additional fields
* improve models UX, only modify models from model tab.
* readme updates
* improve db defaults
* improve ui hover behavior and add note on models
* general qol updats
* add support for returning summary_method
* use ant design tables
* icon and layout updates
* css and layout updates
* readme updates and QOL updates
* fix bug where empty string is used as apikey #1415
* add speaker selection to UI #1373
* Fixed a bug that localAgent updates were not synchronized between GroupChatFlowSpecView and AgentFlowSpecView.
* Fixed a bug in Agent Specification Modal that caused localAgent updates to remain in state when closing a modal other than onOk.
* Fixed a bug that the updated Agent Specification Modal was not saved when the content of FlowConfigViewer Modal was changed after the Agent Specification Modal was updated when an updatedFlowConfig was created using localFlowConfig.
* add version to package
* remove sample key
* early support for versions table and testing models
* Add support for testing model when created #1404
* remove unused imports, qol updates
* fix bug on workflowmanager
* make file_name optional in skills datamodel
* update instructions on models
* fix errors from merge conflict with main
* santize workflow before download
* add support for editing skills in full fledged editor (monaco) #1442
* fix merge artifacts
* Fix build command for windows
Replaced && to & to continue execution when the 'ui' folder doesn't exist and also suppressed error "The system cannot find the file specified."
* Fix setup instructions
The config file starts with a dot (according to gatsby-config.ts).
* Throw error if env file doesn't exist
Otherwise the app will not work (issue very hard to trace)
* version bump
* formattin gupdates
* formatting updates
* Show warning instead of error if env config file doesn't exist
Fix: https://github.com/microsoft/autogen/pull/1475#issuecomment-1918114520
* add rel noopener to a tags
* formating updates
* remove double section in readme.
* update dev readme
* format update
* add default autoreply to agent config datamodel
* add check for empty messages list
* improve groupchat behavior, add sender to list of agents
* update system_message defaults to fit autogen default system message #1474
* simplify response from test_model to only return content, fix serialization issue in #1404
* readme and other formatting updates
* add support for showing temp and default auto reply #1521
* formatting updates
* formating and other updates
---------
Co-authored-by: Paul Retherford <paul@scanpower.com>
Co-authored-by: Chi Wang <wang.chi@microsoft.com>
Co-authored-by: junkei_okinawa <ceazy.x2.okinawan@gmail.com>
Co-authored-by: Christopher Pereira <kripper@imatronix.com>
2024-02-05 18:45:18 -08:00
2024-01-12 20:29:28 -08:00
[](https://badge.fury.io/py/autogenstudio)
2025-01-11 18:25:18 -08:00
2023-12-24 04:20:59 -08:00
2025-01-11 18:25:18 -08:00
2023-12-24 04:20:59 -08:00
AutoGen Studio is an AutoGen-powered AI app (user interface) to help you rapidly prototype AI agents, enhance them with skills, compose them into workflows and interact with them to accomplish tasks. It is built on top of the [AutoGen ](https://microsoft.github.io/autogen ) framework, which is a toolkit for building AI agents.
2024-11-15 14:51:57 -08:00
Code for AutoGen Studio is on GitHub at [microsoft/autogen ](https://github.com/microsoft/autogen/tree/main/python/packages/autogen-studio )
2023-12-24 04:20:59 -08:00
Autogenstudio Updates [CSV support, Workflow Export, Skill Editing, Windows Testing ] (#1475)
* support groupchat, other QOL fixes
* remove gallery success toast
* Fix #1328. Add CSVLoader component and related support for rendering CSV files. Add download link in the modal for appropriate file types including CSV, Code, and PDF.
* add name and description field to session datamodel
* Update website/blog/2023-12-01-AutoGenStudio/index.mdx
Co-authored-by: Chi Wang <wang.chi@microsoft.com>
* sanitize llmconfig, remove additional fields
* improve models UX, only modify models from model tab.
* readme updates
* improve db defaults
* improve ui hover behavior and add note on models
* general qol updats
* add support for returning summary_method
* use ant design tables
* icon and layout updates
* css and layout updates
* readme updates and QOL updates
* fix bug where empty string is used as apikey #1415
* add speaker selection to UI #1373
* Fixed a bug that localAgent updates were not synchronized between GroupChatFlowSpecView and AgentFlowSpecView.
* Fixed a bug in Agent Specification Modal that caused localAgent updates to remain in state when closing a modal other than onOk.
* Fixed a bug that the updated Agent Specification Modal was not saved when the content of FlowConfigViewer Modal was changed after the Agent Specification Modal was updated when an updatedFlowConfig was created using localFlowConfig.
* add version to package
* remove sample key
* early support for versions table and testing models
* Add support for testing model when created #1404
* remove unused imports, qol updates
* fix bug on workflowmanager
* make file_name optional in skills datamodel
* update instructions on models
* fix errors from merge conflict with main
* santize workflow before download
* add support for editing skills in full fledged editor (monaco) #1442
* fix merge artifacts
* Fix build command for windows
Replaced && to & to continue execution when the 'ui' folder doesn't exist and also suppressed error "The system cannot find the file specified."
* Fix setup instructions
The config file starts with a dot (according to gatsby-config.ts).
* Throw error if env file doesn't exist
Otherwise the app will not work (issue very hard to trace)
* version bump
* formattin gupdates
* formatting updates
* Show warning instead of error if env config file doesn't exist
Fix: https://github.com/microsoft/autogen/pull/1475#issuecomment-1918114520
* add rel noopener to a tags
* formating updates
* remove double section in readme.
* update dev readme
* format update
* add default autoreply to agent config datamodel
* add check for empty messages list
* improve groupchat behavior, add sender to list of agents
* update system_message defaults to fit autogen default system message #1474
* simplify response from test_model to only return content, fix serialization issue in #1404
* readme and other formatting updates
* add support for showing temp and default auto reply #1521
* formatting updates
* formating and other updates
---------
Co-authored-by: Paul Retherford <paul@scanpower.com>
Co-authored-by: Chi Wang <wang.chi@microsoft.com>
Co-authored-by: junkei_okinawa <ceazy.x2.okinawan@gmail.com>
Co-authored-by: Christopher Pereira <kripper@imatronix.com>
2024-02-05 18:45:18 -08:00
> [!WARNING]
2025-01-15 06:19:47 +01:00
> AutoGen Studio is under active development and is currently not meant to be a production-ready app. Expect breaking changes in upcoming releases. [Documentation](https://microsoft.github.io/autogen/docs/autogen-studio/getting-started) and the `README.md` might be outdated.
Autogenstudio Updates [CSV support, Workflow Export, Skill Editing, Windows Testing ] (#1475)
* support groupchat, other QOL fixes
* remove gallery success toast
* Fix #1328. Add CSVLoader component and related support for rendering CSV files. Add download link in the modal for appropriate file types including CSV, Code, and PDF.
* add name and description field to session datamodel
* Update website/blog/2023-12-01-AutoGenStudio/index.mdx
Co-authored-by: Chi Wang <wang.chi@microsoft.com>
* sanitize llmconfig, remove additional fields
* improve models UX, only modify models from model tab.
* readme updates
* improve db defaults
* improve ui hover behavior and add note on models
* general qol updats
* add support for returning summary_method
* use ant design tables
* icon and layout updates
* css and layout updates
* readme updates and QOL updates
* fix bug where empty string is used as apikey #1415
* add speaker selection to UI #1373
* Fixed a bug that localAgent updates were not synchronized between GroupChatFlowSpecView and AgentFlowSpecView.
* Fixed a bug in Agent Specification Modal that caused localAgent updates to remain in state when closing a modal other than onOk.
* Fixed a bug that the updated Agent Specification Modal was not saved when the content of FlowConfigViewer Modal was changed after the Agent Specification Modal was updated when an updatedFlowConfig was created using localFlowConfig.
* add version to package
* remove sample key
* early support for versions table and testing models
* Add support for testing model when created #1404
* remove unused imports, qol updates
* fix bug on workflowmanager
* make file_name optional in skills datamodel
* update instructions on models
* fix errors from merge conflict with main
* santize workflow before download
* add support for editing skills in full fledged editor (monaco) #1442
* fix merge artifacts
* Fix build command for windows
Replaced && to & to continue execution when the 'ui' folder doesn't exist and also suppressed error "The system cannot find the file specified."
* Fix setup instructions
The config file starts with a dot (according to gatsby-config.ts).
* Throw error if env file doesn't exist
Otherwise the app will not work (issue very hard to trace)
* version bump
* formattin gupdates
* formatting updates
* Show warning instead of error if env config file doesn't exist
Fix: https://github.com/microsoft/autogen/pull/1475#issuecomment-1918114520
* add rel noopener to a tags
* formating updates
* remove double section in readme.
* update dev readme
* format update
* add default autoreply to agent config datamodel
* add check for empty messages list
* improve groupchat behavior, add sender to list of agents
* update system_message defaults to fit autogen default system message #1474
* simplify response from test_model to only return content, fix serialization issue in #1404
* readme and other formatting updates
* add support for showing temp and default auto reply #1521
* formatting updates
* formating and other updates
---------
Co-authored-by: Paul Retherford <paul@scanpower.com>
Co-authored-by: Chi Wang <wang.chi@microsoft.com>
Co-authored-by: junkei_okinawa <ceazy.x2.okinawan@gmail.com>
Co-authored-by: Christopher Pereira <kripper@imatronix.com>
2024-02-05 18:45:18 -08:00
2025-01-15 06:19:47 +01:00
## Updates
2024-05-11 07:31:21 -07:00
2025-01-15 06:19:47 +01:00
- **2024-11-14:** AutoGen Studio is being rewritten to use the updated AutoGen 0.4.0 api AgentChat api.
- **2024-04-17:** April 17: AutoGen Studio database layer is now rewritten to use [SQLModel ](https://sqlmodel.tiangolo.com/ ) (Pydantic + SQLAlchemy). This provides entity linking (skills, models, agents and workflows are linked via association tables) and supports multiple [database backend dialects ](https://docs.sqlalchemy.org/en/20/dialects/ ) supported in SQLAlchemy (SQLite, PostgreSQL, MySQL, Oracle, Microsoft SQL Server). The backend database can be specified a `--database-uri` argument when running the application. For example, `autogenstudio ui --database-uri sqlite:///database.sqlite` for SQLite and `autogenstudio ui --database-uri postgresql+psycopg://user:password@localhost/dbname` for PostgreSQL.
- **2024-03-12:** Default directory for AutoGen Studio is now /home/\<USER\>/.autogenstudio. You can also specify this directory using the `--appdir` argument when running the application. For example, `autogenstudio ui --appdir /path/to/folder` . This will store the database and other files in the specified directory e.g. `/path/to/folder/database.sqlite` . `.env` files in that directory will be used to set environment variables for the app.
Autogenstudio Updates [Upload/Dowload of Skills/Workflows, Streaming Agent Replies, Agent Message Summarization] (#1801)
* update default agent system message
* session friendly name functionality
* minor formatting
* fix issues with groupchat and version bump
* fix issues with groupchat and version bump. address #1580
* update groupchat system message
* add support for copying message in chatbox
* rewrite how agent history is maintained in workflow manager. Directly extend GroupChat and Conversable agent and override process_message method. Allow passing a message processor.
Fixes bug where the last message from a groupchat manager does not get called via register_reply.
* general qol updates
* add support for downloading + copying skills, models and agents from UI
* add regex check to agent name, address #1507
* add support for uploading workflow files
* refactor, add support for streaming intermediate agent response to ui
* improve streaming ux
* add support for uploading skills, models, agents, workflows
* add datamodel for socket message
* version update
* fix chatbox height bug
* fix csv pagination issue
* improve hidden menu for uploading entities
* fix minor issue with animation timing on chat interface
* version bump, css fixes
* use description field in autogen conversable class for description
* add implementation for llm summarization of agent chat
* support for llm summary of agent history
* formatting fixes
* formatting updates
* add dockerfile to run autogenstudio in a docker contailer
* autogenstudio docker container
* updates to websockets
* update socket connection logic,
* support using socket for passing message requests where a socket is available
* improve command for building frontend
* formatting updates
* remove duplicated code
# overwrite skills.py in work_dir is duplicated
* update description location
as Where the code calls is like config.description
* version bump
* refactor to ensure each session and call within a session has an independent working directory
* support use of socket for sending messages where available
* use rsync to copy built files to ui direction instead of cp -rT
* spelling correctino
* readme update
* fix numpy version
* version bump
* add support for dot env variables and updating default app dir to /home/<user>/.autogenstudio
* formatting update
* update gitignore
* formatting updates
---------
Co-authored-by: James Woffinden-Luey <jluey@microsoft.com>
Co-authored-by: cillyfly <cillyfly@gmail.com>
2024-03-15 19:44:47 -07:00
2023-12-24 04:20:59 -08:00
Project Structure:
- _autogenstudio/_ code for the backend classes and web api (FastAPI)
- _frontend/_ code for the webui, built with Gatsby and TailwindCSS
2025-01-15 06:19:47 +01:00
## Installation
2023-12-24 04:20:59 -08:00
2024-01-23 11:59:58 -08:00
There are two ways to install AutoGen Studio - from PyPi or from source. We **recommend installing from PyPi** unless you plan to modify the source code.
2025-01-15 06:19:47 +01:00
### Install from PyPi (Recommended)
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
We recommend using a virtual environment (e.g., conda) to avoid conflicts with existing Python packages. With Python 3.10 or newer active in your virtual environment, use pip to install AutoGen Studio:
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
```bash
pip install -U autogenstudio
```
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
### Install from source
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
_Note: This approach requires some familiarity with building interfaces in React._
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
You have two options for installing from source: manually or using a dev container.
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
#### A) Install from source manually
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
1. Ensure you have Python 3.10+ and Node.js (version above 14.15.0) installed.
2. Clone the AutoGen Studio repository and install its Python dependencies using `pip install -e .`
3. Navigate to the `python/packages/autogen-studio/frontend` directory, install the dependencies, and build the UI:
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
```bash
npm install -g gatsby-cli
npm install --global yarn
cd frontend
yarn install
yarn build
# Windows users may need alternative commands to build the frontend:
gatsby clean && rmdir /s /q ..\\autogenstudio\\web\\ui 2>nul & (set \"PREFIX_PATH_VALUE=\" || ver>nul) && gatsby build --prefix-paths && xcopy /E /I /Y public ..\\autogenstudio\\web\\ui
```
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
#### B) Install from source using a dev container
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
1. Follow the [Dev Containers tutorial ](https://code.visualstudio.com/docs/devcontainers/tutorial ) to install VS Code, Docker and relevant extensions.
2. Clone the AutoGen Studio repository.
3. Open `python/packages/autogen-studio/` in VS Code. Click the blue button in bottom the corner or press F1 and select _"Dev Containers: Reopen in Container"_ .
4. Build the UI:
2023-12-24 04:20:59 -08:00
2025-01-15 06:19:47 +01:00
```bash
cd frontend
yarn build
```
2023-12-24 04:20:59 -08:00
### Running the Application
Once installed, run the web UI by entering the following in your terminal:
```bash
autogenstudio ui --port 8081
```
2025-01-15 06:19:47 +01:00
This command will start the application on the specified port. Open your web browser and go to < http: / / localhost:8081 / > to use AutoGen Studio.
2024-05-11 07:31:21 -07:00
AutoGen Studio also takes several parameters to customize the application:
2025-01-15 06:19:47 +01:00
- `--host <host>` argument to specify the host address. By default, it is set to `localhost` .
- `--appdir <appdir>` argument to specify the directory where the app files (e.g., database and generated user files) are stored. By default, it is set to the `.autogenstudio` directory in the user's home directory.
2024-05-11 07:31:21 -07:00
- `--port <port>` argument to specify the port number. By default, it is set to `8080` .
- `--reload` argument to enable auto-reloading of the server when changes are made to the code. By default, it is set to `False` .
2025-01-15 06:19:47 +01:00
- `--database-uri` argument to specify the database URI. Example values include `sqlite:///database.sqlite` for SQLite and `postgresql+psycopg://user:password@localhost/dbname` for PostgreSQL. If this is not specified, the database URL defaults to a `database.sqlite` file in the `--appdir` directory.
2024-11-17 12:04:55 -08:00
- `--upgrade-database` argument to upgrade the database schema to the latest version. By default, it is set to `False` .
2023-12-24 04:20:59 -08:00
Now that you have AutoGen Studio installed and running, you are ready to explore its capabilities, including defining and modifying agent workflows, interacting with agents and sessions, and expanding agent skills.
2025-01-15 06:19:47 +01:00
#### Local frontend development server
2024-11-15 14:51:57 -08:00
2025-01-15 06:19:47 +01:00
See `./frontend/README.md`
2024-09-27 16:27:26 -07:00
2024-01-23 11:59:58 -08:00
## Contribution Guide
We welcome contributions to AutoGen Studio. We recommend the following general steps to contribute to the project:
- Review the overall AutoGen project [contribution guide ](https://github.com/microsoft/autogen?tab=readme-ov-file#contributing )
2024-11-17 12:04:55 -08:00
- Please review the AutoGen Studio [roadmap ](https://github.com/microsoft/autogen/issues/4006 ) to get a sense of the current priorities for the project. Help is appreciated especially with Studio issues tagged with `help-wanted`
2024-01-23 11:59:58 -08:00
- Please initiate a discussion on the roadmap issue or a new issue to discuss your proposed contribution.
- Submit a pull request with your contribution!
- If you are modifying AutoGen Studio, it has its own devcontainer. See instructions in `.devcontainer/README.md` to use it
2024-11-17 12:04:55 -08:00
- Please use the tag `proj-studio` for any issues, questions, and PRs related to Studio
2024-01-23 11:59:58 -08:00
2023-12-24 04:20:59 -08:00
## FAQ
2024-06-09 20:29:34 -07:00
Please refer to the AutoGen Studio [FAQs ](https://microsoft.github.io/autogen/docs/autogen-studio/faqs ) page for more information.
Autogenstudio Updates [CSV support, Workflow Export, Skill Editing, Windows Testing ] (#1475)
* support groupchat, other QOL fixes
* remove gallery success toast
* Fix #1328. Add CSVLoader component and related support for rendering CSV files. Add download link in the modal for appropriate file types including CSV, Code, and PDF.
* add name and description field to session datamodel
* Update website/blog/2023-12-01-AutoGenStudio/index.mdx
Co-authored-by: Chi Wang <wang.chi@microsoft.com>
* sanitize llmconfig, remove additional fields
* improve models UX, only modify models from model tab.
* readme updates
* improve db defaults
* improve ui hover behavior and add note on models
* general qol updats
* add support for returning summary_method
* use ant design tables
* icon and layout updates
* css and layout updates
* readme updates and QOL updates
* fix bug where empty string is used as apikey #1415
* add speaker selection to UI #1373
* Fixed a bug that localAgent updates were not synchronized between GroupChatFlowSpecView and AgentFlowSpecView.
* Fixed a bug in Agent Specification Modal that caused localAgent updates to remain in state when closing a modal other than onOk.
* Fixed a bug that the updated Agent Specification Modal was not saved when the content of FlowConfigViewer Modal was changed after the Agent Specification Modal was updated when an updatedFlowConfig was created using localFlowConfig.
* add version to package
* remove sample key
* early support for versions table and testing models
* Add support for testing model when created #1404
* remove unused imports, qol updates
* fix bug on workflowmanager
* make file_name optional in skills datamodel
* update instructions on models
* fix errors from merge conflict with main
* santize workflow before download
* add support for editing skills in full fledged editor (monaco) #1442
* fix merge artifacts
* Fix build command for windows
Replaced && to & to continue execution when the 'ui' folder doesn't exist and also suppressed error "The system cannot find the file specified."
* Fix setup instructions
The config file starts with a dot (according to gatsby-config.ts).
* Throw error if env file doesn't exist
Otherwise the app will not work (issue very hard to trace)
* version bump
* formattin gupdates
* formatting updates
* Show warning instead of error if env config file doesn't exist
Fix: https://github.com/microsoft/autogen/pull/1475#issuecomment-1918114520
* add rel noopener to a tags
* formating updates
* remove double section in readme.
* update dev readme
* format update
* add default autoreply to agent config datamodel
* add check for empty messages list
* improve groupchat behavior, add sender to list of agents
* update system_message defaults to fit autogen default system message #1474
* simplify response from test_model to only return content, fix serialization issue in #1404
* readme and other formatting updates
* add support for showing temp and default auto reply #1521
* formatting updates
* formating and other updates
---------
Co-authored-by: Paul Retherford <paul@scanpower.com>
Co-authored-by: Chi Wang <wang.chi@microsoft.com>
Co-authored-by: junkei_okinawa <ceazy.x2.okinawan@gmail.com>
Co-authored-by: Christopher Pereira <kripper@imatronix.com>
2024-02-05 18:45:18 -08:00
2023-12-24 04:20:59 -08:00
## Acknowledgements
AutoGen Studio is Based on the [AutoGen ](https://microsoft.github.io/autogen ) project. It was adapted from a research prototype built in October 2023 (original credits: Gagan Bansal, Adam Fourney, Victor Dibia, Piali Choudhury, Saleema Amershi, Ahmed Awadallah, Chi Wang).
