Add some OpenAI and Foundry extension methods

dotnet/samples/GettingStarted/Custom/Custom_OpenAIChatClientAgent.cs

@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.Extensions.Logging;
+using Microsoft.Shared.Samples;
+using OpenAI;
+using OpenAI.Chat;
+
+namespace Custom;
+
+/// <summary>
+/// End-to-end sample showing how to use a custom <see cref="OpenAIChatClientAgent"/>.
+/// </summary>
+public sealed class Custom_OpenAIChatClientAgent(ITestOutputHelper output) : AgentSample(output)
+{
+    /// <summary>
+    /// This will create an instance of <see cref="MyOpenAIChatClientAgent"/> and run it.
+    /// </summary>
+    [Fact]
+    public async Task RunCustomChatClientAgent()
+    {
+        var openAIClient = new OpenAIClient(TestConfiguration.OpenAI.ApiKey);
+        var model = TestConfiguration.OpenAI.ChatModelId;
+
+        var agent = new MyOpenAIChatClientAgent(openAIClient, model);
+
+        var chatMessage = new UserChatMessage("Tell me a joke about a pirate.");
+        var chatCompletion = await agent.RunAsync(chatMessage);
+
+        Console.WriteLine(chatCompletion.Content.Last().Text);
+    }
+}
+
+public class MyOpenAIChatClientAgent : OpenAIChatClientAgent
+{
+    private const string JokerName = "Joker";
+    private const string JokerInstructions = "You are good at telling jokes.";
+
+    public MyOpenAIChatClientAgent(OpenAIClient client, string model, ILoggerFactory? loggerFactory = null) :
+        base(client, model, instructions: JokerInstructions, name: JokerName, loggerFactory: loggerFactory)
+    {
+    }
+}

dotnet/samples/GettingStarted/GettingStarted.csproj

@@ -4,7 +4,7 @@
     <RootNamespace>GettingStarted</RootNamespace>
     <OutputType>Library</OutputType>
     <UserSecretsId>5ee045b0-aea3-4f08-8d31-32d1a6f8fed0</UserSecretsId>
-    <NoWarn>$(NoWarn);CA1707;CA1716;IDE0009;IDE1006;OPENAI001;</NoWarn>
+    <NoWarn>$(NoWarn);CA1707;CA1716;IDE0009;IDE1006; OPENAI001;</NoWarn>
     <ImplicitUsings>enable</ImplicitUsings>
     <InjectSharedSamples>true</InjectSharedSamples>
     <InjectSharedThrow>true</InjectSharedThrow>

dotnet/samples/GettingStarted/Orchestration/SequentialOrchestration_Foundry_Agents.cs

@@ -0,0 +1,87 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Azure.AI.Agents.Persistent;
+using Azure.Identity;
+using Microsoft.Agents.Orchestration;
+using Microsoft.Extensions.AI.Agents;
+using Microsoft.Shared.Samples;
+
+namespace Orchestration;
+
+/// <summary>
+/// Demonstrates how to use the <see cref="SequentialOrchestration"/> for
+/// executing multiple Foundry agents in sequence.
+/// </summary>
+public class SequentialOrchestration_Foundry_Agents(ITestOutputHelper output) : OrchestrationSample(output)
+{
+    [Theory]
+    [InlineData(false)]
+    [InlineData(true)]
+    public async Task RunOrchestrationAsync(bool streamedResponse)
+    {
+        // Get a client to create server side agents with.
+        var persistentAgentsClient = new PersistentAgentsClient(TestConfiguration.AzureAI.Endpoint, new AzureCliCredential());
+        var model = TestConfiguration.OpenAI.ChatModelId;
+
+        // Define the agents
+        AIAgent analystAgent =
+            await persistentAgentsClient.CreateAIAgentAsync(
+                model,
+                name: "Analyst",
+                instructions:
+                """
+                You are a marketing analyst. Given a product description, identify:
+                - Key features
+                - Target audience
+                - Unique selling points
+                """,
+                description: "A agent that extracts key concepts from a product description.");
+        AIAgent writerAgent =
+            await persistentAgentsClient.CreateAIAgentAsync(
+                model,
+                name: "copywriter",
+                instructions:
+                """
+                You are a marketing copywriter. Given a block of text describing features, audience, and USPs,
+                compose a compelling marketing copy (like a newsletter section) that highlights these points.
+                Output should be short (around 150 words), output just the copy as a single text block.
+                """,
+                description: "An agent that writes a marketing copy based on the extracted concepts.");
+        AIAgent editorAgent =
+            await persistentAgentsClient.CreateAIAgentAsync(
+                model,
+                name: "editor",
+                instructions:
+                """
+                You are an editor. Given the draft copy, correct grammar, improve clarity, ensure consistent tone,
+                give format and make it polished. Output the final improved copy as a single text block.
+                """,
+                description: "An agent that formats and proofreads the marketing copy.");
+
+        // Create a monitor to capturing agent responses (via ResponseCallback)
+        // to display at the end of this sample. (optional)
+        // NOTE: Create your own callback to capture responses in your application or service.
+        OrchestrationMonitor monitor = new();
+        // Define the orchestration
+        SequentialOrchestration orchestration =
+            new(analystAgent, writerAgent, editorAgent)
+            {
+                LoggerFactory = this.LoggerFactory,
+                ResponseCallback = monitor.ResponseCallback,
+                StreamingResponseCallback = streamedResponse ? monitor.StreamingResultCallback : null,
+            };
+
+        // Run the orchestration
+        string input = "An eco-friendly stainless steel water bottle that keeps drinks cold for 24 hours";
+        Console.WriteLine($"\n# INPUT: {input}\n");
+        AgentRunResponse result = await orchestration.RunAsync(input);
+        Console.WriteLine($"\n# RESULT: {result}");
+
+        this.DisplayHistory(monitor.History);
+
+        // Cleanup
+        await persistentAgentsClient.Administration.DeleteAgentAsync(editorAgent.Id);
+        await persistentAgentsClient.Administration.DeleteAgentAsync(writerAgent.Id);
+        await persistentAgentsClient.Administration.DeleteAgentAsync(analystAgent.Id);
+    }
+}

dotnet/samples/GettingStarted/Orchestration/SequentialOrchestration_Multi_Agent.cs

@@ -0,0 +1,85 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.Agents.Orchestration;
+using Microsoft.Extensions.AI.Agents;
+using Microsoft.Shared.Samples;
+using OpenAI;
+
+namespace Orchestration;
+
+/// <summary>
+/// Demonstrates how to use the <see cref="SequentialOrchestration"/> for
+/// executing multiple heterogeneous agents in sequence.
+/// </summary>
+public class SequentialOrchestration_Multi_Agent(ITestOutputHelper output) : OrchestrationSample(output)
+{
+    [Theory]
+    [InlineData(false)]
+    [InlineData(true)]
+    public async Task RunOrchestrationAsync(bool streamedResponse)
+    {
+        var openAIClient = new OpenAIClient(TestConfiguration.OpenAI.ApiKey);
+        var model = TestConfiguration.OpenAI.ChatModelId;
+
+        // Define the agents
+        AIAgent analystAgent =
+            openAIClient.CreateChatClientAgent(
+                model,
+                name: "Analyst",
+                instructions:
+                """
+                You are a marketing analyst. Given a product description, identify:
+                - Key features
+                - Target audience
+                - Unique selling points
+                """,
+                description: "A agent that extracts key concepts from a product description.");
+        AIAgent writerAgent =
+            openAIClient.CreateResponseClientAgent(
+                model,
+                name: "copywriter",
+                instructions:
+                """
+                You are a marketing copywriter. Given a block of text describing features, audience, and USPs,
+                compose a compelling marketing copy (like a newsletter section) that highlights these points.
+                Output should be short (around 150 words), output just the copy as a single text block.
+                """,
+                description: "An agent that writes a marketing copy based on the extracted concepts.");
+        AIAgent editorAgent =
+            await openAIClient.CreateAssistantClientAgentAsync(
+                model,
+                name: "editor",
+                instructions:
+                """
+                You are an editor. Given the draft copy, correct grammar, improve clarity, ensure consistent tone,
+                give format and make it polished. Output the final improved copy as a single text block.
+                """,
+                description: "An agent that formats and proofreads the marketing copy.");
+
+        // Create a monitor to capturing agent responses (via ResponseCallback)
+        // to display at the end of this sample. (optional)
+        // NOTE: Create your own callback to capture responses in your application or service.
+        OrchestrationMonitor monitor = new();
+        // Define the orchestration
+        SequentialOrchestration orchestration =
+            new(analystAgent, writerAgent, editorAgent)
+            {
+                LoggerFactory = this.LoggerFactory,
+                ResponseCallback = monitor.ResponseCallback,
+                StreamingResponseCallback = streamedResponse ? monitor.StreamingResultCallback : null,
+            };
+
+        // Run the orchestration
+        string input = "An eco-friendly stainless steel water bottle that keeps drinks cold for 24 hours";
+        Console.WriteLine($"\n# INPUT: {input}\n");
+        AgentRunResponse result = await orchestration.RunAsync(input);
+        Console.WriteLine($"\n# RESULT: {result}");
+
+        this.DisplayHistory(monitor.History);
+
+        // Cleanup
+        var assistantClient = openAIClient.GetAssistantClient();
+        await assistantClient.DeleteAssistantAsync(editorAgent.Id);
+        // Need to know how to get the assistant thread ID to delete the thread (issue #260)
+    }
+}

dotnet/samples/GettingStarted/Providers/AIAgent_With_AzureAIAgentsPersistent.cs

@@ -0,0 +1,91 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Azure.AI.Agents.Persistent;
+using Azure.Identity;
+using Microsoft.Extensions.AI.Agents;
+using Microsoft.Shared.Samples;
+
+namespace Providers;
+
+/// <summary>
+/// Shows how to use <see cref="AIAgent"/> with Azure AI Persistent Agents.
+/// </summary>
+/// <remarks>
+/// Running "az login" command in terminal is required for authentication with Azure AI service.
+/// </remarks>
+public sealed class AIAgent_With_AzureAIAgentsPersistent(ITestOutputHelper output) : AgentSample(output)
+{
+    private const string JokerName = "Joker";
+    private const string JokerInstructions = "You are good at telling jokes.";
+
+    [Fact]
+    public async Task GetWithAzureAIAgentsPersistent()
+    {
+        // Get a client to create server side agents with.
+        var persistentAgentsClient = new PersistentAgentsClient(TestConfiguration.AzureAI.Endpoint, new AzureCliCredential());
+
+        // Create a service side persistent agent.
+        var persistentAgent = await persistentAgentsClient.Administration.CreateAgentAsync(
+            model: TestConfiguration.AzureAI.DeploymentName!,
+            name: JokerName,
+            instructions: JokerInstructions);
+
+        // Get a server side agent.
+        AIAgent agent = await persistentAgentsClient.GetAIAgentAsync(persistentAgent.Value.Id);
+
+        // Start a new thread for the agent conversation.
+        AgentThread thread = agent.GetNewThread();
+
+        // Respond to user input
+        await RunAgentAsync("Tell me a joke about a pirate.");
+        await RunAgentAsync("Now add some emojis to the joke.");
+
+        // Local function to run agent and display the conversation messages for the thread.
+        async Task RunAgentAsync(string input)
+        {
+            Console.WriteLine(input);
+
+            var response = await agent.RunAsync(input, thread);
+
+            Console.WriteLine(response);
+        }
+
+        // Cleanup
+        await persistentAgentsClient.Threads.DeleteThreadAsync(thread.Id);
+        await persistentAgentsClient.Administration.DeleteAgentAsync(agent.Id);
+    }
+
+    [Fact]
+    public async Task CreateWithAzureAIAgentsPersistent()
+    {
+        // Get a client to create server side agents with.
+        var persistentAgentsClient = new PersistentAgentsClient(TestConfiguration.AzureAI.Endpoint, new AzureCliCredential());
+
+        // Create a server side persistent agent.
+        AIAgent agent = await persistentAgentsClient.CreateAIAgentAsync(
+            model: TestConfiguration.AzureAI.DeploymentName!,
+            name: JokerName,
+            instructions: JokerInstructions);
+
+        // Start a new thread for the agent conversation.
+        AgentThread thread = agent.GetNewThread();
+
+        // Respond to user input
+        await RunAgentAsync("Tell me a joke about a pirate.");
+        await RunAgentAsync("Now add some emojis to the joke.");
+
+        // Local function to run agent and display the conversation messages for the thread.
+        async Task RunAgentAsync(string input)
+        {
+            Console.WriteLine(input);
+
+            var response = await agent.RunAsync(input, thread);
+
+            Console.WriteLine(response);
+        }
+
+        // Cleanup
+        await persistentAgentsClient.Threads.DeleteThreadAsync(thread.Id);
+        await persistentAgentsClient.Administration.DeleteAgentAsync(agent.Id);
+    }
+}

dotnet/samples/GettingStarted/Providers/ChatClientAgent_With_AzureOpenAIChatCompletion.cs → dotnet/samples/GettingStarted/Providers/AIAgent_With_AzureOpenAIChatCompletion.cs

@@ -3,33 +3,31 @@
 using System.ClientModel;
 using Azure.AI.OpenAI;
 using Azure.Identity;
-using Microsoft.Extensions.AI;
 using Microsoft.Extensions.AI.Agents;
 using Microsoft.Shared.Samples;
+using OpenAI;
 
 namespace Providers;
 
 /// <summary>
 /// End-to-end sample showing how to use <see cref="ChatClientAgent"/> with Azure OpenAI Chat Completion.
 /// </summary>
-public sealed class ChatClientAgent_With_AzureOpenAIChatCompletion(ITestOutputHelper output) : AgentSample(output)
+public sealed class AIAgent_With_AzureOpenAIChatCompletion(ITestOutputHelper output) : AgentSample(output)
 {
     private const string JokerName = "Joker";
     private const string JokerInstructions = "You are good at telling jokes.";
 
     [Fact]
     public async Task RunWithChatCompletion()
     {
-        // Get the chat client to use for the agent.
-        using var chatClient = ((TestConfiguration.AzureOpenAI.ApiKey is null)
+        // Get the OpenAI client to use for the agent.
+        var openAIClient = (TestConfiguration.AzureOpenAI.ApiKey is null)
             // Use Azure CLI credentials if API key is not provided.
             ? new AzureOpenAIClient(TestConfiguration.AzureOpenAI.Endpoint, new AzureCliCredential())
-            : new AzureOpenAIClient(TestConfiguration.AzureOpenAI.Endpoint, new ApiKeyCredential(TestConfiguration.AzureOpenAI.ApiKey)))
-                .GetChatClient(TestConfiguration.AzureOpenAI.DeploymentName)
-                .AsIChatClient();
+            : new AzureOpenAIClient(TestConfiguration.AzureOpenAI.Endpoint, new ApiKeyCredential(TestConfiguration.AzureOpenAI.ApiKey));
 
-        // Define the agent
-        ChatClientAgent agent = new(chatClient, JokerInstructions, JokerName);
+        // Create the agent
+        AIAgent agent = openAIClient.CreateChatClientAgent(TestConfiguration.AzureOpenAI.DeploymentName, JokerInstructions, JokerName);
 
         // Start a new thread for the agent conversation.
         AgentThread thread = agent.GetNewThread();