test

dotnet/samples/GettingStarted/FoundryAgents/FoundryAgents_Step13_Plugins/FoundryAgents_Step13_Plugins.csproj

@@ -0,0 +1,22 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFrameworks>net10.0</TargetFrameworks>
+
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <NoWarn>$(NoWarn);CA1812</NoWarn>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" />
+    <PackageReference Include="Azure.Identity" />
+    <PackageReference Include="Azure.AI.Projects" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\..\src\Microsoft.Agents.AI.AzureAI\Microsoft.Agents.AI.AzureAI.csproj" />
+  </ItemGroup>
+  
+</Project>

dotnet/samples/GettingStarted/FoundryAgents/FoundryAgents_Step13_Plugins/Program.cs

@@ -0,0 +1,139 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+// This sample shows how to use plugins with an AI agent. Plugin classes can
+// depend on other services that need to be injected. In this sample, the
+// AgentPlugin class uses the WeatherProvider and CurrentTimeProvider classes
+// to get weather and current time information. Both services are registered
+// in the service collection and injected into the plugin.
+// Plugin classes may have many methods, but only some are intended to be used
+// as AI functions. The AsAITools method of the plugin class shows how to specify
+// which methods should be exposed to the AI agent.
+
+using Azure.AI.Projects;
+using Azure.Identity;
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+using Microsoft.Extensions.DependencyInjection;
+
+string endpoint = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_ENDPOINT") ?? throw new InvalidOperationException("AZURE_FOUNDRY_PROJECT_ENDPOINT is not set.");
+string deploymentName = Environment.GetEnvironmentVariable("AZURE_FOUNDRY_PROJECT_DEPLOYMENT_NAME") ?? "gpt-4o-mini";
+
+const string AssistantInstructions = "You are a helpful assistant that helps people find information.";
+const string AssistantName = "PluginAssistant";
+
+// Create a service collection to hold the agent plugin and its dependencies.
+ServiceCollection services = new();
+services.AddSingleton<WeatherProvider>();
+services.AddSingleton<CurrentTimeProvider>();
+services.AddSingleton<AgentPlugin>(); // The plugin depends on WeatherProvider and CurrentTimeProvider registered above.
+
+IServiceProvider serviceProvider = services.BuildServiceProvider();
+
+// Get a client to create/retrieve/delete server side agents with Azure Foundry Agents.
+AIProjectClient aiProjectClient = new(new Uri(endpoint), new AzureCliCredential());
+
+// Define the agent with plugin tools
+// Define the agent you want to create. (Prompt Agent in this case)
+AIAgent agent = await aiProjectClient.CreateAIAgentAsync(
+    name: AssistantName,
+    model: deploymentName,
+    instructions: AssistantInstructions,
+    tools: serviceProvider.GetRequiredService<AgentPlugin>().AsAITools().ToList(),
+    services: serviceProvider);
+
+// Invoke the agent and output the text result.
+AgentThread thread = await agent.GetNewThreadAsync();
+Console.WriteLine(await agent.RunAsync("Tell me current time and weather in Seattle.", thread));
+
+// Cleanup by agent name removes the agent version created.
+await aiProjectClient.Agents.DeleteAgentAsync(agent.Name);
+
+/// <summary>
+/// The agent plugin that provides weather and current time information.
+/// </summary>
+/// <param name="weatherProvider">The weather provider to get weather information.</param>
+internal sealed class AgentPlugin(WeatherProvider weatherProvider)
+{
+    /// <summary>
+    /// Gets the weather information for the specified location.
+    /// </summary>
+    /// <remarks>
+    /// This method demonstrates how to use the dependency that was injected into the plugin class.
+    /// </remarks>
+    /// <param name="location">The location to get the weather for.</param>
+    /// <returns>The weather information for the specified location.</returns>
+    public string GetWeather(string location)
+    {
+        return weatherProvider.GetWeather(location);
+    }
+
+    /// <summary>
+    /// Gets the current date and time for the specified location.
+    /// </summary>
+    /// <remarks>
+    /// This method demonstrates how to resolve a dependency using the service provider passed to the method.
+    /// </remarks>
+    /// <param name="sp">The service provider to resolve the <see cref="CurrentTimeProvider"/>.</param>
+    /// <param name="location">The location to get the current time for.</param>
+    /// <returns>The current date and time as a <see cref="DateTimeOffset"/>.</returns>
+    public DateTimeOffset GetCurrentTime(IServiceProvider sp, string location)
+    {
+        // Resolve the CurrentTimeProvider from the service provider
+        CurrentTimeProvider currentTimeProvider = sp.GetRequiredService<CurrentTimeProvider>();
+
+        return currentTimeProvider.GetCurrentTime(location);
+    }
+
+    /// <summary>
+    /// Returns the functions provided by this plugin.
+    /// </summary>
+    /// <remarks>
+    /// In real world scenarios, a class may have many methods and only a subset of them may be intended to be exposed as AI functions.
+    /// This method demonstrates how to explicitly specify which methods should be exposed to the AI agent.
+    /// </remarks>
+    /// <returns>The functions provided by this plugin.</returns>
+    public IEnumerable<AITool> AsAITools()
+    {
+        yield return AIFunctionFactory.Create(this.GetWeather);
+        yield return AIFunctionFactory.Create(this.GetCurrentTime);
+    }
+}
+
+/// <summary>
+/// The weather provider that returns weather information.
+/// </summary>
+internal sealed class WeatherProvider
+{
+    /// <summary>
+    /// Gets the weather information for the specified location.
+    /// </summary>
+    /// <remarks>
+    /// The weather information is hardcoded for demonstration purposes.
+    /// In a real application, this could call a weather API to get actual weather data.
+    /// </remarks>
+    /// <param name="location">The location to get the weather for.</param>
+    /// <returns>The weather information for the specified location.</returns>
+    public string GetWeather(string location)
+    {
+        return $"The weather in {location} is cloudy with a high of 15°C.";
+    }
+}
+
+/// <summary>
+/// Provides the current date and time.
+/// </summary>
+/// <remarks>
+/// This class returns the current date and time using the system's clock.
+/// </remarks>
+internal sealed class CurrentTimeProvider
+{
+    /// <summary>
+    /// Gets the current date and time.
+    /// </summary>
+    /// <param name="location">The location to get the current time for (not used in this implementation).</param>
+    /// <returns>The current date and time as a <see cref="DateTimeOffset"/>.</returns>
+    public DateTimeOffset GetCurrentTime(string location)
+    {
+        return DateTimeOffset.Now;
+    }
+}

dotnet/samples/GettingStarted/FoundryAgents/FoundryAgents_Step13_Plugins/README.md

@@ -0,0 +1,49 @@
+# Using Plugins with AI Agents
+
+This sample demonstrates how to use plugins with AI agents, where plugins are services registered in dependency injection that expose methods as AI function tools.
+
+## What this sample demonstrates
+
+- Creating plugin services with methods to expose as tools
+- Using AsAITools() to selectively expose plugin methods
+- Registering plugins in dependency injection
+- Using plugins with AI agents
+- Managing agent lifecycle (creation and deletion)
+
+## Prerequisites
+
+Before you begin, ensure you have the following prerequisites:
+
+- .NET 10 SDK or later
+- Azure Foundry service endpoint and deployment configured
+- Azure CLI installed and authenticated (for Azure credential authentication)
+
+**Note**: This demo uses Azure CLI credentials for authentication. Make sure you're logged in with `az login` and have access to the Azure Foundry resource. For more information, see the [Azure CLI documentation](https://learn.microsoft.com/cli/azure/authenticate-azure-cli-interactively).
+
+Set the following environment variables:
+
+```powershell
+$env:AZURE_FOUNDRY_PROJECT_ENDPOINT="https://your-foundry-service.services.ai.azure.com/api/projects/your-foundry-project" # Replace with your Azure Foundry resource endpoint
+$env:AZURE_FOUNDRY_PROJECT_DEPLOYMENT_NAME="gpt-4o-mini"  # Optional, defaults to gpt-4o-mini
+```
+
+## Run the sample
+
+Navigate to the FoundryAgents sample directory and run:
+
+```powershell
+cd dotnet/samples/GettingStarted/FoundryAgents
+dotnet run --project .\FoundryAgents_Step13_Plugins
+```
+
+## Expected behavior
+
+The sample will:
+
+1. Create a plugin service with methods to expose as tools
+2. Register the plugin in dependency injection
+3. Create an agent named "PluginAgent" with the plugin methods as function tools
+4. Run the agent with a prompt that triggers it to call plugin methods
+5. The agent will invoke the plugin methods to retrieve information
+6. Clean up resources by deleting the agent
+