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]>
102 lines
3.5 KiB
C#
102 lines
3.5 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using Azure.AI.OpenAI;
|
|
using Azure.Identity;
|
|
using Microsoft.Agents.AI;
|
|
using Microsoft.Extensions.AI;
|
|
using Microsoft.SemanticKernel.Agents.OpenAI;
|
|
using OpenAI.Responses;
|
|
|
|
#pragma warning disable OPENAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
|
|
#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 endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set.");
|
|
var deploymentName = System.Environment.GetEnvironmentVariable("AZURE_OPENAI_DEPLOYMENT_NAME") ?? "gpt-4o";
|
|
var userInput = "Tell me a joke about a pirate.";
|
|
|
|
Console.WriteLine($"User Input: {userInput}");
|
|
|
|
await SKAgentAsync();
|
|
await SKAgent_As_AFAgentAsync();
|
|
await AFAgentAsync();
|
|
|
|
async Task SKAgentAsync()
|
|
{
|
|
Console.WriteLine("\n=== SK Agent ===\n");
|
|
|
|
var responseClient = new AzureOpenAIClient(new Uri(endpoint), new AzureCliCredential())
|
|
.GetResponsesClient();
|
|
OpenAIResponseAgent agent = new(responseClient, deploymentName)
|
|
{
|
|
Name = "Joker",
|
|
Instructions = "You are good at telling jokes.",
|
|
StoreEnabled = true
|
|
};
|
|
|
|
var agentOptions = new OpenAIResponseAgentInvokeOptions() { ResponseCreationOptions = new() { MaxOutputTokenCount = 1000 } };
|
|
|
|
Microsoft.SemanticKernel.Agents.AgentThread? thread = null;
|
|
await foreach (var item in agent.InvokeAsync(userInput, thread, agentOptions))
|
|
{
|
|
thread = item.Thread;
|
|
Console.WriteLine(item.Message);
|
|
}
|
|
|
|
Console.WriteLine("---");
|
|
await foreach (var item in agent.InvokeStreamingAsync(userInput, thread, agentOptions))
|
|
{
|
|
thread = item.Thread;
|
|
Console.Write(item.Message);
|
|
}
|
|
}
|
|
|
|
async Task SKAgent_As_AFAgentAsync()
|
|
{
|
|
Console.WriteLine("\n=== SK Agent Converted as an AF Agent ===\n");
|
|
|
|
var responseClient = new AzureOpenAIClient(new Uri(endpoint), new AzureCliCredential())
|
|
.GetResponsesClient();
|
|
|
|
OpenAIResponseAgent skAgent = new(responseClient, deploymentName)
|
|
{
|
|
Name = "Joker",
|
|
Instructions = "You are good at telling jokes.",
|
|
StoreEnabled = true
|
|
};
|
|
|
|
var agent = skAgent.AsAIAgent();
|
|
|
|
var thread = await agent.CreateSessionAsync();
|
|
var agentOptions = new ChatClientAgentRunOptions(new() { MaxOutputTokens = 8000 });
|
|
|
|
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);
|
|
}
|
|
}
|
|
|
|
async Task AFAgentAsync()
|
|
{
|
|
Console.WriteLine("\n=== AF Agent ===\n");
|
|
|
|
var agent = new AzureOpenAIClient(new Uri(endpoint), new AzureCliCredential())
|
|
.GetResponsesClient()
|
|
.AsAIAgent(model: deploymentName, name: "Joker", instructions: "You are good at telling jokes.");
|
|
|
|
var session = await agent.CreateSessionAsync();
|
|
var agentOptions = new ChatClientAgentRunOptions(new() { MaxOutputTokens = 8000 });
|
|
|
|
var result = await agent.RunAsync(userInput, session, agentOptions);
|
|
Console.WriteLine(result);
|
|
|
|
Console.WriteLine("---");
|
|
await foreach (var update in agent.RunStreamingAsync(userInput, session, agentOptions))
|
|
{
|
|
Console.Write(update);
|
|
}
|
|
}
|