2024-09-17 06:22:38 -07:00
---
myst:
html_meta:
"description lang=en": |
2024-09-23 12:39:36 -04:00
Top-level documentation for AutoGen, a framework for developing applications using AI agents
2024-09-17 06:22:38 -07:00
html_theme.sidebar_secondary.remove: false
2024-09-23 13:45:16 -04:00
sd_hide_title: true
2024-09-17 06:22:38 -07:00
---
2024-09-23 11:37:05 -04:00
< style >
.hero-title {
font-size: 60px;
font-weight: bold;
margin: 2rem auto 0;
}
2024-10-14 12:29:42 -04:00
.wip-card {
border: 1px solid var(--pst-color-success);
background-color: var(--pst-color-success-bg);
border-radius: .25rem;
padding: 0.3rem;
display: flex;
justify-content: center;
align-items: center;
margin-bottom: 1rem;
}
2024-09-23 11:37:05 -04:00
< / style >
2024-09-23 13:45:16 -04:00
# AutoGen
2024-09-23 11:37:05 -04:00
< div class = "container" >
< div class = "row text-center" >
< div class = "col-sm-12" >
< h1 class = "hero-title" >
AutoGen
< / h1 >
< h3 >
2025-01-06 14:13:22 -08:00
A framework for building AI agents and applications
2024-09-23 11:37:05 -04:00
< / h3 >
< / div >
< / div >
2024-10-09 10:08:57 -04:00
< / div >
2024-09-23 11:37:05 -04:00
2024-10-09 10:08:57 -04:00
< div style = "margin-top: 2rem;" >
2024-09-23 11:37:05 -04:00
2024-12-19 12:01:03 -05:00
::::{grid}
:gutter: 2
2024-09-23 11:37:05 -04:00
2024-10-14 12:29:42 -04:00
:::{grid-item-card}
2024-10-09 10:08:57 -04:00
:shadow: none
:margin: 2 0 0 0
2025-01-06 14:13:22 -08:00
:columns: 12 12 6 6
2024-09-23 11:37:05 -04:00
2024-10-14 12:29:42 -04:00
< div class = "sd-card-title sd-font-weight-bold docutils" >
2025-01-06 14:13:22 -08:00
{fas}`book;pst-color-primary`
2025-01-08 15:18:08 -08:00
Magentic-One CLI [](https://pypi.org/project/magentic-one-cli/)
2025-01-08 10:52:33 -08:00
< / div >
2025-01-08 15:18:08 -08:00
A console-based multi-agent assistant for web and file-based tasks.
2025-01-06 14:13:22 -08:00
Built on AgentChat.
2024-09-23 11:37:05 -04:00
2025-01-06 14:13:22 -08:00
```bash
2025-01-13 16:22:03 -05:00
pip install -U magentic-one-cli
2025-01-08 10:52:33 -08:00
m1 "Find flights from Seattle to Paris and format the result in a table"
2024-09-30 19:43:05 -04:00
```
2024-09-17 06:22:38 -07:00
2024-10-09 10:08:57 -04:00
+++
2024-09-23 11:37:05 -04:00
2025-01-06 14:13:22 -08:00
```{button-ref} user-guide/agentchat-user-guide/magentic-one
:color: secondary
Get Started
```
2024-09-23 11:37:05 -04:00
2024-10-09 10:08:57 -04:00
:::
2025-01-03 15:16:56 -05:00
2025-01-08 10:52:33 -08:00
:::{grid-item-card} {fas}`palette;pst-color-primary` Studio [](https://pypi.org/project/autogenstudio/)
2025-01-03 15:16:56 -05:00
:shadow: none
:margin: 2 0 0 0
2025-01-06 14:13:22 -08:00
:columns: 12 12 6 6
2025-01-03 15:16:56 -05:00
2025-01-06 14:13:22 -08:00
An app for prototyping and managing agents without writing code.
Built on AgentChat.
2025-01-03 15:16:56 -05:00
2025-01-06 14:13:22 -08:00
```bash
2025-01-13 16:22:03 -05:00
pip install -U autogenstudio
2025-01-13 06:55:10 -08:00
autogenstudio ui --port 8080 --appdir ./myapp
2025-01-06 14:13:22 -08:00
```
2025-01-03 15:16:56 -05:00
+++
2025-01-06 14:13:22 -08:00
```{button-ref} user-guide/autogenstudio-user-guide/index
2025-01-03 15:16:56 -05:00
:color: secondary
Get Started
```
:::
2025-01-06 14:13:22 -08:00
:::{grid-item-card}
2024-12-19 12:01:03 -05:00
:shadow: none
:margin: 2 0 0 0
:columns: 12 12 12 12
2025-01-06 14:13:22 -08:00
< div class = "sd-card-title sd-font-weight-bold docutils" >
{fas}`people-group;pst-color-primary` AgentChat
2025-01-09 15:29:54 -05:00
[](https://pypi.org/project/autogen-agentchat/)
2025-01-06 14:13:22 -08:00
< / div >
A programming framework for building conversational single and multi-agent applications.
2025-01-12 09:19:57 -08:00
Built on Core. Requires Python 3.10+.
2025-01-06 14:13:22 -08:00
```python
2025-01-09 11:19:25 -08:00
# pip install -U "autogen-agentchat" "autogen-ext[openai]"
2025-01-06 14:13:22 -08:00
import asyncio
from autogen_agentchat.agents import AssistantAgent
from autogen_ext.models.openai import OpenAIChatCompletionClient
async def main() -> None:
2025-01-09 11:19:25 -08:00
agent = AssistantAgent("assistant", OpenAIChatCompletionClient(model="gpt-4o"))
2025-01-12 14:34:30 +05:30
print(await agent.run(task="Say 'Hello World!'"))
2025-01-09 11:19:25 -08:00
2025-01-06 14:13:22 -08:00
asyncio.run(main())
```
_Start here if you are building conversational agents. [Migrating from AutoGen 0.2? ](./user-guide/agentchat-user-guide/migration-guide.md )._
2024-12-19 12:01:03 -05:00
+++
2025-01-06 14:13:22 -08:00
```{button-ref} user-guide/agentchat-user-guide/quickstart
2024-12-19 12:01:03 -05:00
:color: secondary
Get Started
```
:::
2025-01-09 15:29:54 -05:00
:::{grid-item-card} {fas}`cube;pst-color-primary` Core [](https://pypi.org/project/autogen-core/)
2024-10-09 10:08:57 -04:00
:shadow: none
:margin: 2 0 0 0
2025-01-06 14:13:22 -08:00
:columns: 12 12 12 12
2024-12-19 12:01:03 -05:00
2025-01-06 14:13:22 -08:00
An event-driven programming framework for building scalable multi-agent AI systems. Example scenarios:
2024-09-23 11:37:05 -04:00
2025-01-06 14:13:22 -08:00
* Deterministic and dynamic agentic workflows for business processes.
* Research on multi-agent collaboration.
* Distributed agents for multi-language applications.
_Start here if you are building workflows or distributed agent systems._
2024-09-23 11:37:05 -04:00
2024-10-09 10:08:57 -04:00
+++
2024-09-17 06:22:38 -07:00
2024-10-09 10:08:57 -04:00
```{button-ref} user-guide/core-user-guide/quickstart
:color: secondary
2024-09-17 06:22:38 -07:00
2024-10-09 10:08:57 -04:00
Get Started
2024-09-17 06:22:38 -07:00
```
2024-10-09 10:08:57 -04:00
:::
2024-12-19 12:01:03 -05:00
2025-01-09 15:29:54 -05:00
:::{grid-item-card} {fas}`puzzle-piece;pst-color-primary` Extensions [](https://pypi.org/project/autogen-ext/)
2024-12-19 12:01:03 -05:00
:shadow: none
:margin: 2 0 0 0
2025-01-06 14:13:22 -08:00
:columns: 12 12 12 12
2024-12-19 12:01:03 -05:00
2025-01-06 14:13:22 -08:00
Implementations of Core and AgentChat components that interface with external services or other libraries.
You can find and use community extensions or create your own. Examples of built-in extensions:
2024-12-19 12:01:03 -05:00
2025-01-06 14:13:22 -08:00
* {py:class}`~autogen_ext.tools.langchain.LangChainToolAdapter` for using LangChain tools.
* {py:class}`~autogen_ext.agents.openai.OpenAIAssistantAgent` for using Assistant API.
* {py:class}`~autogen_ext.code_executors.docker.DockerCommandLineCodeExecutor` for running model-generated code in a Docker container.
* {py:class}`~autogen_ext.runtimes.grpc.GrpcWorkerAgentRuntime` for distributed agents.
2024-12-19 12:01:03 -05:00
+++
2025-01-06 14:13:22 -08:00
< a class = "sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href = "user-guide/extensions-user-guide/discover.html" > < span class = "doc" > Discover Community Extensions< / span > < / a >
< a class = "sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href = "user-guide/extensions-user-guide/create-your-own.html" > < span class = "doc" > Create New Extension< / span > < / a >
2024-12-19 12:01:03 -05:00
:::
2024-10-09 10:08:57 -04:00
::::
2024-09-17 06:22:38 -07:00
2024-10-09 10:08:57 -04:00
< / div >
2024-09-17 06:22:38 -07:00
```{toctree}
2024-10-09 10:08:57 -04:00
:maxdepth: 3
2024-09-17 06:22:38 -07:00
:hidden:
2024-12-19 10:07:07 -05:00
user-guide/agentchat-user-guide/index
user-guide/core-user-guide/index
user-guide/extensions-user-guide/index
2024-12-19 12:01:03 -05:00
Studio < user-guide / autogenstudio-user-guide / index >
2024-09-17 06:22:38 -07:00
reference/index
```