From b6c3df29201133ea2f422f7f9fa31f3775179ec6 Mon Sep 17 00:00:00 2001 From: Matthew Wyman Date: Thu, 9 Jan 2025 16:29:28 -0800 Subject: [PATCH 1/4] Update README.md to fix spelling error (#4982) --- python/samples/agentchat_chainlit/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/samples/agentchat_chainlit/README.md b/python/samples/agentchat_chainlit/README.md index 3f297158598c..d03ca98e0283 100644 --- a/python/samples/agentchat_chainlit/README.md +++ b/python/samples/agentchat_chainlit/README.md @@ -104,5 +104,5 @@ team = RoundRobinGroupChat( In this example, we created a basic AutoGen team with a single agent in a RoundRobinGroupChat team. There are a few ways you can extend this example: - Add more [agents](https://microsoft.github.io/autogen/dev/user-guide/agentchat-user-guide/tutorial/agents.html) to the team. -- Explor custom agents that sent multimodal messages +- Explore custom agents that sent multimodal messages - Explore more [team](https://microsoft.github.io/autogen/dev/user-guide/agentchat-user-guide/tutorial/teams.html) types beyond the `RoundRobinGroupChat`. From 001f0262babf5baa71148467a2d705e80280653d Mon Sep 17 00:00:00 2001 From: Eric Zhu Date: Fri, 10 Jan 2025 00:08:30 -0800 Subject: [PATCH 2/4] Minor API doc update for openai assistant agent (#4986) --- .../src/autogen_ext/agents/openai/_openai_assistant_agent.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/python/packages/autogen-ext/src/autogen_ext/agents/openai/_openai_assistant_agent.py b/python/packages/autogen-ext/src/autogen_ext/agents/openai/_openai_assistant_agent.py index e4d359cf3eff..d738a5fae894 100644 --- a/python/packages/autogen-ext/src/autogen_ext/agents/openai/_openai_assistant_agent.py +++ b/python/packages/autogen-ext/src/autogen_ext/agents/openai/_openai_assistant_agent.py @@ -109,6 +109,8 @@ class OpenAIAssistantAgent(BaseChatAgent): * Vector store integration for efficient file search * Automatic file parsing and embedding + You can use an existing thread or assistant by providing the `thread_id` or `assistant_id` parameters. + Example: .. code-block:: python @@ -160,6 +162,7 @@ async def example(): instructions (str): System instructions for the assistant tools (Optional[Iterable[Union[Literal["code_interpreter", "file_search"], Tool | Callable[..., Any] | Callable[..., Awaitable[Any]]]]]): Tools the assistant can use assistant_id (Optional[str]): ID of existing assistant to use + thread_id (Optional[str]): ID of existing thread to use metadata (Optional[object]): Additional metadata for the assistant response_format (Optional[AssistantResponseFormatOptionParam]): Response format settings temperature (Optional[float]): Temperature for response generation From 6044924a4fbf96912d0307fce6a5466a16013987 Mon Sep 17 00:00:00 2001 From: Jack Gerrits Date: Fri, 10 Jan 2025 08:47:10 -0500 Subject: [PATCH 3/4] Add guidance for docstrings when adding an API (#4981) --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e9705198c74d..c2e781239c48 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -118,3 +118,19 @@ Args: agent_type (str): Agent type to handle this subscription """ ``` + +## Docs when adding a new API + +Now that 0.4.0 is out, we should ensure the docs between versions are easy to navigate. To this end, added or changed APIs should have the following added to their docstrings respectively: + +```rst +.. versionadded:: v0.4.1 + + Here's a version added message. + +.. versionchanged:: v0.4.1 + + Here's a version changed message. +``` + +See [here](https://pydata-sphinx-theme.readthedocs.io/en/stable/examples/kitchen-sink/admonitions.html#versionadded) for how they are rendered. From c59cfdd787e657fed62345824364883e0b7d88ca Mon Sep 17 00:00:00 2001 From: Tim Rogers Date: Fri, 10 Jan 2025 14:01:00 +0000 Subject: [PATCH 4/4] Fix typo in `Multi-Agent Design Patterns -> Intro` docs (#4991) --- .../src/user-guide/core-user-guide/design-patterns/intro.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/intro.md b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/intro.md index 5fad8db2506c..b8f50d799a98 100644 --- a/python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/intro.md +++ b/python/packages/autogen-core/docs/src/user-guide/core-user-guide/design-patterns/intro.md @@ -9,7 +9,7 @@ like software development. A multi-agent design pattern is a structure that emerges from message protocols: it describes how agents interact with each other to solve problems. -For example, the [tool-equiped agent](../framework/tools.ipynb#tool-equipped-agent) in +For example, the [tool-equipped agent](../framework/tools.ipynb#tool-equipped-agent) in the previous section employs a design pattern called ReAct, which involves an agent interacting with tools.