Merge pull request #344 from MicrosoftDocs/main639045504619495658sync_temp

Repo sync for protected branch

Author: westey-m

.openpublishing.publish.config.json

@@ -6,7 +6,7 @@
       "build_output_subfolder": "agent-framework",
       "locale": "en-us",
       "monikers": [],
-      "open_to_public_contributors": false,
+      "open_to_public_contributors": true,
       "type_mapping": {
         "Conceptual": "Content"
       },

agent-framework/integrations/ag-ui/backend-tool-rendering.md

@@ -147,7 +147,7 @@ ChatClient chatClient = new AzureOpenAIClient(
         new DefaultAzureCredential())
     .GetChatClient(deploymentName);
 
-ChatClientAgent agent = chatClient.AsIChatClient().CreateAIAgent(
+ChatClientAgent agent = chatClient.AsIChatClient().AsAIAgent(
     name: "AGUIAssistant",
     instructions: "You are a helpful assistant with access to restaurant information.",
     tools: tools);
@@ -186,7 +186,7 @@ To see tool calls and results in real-time, extend the client's streaming loop t
 
 ```csharp
 // Inside the streaming loop from getting-started.md
-await foreach (AgentRunResponseUpdate update in agent.RunStreamingAsync(messages, thread))
+await foreach (AgentResponseUpdate update in agent.RunStreamingAsync(messages, thread))
 {
     ChatResponseUpdate chatUpdate = update.AsChatResponseUpdate();
 

agent-framework/integrations/ag-ui/frontend-tools.md

@@ -57,7 +57,7 @@ static string GetUserLocation()
 AITool[] frontendTools = [AIFunctionFactory.Create(GetUserLocation)];
 
 // Pass tools when creating the agent
-AIAgent agent = chatClient.CreateAIAgent(
+AIAgent agent = chatClient.AsAIAgent(
     name: "agui-client",
     description: "AG-UI Client Agent",
     tools: frontendTools);
@@ -67,7 +67,7 @@ The rest of your client code remains the same as shown in the Getting Started tu
 
 ### How Tools Are Sent to the Server
 
-When you register tools with `CreateAIAgent()`, the `AGUIChatClient` automatically:
+When you register tools with `AsAIAgent()`, the `AGUIChatClient` automatically:
 
 1. Captures the tool definitions (names, descriptions, parameter schemas)
 3. Sends the tools with each request to the server agent which maps them to `ChatAgentRunOptions.ChatOptions.Tools`
@@ -85,7 +85,7 @@ AIAgent inspectableAgent = baseAgent
     .Use(runFunc: null, runStreamingFunc: InspectToolsMiddleware)
     .Build();
 
-static async IAsyncEnumerable<AgentRunResponseUpdate> InspectToolsMiddleware(
+static async IAsyncEnumerable<AgentResponseUpdate> InspectToolsMiddleware(
     IEnumerable<ChatMessage> messages,
     AgentThread? thread,
     AgentRunOptions? options,
@@ -109,7 +109,7 @@ static async IAsyncEnumerable<AgentRunResponseUpdate> InspectToolsMiddleware(
         }
     }
 
-    await foreach (AgentRunResponseUpdate update in innerAgent.RunStreamingAsync(messages, thread, options, cancellationToken))
+    await foreach (AgentResponseUpdate update in innerAgent.RunStreamingAsync(messages, thread, options, cancellationToken))
     {
         yield return update;
     }
@@ -123,7 +123,7 @@ This middleware pattern allows you to:
 
 The following are new concepts for frontend tools:
 
-- **Client-side registration**: Tools are registered on the client using `AIFunctionFactory.Create()` and passed to `CreateAIAgent()`
+- **Client-side registration**: Tools are registered on the client using `AIFunctionFactory.Create()` and passed to `AsAIAgent()`
 - **Automatic capture**: Tools are automatically captured and sent via `ChatAgentRunOptions.ChatOptions.Tools`
 
 ## How Frontend Tools Work

agent-framework/integrations/ag-ui/getting-started.md

@@ -92,7 +92,7 @@ ChatClient chatClient = new AzureOpenAIClient(
         new DefaultAzureCredential())
     .GetChatClient(deploymentName);
 
-AIAgent agent = chatClient.AsIChatClient().CreateAIAgent(
+AIAgent agent = chatClient.AsIChatClient().AsAIAgent(
     name: "AGUIAssistant",
     instructions: "You are a helpful assistant.");
 
@@ -107,7 +107,7 @@ await app.RunAsync();
 - **`AddAGUI`**: Registers AG-UI services with the dependency injection container
 - **`MapAGUI`**: Extension method that registers the AG-UI endpoint with automatic request/response handling and SSE streaming
 - **`ChatClient` and `AsIChatClient()`**: `AzureOpenAIClient.GetChatClient()` returns OpenAI's `ChatClient` type. The `AsIChatClient()` extension method (from `Microsoft.Extensions.AI.OpenAI`) converts it to the `IChatClient` interface required by Agent Framework
-- **`CreateAIAgent`**: Creates an Agent Framework agent from an `IChatClient`
+- **`AsAIAgent`**: Creates an Agent Framework agent from an `IChatClient`
 - **ASP.NET Core Integration**: Uses ASP.NET Core's native async support for streaming responses
 - **Instructions**: The agent is created with default instructions, which can be overridden by client messages
 - **Configuration**: `AzureOpenAIClient` with `DefaultAzureCredential` provides secure authentication
@@ -149,7 +149,7 @@ dotnet add package Microsoft.Agents.AI --prerelease
 ```
 
 > [!NOTE]
-> The `Microsoft.Agents.AI` package provides the `CreateAIAgent()` extension method.
+> The `Microsoft.Agents.AI` package provides the `AsAIAgent()` extension method.
 
 ### Client Code
 
@@ -174,11 +174,11 @@ using HttpClient httpClient = new()
 
 AGUIChatClient chatClient = new(httpClient, serverUrl);
 
-AIAgent agent = chatClient.CreateAIAgent(
+AIAgent agent = chatClient.AsAIAgent(
     name: "agui-client",
     description: "AG-UI Client Agent");
 
-AgentThread thread = agent.GetNewThread();
+AgentThread thread = await agent.GetNewThreadAsync();
 List<ChatMessage> messages =
 [
     new(ChatRole.System, "You are a helpful assistant.")
@@ -209,7 +209,7 @@ try
         bool isFirstUpdate = true;
         string? threadId = null;
 
-        await foreach (AgentRunResponseUpdate update in agent.RunStreamingAsync(messages, thread))
+        await foreach (AgentResponseUpdate update in agent.RunStreamingAsync(messages, thread))
         {
             ChatResponseUpdate chatUpdate = update.AsChatResponseUpdate();
 
@@ -256,8 +256,8 @@ catch (Exception ex)
 
 - **Server-Sent Events (SSE)**: The protocol uses SSE for streaming responses
 - **AGUIChatClient**: Client class that connects to AG-UI servers and implements `IChatClient`
-- **CreateAIAgent**: Extension method on `AGUIChatClient` to create an agent from the client
-- **RunStreamingAsync**: Streams responses as `AgentRunResponseUpdate` objects
+- **AsAIAgent**: Extension method on `AGUIChatClient` to create an agent from the client
+- **RunStreamingAsync**: Streams responses as `AgentResponseUpdate` objects
 - **AsChatResponseUpdate**: Extension method to access chat-specific properties like `ConversationId` and `ResponseId`
 - **Thread Management**: The `AgentThread` maintains conversation context across requests
 - **Content Types**: Responses include `TextContent` for messages and `ErrorContent` for errors
@@ -327,7 +327,7 @@ The client displays different content types with distinct colors:
 
 1. `AGUIChatClient` sends HTTP POST request to server endpoint
 2. Server responds with SSE stream
-3. Client parses incoming events into `AgentRunResponseUpdate` objects
+3. Client parses incoming events into `AgentResponseUpdate` objects
 4. Each update is displayed based on its content type
 5. `ConversationId` is captured for conversation continuity
 6. Stream completes when run finishes

agent-framework/integrations/ag-ui/human-in-the-loop.md

@@ -126,7 +126,7 @@ var agent = baseAgent
             cancellationToken))
     .Build();
 
-static async IAsyncEnumerable<AgentRunResponseUpdate> HandleApprovalRequestsMiddleware(
+static async IAsyncEnumerable<AgentResponseUpdate> HandleApprovalRequestsMiddleware(
     IEnumerable<ChatMessage> messages,
     AgentThread? thread,
     AgentRunOptions? options,
@@ -250,8 +250,8 @@ static async IAsyncEnumerable<AgentRunResponseUpdate> HandleApprovalRequestsMidd
     }
 
     // Local function: Convert FunctionApprovalRequestContent to client tool calls
-    static async IAsyncEnumerable<AgentRunResponseUpdate> ConvertFunctionApprovalsToToolCalls(
-        AgentRunResponseUpdate update,
+    static async IAsyncEnumerable<AgentResponseUpdate> ConvertFunctionApprovalsToToolCalls(
+        AgentResponseUpdate update,
         JsonSerializerOptions jsonSerializerOptions)
     {
         // Check if this update contains a FunctionApprovalRequestContent
@@ -292,7 +292,7 @@ static async IAsyncEnumerable<AgentRunResponseUpdate> HandleApprovalRequestsMidd
         var approvalJson = JsonSerializer.Serialize(approvalData, jsonSerializerOptions.GetTypeInfo(typeof(ApprovalRequest)));
 
         // Yield a tool call update that represents the approval request
-        yield return new AgentRunResponseUpdate(ChatRole.Assistant, [
+        yield return new AgentResponseUpdate(ChatRole.Assistant, [
             new FunctionCallContent(
                 callId: approvalId,
                 name: "request_approval",
@@ -337,7 +337,7 @@ var wrappedAgent = agent
             cancellationToken))
     .Build();
 
-static async IAsyncEnumerable<AgentRunResponseUpdate> HandleApprovalRequestsClientMiddleware(
+static async IAsyncEnumerable<AgentResponseUpdate> HandleApprovalRequestsClientMiddleware(
     IEnumerable<ChatMessage> messages,
     AgentThread? thread,
     AgentRunOptions? options,
@@ -414,8 +414,8 @@ static async IAsyncEnumerable<AgentRunResponseUpdate> HandleApprovalRequestsClie
     }
 
     // Local function: Convert request_approval tool calls to FunctionApprovalRequestContent
-    static async IAsyncEnumerable<AgentRunResponseUpdate> ConvertToolCallsToApprovalRequests(
-        AgentRunResponseUpdate update,
+    static async IAsyncEnumerable<AgentResponseUpdate> ConvertToolCallsToApprovalRequests(
+        AgentResponseUpdate update,
         JsonSerializerOptions jsonSerializerOptions)
     {
         FunctionCallContent? approvalToolCall = null;
@@ -452,7 +452,7 @@ static async IAsyncEnumerable<AgentRunResponseUpdate> HandleApprovalRequestsClie
             arguments: functionArguments);
 
         // Yield the original tool call first (for message history)
-        yield return new AgentRunResponseUpdate(ChatRole.Assistant, [approvalToolCall]);
+        yield return new AgentResponseUpdate(ChatRole.Assistant, [approvalToolCall]);
 
         // Create approval request with CallId stored in AdditionalProperties
         var approvalRequestContent = new FunctionApprovalRequestContent(
@@ -463,7 +463,7 @@ static async IAsyncEnumerable<AgentRunResponseUpdate> HandleApprovalRequestsClie
         approvalRequestContent.AdditionalProperties ??= new Dictionary<string, object?>();
         approvalRequestContent.AdditionalProperties["request_approval_call_id"] = approvalToolCall.CallId;
 
-        yield return new AgentRunResponseUpdate(ChatRole.Assistant, [approvalRequestContent]);
+        yield return new AgentResponseUpdate(ChatRole.Assistant, [approvalRequestContent]);
     }
 }
 #pragma warning restore MEAI001
@@ -490,7 +490,7 @@ do
     approvalResponses.Clear();
     approvalToolCalls.Clear();
 
-    await foreach (AgentRunResponseUpdate update in wrappedAgent.RunStreamingAsync(
+    await foreach (AgentResponseUpdate update in wrappedAgent.RunStreamingAsync(
         messages, thread, cancellationToken: cancellationToken))
     {
         foreach (AIContent content in update.Contents)

agent-framework/integrations/ag-ui/index.md

@@ -114,7 +114,7 @@ Understanding how Agent Framework concepts map to AG-UI helps you build effectiv
 | `AIAgent` | Agent Endpoint | Each agent becomes an HTTP endpoint |
 | `agent.Run()` | HTTP POST Request | Client sends messages via HTTP |
 | `agent.RunStreamingAsync()` | Server-Sent Events | Streaming responses via SSE |
-| `AgentRunResponseUpdate` | AG-UI Events | Converted to protocol events automatically |
+| `AgentResponseUpdate` | AG-UI Events | Converted to protocol events automatically |
 | `AIFunctionFactory.Create()` | Backend Tools | Executed on server, results streamed |
 | `ApprovalRequiredAIFunction` | Human-in-the-Loop | Middleware converts to approval protocol |
 | `AgentThread` | Thread Management | `ConversationId` maintains context |
@@ -251,7 +251,7 @@ To get started with AG-UI integration:
 
 - [Agent Framework Documentation](../../overview/agent-framework-overview.md)
 - [AG-UI Protocol Documentation](https://docs.ag-ui.com/introduction)
-- [AG-UI Dojo App](https://github.com/ag-oss/ag-ui/tree/main/apps/dojo) - Example application demonstrating Agent Framework integration
+- [AG-UI Dojo App](https://dojo.ag-ui.com/) - Example application demonstrating Agent Framework integration
 - [Agent Framework GitHub Repository](https://github.com/microsoft/agent-framework)
 
 ::: zone-end

agent-framework/integrations/ag-ui/state-management.md

@@ -113,17 +113,17 @@ internal sealed class SharedStateAgent : DelegatingAIAgent
         this._jsonSerializerOptions = jsonSerializerOptions;
     }
 
-    public override Task<AgentRunResponse> RunAsync(
+    public override Task<AgentResponse> RunAsync(
         IEnumerable<ChatMessage> messages,
         AgentThread? thread = null,
         AgentRunOptions? options = null,
         CancellationToken cancellationToken = default)
     {
         return this.RunStreamingAsync(messages, thread, options, cancellationToken)
-            .ToAgentRunResponseAsync(cancellationToken);
+            .ToAgentResponseAsync(cancellationToken);
     }
 
-    public override async IAsyncEnumerable<AgentRunResponseUpdate> RunStreamingAsync(
+    public override async IAsyncEnumerable<AgentResponseUpdate> RunStreamingAsync(
         IEnumerable<ChatMessage> messages,
         AgentThread? thread = null,
         AgentRunOptions? options = null,
@@ -187,7 +187,7 @@ internal sealed class SharedStateAgent : DelegatingAIAgent
         var firstRunMessages = messages.Append(stateUpdateMessage);
 
         // Collect all updates from first run
-        var allUpdates = new List<AgentRunResponseUpdate>();
+        var allUpdates = new List<AgentResponseUpdate>();
         await foreach (var update in this.InnerAgent.RunStreamingAsync(firstRunMessages, thread, firstRunOptions, cancellationToken).ConfigureAwait(false))
         {
             allUpdates.Add(update);
@@ -200,7 +200,7 @@ internal sealed class SharedStateAgent : DelegatingAIAgent
             }
         }
 
-        var response = allUpdates.ToAgentRunResponse();
+        var response = allUpdates.ToAgentResponse();
 
         // Try to deserialize the structured state response
         if (response.TryDeserialize(this._jsonSerializerOptions, out JsonElement stateSnapshot))
@@ -209,7 +209,7 @@ internal sealed class SharedStateAgent : DelegatingAIAgent
             byte[] stateBytes = JsonSerializer.SerializeToUtf8Bytes(
                 stateSnapshot,
                 this._jsonSerializerOptions.GetTypeInfo(typeof(JsonElement)));
-            yield return new AgentRunResponseUpdate
+            yield return new AgentResponseUpdate
             {
                 Contents = [new DataContent(stateBytes, "application/json")]
             };
@@ -255,7 +255,7 @@ AIAgent CreateRecipeAgent(JsonSerializerOptions jsonSerializerOptions)
     var chatClient = azureClient.GetChatClient(deploymentName);
 
     // Create base agent
-    AIAgent baseAgent = chatClient.AsIChatClient().CreateAIAgent(
+    AIAgent baseAgent = chatClient.AsIChatClient().AsAIAgent(
         name: "RecipeAgent",
         instructions: """
             You are a helpful recipe assistant. When users ask you to create or suggest a recipe,

agent-framework/integrations/ag-ui/testing-with-dojo.md

@@ -11,7 +11,7 @@ ms.service: agent-framework
 
 # Testing with AG-UI Dojo
 
-The [AG-UI Dojo application](https://github.com/ag-oss/ag-ui/tree/main/apps/dojo) provides an interactive environment to test and explore Microsoft Agent Framework agents that implement the AG-UI protocol. Dojo offers a visual interface to connect to your agents and interact with all 7 AG-UI features.
+The [AG-UI Dojo application](https://dojo.ag-ui.com/) provides an interactive environment to test and explore Microsoft Agent Framework agents that implement the AG-UI protocol. Dojo offers a visual interface to connect to your agents and interact with all 7 AG-UI features.
 
 :::zone pivot="programming-language-python"
 
@@ -226,18 +226,18 @@ If you see authentication errors:
 
 ## Next Steps
 
-- Explore the [example agents](https://github.com/ag-oss/ag-ui/tree/main/integrations/microsoft-agent-framework/python/examples/agents) to see implementation patterns
+- Explore the [example agents](https://github.com/ag-ui-protocol/ag-ui/tree/main/integrations/microsoft-agent-framework/python/examples/agents) to see implementation patterns
 - Learn about [Backend Tool Rendering](backend-tool-rendering.md) to customize tool UIs
 <!-- - Implement [Human-in-the-Loop](human-in-the-loop.md) workflows for approval flows -->
 <!-- - Add [State Management](state-management.md) for complex interactive experiences -->
 
 ## Additional Resources
 
 - [AG-UI Documentation](https://docs.ag-ui.com/introduction)
-- [AG-UI GitHub Repository](https://github.com/ag-oss/ag-ui)
-- [Dojo Application](https://github.com/ag-oss/ag-ui/tree/main/apps/dojo)
+- [AG-UI GitHub Repository](https://github.com/ag-ui-protocol/ag-ui)
+- [Dojo Application](https://dojo.ag-ui.com/)
 
-- [Microsoft Agent Framework Integration Examples](https://github.com/ag-oss/ag-ui/tree/main/integrations/microsoft-agent-framework)
+- [Microsoft Agent Framework Integration Examples](https://github.com/ag-ui-protocol/ag-ui/tree/main/integrations/microsoft-agent-framework)
 
 :::zone-end