.Net: Add OpenAI Responses Agent Samples (#83)

* Improved Merge logic * Add modularization for Model Samples and Azure OpenAI * Address PR feedback * Warning fix * Address PR comments * Adding OpenAI Response Samples * Clean up * Revert to provider specific chat options * Fix warnings * Revert slnx changes
2026-06-16 21:04:09 +08:00 · 2025-06-19 18:06:08 +00:00
parent 47dcad6b49
commit 2cd77596c3
3 changed files with 97 additions and 5 deletions
@@ -0,0 +1,60 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.Agents;
+using Microsoft.Extensions.AI;
+using Microsoft.Shared.Samples;
+using OpenAI;
+using OpenAI.Responses;
+
+#pragma warning disable CS8524 // The switch expression does not handle some values of its input type (it is not exhaustive) involving an unnamed enum value.
+
+namespace Providers;
+
+/// <summary>
+/// End-to-end sample showing how to use <see cref="ChatClientAgent"/> with OpenAI Chat Completion.
+/// </summary>
+public sealed class ChatClientAgent_With_OpenAIResponsesChatCompletion(ITestOutputHelper output) : AgentSample(output)
+{
+    private const string JokerName = "Joker";
+    private const string JokerInstructions = "You are good at telling jokes.";
+
+    [Theory]
+    [InlineData(false)] // This will use in-memory messages to store the thread state.
+    [InlineData(true)] // This will use the conversation id to reference the thread state on the server side.
+    public async Task RunWithChatCompletion(bool useConversationIdThread)
+    {
+        // Get the chat client to use for the agent.
+        using var chatClient = new OpenAIClient(TestConfiguration.OpenAI.ApiKey)
+            .GetOpenAIResponseClient(TestConfiguration.OpenAI.ChatModelId)
+            .AsIChatClient();
+
+        // Define the agent
+        ChatClientAgent agent =
+            new(chatClient, new()
+            {
+                Name = JokerName,
+                Instructions = JokerInstructions,
+                ChatOptions = new ChatOptions
+                {
+                    RawRepresentationFactory = (_) => new ResponseCreationOptions() { StoredOutputEnabled = useConversationIdThread }
+                }
+            });
+
+        // Start a new thread for the agent conversation based on the type.
+        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 invoke agent and display the conversation messages for the thread.
+        async Task RunAgentAsync(string input)
+        {
+            this.WriteUserMessage(input);
+
+            var response = await agent.RunAsync(input, thread);
+
+            this.WriteResponseOutput(response);
+        }
+    }
+}