A programming framework for agentic AI
update docs (#129)
Eric Zhua4f08959b753
diff --git a/python/docs/src/core-concepts/patterns.md b/python/docs/src/core-concepts/patterns.mdindex d8f1e5c20..e1b32b014 100644--- a/python/docs/src/core-concepts/patterns.md+++ b/python/docs/src/core-concepts/patterns.md@@ -10,3 +10,5 @@ like software development.You can implement any multi-agent pattern using AGNext agents, whichcommunicate with each other using messages through the agent runtime(see {doc}`/core-concepts/runtime` and {doc}`/core-concepts/agent`).+See `examples <https://github.com/microsoft/agnext/tree/main/python/examples#pattern-examples>`_+for how to implement patterns like reflection and group chat.diff --git a/python/docs/src/core-concepts/tools.md b/python/docs/src/core-concepts/tools.mdindex 40986faed..e609c3c38 100644--- a/python/docs/src/core-concepts/tools.md+++ b/python/docs/src/core-concepts/tools.md@@ -1 +1,8 @@# Tools++Tools can be used together with agents powered by the OpenAI's ChatCompletion or the Assistant API.+AGNext provides the {py:mod}`agnext.components.tools` module with a suite of built-in+tools and utilities for creating and running custom tools.++See [examples](https://github.com/microsoft/agnext/tree/main/python/examples#tool-use-examples)+for how to use the built-in code execution tool and creating custom tools.diff --git a/python/docs/src/index.rst b/python/docs/src/index.rstindex 27e23581b..87ea28ca9 100644--- a/python/docs/src/index.rst+++ b/python/docs/src/index.rst@@ -1,23 +1,28 @@AGNext-------AGNext is a framework for building multi-agent applications. It is designed to be easy to use, flexible, and scalable.+AGNext is a framework for building multi-agent applications.-At a high level it provides both a framework for inter-agent communication and a set of components for building and managing agents.+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+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>`.-AGNext supports both RPC or event based based+AGNext supports both RPC-like direct messaging and event basedcommunication between agents, allowing for a :doc:`diverse set of agent patterns-<core-concepts/patterns>`. AGNext provides default agent implementations for-common uses, such as chat completion agents, but also allows for fully custom agents.+<core-concepts/patterns>`.AGNext's developer API consists of the following layers:- :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.-- :doc:`components <reference/agnext.components>` - Interfaces and implementations for agents, models, memory, and tools.+- :doc:`components <reference/agnext.components>` - Independent agent-building components: agents, models, memory, and tools.-To get you started quickly, we also offers [a suite of examples](https://github.com/microsoft/agnext/tree/main/python/examples) to demonstrate the core concepts.+To get you started quickly, we also offers+`a suite of examples <https://github.com/microsoft/agnext/tree/main/python/examples>`_+that demonstrate how to use AGNext... toctree:::caption: Getting started