Merge branch 'main' into rysweet-python-xlang

.azure/pipelines/build.yaml

@@ -3,16 +3,15 @@ trigger:
     include:
     - main
   paths:
-    exclude:
-    - samples
+    include:
+    - dotnet
 
 schedules:
 - cron: "0 0 * * *"
   displayName: 'Daily midnight build (including CodeQL)'
   branches:
     include:
     - main
-    - 3.x
   always: true
 
 parameters:
@@ -46,6 +45,10 @@ parameters:
   - name: publish_nightly
     displayName: Publish to autogen-nightly
     type: boolean
+    default: true
+  - name: publish_artifacts
+    displayName: Publish artifacts
+    type: boolean
     default: false
   - name: runCodeQL3000
     default: false
@@ -87,4 +90,5 @@ extends:
           skip_test: ${{ parameters.skip_test }}
           publish_nightly: ${{ parameters.publish_nightly }}
           publish_nuget: ${{ parameters.publish_nuget }}
-          runCodeQL3000: ${{ parameters.runCodeQL3000 }}
+          runCodeQL3000: ${{ parameters.runCodeQL3000 }}
+          publish_artifacts: ${{ parameters.publish_artifacts }}

.azure/pipelines/templates/build.yaml

@@ -30,6 +30,10 @@ parameters:
     displayName: Publish to nuget.org
     type: boolean
     default: false
+  - name: publish_artifacts
+    displayName: Publish artifacts
+    type: boolean
+    default: false
   - name: runCodeQL3000
     default: false
     displayName: Run CodeQL3000 tasks
@@ -49,9 +53,11 @@ jobs:
   ${{ if ne(variables['System.TeamProject'], 'GitHub - PR Builds') }}:
     templateContext:
       outputs:
-      - output: pipelineArtifact
-        targetPath: '$(build.sourcesdirectory)/dotnet/artifacts'
-        artifactName: artifacts folder
+      # Publish artifacts if enabled
+      - ${{ if eq(parameters.publish_artifacts, true) }}: # TODO add eq(parameters.codesign, true)
+        - output: pipelineArtifact
+          targetPath: '$(build.sourcesdirectory)/dotnet/artifacts'
+          artifactName: artifacts folder
       # Publish packages to nightly
       - ${{ if eq(parameters.publish_nightly, true) }}: # TODO add eq(parameters.codesign, true)
         - output: nuget

.github/workflows/checks.yml

@@ -153,6 +153,27 @@ jobs:
           poe --directory ${{ matrix.package }} docs-check
         working-directory: ./python
 
+  docs-example-check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        package: ["./packages/autogen-core"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - run: uv sync --locked --all-extras
+        working-directory: ./python
+      - name: Run task
+        run: |
+          source ${{ github.workspace }}/python/.venv/bin/activate
+          poe --directory ${{ matrix.package }} docs-check-examples
+        working-directory: ./python
+
   check-proto-changes-python:
     runs-on: ubuntu-latest
     steps:

.github/workflows/docs.yml

@@ -39,6 +39,7 @@ jobs:
             { ref: "v0.4.0.dev4", dest-dir: "0.4.0.dev4" },
             { ref: "v0.4.0.dev5", dest-dir: "0.4.0.dev5" },
             { ref: "v0.4.0.dev6", dest-dir: "0.4.0.dev6" },
+            { ref: "v0.4.0.dev7", dest-dir: "0.4.0.dev7" },
           ]
     steps:
       - name: Checkout

README.md

@@ -10,7 +10,7 @@
 # AutoGen
 
 > [!IMPORTANT]
->
+> - (11/14/24) ⚠️ In response to a number of asks to clarify and distinguish between official AutoGen and its forks that created confusion, we issued a [clarification statement](https://github.com/microsoft/autogen/discussions/4217).
 > - (10/13/24) Interested in the standard AutoGen as a prior user? Find it at the actively-maintained *AutoGen* [0.2 branch](https://github.com/microsoft/autogen/tree/0.2) and `autogen-agentchat~=0.2` PyPi package.
 > - (10/02/24) [AutoGen 0.4](https://microsoft.github.io/autogen/dev) is a from-the-ground-up rewrite of AutoGen. Learn more about the history, goals and future at [this blog post](https://microsoft.github.io/autogen/blog). We’re excited to work with the community to gather feedback, refine, and improve the project before we officially release 0.4. This is a big change, so AutoGen 0.2 is still available, maintained, and developed in the [0.2 branch](https://github.com/microsoft/autogen/tree/0.2).
 
@@ -101,7 +101,7 @@ We look forward to your contributions!
 First install the packages:
 
 ```bash
-pip install 'autogen-agentchat==0.4.0.dev6' 'autogen-ext[openai]==0.4.0.dev6'
+pip install 'autogen-agentchat==0.4.0.dev7' 'autogen-ext[openai]==0.4.0.dev7'
 ```
 
 The following code uses OpenAI's GPT-4o model and you need to provide your

docs/design/01 - Programming Model.md

@@ -6,23 +6,27 @@ The programming model is basically publish-subscribe. Agents subscribe to events
 
 ## Events Delivered as CloudEvents
 
-Each event in the system is defined using the [CloudEvents Specification](https://cloudevents.io/). This allows for a common event format that can be used across different systems and languages.  In CloudEvents, each event has a Context Attributes that must unique *id* (eg a UUID) a *source* (a unique urn or path), a *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.
+Each event in the system is defined using the [CloudEvents Specification](https://cloudevents.io/). This allows for a common event format that can be used across different systems and languages. In CloudEvents, each event has "Context Attributes" that must include:
+
+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.
 
 ## Event Handlers
 
-Each agent has a set of event handlers, that are bound to a specific match against a CloudEvents *type*. Event Handlers could match against an exact type or match for a pattern of events of a particular level in the type heirarchy (eg: *com.Microsoft.AutoGen.Agents.System.\** for all Events in the *System* namespace) Each event handler is a function that can change state, call models, access memory, call external tools, emit other events, and flow data to/from other systems. Each event handler can be a simple function or a more complex function that uses a state machine or other control logic.
+Each agent has a set of event handlers, that are bound to a specific match against a CloudEvents *type*. Event Handlers could match against an exact type or match for a pattern of events of a particular level in the type heirarchy (eg: `com.Microsoft.AutoGen.Agents.System.*` for all Events in the `System` namespace) Each event handler is a function that can change state, call models, access memory, call external tools, emit other events, and flow data to/from other systems. Each event handler can be a simple function or a more complex function that uses a state machine or other control logic.
 
 ## Orchestrating Agents
 
-If is possible to build a functional and scalable agent system that only reacts to external events. In many cases, however, you will want to orchestrate the agents to achieve a specific goal or follow a pre-determined workflow. In this case, you will need to build an orchestrator agent that manages the flow of events between agents.
+It is possible to build a functional and scalable agent system that only reacts to external events. In many cases, however, you will want to orchestrate the agents to achieve a specific goal or follow a pre-determined workflow. In this case, you will need to build an orchestrator agent that manages the flow of events between agents.
 
 ## Built-in Event Types
 
 The AutoGen system comes with a set of built-in event types that are used to manage the system. These include:
 
-* System Events - Events that are used to manage the system itself. These include events for starting and stopping the Agents, sending messages to all agents, and other system-level events.
-* ? insert other types here ?
+- *System Events* - Events that are used to manage the system itself. These include events for starting and stopping the Agents, sending messages to all agents, and other system-level events.
+- *Insert other types here*
 
 ## Agent Contracts
 

docs/design/02 - Topics.md

@@ -17,16 +17,16 @@ This document does not specify RPC/direct messaging
 A topic is identified by two components (called a `TopicId`):
 
 - [`type`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#type) - represents the type of event that occurs, this is static and defined in code
-    - SHOULD use reverse domain name notation to avoid naming conflicts. For example: `com.example.my-topic`.
+  - SHOULD use reverse domain name notation to avoid naming conflicts. For example: `com.example.my-topic`.
 - [`source`](https://github.com/cloudevents/spec/blob/v1.0.2/cloudevents/spec.md#source-1) - represents where the event originated from, this is dynamic and based on the message itself
-    - SHOULD be a URI
+  - SHOULD be a URI
 
 Agent instances are identified by two components (called an `AgentId`):
 
 - `type` - represents the type of agent, this is static and defined in code
-    - MUST be a valid identifier as defined [here](https://docs.python.org/3/reference/lexical_analysis.html#identifiers) except that only the ASCII range is allowed
+  - MUST be a valid identifier as defined [here](https://docs.python.org/3/reference/lexical_analysis.html#identifiers) except that only the ASCII range is allowed
 - `key` - represents the instance of the agent type for the key
-    - SHOULD be a URI
+  - SHOULD be a URI
 
 For example: `GraphicDesigner:1234`
 

docs/design/03 - Agent Worker Protocol.md

@@ -22,7 +22,7 @@ Agents are never explicitly created or destroyed. When a request is received for
 
 ## Worker protocol flow
 
-The worker protocol has three phases, following the lifetime of the worker: initiation, operation, and termination.
+The worker protocol has three phases, following the lifetime of the worker: initialization, operation, and termination.
 
 ### Initialization
 

docs/design/04 - Agent and Topic ID Specs.md

@@ -8,40 +8,40 @@ This document describes the structure, constraints, and behavior of Agent IDs an
 
 #### type
 
-* Type: `string`
-* Description: The agent type is not an agent class. It associates an agent with a specific factory function, which produces instances of agents of the same agent `type`. For example, different factory functions can produce the same agent class but with different constructor perameters.
-* Constraints: UTF8 and only contain alphanumeric letters (a-z) and (0-9), or underscores (_). A valid identifier cannot start with a number, or contain any spaces.
-* Examples:
-    * `code_reviewer`
-    * `WebSurfer`
-    * `UserProxy`
+- Type: `string`
+- Description: The agent type is not an agent class. It associates an agent with a specific factory function, which produces instances of agents of the same agent `type`. For example, different factory functions can produce the same agent class but with different constructor perameters.
+- Constraints: UTF8 and only contain alphanumeric letters (a-z) and (0-9), or underscores (\_). A valid identifier cannot start with a number, or contain any spaces.
+- Examples:
+  - `code_reviewer`
+  - `WebSurfer`
+  - `UserProxy`
 
 #### key
 
-* Type: `string`
-* Description: The agent key is an instance identifier for the given agent `type`
-* Constraints: UTF8 and only contain characters between (inclusive) ascii 32 (space) and 126 (~).
-* Examples:
-    * `default`
-    * A memory address
-    * a UUID string
+- Type: `string`
+- Description: The agent key is an instance identifier for the given agent `type`
+- Constraints: UTF8 and only contain characters between (inclusive) ascii 32 (space) and 126 (~).
+- Examples:
+  - `default`
+  - A memory address
+  - a UUID string
 
 ## Topic ID
 
 ### Required Attributes
 
 #### type
 
-* Type: `string`
-* Description: topic type is usually defined by application code to mark the type of messages the topic is for.
-* Constraints: UTF8 and only contain alphanumeric letters (a-z) and (0-9), or underscores (_). A valid identifier cannot start with a number, or contain any spaces.
-* Examples:
-    * `GitHub_Issues`
+- Type: `string`
+- Description: Topic type is usually defined by application code to mark the type of messages the topic is for.
+- Constraints: UTF8 and only contain alphanumeric letters (a-z) and (0-9), or underscores (\_). A valid identifier cannot start with a number, or contain any spaces.
+- Examples:
+  - `GitHub_Issues`
 
 #### source
 
-* Type: `string`
-* Description: Topic source is the unique identifier for a topic within a topic type. It is typically defined by application data.
-* Constraints: UTF8 and only contain characters between (inclusive) ascii 32 (space) and 126 (~).
-* Examples:
-    * `github.com/{repo_name}/issues/{issue_number}`
+- Type: `string`
+- Description: Topic source is the unique identifier for a topic within a topic type. It is typically defined by application data.
+- Constraints: UTF8 and only contain characters between (inclusive) ascii 32 (space) and 126 (~).
+- Examples:
+  - `github.com/{repo_name}/issues/{issue_number}`

docs/switcher.json

@@ -41,7 +41,12 @@
     {
         "name": "0.4.0.dev6",
         "version": "0.4.0.dev6",
-        "url": "/autogen/0.4.0.dev6/",
+        "url": "/autogen/0.4.0.dev6/"
+    },
+    {
+        "name": "0.4.0.dev7",
+        "version": "0.4.0.dev7",
+        "url": "/autogen/0.4.0.dev7/",
         "preferred": true
     }
 ]

dotnet/.gitignore

@@ -82,6 +82,7 @@ BenchmarkDotNet.Artifacts/
 project.lock.json
 project.fragment.lock.json
 artifacts/
+appsettings.Development.json
 
 # Tye
 .tye/

dotnet/AutoGen.v3.ncrunchsolution

@@ -0,0 +1,8 @@
+<SolutionConfiguration>
+  <Settings>
+    <AllowParallelTestExecution>True</AllowParallelTestExecution>
+    <EnableRDI>True</EnableRDI>
+    <RdiConfigured>True</RdiConfigured>
+    <SolutionConfigured>True</SolutionConfigured>
+  </Settings>
+</SolutionConfiguration>