.NET Samples - Create 02-agents learning path step (#4107)

dotnet/samples/02-agents/AgentWithOpenAI/Agent_OpenAI_Step04_CreateFromOpenAIResponseClient/Agent_OpenAI_Step04_CreateFromOpenAIResponseClient.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFrameworks>net10.0</TargetFrameworks>
+
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.OpenAI\Microsoft.Agents.AI.OpenAI.csproj" />
+  </ItemGroup>
+
+</Project>

dotnet/samples/02-agents/AgentWithOpenAI/Agent_OpenAI_Step04_CreateFromOpenAIResponseClient/OpenAIResponseClientAgent.cs

@@ -0,0 +1,114 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System.Runtime.CompilerServices;
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+using Microsoft.Extensions.Logging;
+using OpenAI.Responses;
+
+namespace OpenAIResponseClientSample;
+
+/// <summary>
+/// Provides an <see cref="AIAgent"/> backed by an OpenAI Responses implementation.
+/// </summary>
+public class OpenAIResponseClientAgent : DelegatingAIAgent
+{
+    /// <summary>
+    /// Initialize an instance of <see cref="OpenAIResponseClientAgent"/>.
+    /// </summary>
+    /// <param name="client">Instance of <see cref="ResponsesClient"/></param>
+    /// <param name="instructions">Optional instructions for the agent.</param>
+    /// <param name="name">Optional name for the agent.</param>
+    /// <param name="description">Optional description for the agent.</param>
+    /// <param name="loggerFactory">Optional instance of <see cref="ILoggerFactory"/></param>
+    public OpenAIResponseClientAgent(
+        ResponsesClient client,
+        string? instructions = null,
+        string? name = null,
+        string? description = null,
+        ILoggerFactory? loggerFactory = null) :
+        this(client, new()
+        {
+            Name = name,
+            Description = description,
+            ChatOptions = new ChatOptions() { Instructions = instructions },
+        }, loggerFactory)
+    {
+    }
+
+    /// <summary>
+    /// Initialize an instance of <see cref="OpenAIResponseClientAgent"/>.
+    /// </summary>
+    /// <param name="client">Instance of <see cref="ResponsesClient"/></param>
+    /// <param name="options">Options to create the agent.</param>
+    /// <param name="loggerFactory">Optional instance of <see cref="ILoggerFactory"/></param>
+    public OpenAIResponseClientAgent(
+        ResponsesClient client, ChatClientAgentOptions options, ILoggerFactory? loggerFactory = null) :
+        base(new ChatClientAgent((client ?? throw new ArgumentNullException(nameof(client))).AsIChatClient(), options, loggerFactory))
+    {
+    }
+
+    /// <summary>
+    /// Run the agent with the provided message and arguments.
+    /// </summary>
+    /// <param name="messages">The messages to pass to the agent.</param>
+    /// <param name="session">The conversation session to continue with this invocation. If not provided, creates a new session. The session will be mutated with the provided messages and agent response.</param>
+    /// <param name="options">Optional parameters for agent invocation.</param>
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
+    /// <returns>A <see cref="ResponseResult"/> containing the list of <see cref="ChatMessage"/> items.</returns>
+    public virtual async Task<ResponseResult> RunAsync(
+        IEnumerable<ResponseItem> messages,
+        AgentSession? session = null,
+        AgentRunOptions? options = null,
+        CancellationToken cancellationToken = default)
+    {
+        var response = await this.RunAsync(messages.AsChatMessages(), session, options, cancellationToken).ConfigureAwait(false);
+
+        return response.AsOpenAIResponse();
+    }
+
+    /// <summary>
+    /// Run the agent streaming with the provided message and arguments.
+    /// </summary>
+    /// <param name="messages">The messages to pass to the agent.</param>
+    /// <param name="session">The conversation session to continue with this invocation. If not provided, creates a new session. The session will be mutated with the provided messages and agent response.</param>
+    /// <param name="options">Optional parameters for agent invocation.</param>
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.</param>
+    /// <returns>A <see cref="ResponseResult"/> containing the list of <see cref="ChatMessage"/> items.</returns>
+    public virtual async IAsyncEnumerable<StreamingResponseUpdate> RunStreamingAsync(
+        IEnumerable<ResponseItem> messages,
+        AgentSession? session = null,
+        AgentRunOptions? options = null,
+        [EnumeratorCancellation] CancellationToken cancellationToken = default)
+    {
+        var response = this.RunStreamingAsync(messages.AsChatMessages(), session, options, cancellationToken);
+
+        await foreach (var update in response.ConfigureAwait(false))
+        {
+            switch (update.RawRepresentation)
+            {
+                case StreamingResponseUpdate rawUpdate:
+                    yield return rawUpdate;
+                    break;
+
+                case ChatResponseUpdate { RawRepresentation: StreamingResponseUpdate rawUpdate }:
+                    yield return rawUpdate;
+                    break;
+
+                default:
+                    // TODO: The OpenAI library does not currently expose model factory methods for creating
+                    // StreamingResponseUpdates. We are thus unable to manufacture such instances when there isn't
+                    // already one in the update and instead skip them.
+                    break;
+            }
+        }
+    }
+
+    /// <inheritdoc/>
+    protected sealed override Task<AgentResponse> RunCoreAsync(IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default) =>
+        base.RunCoreAsync(messages, session, options, cancellationToken);
+
+    /// <inheritdoc/>
+    protected sealed override IAsyncEnumerable<AgentResponseUpdate> RunCoreStreamingAsync(IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default) =>
+        base.RunCoreStreamingAsync(messages, session, options, cancellationToken);
+}

dotnet/samples/02-agents/AgentWithOpenAI/Agent_OpenAI_Step04_CreateFromOpenAIResponseClient/Program.cs

@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+// This sample demonstrates how to create OpenAIResponseClientAgent directly from an ResponsesClient instance.
+
+using OpenAI;
+using OpenAI.Responses;
+using OpenAIResponseClientSample;
+
+var apiKey = Environment.GetEnvironmentVariable("OPENAI_API_KEY") ?? throw new InvalidOperationException("OPENAI_API_KEY is not set.");
+var model = Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o-mini";
+
+// Create a ResponsesClient directly from OpenAIClient
+ResponsesClient responseClient = new OpenAIClient(apiKey).GetResponsesClient(model);
+
+// Create an agent directly from the ResponsesClient using OpenAIResponseClientAgent
+OpenAIResponseClientAgent agent = new(responseClient, instructions: "You are good at telling jokes.", name: "Joker");
+
+ResponseItem userMessage = ResponseItem.CreateUserMessageItem("Tell me a joke about a pirate.");
+
+// Invoke the agent and output the text result.
+ResponseResult response = await agent.RunAsync([userMessage]);
+Console.WriteLine(response.GetOutputText());
+
+// Invoke the agent with streaming support.
+IAsyncEnumerable<StreamingResponseUpdate> responseUpdates = agent.RunStreamingAsync([userMessage]);
+await foreach (StreamingResponseUpdate responseUpdate in responseUpdates)
+{
+    if (responseUpdate is StreamingResponseOutputTextDeltaUpdate textUpdate)
+    {
+        Console.WriteLine(textUpdate.Delta);
+    }
+}

dotnet/samples/02-agents/AgentWithOpenAI/Agent_OpenAI_Step04_CreateFromOpenAIResponseClient/README.md

@@ -0,0 +1,22 @@
+# Creating an Agent from an OpenAIResponseClient
+
+This sample demonstrates how to create an AI agent directly from an `OpenAI.Responses.OpenAIResponseClient` instance using the `OpenAIResponseClientAgent` class.
+
+## What This Sample Shows
+
+- **Direct OpenAIResponseClient Creation**: Shows how to create an `OpenAI.Responses.OpenAIResponseClient` from `OpenAI.OpenAIClient` and then use it to instantiate an agent
+- **OpenAIResponseClientAgent**: Demonstrates using the OpenAI SDK primitives instead of the ones from Microsoft.Extensions.AI and Microsoft.Agents.AI abstractions
+- **Full Agent Capabilities**: Shows both regular and streaming invocation of the agent
+
+## Running the Sample
+
+1. Set the required environment variables:
+   ```bash
+   set OPENAI_API_KEY=your_api_key_here
+   set OPENAI_MODEL=gpt-4o-mini
+   ```
+
+2. Run the sample:
+   ```bash
+   dotnet run
+   ```