Merge branch 'victordibia-patch-1' of github.com:microsoft/autogen into victordibia-patch-1

Author: victordibia

.github/ISSUE_TEMPLATE/1-bug_report.yml

@@ -90,6 +90,14 @@ body:
       multiple: false
       options:
         - "Python dev (main branch)"
+        - "Python 0.5.6"
+        - "Python 0.5.5"
+        - "Python 0.5.4"
+        - "Python 0.5.3"
+        - "Python 0.5.2"
+        - "Python 0.5.1"
+        - "Python 0.4.9"
+        - "Python 0.4.8"
         - "Python 0.4.7"
         - "Python 0.4.6"
         - "Python 0.4.5"

.github/workflows/checks.yml

@@ -181,6 +181,44 @@ jobs:
           name: coverage-autogen-ext-grpc
           path: ./python/coverage_autogen-ext-grpc.xml
 
+  test-autogen-ext-pwsh:
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          version: "0.5.18"
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install Python deps
+        run: |
+          uv sync --locked --all-extras
+        shell: pwsh
+        working-directory: ./python
+
+      - name: Run tests for Windows
+        run: |
+          .venv/Scripts/activate.ps1
+          poe --directory ./packages/autogen-ext test-windows
+        shell: pwsh
+        working-directory: ./python
+
+      - name: Move coverage file
+        run: |
+          mv ./packages/autogen-ext/coverage.xml coverage_autogen_ext_windows.xml
+        working-directory: ./python
+
+      - name: Upload coverage artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-autogen-ext-windows
+          path: ./python/coverage_autogen_ext_windows.xml
+
   codecov:
     runs-on: ubuntu-latest
     needs: [test, test-grpc]

.github/workflows/docs.yml

@@ -33,7 +33,7 @@ jobs:
           [
             # For main use the workflow target
             { ref: "${{github.ref}}", dest-dir: dev, uv-version: "0.5.13", sphinx-release-override: "dev" },
-            { ref: "python-v0.4.7", dest-dir: stable, uv-version: "0.5.13", sphinx-release-override: "stable" },
+            { ref: "python-v0.5.6", dest-dir: stable, uv-version: "0.5.13", sphinx-release-override: "stable" },
             { ref: "v0.4.0.post1", dest-dir: "0.4.0", uv-version: "0.5.13", sphinx-release-override: "" },
             { ref: "v0.4.1", dest-dir: "0.4.1", uv-version: "0.5.13", sphinx-release-override: "" },
             { ref: "v0.4.2", dest-dir: "0.4.2", uv-version: "0.5.13", sphinx-release-override: "" },
@@ -42,6 +42,14 @@ jobs:
             { ref: "python-v0.4.5", dest-dir: "0.4.5", uv-version: "0.5.13", sphinx-release-override: "" },
             { ref: "python-v0.4.6", dest-dir: "0.4.6", uv-version: "0.5.13", sphinx-release-override: "" },
             { ref: "python-v0.4.7", dest-dir: "0.4.7", uv-version: "0.5.13", sphinx-release-override: "" },
+            { ref: "python-v0.4.8", dest-dir: "0.4.8", uv-version: "0.5.13", sphinx-release-override: "" },
+            { ref: "python-v0.4.9-website", dest-dir: "0.4.9", uv-version: "0.5.13", sphinx-release-override: "" },
+            { ref: "python-v0.5.1", dest-dir: "0.5.1", uv-version: "0.5.13", sphinx-release-override: "" },
+            { ref: "python-v0.5.2", dest-dir: "0.5.2", uv-version: "0.5.13", sphinx-release-override: "" },
+            { ref: "python-v0.5.3", dest-dir: "0.5.3", uv-version: "0.5.13", sphinx-release-override: "" },
+            { ref: "python-v0.5.4", dest-dir: "0.5.4", uv-version: "0.5.13", sphinx-release-override: "" },
+            { ref: "python-v0.5.5", dest-dir: "0.5.5", uv-version: "0.5.13", sphinx-release-override: "" },
+            { ref: "python-v0.5.6", dest-dir: "0.5.6", uv-version: "0.5.13", sphinx-release-override: "" },
           ]
     steps:
       - name: Checkout
@@ -133,10 +141,11 @@ jobs:
       - name: setup python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.8"
+          python-version: "3.9"
       - name: pydoc-markdown install
         run: |
           python -m pip install --upgrade pip
+          pip install nr_util>=0.8.12
           pip install pydoc-markdown pyyaml termcolor
           # Pin databind packages as version 4.5.0 is not compatible with pydoc-markdown.
           pip install databind.core==4.4.2 databind.json==4.4.2

.gitignore

@@ -198,4 +198,7 @@ notebook/coding
 artifacts
 
 # project data
-registry.json
+registry.json
+
+# files created by the gitty agent in python/samples/gitty
+.gitty/

CONTRIBUTING.md

@@ -34,7 +34,7 @@ For common tasks that are helpful during development and run in CI, see [here](.
 
 ## Roadmap
 
-We use GitHub issues and milestones to track our roadmap. You can view the upcoming milestones [here]([Roadmap Issues](https://aka.ms/autogen-roadmap).
+We use GitHub issues and milestones to track our roadmap. You can view the upcoming milestones [here]([Roadmap Issues](https://aka.ms/autogen-roadmap)).
 
 ## Versioning
 
@@ -48,11 +48,11 @@ We will update verion numbers according to the following rules:
 ## Release process
 
 1. Create a PR that updates the version numbers across the codebase ([example](https://github.com/microsoft/autogen/pull/4359))
-    2. The docs CI will fail for the PR, but this is expected and will be resolved in the next step
-2. After merging the PR, create and push a tag that corresponds to the new verion. For example, for `0.4.0.dev13`:
+2. The docs CI will fail for the PR, but this is expected and will be resolved in the next step
+3. After merging the PR, create and push a tag that corresponds to the new verion. For example, for `0.4.0.dev13`:
     - `git tag v0.4.0.dev13 && git push origin v0.4.0.dev13`
-3. Restart the docs CI by finding the failed [job corresponding to the `push` event](https://github.com/microsoft/autogen/actions/workflows/docs.yml) and restarting all jobs
-4. Run [this](https://github.com/microsoft/autogen/actions/workflows/single-python-package.yml) workflow for each of the packages that need to be released and get an approval for the release for it to run
+4. Restart the docs CI by finding the failed [job corresponding to the `push` event](https://github.com/microsoft/autogen/actions/workflows/docs.yml) and restarting all jobs
+5. Run [this](https://github.com/microsoft/autogen/actions/workflows/single-python-package.yml) workflow for each of the packages that need to be released and get an approval for the release for it to run
 
 ## Triage process
 

README.md

@@ -47,22 +47,24 @@ from autogen_agentchat.agents import AssistantAgent
 from autogen_ext.models.openai import OpenAIChatCompletionClient
 
 async def main() -> None:
-    agent = AssistantAgent("assistant", OpenAIChatCompletionClient(model="gpt-4o"))
+    model_client = OpenAIChatCompletionClient(model="gpt-4o")
+    agent = AssistantAgent("assistant", model_client=model_client)
     print(await agent.run(task="Say 'Hello World!'"))
+    await model_client.close()
 
 asyncio.run(main())
 ```
 
-### Team
+### Web Browsing Agent Team
 
-Create a group chat team with an assistant agent, a web surfer agent, and a user proxy agent
+Create a group chat team with a web surfer agent and a user proxy agent
 for web browsing tasks. You need to install [playwright](https://playwright.dev/python/docs/library).
 
 ```python
 # pip install -U autogen-agentchat autogen-ext[openai,web-surfer]
 # playwright install
 import asyncio
-from autogen_agentchat.agents import AssistantAgent, UserProxyAgent
+from autogen_agentchat.agents import UserProxyAgent
 from autogen_agentchat.conditions import TextMentionTermination
 from autogen_agentchat.teams import RoundRobinGroupChat
 from autogen_agentchat.ui import Console
@@ -71,12 +73,21 @@ from autogen_ext.agents.web_surfer import MultimodalWebSurfer
 
 async def main() -> None:
     model_client = OpenAIChatCompletionClient(model="gpt-4o")
-    assistant = AssistantAgent("assistant", model_client)
-    web_surfer = MultimodalWebSurfer("web_surfer", model_client)
+    # The web surfer will open a Chromium browser window to perform web browsing tasks.
+    web_surfer = MultimodalWebSurfer("web_surfer", model_client, headless=False, animate_actions=True)
+    # The user proxy agent is used to get user input after each step of the web surfer.
+    # NOTE: you can skip input by pressing Enter.
     user_proxy = UserProxyAgent("user_proxy")
-    termination = TextMentionTermination("exit") # Type 'exit' to end the conversation.
-    team = RoundRobinGroupChat([web_surfer, assistant, user_proxy], termination_condition=termination)
-    await Console(team.run_stream(task="Find information about AutoGen and write a short summary."))
+    # The termination condition is set to end the conversation when the user types 'exit'.
+    termination = TextMentionTermination("exit", sources=["user_proxy"])
+    # Web surfer and user proxy take turns in a round-robin fashion.
+    team = RoundRobinGroupChat([web_surfer, user_proxy], termination_condition=termination)
+    try:
+        # Start the team and wait for it to terminate.
+        await Console(team.run_stream(task="Find information about AutoGen and write a short summary."))
+    finally:
+        await web_surfer.close()
+        await model_client.close()
 
 asyncio.run(main())
 ```
@@ -101,7 +112,7 @@ The AutoGen ecosystem provides everything you need to create AI agents, especial
 The _framework_ uses a layered and extensible design. Layers have clearly divided responsibilities and build on top of layers below. This design enables you to use the framework at different levels of abstraction, from high-level APIs to low-level components.
 
 - [Core API](./python/packages/autogen-core/) implements message passing, event-driven agents, and local and distributed runtime for flexibility and power. It also support cross-language support for .NET and Python.
-- [AgentChat API](./python/packages/autogen-agentchat/) implements a simpler but opinionated API rapid for prototyping. This API is built on top of the Core API and is closest to what users of v0.2 are familiar with and supports familiar multi-agent patterns such as two-agent chat or group chats.
+- [AgentChat API](./python/packages/autogen-agentchat/) implements a simpler but opinionated API for rapid prototyping. This API is built on top of the Core API and is closest to what users of v0.2 are familiar with and supports common multi-agent patterns such as two-agent chat or group chats.
 - [Extensions API](./python/packages/autogen-ext/) enables first- and third-party extensions continuously expanding framework capabilities. It support specific implementation of LLM clients (e.g., OpenAI, AzureOpenAI), and capabilities such as code execution.
 
 The ecosystem also supports two essential _developer tools_:
@@ -113,7 +124,7 @@ The ecosystem also supports two essential _developer tools_:
 - [AutoGen Studio](./python/packages/autogen-studio/) provides a no-code GUI for building multi-agent applications.
 - [AutoGen Bench](./python/packages/agbench/) provides a benchmarking suite for evaluating agent performance.
 
-You can use the AutoGen framework and developer tools to create applications for your domain. For example, [Magentic-One](./python/packages/magentic-one-cli/) is a state-of-art multi-agent team built using AgentChat API and Extensions API that can handle variety of tasks that require web browsing, code execution, and file handling.
+You can use the AutoGen framework and developer tools to create applications for your domain. For example, [Magentic-One](./python/packages/magentic-one-cli/) is a state-of-the-art multi-agent team built using AgentChat API and Extensions API that can handle a variety of tasks that require web browsing, code execution, and file handling.
 
 With AutoGen you get to join and contribute to a thriving ecosystem. We host weekly office hours and talks with maintainers and community. We also have a [Discord server](https://aka.ms/autogen-discord) for real-time chat, GitHub Discussions for Q&A, and a blog for tutorials and updates.
 

docs/design/01 - Programming Model.md

@@ -11,7 +11,7 @@ Each event in the system is defined using the [CloudEvents Specification](https:
 1. *id* - A unique id (eg. a UUID).
 2. *source* - A URI or URN indicating the event's origin.
 3. *type* - The namespace of the event - prefixed with a reverse-DNS name.
-   - The prefixed domain dictates the organization which defines the semantics of this event type: e.g `com.github.pull_request.opened` or `com.example.object.deleted.v2`), and optionally fields describing the data schema/content-type or extensions.
+   - The prefixed domain dictates the organization which defines the semantics of this event type: e.g (`com.github.pull_request.opened` or `com.example.object.deleted.v2`), and optionally fields describing the data schema/content-type or extensions.
 
 ## Event Handlers
 

docs/design/02 - Topics.md

@@ -62,7 +62,7 @@ For this subscription source should map directly to agent key.
 
 This subscription will therefore receive all events for the following well known topics:
 
-- `{AgentType}:` - General purpose direct messages. These should be routed to the approriate message handler.
-- `{AgentType}:rpc_request={RequesterAgentType}` - RPC request messages. These should be routed to the approriate RPC handler, and RequesterAgentType used to publish the response
+- `{AgentType}:` - General purpose direct messages. These should be routed to the appropriate message handler.
+- `{AgentType}:rpc_request={RequesterAgentType}` - RPC request messages. These should be routed to the appropriate RPC handler, and RequesterAgentType used to publish the response
 - `{AgentType}:rpc_response={RequestId}` - RPC response messages. These should be routed back to the response future of the caller.
 - `{AgentType}:error={RequestId}` - Error message that corresponds to the given request.

docs/dotnet/core/toc.yml

@@ -7,4 +7,4 @@
 - name: Differences from Python
   href: differences-from-python.md
 - name: Protobuf message types
-  href: protobuf-message-types.md
+  href: protobuf-message-types.md

docs/dotnet/docfx.json

@@ -73,4 +73,4 @@
     "keepFileLink": false,
     "disableGitFeatures": false
   }
-}
+}