Merge pull request #958 from MicrosoftDocs/foundry-updates-0004

Fix pre-existing C# code inaccuracies in workflows and integrations docs

Author: rogerbarreto

agent-framework/agents/providers/custom.md

@@ -68,11 +68,11 @@ Agents can therefore attach any additional state or behaviors needed to the sess
 Two methods are required to be implemented:
 
 ```csharp
-    public override Task<AgentSession> CreateSessionAsync(CancellationToken cancellationToken = default) 
-        => Task.FromResult<AgentSession>(new CustomAgentSession());
+    protected override ValueTask<AgentSession> CreateSessionCoreAsync(CancellationToken cancellationToken = default) 
+        => new(new CustomAgentSession());
 
-    public override Task<AgentSession> DeserializeSessionAsync(JsonElement serializedSession, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
-        => Task.FromResult<AgentSession>(new CustomAgentSession(serializedSession, jsonSerializerOptions));
+    protected override ValueTask<AgentSession> DeserializeSessionCoreAsync(JsonElement serializedState, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
+        => new(new CustomAgentSession(serializedState, jsonSerializerOptions));
 ```
 
 ### Core agent logic
@@ -109,7 +109,7 @@ Messages can be retrieved and passed to the `ChatHistoryProvider` on the session
 If you don't do this, the user won't be able to have a multi-turn conversation with the agent and each run will be a fresh interaction.
 
 ```csharp
-    public override async Task<AgentResponse> RunAsync(IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default)
+    protected override async Task<AgentResponse> RunCoreAsync(IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default)
     {
         session ??= await this.CreateSessionAsync(cancellationToken);
 
@@ -134,7 +134,7 @@ If you don't do this, the user won't be able to have a multi-turn conversation w
         };
     }
 
-    public override async IAsyncEnumerable<AgentResponseUpdate> RunStreamingAsync(IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    protected override async IAsyncEnumerable<AgentResponseUpdate> RunCoreStreamingAsync(IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
     {
         session ??= await this.CreateSessionAsync(cancellationToken);
 

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

@@ -113,7 +113,7 @@ internal sealed class SharedStateAgent : DelegatingAIAgent
         this._jsonSerializerOptions = jsonSerializerOptions;
     }
 
-    public override Task<AgentResponse> RunAsync(
+    protected override Task<AgentResponse> RunCoreAsync(
         IEnumerable<ChatMessage> messages,
         AgentSession? session = null,
         AgentRunOptions? options = null,
@@ -123,7 +123,7 @@ internal sealed class SharedStateAgent : DelegatingAIAgent
             .ToAgentResponseAsync(cancellationToken);
     }
 
-    public override async IAsyncEnumerable<AgentResponseUpdate> RunStreamingAsync(
+    protected override async IAsyncEnumerable<AgentResponseUpdate> RunCoreStreamingAsync(
         IEnumerable<ChatMessage> messages,
         AgentSession? session = null,
         AgentRunOptions? options = null,
@@ -203,22 +203,25 @@ internal sealed class SharedStateAgent : DelegatingAIAgent
         var response = allUpdates.ToAgentResponse();
 
         // Try to deserialize the structured state response
-        if (response.TryDeserialize(this._jsonSerializerOptions, out JsonElement stateSnapshot))
+        JsonElement stateSnapshot;
+        try
         {
-            // Serialize and emit as STATE_SNAPSHOT via DataContent
-            byte[] stateBytes = JsonSerializer.SerializeToUtf8Bytes(
-                stateSnapshot,
-                this._jsonSerializerOptions.GetTypeInfo(typeof(JsonElement)));
-            yield return new AgentResponseUpdate
-            {
-                Contents = [new DataContent(stateBytes, "application/json")]
-            };
+            stateSnapshot = JsonSerializer.Deserialize<JsonElement>(response.Text, this._jsonSerializerOptions);
         }
-        else
+        catch (JsonException)
         {
             yield break;
         }
 
+        // Serialize and emit as STATE_SNAPSHOT via DataContent
+        byte[] stateBytes = JsonSerializer.SerializeToUtf8Bytes(
+            stateSnapshot,
+            this._jsonSerializerOptions.GetTypeInfo(typeof(JsonElement)));
+        yield return new AgentResponseUpdate
+        {
+            Contents = [new DataContent(stateBytes, "application/json")]
+        };
+
         // Second run: Generate user-friendly summary
         var secondRunMessages = messages.Concat(response.Messages).Append(
             new ChatMessage(

agent-framework/workflows/edges.md

@@ -68,7 +68,7 @@ Collect messages from multiple sources into a single target:
 ::: zone pivot="programming-language-csharp"
 
 ```csharp
-builder.AddFanInBarrierEdge(sources: [worker1, worker2, worker3], target: aggregatorExecutor);
+builder.AddFanInBarrierEdge(sources: [ worker1, worker2, worker3 ], target: aggregatorExecutor);
 ```
 
 ::: zone-end
@@ -210,10 +210,11 @@ using Microsoft.Extensions.AI;
 /// </summary>
 /// <returns>A ChatClientAgent configured for spam detection</returns>
 private static ChatClientAgent GetSpamDetectionAgent(IChatClient chatClient) =>
-    new(chatClient, new ChatClientAgentOptions(instructions: "You are a spam detection assistant that identifies spam emails.")
+    new(chatClient, new ChatClientAgentOptions
     {
         ChatOptions = new()
         {
+            Instructions = "You are a spam detection assistant that identifies spam emails.",
             ResponseFormat = ChatResponseFormat.ForJsonSchema(AIJsonUtilities.CreateJsonSchema(typeof(DetectionResult)))
         }
     });
@@ -223,10 +224,11 @@ private static ChatClientAgent GetSpamDetectionAgent(IChatClient chatClient) =>
 /// </summary>
 /// <returns>A ChatClientAgent configured for email assistance</returns>
 private static ChatClientAgent GetEmailAssistantAgent(IChatClient chatClient) =>
-    new(chatClient, new ChatClientAgentOptions(instructions: "You are an email assistant that helps users draft professional responses to emails.")
+    new(chatClient, new ChatClientAgentOptions
     {
         ChatOptions = new()
         {
+            Instructions = "You are an email assistant that helps users draft professional responses to emails.",
             ResponseFormat = ChatResponseFormat.ForJsonSchema(AIJsonUtilities.CreateJsonSchema(typeof(EmailResponse)))
         }
     });
@@ -378,7 +380,7 @@ public static class Program
 
         // Execute the workflow with sample spam email
         string emailContent = "Congratulations! You've won $1,000,000! Click here to claim your prize now!";
-        StreamingRun run = await InProcessExecution.StreamAsync(workflow, new ChatMessage(ChatRole.User, emailContent));
+        StreamingRun run = await InProcessExecution.RunStreamingAsync(workflow, new ChatMessage(ChatRole.User, emailContent));
         await run.TrySendMessageAsync(new TurnToken(emitEvents: true));
 
         await foreach (WorkflowEvent evt in run.WatchStreamAsync().ConfigureAwait(false))
@@ -815,10 +817,11 @@ Update the spam detection agent to be less confident and return three-way classi
 /// </summary>
 /// <returns>A ChatClientAgent configured for three-way spam detection</returns>
 private static ChatClientAgent GetSpamDetectionAgent(IChatClient chatClient) =>
-    new(chatClient, new ChatClientAgentOptions(instructions: "You are a spam detection assistant that identifies spam emails. Be less confident in your assessments.")
+    new(chatClient, new ChatClientAgentOptions
     {
         ChatOptions = new()
         {
+            Instructions = "You are a spam detection assistant that identifies spam emails. Be less confident in your assessments.",
             ResponseFormat = ChatResponseFormat.ForJsonSchema<DetectionResult>()
         }
     });
@@ -828,10 +831,11 @@ private static ChatClientAgent GetSpamDetectionAgent(IChatClient chatClient) =>
 /// </summary>
 /// <returns>A ChatClientAgent configured for email assistance</returns>
 private static ChatClientAgent GetEmailAssistantAgent(IChatClient chatClient) =>
-    new(chatClient, new ChatClientAgentOptions(instructions: "You are an email assistant that helps users draft responses to emails with professionalism.")
+    new(chatClient, new ChatClientAgentOptions
     {
         ChatOptions = new()
         {
+            Instructions = "You are an email assistant that helps users draft responses to emails with professionalism.",
             ResponseFormat = ChatResponseFormat.ForJsonSchema<EmailResponse>()
         }
     });
@@ -1015,7 +1019,7 @@ public static class Program
         string email = Resources.Read("ambiguous_email.txt");
 
         // Execute the workflow
-        StreamingRun run = await InProcessExecution.StreamAsync(workflow, new ChatMessage(ChatRole.User, email));
+        StreamingRun run = await InProcessExecution.RunStreamingAsync(workflow, new ChatMessage(ChatRole.User, email));
         await run.TrySendMessageAsync(new TurnToken(emitEvents: true));
         await foreach (WorkflowEvent evt in run.WatchStreamAsync().ConfigureAwait(false))
         {
@@ -1677,10 +1681,11 @@ Create agents for analysis, assistance, and summarization:
 /// </summary>
 /// <returns>A ChatClientAgent configured for comprehensive email analysis</returns>
 private static ChatClientAgent GetEmailAnalysisAgent(IChatClient chatClient) =>
-    new(chatClient, new ChatClientAgentOptions(instructions: "You are a spam detection assistant that identifies spam emails.")
+    new(chatClient, new ChatClientAgentOptions
     {
         ChatOptions = new()
         {
+            Instructions = "You are a spam detection assistant that identifies spam emails.",
             ResponseFormat = ChatResponseFormat.ForJsonSchema<AnalysisResult>()
         }
     });
@@ -1690,10 +1695,11 @@ private static ChatClientAgent GetEmailAnalysisAgent(IChatClient chatClient) =>
 /// </summary>
 /// <returns>A ChatClientAgent configured for email assistance</returns>
 private static ChatClientAgent GetEmailAssistantAgent(IChatClient chatClient) =>
-    new(chatClient, new ChatClientAgentOptions(instructions: "You are an email assistant that helps users draft responses to emails with professionalism.")
+    new(chatClient, new ChatClientAgentOptions
     {
         ChatOptions = new()
         {
+            Instructions = "You are an email assistant that helps users draft responses to emails with professionalism.",
             ResponseFormat = ChatResponseFormat.ForJsonSchema<EmailResponse>()
         }
     });
@@ -1703,10 +1709,11 @@ private static ChatClientAgent GetEmailAssistantAgent(IChatClient chatClient) =>
 /// </summary>
 /// <returns>A ChatClientAgent configured for email summarization</returns>
 private static ChatClientAgent GetEmailSummaryAgent(IChatClient chatClient) =>
-    new(chatClient, new ChatClientAgentOptions(instructions: "You are an assistant that helps users summarize emails.")
+    new(chatClient, new ChatClientAgentOptions
     {
         ChatOptions = new()
         {
+            Instructions = "You are an assistant that helps users summarize emails.",
             ResponseFormat = ChatResponseFormat.ForJsonSchema<EmailSummary>()
         }
     });
@@ -1773,7 +1780,7 @@ public static class Program
         string email = Resources.Read("email.txt");
 
         // Execute the workflow with custom event handling
-        StreamingRun run = await InProcessExecution.StreamAsync(workflow, new ChatMessage(ChatRole.User, email));
+        StreamingRun run = await InProcessExecution.RunStreamingAsync(workflow, new ChatMessage(ChatRole.User, email));
         await run.TrySendMessageAsync(new TurnToken(emitEvents: true));
         await foreach (WorkflowEvent evt in run.WatchStreamAsync().ConfigureAwait(false))
         {

agent-framework/workflows/orchestrations/concurrent.md

@@ -121,7 +121,7 @@ await foreach (WorkflowEvent evt in run.WatchStreamAsync())
 Console.WriteLine("===== Final Aggregated Results =====");
 foreach (var message in result)
 {
-    Console.WriteLine($"{message.Role}: {message.Content}");
+    Console.WriteLine($"{message.Role}: {message.Text}");
 }
 ```
 

agent-framework/workflows/orchestrations/sequential.md

@@ -135,7 +135,7 @@ await foreach (WorkflowEvent evt in run.WatchStreamAsync())
 Console.WriteLine();
 foreach (var message in result)
 {
-    Console.WriteLine($"{message.Role}: {message.Content}");
+    Console.WriteLine($"{message.Role}: {message.Text}");
 }
 ```