Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into agentchat_termination…
Browse files Browse the repository at this point in the history
…_config_vd
  • Loading branch information
victordibia committed Jan 11, 2025
2 parents fb65bad + 115fefa commit 4ea176b
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 6 deletions.
16 changes: 16 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
var version = DOCUMENTATION_OPTIONS.VERSION;
if (version === "stable") {
var styles = `
s#bd-header-version-warning {
#bd-header-version-warning {
display: none;
}
`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import importlib
import warnings
from typing import Any, ClassVar, Dict, Generic, Literal, Protocol, Type, cast, overload, runtime_checkable
from typing import Any, ClassVar, Dict, Generic, List, Literal, Protocol, Type, cast, overload, runtime_checkable

from pydantic import BaseModel
from typing_extensions import Self, TypeVar
Expand Down Expand Up @@ -243,9 +243,9 @@ def _from_config(cls, config: Config) -> MyComponent:
return cls(value=config.value)
"""

required_class_vars = ["component_config_schema", "component_type"]
required_class_vars: ClassVar[List[str]] = ["component_config_schema", "component_type"]

def __init_subclass__(cls, **kwargs: Any):
def __init_subclass__(cls, **kwargs: Any) -> None:
super().__init_subclass__(**kwargs)

# TODO: validate provider is loadable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Empty file.
2 changes: 1 addition & 1 deletion python/samples/agentchat_chainlit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

0 comments on commit 4ea176b

Please sign in to comment.