Files
wehub-resource-sync b957a53def
CodeQL / Analyze (csharp) (push) Waiting to run
CodeQL / Analyze (python) (push) Waiting to run
chore: import upstream snapshot with attribution
2026-07-13 13:21:23 +08:00

103 lines
3.3 KiB
C#

// Copyright (c) Microsoft. All rights reserved.
using Events;
using Microsoft.SemanticKernel;
namespace SharedSteps;
/// <summary>
/// A step that elicits user input.
///
/// Step used in the Processes Samples:
/// - Step01_Processes.cs
/// - Step02_AccountOpening.cs
/// - Step04_AgentOrchestration
/// </summary>
public class ScriptedUserInputStep : KernelProcessStep<UserInputState>
{
public static class ProcessStepFunctions
{
public const string GetUserInput = nameof(GetUserInput);
}
protected bool SuppressOutput { get; init; }
/// <summary>
/// The state object for the user input step. This object holds the user inputs and the current input index.
/// </summary>
private UserInputState? _state;
/// <summary>
/// Method to be overridden by the user to populate with custom user messages
/// </summary>
/// <param name="state">The initialized state object for the step.</param>
public virtual void PopulateUserInputs(UserInputState state)
{
return;
}
/// <summary>
/// Activates the user input step by initializing the state object. This method is called when the process is started
/// and before any of the KernelFunctions are invoked.
/// </summary>
/// <param name="state">The state object for the step.</param>
/// <returns>A <see cref="ValueTask"/></returns>
public override ValueTask ActivateAsync(KernelProcessStepState<UserInputState> state)
{
_state = state.State;
PopulateUserInputs(_state!);
return ValueTask.CompletedTask;
}
internal string GetNextUserMessage()
{
if (_state != null && _state.CurrentInputIndex >= 0 && _state.CurrentInputIndex < this._state.UserInputs.Count)
{
var userMessage = this._state!.UserInputs[_state.CurrentInputIndex];
_state.CurrentInputIndex++;
Console.ForegroundColor = ConsoleColor.Yellow;
Console.WriteLine($"USER: {userMessage}");
Console.ResetColor();
return userMessage;
}
Console.WriteLine("SCRIPTED_USER_INPUT: No more scripted user messages defined, returning empty string as user message");
return string.Empty;
}
/// <summary>
/// Gets the user input.
/// Could be overridden to customize the output events to be emitted
/// </summary>
/// <param name="context">An instance of <see cref="KernelProcessStepContext"/> which can be
/// used to emit events from within a KernelFunction.</param>
/// <returns>A <see cref="ValueTask"/></returns>
[KernelFunction(ProcessStepFunctions.GetUserInput)]
public virtual async ValueTask GetUserInputAsync(KernelProcessStepContext context)
{
var userMessage = this.GetNextUserMessage();
// Emit the user input
if (string.IsNullOrEmpty(userMessage))
{
await context.EmitEventAsync(new() { Id = CommonEvents.Exit });
return;
}
await context.EmitEventAsync(new() { Id = CommonEvents.UserInputReceived, Data = userMessage });
}
}
/// <summary>
/// The state object for the <see cref="ScriptedUserInputStep"/>
/// </summary>
public record UserInputState
{
public List<string> UserInputs { get; init; } = [];
public int CurrentInputIndex { get; set; } = 0;
}