mirror of
https://github.com/microsoft/semantic-kernel.git
synced 2026-10-12 02:19:06 +00:00
## Description Updates the SK → Agent Framework migration document, samples, and bridge code from AF preview (`1.0.0-preview.251009.1`) to GA (`1.0.0`). ### Breaking changes addressed | Preview API | AF 1.0 GA | Scope | |---|---|---| | `AgentThread` | `AgentSession` | Core type rename | | `GetNewThread()` | `CreateSessionAsync()` | Now async | | `AgentRunResponse` | `AgentResponse` | Return type rename | | `AgentRunResponseUpdate` | `AgentResponseUpdate` | Streaming type rename | | `CreateAIAgent()` | `AsAIAgent()` | Extension method rename | | `AssistantClient.CreateAIAgentAsync()` | **Removed** | Redirect to Responses API | | `PersistentAgentsClient` | **Obsolete** | Use `AIProjectClient` via `Microsoft.Agents.AI.Foundry` | | `Microsoft.Agents.AI.AzureAI` | `Microsoft.Agents.AI.Foundry` | Package rename | | `InProcessExecution.StreamAsync` | `RunStreamingAsync` | Workflow API | | `AgentRunUpdateEvent` | `AgentResponseUpdateEvent` | Workflow event | | `AIAgent.Id` (virtual) | `IdCore` (protected virtual) | Override pattern | ### Additional discoveries - `using OpenAI.Chat;` required for `ChatClient.AsAIAgent()` extension to resolve - `using OpenAI.Responses;` required for `ResponsesClient.AsAIAgent()` extension to resolve ### What changed **Package versions** (`dotnet/Directory.Packages.props`) - AF packages updated to `1.0.0` - `Microsoft.Agents.AI.AzureAI` → `Microsoft.Agents.AI.Foundry` **Bridge code** (`dotnet/src/Agents/Abstractions/AIAgent/`) - `SemanticKernelAIAgent.cs`: New `Core` method overrides (`CreateSessionCoreAsync`, `RunCoreAsync`, etc.) - `SemanticKernelAIAgentThread` → `SemanticKernelAIAgentSession` (extends `AgentSession`) **31 migration samples** (all compile ✅) - OpenAI/AzureOpenAI: `AsAIAgent`, `CreateSessionAsync`, `using OpenAI.Chat;` - Assistants (8): AF sections rewritten to Responses API - Responses (8): Direct `ResponsesClient.AsAIAgent()` - Foundry (4): `AIProjectClient.AsAIAgent()` via `Microsoft.Agents.AI.Foundry` - Orchestrations (3): `RunStreamingAsync`, `AgentResponseUpdateEvent` **Migration document** (`.github/upgrades/prompts/SemanticKernelToAgentFramework.md`) - All AF preview API references updated to 1.0 GA patterns **Unit/integration tests** (~15 files) - Mechanical renames for `AgentSession`, `AgentResponse`, `CreateSessionAsync` ### Validation 8 standalone console programs were created and executed against AF 1.0.0 NuGet packages with real API keys, validating all migration patterns end-to-end: 1. OpenAI Basics (ChatClient → AsAIAgent, CreateSessionAsync, Run/RunStreaming) 2. OpenAI ToolCall (AIFunctionFactory.Create, tool invocation) 3. OpenAI DI (ServiceProvider registration) 4. OpenAI Responses (ResponsesClient.AsAIAgent) 5. Azure AI Foundry (AIProjectClient.AsAIAgent) 6. Workflows Handoff (HandoffWorkflowBuilder, InProcessExecution.RunStreamingAsync) 7. Session Lifecycle (Create, Serialize, Deserialize, multi-turn) 8. Assistants Migration Path (Responses API as replacement) --------- Co-authored-by: Copilot <[email protected]>
99 lines
3.6 KiB
C#
99 lines
3.6 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System.ComponentModel;
|
|
using Microsoft.Agents.AI;
|
|
using Microsoft.Extensions.AI;
|
|
using Microsoft.SemanticKernel;
|
|
using Microsoft.SemanticKernel.Agents;
|
|
using OpenAI;
|
|
using OpenAI.Chat;
|
|
|
|
var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new InvalidOperationException("OPENAI_API_KEY is not set.");
|
|
var model = System.Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o";
|
|
var userInput = "What is the weather like in Amsterdam?";
|
|
|
|
Console.WriteLine($"User Input: {userInput}");
|
|
|
|
[KernelFunction]
|
|
[Description("Get the weather for a given location.")]
|
|
static string GetWeather([Description("The location to get the weather for.")] string location)
|
|
=> $"The weather in {location} is cloudy with a high of 15°C.";
|
|
|
|
await SKAgentAsync();
|
|
await SKAgent_As_AFAgentAsync();
|
|
await AFAgentAsync();
|
|
|
|
async Task SKAgentAsync()
|
|
{
|
|
var builder = Kernel.CreateBuilder().AddOpenAIChatClient(model, apiKey);
|
|
|
|
ChatCompletionAgent agent = new()
|
|
{
|
|
Instructions = "You are a helpful assistant",
|
|
Kernel = builder.Build(),
|
|
Arguments = new KernelArguments(new PromptExecutionSettings() { FunctionChoiceBehavior = FunctionChoiceBehavior.Auto() }),
|
|
};
|
|
|
|
// Initialize plugin and add to the agent's Kernel (same as direct Kernel usage).
|
|
agent.Kernel.Plugins.Add(KernelPluginFactory.CreateFromFunctions("KernelPluginName", [KernelFunctionFactory.CreateFromMethod(GetWeather)]));
|
|
|
|
Console.WriteLine("\n=== SK Agent Response ===\n");
|
|
|
|
await foreach (var item in agent.InvokeAsync(userInput))
|
|
{
|
|
Console.Write(item.Message);
|
|
}
|
|
}
|
|
|
|
// Example of Semantic Kernel Agent code converted as an Agent Framework Agent
|
|
async Task SKAgent_As_AFAgentAsync()
|
|
{
|
|
Console.WriteLine("\n=== SK Agent Converted as an AF Agent ===\n");
|
|
|
|
var builder = Kernel.CreateBuilder().AddOpenAIChatClient(model, apiKey);
|
|
|
|
ChatCompletionAgent skAgent = new()
|
|
{
|
|
Instructions = "You are a helpful assistant",
|
|
Kernel = builder.Build(),
|
|
Arguments = new KernelArguments(new PromptExecutionSettings() { FunctionChoiceBehavior = FunctionChoiceBehavior.Auto() }),
|
|
};
|
|
|
|
// Initialize plugin and add to the agent's Kernel (same as direct Kernel usage).
|
|
skAgent.Kernel.Plugins.Add(KernelPluginFactory.CreateFromFunctions("KernelPluginName", [KernelFunctionFactory.CreateFromMethod(GetWeather)]));
|
|
|
|
#pragma warning disable SKEXP0110 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
|
|
var agent = skAgent.AsAIAgent();
|
|
#pragma warning restore SKEXP0110 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
|
|
|
|
var thread = await agent.CreateSessionAsync();
|
|
var agentOptions = new ChatClientAgentRunOptions(new() { MaxOutputTokens = 1000 });
|
|
|
|
var result = await agent.RunAsync(userInput, thread, agentOptions);
|
|
Console.WriteLine(result);
|
|
|
|
Console.WriteLine("---");
|
|
await foreach (var update in agent.RunStreamingAsync(userInput, thread, agentOptions))
|
|
{
|
|
Console.Write(update);
|
|
}
|
|
|
|
Console.WriteLine("\n---\n");
|
|
await foreach (var item in skAgent.InvokeAsync(userInput))
|
|
{
|
|
Console.Write(item.Message);
|
|
}
|
|
}
|
|
|
|
async Task AFAgentAsync()
|
|
{
|
|
var agent = new OpenAIClient(apiKey).GetChatClient(model).AsAIAgent(
|
|
instructions: "You are a helpful assistant",
|
|
tools: [AIFunctionFactory.Create(GetWeather)]);
|
|
|
|
Console.WriteLine("\n=== AF Agent Response ===\n");
|
|
|
|
var result = await agent.RunAsync(userInput);
|
|
Console.WriteLine(result);
|
|
}
|