agent/agent-framework
2
0
Fork 0
mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

.NET Samples - Create 03-workflows learning path step (#4102)

Browse Source
This commit is contained in:
Chris
2026-02-19 13:45:25 -08:00
committed by GitHub
Unverified
parent 160cc635c1
commit eeb8644f3c
128 changed files with 444 additions and 252 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dotnet/samples/03-workflows/Declarative/ExecuteCode/ExecuteCode.csproj
+33
View File
@@ -0,0 +1,33 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFrameworks>net10.0</TargetFrameworks>
<Nullable>enable</Nullable>
<ImplicitUsings>enable</ImplicitUsings>
<UserSecretsId>5ee045b0-aea3-4f08-8d31-32d1a6f8fed0</UserSecretsId>
<NoWarn>$(NoWarn);CA1812</NoWarn>
</PropertyGroup>
<PropertyGroup>
<InjectIsExternalInitOnLegacy>true</InjectIsExternalInitOnLegacy>
<InjectSharedWorkflowsExecution>true</InjectSharedWorkflowsExecution>
<InjectSharedWorkflowsSettings>true</InjectSharedWorkflowsSettings>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Configuration" />
<PackageReference Include="Microsoft.Extensions.Configuration.Binder" />
<PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" />
<PackageReference Include="Microsoft.Extensions.Configuration.Json" />
<PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" />
<PackageReference Include="Microsoft.Extensions.DependencyInjection" />
<PackageReference Include="Microsoft.Extensions.Logging" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Workflows.Declarative\Microsoft.Agents.AI.Workflows.Declarative.csproj" />
<ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.Workflows.Declarative.AzureAI\Microsoft.Agents.AI.Workflows.Declarative.AzureAI.csproj" />
</ItemGroup>
</Project>
dotnet/samples/03-workflows/Declarative/ExecuteCode/Generated.cs
+267
View File
@@ -0,0 +1,267 @@
// ------------------------------------------------------------------------------
// <auto-generated>
// This code was generated by a tool.
// </auto-generated>
// ------------------------------------------------------------------------------
#nullable enable
#pragma warning disable IDE0005 // Extra using directive is ok.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Microsoft.Agents.AI;
using Microsoft.Agents.AI.Workflows;
using Microsoft.Agents.AI.Workflows.Declarative;
using Microsoft.Agents.AI.Workflows.Declarative.Kit;
using Microsoft.Extensions.AI;
namespace Demo.DeclarativeCode;
/// <summary>
/// This class provides a factory method to create a <see cref="Workflow" /> instance.
/// </summary>
/// <remarks>
/// The workflow defined here was generated from a declarative workflow definition.
/// Declarative workflows utilize Power FX for defining conditions and expressions.
/// To learn more about Power FX, see:
/// https://learn.microsoft.com/power-platform/power-fx/formula-reference-copilot-studio
/// </remarks>
public static class SampleWorkflowProvider
{
/// <summary>
/// The root executor for a declarative workflow.
/// </summary>
internal sealed class WorkflowDemoRootExecutor<TInput>(
DeclarativeWorkflowOptions options,
Func<TInput, ChatMessage> inputTransform) :
RootExecutor<TInput>("workflow_demo_Root", options, inputTransform)
where TInput : notnull
{
protected override async ValueTask ExecuteAsync(TInput message, IWorkflowContext context, CancellationToken cancellationToken)
{
}
}
/// <summary>
/// Invokes an agent to process messages and return a response within a conversation context.
/// </summary>
internal sealed class QuestionStudentExecutor(FormulaSession session, ResponseAgentProvider agentProvider) : AgentExecutor(id: "question_student", session, agentProvider)
{
// <inheritdoc />
protected override async ValueTask<object?> ExecuteAsync(IWorkflowContext context, CancellationToken cancellationToken)
{
string? agentName = "StudentAgent";
if (string.IsNullOrWhiteSpace(agentName))
{
throw new DeclarativeActionException($"Agent name must be defined: {this.Id}");
}
string? conversationId = await context.ReadStateAsync<string>(key: "ConversationId", scopeName: "System").ConfigureAwait(false);
bool autoSend = true;
IList<ChatMessage>? inputMessages = null;
AgentResponse agentResponse =
await InvokeAgentAsync(
context,
agentName,
conversationId,
autoSend,
inputMessages,
cancellationToken).ConfigureAwait(false);
if (autoSend)
{
await context.AddEventAsync(new AgentResponseEvent(this.Id, agentResponse)).ConfigureAwait(false);
}
return default;
}
}
/// <summary>
/// Invokes an agent to process messages and return a response within a conversation context.
/// </summary>
internal sealed class QuestionTeacherExecutor(FormulaSession session, ResponseAgentProvider agentProvider) : AgentExecutor(id: "question_teacher", session, agentProvider)
{
// <inheritdoc />
protected override async ValueTask<object?> ExecuteAsync(IWorkflowContext context, CancellationToken cancellationToken)
{
string? agentName = "TeacherAgent";
if (string.IsNullOrWhiteSpace(agentName))
{
throw new DeclarativeActionException($"Agent name must be defined: {this.Id}");
}
string? conversationId = await context.ReadStateAsync<string>(key: "ConversationId", scopeName: "System").ConfigureAwait(false);
bool autoSend = false;
IList<ChatMessage>? inputMessages = null;
AgentResponse agentResponse =
await InvokeAgentAsync(
context,
agentName,
conversationId,
autoSend,
inputMessages,
cancellationToken).ConfigureAwait(false);
if (autoSend)
{
await context.AddEventAsync(new AgentResponseEvent(this.Id, agentResponse)).ConfigureAwait(false);
}
await context.QueueStateUpdateAsync(key: "TeacherResponse", value: agentResponse.Messages, scopeName: "Local").ConfigureAwait(false);
return default;
}
}
/// <summary>
/// Assigns an evaluated expression, other variable, or literal value to the "Local.TurnCount" variable.
/// </summary>
internal sealed class SetCountIncrementExecutor(FormulaSession session) : ActionExecutor(id: "set_count_increment", session)
{
// <inheritdoc />
protected override async ValueTask<object?> ExecuteAsync(IWorkflowContext context, CancellationToken cancellationToken)
{
object? evaluatedValue = await context.EvaluateValueAsync<object>("Local.TurnCount + 1").ConfigureAwait(false);
await context.QueueStateUpdateAsync(key: "TurnCount", value: evaluatedValue, scopeName: "Local").ConfigureAwait(false);
return default;
}
}
/// <summary>
/// Conditional branching similar to an if / elseif / elseif / else chain.
/// </summary>
internal sealed class CheckCompletionExecutor(FormulaSession session) : ActionExecutor(id: "check_completion", session)
{
// <inheritdoc />
protected override async ValueTask<object?> ExecuteAsync(IWorkflowContext context, CancellationToken cancellationToken)
{
bool condition0 = await context.EvaluateValueAsync<bool>("""!IsBlank(Find("CONGRATULATIONS", Upper(Last(Local.TeacherResponse).Text)))""").ConfigureAwait(false);
if (condition0)
{
return "check_turn_done";
}
bool condition1 = await context.EvaluateValueAsync<bool>("Local.TurnCount < 4").ConfigureAwait(false);
if (condition1)
{
return "check_turn_count";
}
return "check_completionElseActions";
}
}
/// <summary>
/// Formats a message template and sends an activity event.
/// </summary>
internal sealed class SendactivityDoneExecutor(FormulaSession session) : ActionExecutor(id: "sendActivity_done", session)
{
// <inheritdoc />
protected override async ValueTask<object?> ExecuteAsync(IWorkflowContext context, CancellationToken cancellationToken)
{
string activityText =
await context.FormatTemplateAsync(
"""
GOLD STAR!
"""
);
AgentResponse response = new([new ChatMessage(ChatRole.Assistant, activityText)]);
await context.AddEventAsync(new AgentResponseEvent(this.Id, response)).ConfigureAwait(false);
return default;
}
}
/// <summary>
/// Formats a message template and sends an activity event.
/// </summary>
internal sealed class SendactivityTiredExecutor(FormulaSession session) : ActionExecutor(id: "sendActivity_tired", session)
{
// <inheritdoc />
protected override async ValueTask<object?> ExecuteAsync(IWorkflowContext context, CancellationToken cancellationToken)
{
string activityText =
await context.FormatTemplateAsync(
"""
Let's try again later...
"""
);
AgentResponse response = new([new ChatMessage(ChatRole.Assistant, activityText)]);
await context.AddEventAsync(new AgentResponseEvent(this.Id, response)).ConfigureAwait(false);
return default;
}
}
public static Workflow CreateWorkflow<TInput>(
DeclarativeWorkflowOptions options,
Func<TInput, ChatMessage>? inputTransform = null)
where TInput : notnull
{
// Create root executor to initialize the workflow.
inputTransform ??= (message) => DeclarativeWorkflowBuilder.DefaultTransform(message);
WorkflowDemoRootExecutor<TInput> workflowDemoRoot = new(options, inputTransform);
DelegateExecutor workflowDemo = new(id: "workflow_demo", workflowDemoRoot.Session);
QuestionStudentExecutor questionStudent = new(workflowDemoRoot.Session, options.AgentProvider);
QuestionTeacherExecutor questionTeacher = new(workflowDemoRoot.Session, options.AgentProvider);
SetCountIncrementExecutor setCountIncrement = new(workflowDemoRoot.Session);
CheckCompletionExecutor checkCompletion = new(workflowDemoRoot.Session);
DelegateExecutor checkTurnDone = new(id: "check_turn_done", workflowDemoRoot.Session);
DelegateExecutor checkTurnCount = new(id: "check_turn_count", workflowDemoRoot.Session);
DelegateExecutor checkCompletionelseactions = new(id: "check_completionElseActions", workflowDemoRoot.Session);
DelegateExecutor checkTurnDoneactions = new(id: "check_turn_doneActions", workflowDemoRoot.Session);
SendactivityDoneExecutor sendActivityDone = new(workflowDemoRoot.Session);
DelegateExecutor checkTurnCountactions = new(id: "check_turn_countActions", workflowDemoRoot.Session);
DelegateExecutor gotoStudentAgent = new(id: "goto_student_agent", workflowDemoRoot.Session);
DelegateExecutor checkTurnCountRestart = new(id: "check_turn_count_Restart", workflowDemoRoot.Session);
SendactivityTiredExecutor sendActivityTired = new(workflowDemoRoot.Session);
DelegateExecutor checkTurnDonePost = new(id: "check_turn_done_Post", workflowDemoRoot.Session);
DelegateExecutor checkCompletionPost = new(id: "check_completion_Post", workflowDemoRoot.Session);
DelegateExecutor checkTurnCountPost = new(id: "check_turn_count_Post", workflowDemoRoot.Session);
DelegateExecutor checkTurnDoneactionsPost = new(id: "check_turn_doneActions_Post", workflowDemoRoot.Session);
DelegateExecutor gotoStudentAgentRestart = new(id: "goto_student_agent_Restart", workflowDemoRoot.Session);
DelegateExecutor checkTurnCountactionsPost = new(id: "check_turn_countActions_Post", workflowDemoRoot.Session);
DelegateExecutor checkCompletionelseactionsPost = new(id: "check_completionElseActions_Post", workflowDemoRoot.Session);
// Define the workflow builder
WorkflowBuilder builder = new(workflowDemoRoot);
// Connect executors
builder.AddEdge(workflowDemoRoot, workflowDemo);
builder.AddEdge(workflowDemo, questionStudent);
builder.AddEdge(questionStudent, questionTeacher);
builder.AddEdge(questionTeacher, setCountIncrement);
builder.AddEdge(setCountIncrement, checkCompletion);
builder.AddEdge(checkCompletion, checkTurnDone, (object? result) => ActionExecutor.IsMatch("check_turn_done", result));
builder.AddEdge(checkCompletion, checkTurnCount, (object? result) => ActionExecutor.IsMatch("check_turn_count", result));
builder.AddEdge(checkCompletion, checkCompletionelseactions, (object? result) => ActionExecutor.IsMatch("check_completionElseActions", result));
builder.AddEdge(checkTurnDone, checkTurnDoneactions);
builder.AddEdge(checkTurnDoneactions, sendActivityDone);
builder.AddEdge(checkTurnCount, checkTurnCountactions);
builder.AddEdge(checkTurnCountactions, gotoStudentAgent);
builder.AddEdge(gotoStudentAgent, questionStudent);
builder.AddEdge(checkTurnCountRestart, checkCompletionelseactions);
builder.AddEdge(checkCompletionelseactions, sendActivityTired);
builder.AddEdge(checkTurnDonePost, checkCompletionPost);
builder.AddEdge(checkTurnCountPost, checkCompletionPost);
builder.AddEdge(sendActivityDone, checkTurnDoneactionsPost);
builder.AddEdge(checkTurnDoneactionsPost, checkTurnDonePost);
builder.AddEdge(gotoStudentAgentRestart, checkTurnCountactionsPost);
builder.AddEdge(checkTurnCountactionsPost, checkTurnCountPost);
builder.AddEdge(sendActivityTired, checkCompletionelseactionsPost);
builder.AddEdge(checkCompletionelseactionsPost, checkCompletionPost);
// Build the workflow
return builder.Build(validateOrphans: false);
}
}
dotnet/samples/03-workflows/Declarative/ExecuteCode/Program.cs
+144
View File
@@ -0,0 +1,144 @@
// Copyright (c) Microsoft. All rights reserved.
// Uncomment this to enable JSON checkpointing to the local file system.
//#define CHECKPOINT_JSON
using System.Reflection;
using Azure.Identity;
using Microsoft.Agents.AI.Workflows;
using Microsoft.Agents.AI.Workflows.Declarative;
using Microsoft.Extensions.Configuration;
using Shared.Workflows;
namespace Demo.DeclarativeCode;
/// <summary>
/// HOW TO: Execute a declarative workflow that has been converted to code.
/// </summary>
/// <remarks>
/// <b>Configuration</b>
/// Define FOUNDRY_PROJECT_ENDPOINT as a user-secret or environment variable that
/// points to your Foundry project endpoint.
/// </remarks>
internal sealed class Program
{
public static async Task Main(string[] args)
{
string? workflowInput = ParseWorkflowInput(args);
Program program = new(workflowInput);
await program.ExecuteAsync();
}
private async Task ExecuteAsync()
{
Notify("\nWORKFLOW: Starting...");
string input = this.GetWorkflowInput();
// Execute the workflow: The WorkflowRunner demonstrates how to execute
// a workflow, handle the workflow events, and providing external input.
// This also includes the ability to checkpoint workflow state and how to
// resume execution.
await this.Runner.ExecuteAsync(this.CreateWorkflow, input);
Notify("\nWORKFLOW: Done!\n");
}
private Workflow CreateWorkflow()
{
// WARNING: DefaultAzureCredential is convenient for development but requires careful consideration in production.
// In production, consider using a specific credential (e.g., ManagedIdentityCredential) to avoid
// latency issues, unintended credential probing, and potential security risks from fallback mechanisms.
// Use DeclarativeWorkflowBuilder to build a workflow based on a YAML file.
DeclarativeWorkflowOptions options =
new(new AzureAgentProvider(new Uri(this.FoundryEndpoint), new DefaultAzureCredential()))
{
Configuration = this.Configuration
};
// Use the generated provider to create a workflow instance.
return SampleWorkflowProvider.CreateWorkflow<string>(options);
}
private string? WorkflowInput { get; }
private string FoundryEndpoint { get; }
private IConfiguration Configuration { get; }
private WorkflowRunner Runner { get; }
private Program(string? workflowInput)
{
this.WorkflowInput = workflowInput;
this.Configuration = InitializeConfig();
this.FoundryEndpoint = this.Configuration[Application.Settings.FoundryEndpoint] ?? throw new InvalidOperationException($"Undefined configuration setting: {Application.Settings.FoundryEndpoint}");
this.Runner =
new()
{
#if CHECKPOINT_JSON
// Use an json file checkpoint store that will persist checkpoints to the local file system.
UseJsonCheckpoints = true
#else
// Use an in-memory checkpoint store that will not persist checkpoints beyond the lifetime of the process.
UseJsonCheckpoints = false
#endif
};
}
private string GetWorkflowInput()
{
string? input = this.WorkflowInput;
try
{
Console.ForegroundColor = ConsoleColor.DarkGreen;
Console.Write("\nINPUT: ");
Console.ForegroundColor = ConsoleColor.White;
if (!string.IsNullOrWhiteSpace(input))
{
Console.WriteLine(input);
return input;
}
while (string.IsNullOrWhiteSpace(input))
{
input = Console.ReadLine();
}
return input.Trim();
}
finally
{
Console.ResetColor();
}
}
private static string? ParseWorkflowInput(string[] args)
{
return args?.FirstOrDefault();
}
// Load configuration from user-secrets
private static IConfigurationRoot InitializeConfig() =>
new ConfigurationBuilder()
.AddUserSecrets(Assembly.GetExecutingAssembly())
.AddEnvironmentVariables()
.Build();
private static void Notify(string message)
{
Console.ForegroundColor = ConsoleColor.Cyan;
try
{
Console.WriteLine(message);
}
finally
{
Console.ResetColor();
}
}
}