Rename AI Agent packages to use Microsoft.Agents.AI (#913)

* Rename AI Agent packages to use Microsoft.Agents.AI * Fix for build * Fix formatting * Fix formatting * Ignore in VSTHRD200 in migration samples * Ignore in VSTHRD200 in migration samples * Add some missing projects and run format * Fix build errors * Address code review feedback * Fix merge issues --------- Co-authored-by: Mark Wallace <markwallace@microsoft.com>
2026-06-16 21:04:09 +08:00 · 2025-09-25 19:31:25 +00:00
parent a480ccfd16
commit 32e054f1fe
332 changed files with 520 additions and 432 deletions
@@ -0,0 +1,67 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+using Microsoft.Extensions.Logging;
+using Microsoft.Shared.Diagnostics;
+using OpenAI.Responses;
+
+namespace OpenAI;
+
+/// <summary>
+/// Provides extension methods for <see cref="OpenAIResponseClient"/>
+/// to simplify the creation of AI agents that work with OpenAI services.
+/// </summary>
+/// <remarks>
+/// These extensions bridge the gap between OpenAI SDK client objects and the Microsoft Extensions AI Agent framework,
+/// allowing developers to easily create AI agents that leverage OpenAI's chat completion and response services.
+/// The methods handle the conversion from OpenAI clients to <see cref="IChatClient"/> instances and then wrap them
+/// in <see cref="ChatClientAgent"/> objects that implement the <see cref="AIAgent"/> interface.
+/// </remarks>
+public static class OpenAIResponseClientExtensions
+{
+    /// <summary>
+    /// Creates an AI agent from an <see cref="OpenAIResponseClient"/> using the OpenAI Response API.
+    /// </summary>
+    /// <param name="client">The <see cref="OpenAIResponseClient" /> to use for the agent.</param>
+    /// <param name="instructions">Optional system instructions that define the agent's behavior and personality.</param>
+    /// <param name="name">Optional name for the agent for identification purposes.</param>
+    /// <param name="description">Optional description of the agent's capabilities and purpose.</param>
+    /// <param name="tools">Optional collection of AI tools that the agent can use during conversations.</param>
+    /// <param name="loggerFactory">Optional logger factory for enabling logging within the agent.</param>
+    /// <returns>An <see cref="AIAgent"/> instance backed by the OpenAI Response service.</returns>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="client"/> is <see langword="null"/>.</exception>
+    public static AIAgent CreateAIAgent(this OpenAIResponseClient client, string? instructions = null, string? name = null, string? description = null, IList<AITool>? tools = null, ILoggerFactory? loggerFactory = null)
+    {
+        Throw.IfNull(client);
+
+        return client.CreateAIAgent(
+            new ChatClientAgentOptions()
+            {
+                Name = name,
+                Description = description,
+                Instructions = instructions,
+                ChatOptions = tools is null ? null : new ChatOptions()
+                {
+                    Tools = tools,
+                }
+            },
+            loggerFactory);
+    }
+
+    /// <summary>
+    /// Creates an AI agent from an <see cref="OpenAIResponseClient"/> using the OpenAI Response API.
+    /// </summary>
+    /// <param name="client">The <see cref="OpenAIResponseClient" /> to use for the agent.</param>
+    /// <param name="options">Full set of options to configure the agent.</param>
+    /// <param name="loggerFactory">Optional logger factory for enabling logging within the agent.</param>
+    /// <returns>An <see cref="AIAgent"/> instance backed by the OpenAI Response service.</returns>
+    /// <exception cref="ArgumentNullException">Thrown when <paramref name="client"/> or <paramref name="options"/> is <see langword="null"/>.</exception>
+    public static AIAgent CreateAIAgent(this OpenAIResponseClient client, ChatClientAgentOptions options, ILoggerFactory? loggerFactory = null)
+    {
+        Throw.IfNull(client);
+        Throw.IfNull(options);
+
+        return new ChatClientAgent(client.AsIChatClient(), options, loggerFactory);
+    }
+}