autogen/python/docs/src/index.rst

71 lines
2.1 KiB
ReStructuredText
Raw Normal View History

AGNext
------
2024-06-25 16:51:49 -07:00
AGNext is a framework for building multi-agent applications.
2024-06-28 10:22:44 -04:00
At a high level, it provides a framework for inter-agent communication and a
suite of independent components for building and managing agents. It models agents as
independent actors communicating via messages. You can implement agents in
2024-06-25 16:51:49 -07:00
different languages and run them on different machines across organizational boundaries.
You can also implement agents using other agent frameworks and run them in AGNext.
:doc:`Agents <core-concepts/agent>` are hosted by and managed by a :doc:`runtime <core-concepts/runtime>`.
2024-06-25 16:51:49 -07:00
AGNext supports both RPC-like direct messaging and event based
communication between agents, allowing for a :doc:`diverse set of agent patterns
2024-06-25 16:51:49 -07:00
<core-concepts/patterns>`.
2024-06-21 05:05:54 -07:00
AGNext's developer API consists of the following layers:
2024-06-21 08:49:57 -07:00
- :doc:`core <reference/agnext.core>` - The core interfaces that defines agent and runtime.
- :doc:`application <reference/agnext.application>` - Implementations of the runtime and other modules (e.g., logging) for building applications.
2024-06-25 16:51:49 -07:00
- :doc:`components <reference/agnext.components>` - Independent agent-building components: agents, models, memory, and tools.
2024-06-21 05:05:54 -07:00
2024-06-28 10:22:44 -04:00
To get you started quickly, we also offers
2024-06-25 16:51:49 -07:00
`a suite of examples <https://github.com/microsoft/agnext/tree/main/python/examples>`_
that demonstrate how to use AGNext.
2024-06-21 05:05:54 -07:00
.. toctree::
:caption: Getting started
:hidden:
getting-started/installation
getting-started/tutorial
.. toctree::
:caption: Core Concepts
:hidden:
core-concepts/runtime
core-concepts/agent
core-concepts/patterns
core-concepts/memory
core-concepts/tools
2024-06-12 17:10:17 -04:00
core-concepts/cancellation
core-concepts/logging
core-concepts/namespace
.. toctree::
:caption: Guides
:hidden:
2024-06-12 17:10:17 -04:00
guides/type-routed-agent
guides/azure-openai-with-aad-auth
guides/termination-with-intervention
2024-06-28 10:22:44 -04:00
guides/extracting-results-with-an-agent
.. toctree::
:caption: Reference
:hidden:
2024-06-04 10:00:05 -04:00
reference/agnext.components
reference/agnext.application
reference/agnext.core
.. toctree::
:caption: Other
:hidden:
contributing