Add models.openai and tools.langchain namespaces (#4601)

* add models.openai namespace * refactor tools namespace * update lock file * revert pyproject changes * update docs and add cast * update ext models doc ref * increase underline * add reply models namespace * update imports * fix test * linting * fix missing conflicts * revert pydantic changes * rename to replay * replay * fix reply * Fix test * formatting * example --------- Co-authored-by: Leonardo Pinheiro <[email protected]> Co-authored-by: Jack Gerrits <[email protected]> Co-authored-by: Jack Gerrits <[email protected]>
microsoft · Dec 10, 2024 · 253fe21 · 253fe21
1 parent 3e5e12b
commit 253fe21
Show file tree

Hide file tree

Showing 63 changed files with 634 additions and 621 deletions.
diff --git a/python/packages/autogen-agentchat/src/autogen_agentchat/agents/_assistant_agent.py b/python/packages/autogen-agentchat/src/autogen_agentchat/agents/_assistant_agent.py
@@ -121,7 +121,7 @@ class AssistantAgent(BaseChatAgent):
 
             import asyncio
             from autogen_core import CancellationToken
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.messages import TextMessage
 
@@ -149,7 +149,7 @@ async def main() -> None:
         .. code-block:: python
 
             import asyncio
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.messages import TextMessage
             from autogen_agentchat.ui import Console
@@ -183,7 +183,7 @@ async def main() -> None:
 
             import asyncio
             from autogen_core import CancellationToken
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.messages import TextMessage
 

diff --git a/python/packages/autogen-agentchat/src/autogen_agentchat/agents/_society_of_mind_agent.py b/python/packages/autogen-agentchat/src/autogen_agentchat/agents/_society_of_mind_agent.py
@@ -40,7 +40,7 @@ class SocietyOfMindAgent(BaseChatAgent):
 
         import asyncio
         from autogen_agentchat.agents import AssistantAgent, SocietyOfMindAgent
-        from autogen_ext.models import OpenAIChatCompletionClient
+        from autogen_ext.models.openai import OpenAIChatCompletionClient
         from autogen_agentchat.teams import RoundRobinGroupChat
         from autogen_agentchat.conditions import MaxMessageTermination
 

diff --git a/python/packages/autogen-agentchat/src/autogen_agentchat/base/_handoff.py b/python/packages/autogen-agentchat/src/autogen_agentchat/base/_handoff.py
@@ -15,23 +15,23 @@ class Handoff(BaseModel):
     target: str
     """The name of the target agent to handoff to."""
 
-    description: str = Field(default=None)
+    description: str = Field(default="")
     """The description of the handoff such as the condition under which it should happen and the target agent's ability.
     If not provided, it is generated from the target agent's name."""
 
-    name: str = Field(default=None)
+    name: str = Field(default="")
     """The name of this handoff configuration. If not provided, it is generated from the target agent's name."""
 
-    message: str = Field(default=None)
+    message: str = Field(default="")
     """The message to the target agent.
     If not provided, it is generated from the target agent's name."""
 
     @model_validator(mode="before")
     @classmethod
     def set_defaults(cls, values: Dict[str, Any]) -> Dict[str, Any]:
-        if values.get("description") is None:
+        if not values.get("description"):
             values["description"] = f"Handoff to {values['target']}."
-        if values.get("name") is None:
+        if not values.get("name"):
             values["name"] = f"transfer_to_{values['target']}".lower()
         else:
             name = values["name"]
@@ -40,7 +40,7 @@ def set_defaults(cls, values: Dict[str, Any]) -> Dict[str, Any]:
             # Check if name is a valid identifier.
             if not name.isidentifier():
                 raise ValueError(f"Handoff name must be a valid identifier: {values['name']}")
-        if values.get("message") is None:
+        if not values.get("message"):
             values["message"] = (
                 f"Transferred to {values['target']}, adopting the role of {values['target']} immediately."
             )

diff --git a/...on/packages/autogen-agentchat/src/autogen_agentchat/teams/_group_chat/_base_group_chat.py b/...on/packages/autogen-agentchat/src/autogen_agentchat/teams/_group_chat/_base_group_chat.py
@@ -188,7 +188,7 @@ async def run(
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.conditions import MaxMessageTermination
             from autogen_agentchat.teams import RoundRobinGroupChat
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
 
 
             async def main() -> None:
@@ -219,7 +219,7 @@ async def main() -> None:
             from autogen_agentchat.conditions import MaxMessageTermination
             from autogen_agentchat.teams import RoundRobinGroupChat
             from autogen_core import CancellationToken
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
 
 
             async def main() -> None:
@@ -286,7 +286,7 @@ async def run_stream(
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.conditions import MaxMessageTermination
             from autogen_agentchat.teams import RoundRobinGroupChat
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
 
 
             async def main() -> None:
@@ -320,7 +320,7 @@ async def main() -> None:
             from autogen_agentchat.ui import Console
             from autogen_agentchat.teams import RoundRobinGroupChat
             from autogen_core import CancellationToken
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
 
 
             async def main() -> None:
@@ -437,7 +437,7 @@ async def reset(self) -> None:
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.conditions import MaxMessageTermination
             from autogen_agentchat.teams import RoundRobinGroupChat
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
 
 
             async def main() -> None:

diff --git a/...entchat/src/autogen_agentchat/teams/_group_chat/_magentic_one/_magentic_one_group_chat.py b/...entchat/src/autogen_agentchat/teams/_group_chat/_magentic_one/_magentic_one_group_chat.py
@@ -38,7 +38,7 @@ class MagenticOneGroupChat(BaseGroupChat):
         .. code-block:: python
 
             import asyncio
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.teams import MagenticOneGroupChat
             from autogen_agentchat.ui import Console

diff --git a/...ages/autogen-agentchat/src/autogen_agentchat/teams/_group_chat/_round_robin_group_chat.py b/...ages/autogen-agentchat/src/autogen_agentchat/teams/_group_chat/_round_robin_group_chat.py
@@ -83,7 +83,7 @@ class RoundRobinGroupChat(BaseGroupChat):
         .. code-block:: python
 
             import asyncio
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.teams import RoundRobinGroupChat
             from autogen_agentchat.conditions import TextMentionTermination
@@ -113,7 +113,7 @@ async def get_weather(location: str) -> str:
         .. code-block:: python
 
             import asyncio
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.teams import RoundRobinGroupChat
             from autogen_agentchat.conditions import TextMentionTermination

diff --git a/...ackages/autogen-agentchat/src/autogen_agentchat/teams/_group_chat/_selector_group_chat.py b/...ackages/autogen-agentchat/src/autogen_agentchat/teams/_group_chat/_selector_group_chat.py
@@ -219,7 +219,7 @@ class SelectorGroupChat(BaseGroupChat):
         .. code-block:: python
 
             import asyncio
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.teams import SelectorGroupChat
             from autogen_agentchat.conditions import TextMentionTermination
@@ -273,7 +273,7 @@ async def book_trip() -> str:
 
             import asyncio
             from typing import Sequence
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.teams import SelectorGroupChat
             from autogen_agentchat.conditions import TextMentionTermination

diff --git a/...n/packages/autogen-agentchat/src/autogen_agentchat/teams/_group_chat/_swarm_group_chat.py b/...n/packages/autogen-agentchat/src/autogen_agentchat/teams/_group_chat/_swarm_group_chat.py
@@ -108,7 +108,7 @@ class Swarm(BaseGroupChat):
         .. code-block:: python
 
             import asyncio
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.teams import Swarm
             from autogen_agentchat.conditions import MaxMessageTermination
@@ -143,7 +143,7 @@ async def main() -> None:
         .. code-block:: python
 
             import asyncio
-            from autogen_ext.models import OpenAIChatCompletionClient
+            from autogen_ext.models.openai import OpenAIChatCompletionClient
             from autogen_agentchat.agents import AssistantAgent
             from autogen_agentchat.teams import Swarm
             from autogen_agentchat.conditions import HandoffTermination, MaxMessageTermination

diff --git a/python/packages/autogen-agentchat/tests/test_assistant_agent.py b/python/packages/autogen-agentchat/tests/test_assistant_agent.py
@@ -16,7 +16,7 @@
 )
 from autogen_core import Image
 from autogen_core.tools import FunctionTool
-from autogen_ext.models import OpenAIChatCompletionClient
+from autogen_ext.models.openai import OpenAIChatCompletionClient
 from openai.resources.chat.completions import AsyncCompletions
 from openai.types.chat.chat_completion import ChatCompletion, Choice
 from openai.types.chat.chat_completion_chunk import ChatCompletionChunk

diff --git a/python/packages/autogen-agentchat/tests/test_group_chat.py b/python/packages/autogen-agentchat/tests/test_group_chat.py
@@ -35,7 +35,8 @@
 from autogen_core import AgentId, CancellationToken
 from autogen_core.tools import FunctionTool
 from autogen_ext.code_executors.local import LocalCommandLineCodeExecutor
-from autogen_ext.models import OpenAIChatCompletionClient, ReplayChatCompletionClient
+from autogen_ext.models.openai import OpenAIChatCompletionClient
+from autogen_ext.models.replay import ReplayChatCompletionClient
 from openai.resources.chat.completions import AsyncCompletions
 from openai.types.chat.chat_completion import ChatCompletion, Choice
 from openai.types.chat.chat_completion_chunk import ChatCompletionChunk

diff --git a/python/packages/autogen-agentchat/tests/test_magentic_one_group_chat.py b/python/packages/autogen-agentchat/tests/test_magentic_one_group_chat.py
@@ -18,7 +18,7 @@
 )
 from autogen_agentchat.teams._group_chat._magentic_one._magentic_one_orchestrator import MagenticOneOrchestrator
 from autogen_core import AgentId, CancellationToken
-from autogen_ext.models import ReplayChatCompletionClient
+from autogen_ext.models.replay import ReplayChatCompletionClient
 from utils import FileLogHandler
 
 logger = logging.getLogger(EVENT_LOGGER_NAME)

diff --git a/python/packages/autogen-agentchat/tests/test_society_of_mind_agent.py b/python/packages/autogen-agentchat/tests/test_society_of_mind_agent.py
@@ -5,7 +5,7 @@
 from autogen_agentchat.agents import AssistantAgent, SocietyOfMindAgent
 from autogen_agentchat.conditions import MaxMessageTermination
 from autogen_agentchat.teams import RoundRobinGroupChat
-from autogen_ext.models import OpenAIChatCompletionClient
+from autogen_ext.models.openai import OpenAIChatCompletionClient
 from openai.resources.chat.completions import AsyncCompletions
 from openai.types.chat.chat_completion import ChatCompletion, Choice
 from openai.types.chat.chat_completion_chunk import ChatCompletionChunk

diff --git a/python/packages/autogen-core/docs/src/reference/index.md b/python/packages/autogen-core/docs/src/reference/index.md
@@ -45,8 +45,9 @@ python/autogen_ext.agents.web_surfer
 python/autogen_ext.agents.file_surfer
 python/autogen_ext.agents.video_surfer
 python/autogen_ext.agents.video_surfer.tools
-python/autogen_ext.models
-python/autogen_ext.tools
+python/autogen_ext.models.openai
+python/autogen_ext.models.replay
+python/autogen_ext.tools.langchain
 python/autogen_ext.code_executors.local
 python/autogen_ext.code_executors.docker
 python/autogen_ext.code_executors.azure

diff --git a/...n/packages/autogen-core/docs/src/reference/python/autogen_ext.models.openai.rst b/...n/packages/autogen-core/docs/src/reference/python/autogen_ext.models.openai.rst
@@ -0,0 +1,8 @@
+autogen\_ext.models.openai
+==========================
+
+
+.. automodule:: autogen_ext.models.openai
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/...n/packages/autogen-core/docs/src/reference/python/autogen_ext.models.replay.rst b/...n/packages/autogen-core/docs/src/reference/python/autogen_ext.models.replay.rst
@@ -0,0 +1,8 @@
+autogen\_ext.models.replay
+==========================
+
+
+.. automodule:: autogen_ext.models.replay
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.models.rst b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.models.rst
diff --git a/...rc/reference/python/autogen_ext.tools.rst → ...ce/python/autogen_ext.tools.langchain.rst b/...rc/reference/python/autogen_ext.tools.rst → ...ce/python/autogen_ext.tools.langchain.rst
diff --git a/...ges/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/company-research.ipynb b/...ges/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/company-research.ipynb
@@ -27,7 +27,7 @@
     "from autogen_agentchat.teams import RoundRobinGroupChat\n",
     "from autogen_agentchat.ui import Console\n",
     "from autogen_core.tools import FunctionTool\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient"
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient"
    ]
   },
   {

diff --git a/...es/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/literature-review.ipynb b/...es/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/literature-review.ipynb
@@ -27,7 +27,7 @@
     "from autogen_agentchat.teams import RoundRobinGroupChat\n",
     "from autogen_agentchat.ui import Console\n",
     "from autogen_core.tools import FunctionTool\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient"
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient"
    ]
   },
   {

diff --git a/...ages/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/travel-planning.ipynb b/...ages/autogen-core/docs/src/user-guide/agentchat-user-guide/examples/travel-planning.ipynb
@@ -21,7 +21,7 @@
     "from autogen_agentchat.conditions import TextMentionTermination\n",
     "from autogen_agentchat.teams import RoundRobinGroupChat\n",
     "from autogen_agentchat.ui import Console\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient"
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient"
    ]
   },
   {

diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/quickstart.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/quickstart.ipynb
@@ -76,7 +76,7 @@
                 "from autogen_agentchat.conditions import TextMentionTermination\n",
                 "from autogen_agentchat.teams import RoundRobinGroupChat\n",
                 "from autogen_agentchat.ui import Console\n",
-                "from autogen_ext.models import OpenAIChatCompletionClient\n",
+                "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
                 "\n",
                 "\n",
                 "# Define a tool\n",

diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/agents.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/agents.ipynb
@@ -33,7 +33,7 @@
     "from autogen_agentchat.agents import AssistantAgent\n",
     "from autogen_agentchat.messages import TextMessage\n",
     "from autogen_core import CancellationToken\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient\n",
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
     "\n",
     "\n",
     "# Define a tool that searches the web for information.\n",

diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/models.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/models.ipynb
@@ -44,7 +44,7 @@
             "metadata": {},
             "outputs": [],
             "source": [
-                "from autogen_ext.models import OpenAIChatCompletionClient\n",
+                "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
                 "\n",
                 "opneai_model_client = OpenAIChatCompletionClient(\n",
                 "    model=\"gpt-4o-2024-08-06\",\n",
@@ -128,7 +128,7 @@
             "metadata": {},
             "outputs": [],
             "source": [
-                "from autogen_ext.models import AzureOpenAIChatCompletionClient\n",
+                "from autogen_ext.models.openai import AzureOpenAIChatCompletionClient\n",
                 "from azure.identity import DefaultAzureCredential, get_bearer_token_provider\n",
                 "\n",
                 "# Create the token provider\n",

diff --git a/.../autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/selector-group-chat.ipynb b/.../autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/selector-group-chat.ipynb
@@ -67,7 +67,7 @@
     "from autogen_agentchat.messages import AgentMessage\n",
     "from autogen_agentchat.teams import SelectorGroupChat\n",
     "from autogen_agentchat.ui import Console\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient"
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient"
    ]
   },
   {

diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/state.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/state.ipynb
@@ -39,7 +39,7 @@
     "from autogen_agentchat.teams import RoundRobinGroupChat\n",
     "from autogen_agentchat.ui import Console\n",
     "from autogen_core import CancellationToken\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient\n",
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
     "\n",
     "assistant_agent = AssistantAgent(\n",
     "    name=\"assistant_agent\",\n",

diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/swarm.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/swarm.ipynb
@@ -100,7 +100,7 @@
     "from autogen_agentchat.messages import HandoffMessage\n",
     "from autogen_agentchat.teams import Swarm\n",
     "from autogen_agentchat.ui import Console\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient"
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient"
    ]
   },
   {

diff --git a/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/teams.ipynb b/python/packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/teams.ipynb
@@ -33,7 +33,7 @@
     "from autogen_agentchat.agents import AssistantAgent\n",
     "from autogen_agentchat.conditions import TextMentionTermination\n",
     "from autogen_agentchat.teams import RoundRobinGroupChat\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient\n",
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
     "\n",
     "# Create an OpenAI model client.\n",
     "model_client = OpenAIChatCompletionClient(\n",
@@ -260,7 +260,7 @@
     "from autogen_agentchat.conditions import MaxMessageTermination, TextMentionTermination\n",
     "from autogen_agentchat.teams import RoundRobinGroupChat\n",
     "from autogen_agentchat.ui import Console\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient\n",
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
     "\n",
     "# Create an OpenAI model client.\n",
     "model_client = OpenAIChatCompletionClient(\n",
@@ -633,7 +633,7 @@
     "from autogen_agentchat.base import Handoff\n",
     "from autogen_agentchat.conditions import HandoffTermination, TextMentionTermination\n",
     "from autogen_agentchat.teams import RoundRobinGroupChat\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient\n",
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
     "\n",
     "# Create an OpenAI model client.\n",
     "model_client = OpenAIChatCompletionClient(\n",

diff --git a/...packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/termination.ipynb b/...packages/autogen-core/docs/src/user-guide/agentchat-user-guide/tutorial/termination.ipynb
@@ -58,7 +58,7 @@
     "from autogen_agentchat.conditions import MaxMessageTermination, TextMentionTermination\n",
     "from autogen_agentchat.teams import RoundRobinGroupChat\n",
     "from autogen_agentchat.ui import Console\n",
-    "from autogen_ext.models import OpenAIChatCompletionClient\n",
+    "from autogen_ext.models.openai import OpenAIChatCompletionClient\n",
     "\n",
     "model_client = OpenAIChatCompletionClient(\n",
     "    model=\"gpt-4o\",\n",

diff --git a/...core/docs/src/user-guide/core-user-guide/cookbook/azure-openai-with-aad-auth.md b/...core/docs/src/user-guide/core-user-guide/cookbook/azure-openai-with-aad-auth.md
@@ -15,7 +15,7 @@ pip install azure-identity
 ## Using the Model Client
 
 ```python
-from autogen_ext.models import AzureOpenAIChatCompletionClient
+from autogen_ext.models.openai import AzureOpenAIChatCompletionClient
 from azure.identity import DefaultAzureCredential, get_bearer_token_provider
 
 # Create the token provider