test

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/ActorFrameworkWebApplicationExtensions.cs

@@ -0,0 +1,40 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System.Diagnostics.CodeAnalysis;
+using System.Text.Json.Serialization;
+using Microsoft.Agents.AI;
+
+namespace AgentWebChat.AgentHost;
+
+internal static class ActorFrameworkWebApplicationExtensions
+{
+    public static void MapAgentDiscovery(this IEndpointRouteBuilder endpoints, [StringSyntax("Route")] string path)
+    {
+        var registeredAIAgents = endpoints.ServiceProvider.GetKeyedServices<AIAgent>(KeyedService.AnyKey);
+
+        var routeGroup = endpoints.MapGroup(path);
+        routeGroup.MapGet("/", async (CancellationToken cancellationToken) =>
+        {
+            var results = new List<AgentDiscoveryCard>();
+            foreach (var result in registeredAIAgents)
+            {
+                results.Add(new AgentDiscoveryCard
+                {
+                    Name = result.Name!,
+                    Description = result.Description,
+                });
+            }
+
+            return Results.Ok(results);
+        })
+        .WithName("GetAgents");
+    }
+
+    internal sealed class AgentDiscoveryCard
+    {
+        public required string Name { get; set; }
+
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        public string? Description { get; set; }
+    }
+}

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/AgentWebChat.AgentHost.csproj

@@ -0,0 +1,33 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFrameworks>net10.0</TargetFrameworks>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.DevUI\Microsoft.Agents.AI.DevUI.csproj" />
+    <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.Workflows\Microsoft.Agents.AI.Workflows.csproj" />
+    <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.Abstractions\Microsoft.Agents.AI.Abstractions.csproj" />
+    <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.Hosting\Microsoft.Agents.AI.Hosting.csproj" />
+    <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI\Microsoft.Agents.AI.csproj" />
+    <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.Hosting.A2A.AspNetCore\Microsoft.Agents.AI.Hosting.A2A.AspNetCore.csproj" />
+    <ProjectReference Include="..\..\..\src\Microsoft.Agents.AI.Hosting.OpenAI\Microsoft.Agents.AI.Hosting.OpenAI.csproj" />
+    <ProjectReference Include="..\AgentWebChat.ServiceDefaults\AgentWebChat.ServiceDefaults.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Aspire.Azure.AI.OpenAI" />
+    <PackageReference Include="Aspire.Hosting.Azure.CognitiveServices" />
+    <PackageReference Include="Aspire.Microsoft.Azure.Cosmos" />
+    <PackageReference Include="CommunityToolkit.Aspire.OllamaSharp" />
+    <PackageReference Include="Microsoft.Extensions.AI" />
+    <PackageReference Include="Microsoft.Extensions.AI.Abstractions" />
+    <PackageReference Include="Microsoft.Extensions.AI.OpenAI" />
+    <PackageReference Include="Microsoft.AspNetCore.OpenAPI" />
+    <PackageReference Include="Swashbuckle.AspNetCore.SwaggerUI" />
+  </ItemGroup>
+
+</Project>

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Custom/CustomAITools.cs

@@ -0,0 +1,15 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using Microsoft.Extensions.AI;
+
+namespace AgentWebChat.AgentHost.Custom;
+
+public class CustomAITool : AITool;
+
+public class CustomFunctionTool : AIFunction
+{
+    protected override ValueTask<object?> InvokeCoreAsync(AIFunctionArguments arguments, CancellationToken cancellationToken)
+    {
+        return new ValueTask<object?>(arguments.Context?.Count ?? 0);
+    }
+}

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Program.cs

@@ -0,0 +1,181 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using A2A.AspNetCore;
+using AgentWebChat.AgentHost;
+using AgentWebChat.AgentHost.Custom;
+using AgentWebChat.AgentHost.Utilities;
+using Microsoft.Agents.AI;
+using Microsoft.Agents.AI.DevUI;
+using Microsoft.Agents.AI.Hosting;
+using Microsoft.Agents.AI.Workflows;
+using Microsoft.Extensions.AI;
+
+var builder = WebApplication.CreateBuilder(args);
+
+// Add service defaults & Aspire client integrations.
+builder.AddServiceDefaults();
+builder.Services.AddOpenApi();
+
+// Add services to the container.
+builder.Services.AddProblemDetails();
+
+// Configure the chat model and our agent.
+builder.AddKeyedChatClient("chat-model");
+
+// Add DevUI services
+builder.AddDevUI();
+
+// Add OpenAI services
+builder.AddOpenAIChatCompletions();
+builder.AddOpenAIResponses();
+
+var pirateAgentBuilder = builder.AddAIAgent(
+    "pirate",
+    instructions: "You are a pirate. Speak like a pirate",
+    description: "An agent that speaks like a pirate.",
+    chatClientServiceKey: "chat-model")
+    .WithAITool(new CustomAITool())
+    .WithAITool(new CustomFunctionTool())
+    .WithInMemoryThreadStore();
+
+var knightsKnavesAgentBuilder = builder.AddAIAgent("knights-and-knaves", (sp, key) =>
+{
+    var chatClient = sp.GetRequiredKeyedService<IChatClient>("chat-model");
+
+    ChatClientAgent knight = new(
+        chatClient,
+        """
+        You are a knight. This means that you must always tell the truth. Your name is Alice.
+        Bob is standing next to you. Bob is a knave, which means he always lies.
+        When replying, always start with your name (Alice). Eg, "Alice: I am a knight."
+        """, "Alice");
+
+    ChatClientAgent knave = new(
+        chatClient,
+        """
+        You are a knave. This means that you must always lie. Your name is Bob.
+        Alice is standing next to you. Alice is a knight, which means she always tells the truth.
+        When replying, always include your name (Bob). Eg, "Bob: I am a knight."
+        """, "Bob");
+
+    ChatClientAgent narrator = new(
+        chatClient,
+        """
+        You are are the narrator of a puzzle involving knights (who always tell the truth) and knaves (who always lie).
+        The user is going to ask questions and guess whether Alice or Bob is the knight or knave.
+        Alice is standing to one side of you. Alice is a knight, which means she always tells the truth.
+        Bob is standing to the other side of you. Bob is a knave, which means he always lies.
+        When replying, always include your name (Narrator).
+        Once the user has deduced what type (knight or knave) both Alice and Bob are, tell them whether they are right or wrong.
+        If the user asks a general question about their surrounding, make something up which is consistent with the scenario.
+        """, "Narrator");
+
+    return AgentWorkflowBuilder.BuildConcurrent([knight, knave, narrator]).AsAgent(name: key);
+});
+
+// Workflow consisting of multiple specialized agents
+var chemistryAgent = builder.AddAIAgent("chemist",
+    instructions: "You are a chemistry expert. Answer thinking from the chemistry perspective",
+    description: "An agent that helps with chemistry.",
+    chatClientServiceKey: "chat-model");
+
+var mathsAgent = builder.AddAIAgent("mathematician",
+    instructions: "You are a mathematics expert. Answer thinking from the maths perspective",
+    description: "An agent that helps with mathematics.",
+    chatClientServiceKey: "chat-model");
+
+var literatureAgent = builder.AddAIAgent("literator",
+    instructions: "You are a literature expert. Answer thinking from the literature perspective",
+    description: "An agent that helps with literature.",
+    chatClientServiceKey: "chat-model");
+
+var scienceSequentialWorkflow = builder.AddWorkflow("science-sequential-workflow", (sp, key) =>
+{
+    List<IHostedAgentBuilder> usedAgents = [chemistryAgent, mathsAgent, literatureAgent];
+    var agents = usedAgents.Select(ab => sp.GetRequiredKeyedService<AIAgent>(ab.Name));
+    return AgentWorkflowBuilder.BuildSequential(workflowName: key, agents: agents);
+}).AddAsAIAgent();
+
+var scienceConcurrentWorkflow = builder.AddWorkflow("science-concurrent-workflow", (sp, key) =>
+{
+    List<IHostedAgentBuilder> usedAgents = [chemistryAgent, mathsAgent, literatureAgent];
+    var agents = usedAgents.Select(ab => sp.GetRequiredKeyedService<AIAgent>(ab.Name));
+    return AgentWorkflowBuilder.BuildConcurrent(workflowName: key, agents: agents);
+}).AddAsAIAgent();
+
+builder.AddWorkflow("nonAgentWorkflow", (sp, key) =>
+{
+    List<IHostedAgentBuilder> usedAgents = [pirateAgentBuilder, chemistryAgent];
+    var agents = usedAgents.Select(ab => sp.GetRequiredKeyedService<AIAgent>(ab.Name));
+    return AgentWorkflowBuilder.BuildSequential(workflowName: key, agents: agents);
+});
+
+builder.Services.AddKeyedSingleton("NonAgentAndNonmatchingDINameWorkflow", (sp, key) =>
+{
+    List<IHostedAgentBuilder> usedAgents = [pirateAgentBuilder, chemistryAgent];
+    var agents = usedAgents.Select(ab => sp.GetRequiredKeyedService<AIAgent>(ab.Name));
+    return AgentWorkflowBuilder.BuildSequential(workflowName: "random-name", agents: agents);
+});
+
+builder.Services.AddSingleton<AIAgent>(sp =>
+{
+    var chatClient = sp.GetRequiredKeyedService<IChatClient>("chat-model");
+    return new ChatClientAgent(chatClient, name: "default-agent", instructions: "you are a default agent.");
+});
+
+builder.Services.AddKeyedSingleton<AIAgent>("my-di-nonmatching-agent", (sp, name) =>
+{
+    var chatClient = sp.GetRequiredKeyedService<IChatClient>("chat-model");
+    return new ChatClientAgent(
+        chatClient,
+        name: "some-random-name", // demonstrating registration can be different for DI and actual agent
+        instructions: "you are a dependency inject agent. Tell me all about dependency injection.");
+});
+
+builder.Services.AddKeyedSingleton<AIAgent>("my-di-matchingname-agent", (sp, name) =>
+{
+    if (name is not string nameStr)
+    {
+        throw new NotSupportedException("Name should be passed as a key");
+    }
+
+    var chatClient = sp.GetRequiredKeyedService<IChatClient>("chat-model");
+    return new ChatClientAgent(
+        chatClient,
+        name: nameStr, // demonstrating registration with the same name
+        instructions: "you are a dependency inject agent. Tell me all about dependency injection.");
+});
+
+var app = builder.Build();
+
+app.MapOpenApi();
+app.UseSwaggerUI(options => options.SwaggerEndpoint("/openapi/v1.json", "Agents API"));
+
+// Configure the HTTP request pipeline.
+app.UseExceptionHandler();
+
+// attach a2a with simple message communication
+app.MapA2A(pirateAgentBuilder, path: "/a2a/pirate");
+app.MapA2A(knightsKnavesAgentBuilder, path: "/a2a/knights-and-knaves", agentCard: new()
+{
+    Name = "Knights and Knaves",
+    Description = "An agent that helps you solve the knights and knaves puzzle.",
+    Version = "1.0",
+
+    // Url can be not set, and SDK will help assign it.
+    // Url = "http://localhost:5390/a2a/knights-and-knaves"
+});
+
+app.MapDevUI();
+
+app.MapOpenAIResponses();
+app.MapOpenAIConversations();
+
+app.MapOpenAIChatCompletions(pirateAgentBuilder);
+app.MapOpenAIChatCompletions(knightsKnavesAgentBuilder);
+
+// Map the agents HTTP endpoints
+app.MapAgentDiscovery("/agents");
+
+app.MapDefaultEndpoints();
+app.Run();

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Properties/launchSettings.json

@@ -0,0 +1,25 @@
+{
+  "$schema": "https://json.schemastore.org/launchsettings.json",
+  "profiles": {
+    "http": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "applicationUrl": "http://localhost:5390",
+      "launchUrl": "swagger",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    },
+    "https": {
+      "commandName": "Project",
+      "dotnetRunMessages": true,
+      "launchBrowser": false,
+      "launchUrl": "swagger",
+      "applicationUrl": "https://localhost:7373;http://localhost:5390",
+      "environmentVariables": {
+        "ASPNETCORE_ENVIRONMENT": "Development"
+      }
+    }
+  }
+}

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Utilities/ChatClientConnectionInfo.cs

@@ -0,0 +1,80 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using System.Data.Common;
+using System.Diagnostics.CodeAnalysis;
+
+namespace AgentWebChat.AgentHost.Utilities;
+
+public class ChatClientConnectionInfo
+{
+    public Uri? Endpoint { get; init; }
+    public required string SelectedModel { get; init; }
+
+    public ClientChatProvider Provider { get; init; }
+    public string? AccessKey { get; init; }
+
+    // Example connection string:
+    // Endpoint=https://localhost:4523;Model=phi3.5;AccessKey=1234;Provider=ollama;
+    public static bool TryParse(string? connectionString, [NotNullWhen(true)] out ChatClientConnectionInfo? settings)
+    {
+        if (string.IsNullOrEmpty(connectionString))
+        {
+            settings = null;
+            return false;
+        }
+
+        var connectionBuilder = new DbConnectionStringBuilder
+        {
+            ConnectionString = connectionString
+        };
+
+        Uri? endpoint = null;
+        if (connectionBuilder.ContainsKey("Endpoint") && Uri.TryCreate(connectionBuilder["Endpoint"].ToString(), UriKind.Absolute, out endpoint))
+        {
+        }
+
+        string? model = null;
+        if (connectionBuilder.ContainsKey("Model"))
+        {
+            model = (string)connectionBuilder["Model"];
+        }
+
+        string? accessKey = null;
+        if (connectionBuilder.ContainsKey("AccessKey"))
+        {
+            accessKey = (string)connectionBuilder["AccessKey"];
+        }
+
+        var provider = ClientChatProvider.Unknown;
+        if (connectionBuilder.ContainsKey("Provider"))
+        {
+            var providerValue = (string)connectionBuilder["Provider"];
+            Enum.TryParse(providerValue, ignoreCase: true, out provider);
+        }
+
+        if ((endpoint is null && provider != ClientChatProvider.OpenAI) || model is null || provider is ClientChatProvider.Unknown)
+        {
+            settings = null;
+            return false;
+        }
+
+        settings = new ChatClientConnectionInfo
+        {
+            Endpoint = endpoint,
+            SelectedModel = model,
+            AccessKey = accessKey,
+            Provider = provider
+        };
+
+        return true;
+    }
+}
+
+public enum ClientChatProvider
+{
+    Unknown,
+    Ollama,
+    OpenAI,
+    AzureOpenAI,
+    AzureAIInference,
+}

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/Utilities/ChatClientExtensions.cs

@@ -0,0 +1,106 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+using AgentWebChat.AgentHost.Utilities;
+using Microsoft.Extensions.AI;
+using OllamaSharp;
+
+namespace AgentWebChat.AgentHost.Utilities;
+
+public static class ChatClientExtensions
+{
+    public static ChatClientBuilder AddChatClient(this IHostApplicationBuilder builder, string connectionName)
+    {
+        var cs = builder.Configuration.GetConnectionString(connectionName);
+
+        if (!ChatClientConnectionInfo.TryParse(cs, out var connectionInfo))
+        {
+            throw new InvalidOperationException($"Invalid connection string: {cs}. Expected format: 'Endpoint=endpoint;AccessKey=your_access_key;Model=model_name;Provider=ollama/openai/azureopenai;'.");
+        }
+
+        var chatClientBuilder = connectionInfo.Provider switch
+        {
+            ClientChatProvider.Ollama => builder.AddOllamaClient(connectionName, connectionInfo),
+            ClientChatProvider.OpenAI => builder.AddOpenAIClient(connectionName, connectionInfo),
+            ClientChatProvider.AzureOpenAI => builder.AddAzureOpenAIClient(connectionName).AddChatClient(connectionInfo.SelectedModel),
+            _ => throw new NotSupportedException($"Unsupported provider: {connectionInfo.Provider}")
+        };
+
+        // Add OpenTelemetry tracing for the ChatClient activity source
+        chatClientBuilder.UseOpenTelemetry().UseLogging();
+
+        builder.Services.AddOpenTelemetry().WithTracing(t => t.AddSource("Experimental.Microsoft.Extensions.AI"));
+
+        return chatClientBuilder;
+    }
+
+    private static ChatClientBuilder AddOpenAIClient(this IHostApplicationBuilder builder, string connectionName, ChatClientConnectionInfo connectionInfo) =>
+        builder.AddOpenAIClient(connectionName, settings =>
+        {
+            settings.Endpoint = connectionInfo.Endpoint;
+            settings.Key = connectionInfo.AccessKey;
+        })
+        .AddChatClient(connectionInfo.SelectedModel);
+
+    private static ChatClientBuilder AddOllamaClient(this IHostApplicationBuilder builder, string connectionName, ChatClientConnectionInfo connectionInfo)
+    {
+        var httpKey = $"{connectionName}_http";
+
+        builder.Services.AddHttpClient(httpKey, c => c.BaseAddress = connectionInfo.Endpoint);
+
+        return builder.Services.AddChatClient(sp =>
+        {
+            // Create a client for the Ollama API using the http client factory
+            var client = sp.GetRequiredService<IHttpClientFactory>().CreateClient(httpKey);
+
+            return new OllamaApiClient(client, connectionInfo.SelectedModel);
+        });
+    }
+
+    public static ChatClientBuilder AddKeyedChatClient(this IHostApplicationBuilder builder, string connectionName)
+    {
+        var cs = builder.Configuration.GetConnectionString(connectionName);
+
+        if (!ChatClientConnectionInfo.TryParse(cs, out var connectionInfo))
+        {
+            throw new InvalidOperationException($"Invalid connection string: {cs}. Expected format: 'Endpoint=endpoint;AccessKey=your_access_key;Model=model_name;Provider=ollama/openai/azureopenai;'.");
+        }
+
+        var chatClientBuilder = connectionInfo.Provider switch
+        {
+            ClientChatProvider.Ollama => builder.AddKeyedOllamaClient(connectionName, connectionInfo),
+            ClientChatProvider.OpenAI => builder.AddKeyedOpenAIClient(connectionName, connectionInfo),
+            ClientChatProvider.AzureOpenAI => builder.AddKeyedAzureOpenAIClient(connectionName).AddKeyedChatClient(connectionName, connectionInfo.SelectedModel),
+            _ => throw new NotSupportedException($"Unsupported provider: {connectionInfo.Provider}")
+        };
+
+        // Add OpenTelemetry tracing for the ChatClient activity source
+        chatClientBuilder.UseOpenTelemetry().UseLogging();
+
+        builder.Services.AddOpenTelemetry().WithTracing(t => t.AddSource("Experimental.Microsoft.Extensions.AI"));
+
+        return chatClientBuilder;
+    }
+
+    private static ChatClientBuilder AddKeyedOpenAIClient(this IHostApplicationBuilder builder, string connectionName, ChatClientConnectionInfo connectionInfo) =>
+        builder.AddKeyedOpenAIClient(connectionName, settings =>
+        {
+            settings.Endpoint = connectionInfo.Endpoint;
+            settings.Key = connectionInfo.AccessKey;
+        })
+        .AddKeyedChatClient(connectionName, connectionInfo.SelectedModel);
+
+    private static ChatClientBuilder AddKeyedOllamaClient(this IHostApplicationBuilder builder, string connectionName, ChatClientConnectionInfo connectionInfo)
+    {
+        var httpKey = $"{connectionName}_http";
+
+        builder.Services.AddHttpClient(httpKey, c => c.BaseAddress = connectionInfo.Endpoint);
+
+        return builder.Services.AddKeyedChatClient(connectionName, sp =>
+        {
+            // Create a client for the Ollama API using the http client factory
+            var client = sp.GetRequiredService<IHttpClientFactory>().CreateClient(httpKey);
+
+            return new OllamaApiClient(client, connectionInfo.SelectedModel);
+        });
+    }
+}

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/appsettings.Development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

dotnet/samples/AgentWebChat/AgentWebChat.AgentHost/appsettings.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}