.NET: Add provider sample for OpenAI Assistants (#812)

* Add provider sample for OpenAI Assistants * Suggestions from pr Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add deprecation warnings for OpenAI Assistants --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
2026-06-16 21:04:09 +08:00 · 2025-09-18 16:22:06 +01:00
parent edf114b5e2
commit daee44d583
6 changed files with 77 additions and 1 deletions
@@ -33,6 +33,7 @@
    <Project Path="samples/GettingStarted/AgentProviders/Agent_With_CustomImplementation/Agent_With_CustomImplementation.csproj" />
    <Project Path="samples/GettingStarted/AgentProviders/Agent_With_Ollama/Agent_With_Ollama.csproj" />
    <Project Path="samples/GettingStarted/AgentProviders/Agent_With_ONNX/Agent_With_ONNX.csproj" />
+    <Project Path="samples/GettingStarted/AgentProviders/Agent_With_OpenAIAssistants/Agent_With_OpenAIAssistants.csproj" />
    <Project Path="samples/GettingStarted/AgentProviders/Agent_With_OpenAIChatCompletion/Agent_With_OpenAIChatCompletion.csproj" />
    <Project Path="samples/GettingStarted/AgentProviders/Agent_With_OpenAIResponses/Agent_With_OpenAIResponses.csproj" />
  </Folder>
@@ -0,0 +1,16 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net9.0</TargetFramework>
+
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>disable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Extensions.AI.Agents.OpenAI\Microsoft.Extensions.AI.Agents.OpenAI.csproj" />
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Extensions.AI.Agents\Microsoft.Extensions.AI.Agents.csproj" />
+  </ItemGroup>
+
+</Project>
@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+// This sample shows how to create and use a simple AI agent with OpenAI Assistants as the backend.
+
+// WARNING: The Assistants API is deprecated and will be shut down.
+// For more information see the OpenAI documentation: https://platform.openai.com/docs/assistants/migration
+
+#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.
+
+using System;
+using Microsoft.Extensions.AI.Agents;
+using OpenAI;
+
+var apiKey = Environment.GetEnvironmentVariable("OPENAI_APIKEY") ?? throw new InvalidOperationException("OPENAI_APIKEY is not set.");
+var mmodel = Environment.GetEnvironmentVariable("OPENAI_MODEL") ?? "gpt-4o-mini";
+
+const string JokerName = "Joker";
+const string JokerInstructions = "You are good at telling jokes.";
+
+// Get a client to create/retrieve server side agents with.
+var assistantClient = new OpenAIClient(apiKey).GetAssistantClient();
+
+// You can create a server side assistant with the OpenAI SDK.
+var createResult = await assistantClient.CreateAssistantAsync(mmodel, new() { Name = JokerName, Instructions = JokerInstructions });
+
+// You can retrieve an already created server side assistant as an AIAgent.
+AIAgent agent1 = await assistantClient.GetAIAgentAsync(createResult.Value.Id);
+
+// You can also create a server side assistant and return it as an AIAgent directly.
+AIAgent agent2 = await assistantClient.CreateAIAgentAsync(
+    model: mmodel,
+    name: JokerName,
+    instructions: JokerInstructions);
+
+// You can invoke the agent like any other AIAgent.
+AgentThread thread = agent1.GetNewThread();
+Console.WriteLine(await agent1.RunAsync("Tell me a joke about a pirate.", thread));
+
+// Cleanup for sample purposes.
+await assistantClient.DeleteThreadAsync(thread.ConversationId);
+await assistantClient.DeleteAssistantAsync(agent1.Id);
+await assistantClient.DeleteAssistantAsync(agent2.Id);
@@ -0,0 +1,16 @@
+# Prerequisites
+
+WARNING: The Assistants API is deprecated and will be shut down.
+For more information see the OpenAI documentation: https://platform.openai.com/docs/assistants/migration
+
+Before you begin, ensure you have the following prerequisites:
+
+- .NET 8.0 SDK or later
+- OpenAI API key
+
+Set the following environment variables:
+
+```powershell
+$env:OPENAI_APIKEY="*****" # Replace with your OpenAI API key
+$env:OPENAI_MODEL="gpt-4o-mini"  # Optional, defaults to gpt-4o-mini
+```
@@ -21,6 +21,7 @@ See the README.md for each sample for the prerequisites for that sample.
 |[Creating an AIAgent with a custom implementation](./Agent_With_CustomImplementation/)|This sample demonstrates how to create an AIAgent with a custom implementation|
 |[Creating an AIAgent with Ollama](./Agent_With_Ollama/)|This sample demonstrates how to create an AIAgent using Ollama as the underlying inference service|
 |[Creating an AIAgent with ONNX](./Agent_With_ONNX/)|This sample demonstrates how to create an AIAgent using ONNX as the underlying inference service|
+|[Creating an AIAgent with OpenAI Assistants](./Agent_With_OpenAIAssistants/)|This sample demonstrates how to create an AIAgent using OpenAI Assistants as the underlying inference service.</br>WARNING: The Assistants API is deprecated and will be shut down. For more information see the OpenAI documentation: https://platform.openai.com/docs/assistants/migration|
 |[Creating an AIAgent with OpenAI ChatCompletion](./Agent_With_OpenAIChatCompletion/)|This sample demonstrates how to create an AIAgent using OpenAI ChatCompletion as the underlying inference service|
 |[Creating an AIAgent with OpenAI Responses](./Agent_With_OpenAIResponses/)|This sample demonstrates how to create an AIAgent using OpenAI Responses as the underlying inference service|

@@ -25,7 +25,7 @@ public static class AssistantExtensions
            throw new ArgumentNullException(nameof(assistantClientResult));
        }

-        return AsAIAgent(assistantClientResult, assistantClient, chatOptions);
+        return AsAIAgent(assistantClientResult.Value, assistantClient, chatOptions);
    }

    /// <summary>