test

dotnet/samples/GettingStarted/AgentProviders/Agent_With_CustomImplementation/Agent_With_CustomImplementation.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\Microsoft.Agents.AI.csproj" />
+  </ItemGroup>
+
+</Project>

dotnet/samples/GettingStarted/AgentProviders/Agent_With_CustomImplementation/Program.cs

@@ -0,0 +1,141 @@
+// Copyright (c) Microsoft. All rights reserved.
+
+// This sample shows all the required steps to create a fully custom agent implementation.
+// In this case the agent doesn't use AI at all, and simply parrots back the user input in upper case.
+// You can however, build a fully custom agent that uses AI in any way you want.
+
+using System.Runtime.CompilerServices;
+using System.Text.Json;
+using Microsoft.Agents.AI;
+using Microsoft.Extensions.AI;
+using SampleApp;
+
+AIAgent agent = new UpperCaseParrotAgent();
+
+// Invoke the agent and output the text result.
+Console.WriteLine(await agent.RunAsync("Tell me a joke about a pirate."));
+
+// Invoke the agent with streaming support.
+await foreach (var update in agent.RunStreamingAsync("Tell me a joke about a pirate."))
+{
+    Console.WriteLine(update);
+}
+
+namespace SampleApp
+{
+    // Custom agent that parrot's the user input back in upper case.
+    internal sealed class UpperCaseParrotAgent : AIAgent
+    {
+        public override string? Name => "UpperCaseParrotAgent";
+
+        public override ValueTask<AgentThread> GetNewThreadAsync(CancellationToken cancellationToken = default)
+            => new(new CustomAgentThread());
+
+        public override ValueTask<AgentThread> DeserializeThreadAsync(JsonElement serializedThread, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
+            => new(new CustomAgentThread(serializedThread, jsonSerializerOptions));
+
+        protected override async Task<AgentResponse> RunCoreAsync(IEnumerable<ChatMessage> messages, AgentThread? thread = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default)
+        {
+            // Create a thread if the user didn't supply one.
+            thread ??= await this.GetNewThreadAsync(cancellationToken);
+
+            if (thread is not CustomAgentThread typedThread)
+            {
+                throw new ArgumentException($"The provided thread is not of type {nameof(CustomAgentThread)}.", nameof(thread));
+            }
+
+            // Get existing messages from the store
+            var invokingContext = new ChatMessageStore.InvokingContext(messages);
+            var storeMessages = await typedThread.MessageStore.InvokingAsync(invokingContext, cancellationToken);
+
+            // Clone the input messages and turn them into response messages with upper case text.
+            List<ChatMessage> responseMessages = CloneAndToUpperCase(messages, this.Name).ToList();
+
+            // Notify the thread of the input and output messages.
+            var invokedContext = new ChatMessageStore.InvokedContext(messages, storeMessages)
+            {
+                ResponseMessages = responseMessages
+            };
+            await typedThread.MessageStore.InvokedAsync(invokedContext, cancellationToken);
+
+            return new AgentResponse
+            {
+                AgentId = this.Id,
+                ResponseId = Guid.NewGuid().ToString("N"),
+                Messages = responseMessages
+            };
+        }
+
+        protected override async IAsyncEnumerable<AgentResponseUpdate> RunCoreStreamingAsync(IEnumerable<ChatMessage> messages, AgentThread? thread = null, AgentRunOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
+        {
+            // Create a thread if the user didn't supply one.
+            thread ??= await this.GetNewThreadAsync(cancellationToken);
+
+            if (thread is not CustomAgentThread typedThread)
+            {
+                throw new ArgumentException($"The provided thread is not of type {nameof(CustomAgentThread)}.", nameof(thread));
+            }
+
+            // Get existing messages from the store
+            var invokingContext = new ChatMessageStore.InvokingContext(messages);
+            var storeMessages = await typedThread.MessageStore.InvokingAsync(invokingContext, cancellationToken);
+
+            // Clone the input messages and turn them into response messages with upper case text.
+            List<ChatMessage> responseMessages = CloneAndToUpperCase(messages, this.Name).ToList();
+
+            // Notify the thread of the input and output messages.
+            var invokedContext = new ChatMessageStore.InvokedContext(messages, storeMessages)
+            {
+                ResponseMessages = responseMessages
+            };
+            await typedThread.MessageStore.InvokedAsync(invokedContext, cancellationToken);
+
+            foreach (var message in responseMessages)
+            {
+                yield return new AgentResponseUpdate
+                {
+                    AgentId = this.Id,
+                    AuthorName = message.AuthorName,
+                    Role = ChatRole.Assistant,
+                    Contents = message.Contents,
+                    ResponseId = Guid.NewGuid().ToString("N"),
+                    MessageId = Guid.NewGuid().ToString("N")
+                };
+            }
+        }
+
+        private static IEnumerable<ChatMessage> CloneAndToUpperCase(IEnumerable<ChatMessage> messages, string? agentName) => messages.Select(x =>
+            {
+                // Clone the message and update its author to be the agent.
+                var messageClone = x.Clone();
+                messageClone.Role = ChatRole.Assistant;
+                messageClone.MessageId = Guid.NewGuid().ToString("N");
+                messageClone.AuthorName = agentName;
+
+                // Clone and convert any text content to upper case.
+                messageClone.Contents = x.Contents.Select(c => c switch
+                {
+                    TextContent tc => new TextContent(tc.Text.ToUpperInvariant())
+                    {
+                        AdditionalProperties = tc.AdditionalProperties,
+                        Annotations = tc.Annotations,
+                        RawRepresentation = tc.RawRepresentation
+                    },
+                    _ => c
+                }).ToList();
+
+                return messageClone;
+            });
+
+        /// <summary>
+        /// A thread type for our custom agent that only supports in memory storage of messages.
+        /// </summary>
+        internal sealed class CustomAgentThread : InMemoryAgentThread
+        {
+            internal CustomAgentThread() { }
+
+            internal CustomAgentThread(JsonElement serializedThreadState, JsonSerializerOptions? jsonSerializerOptions = null)
+                : base(serializedThreadState, jsonSerializerOptions) { }
+        }
+    }
+}

dotnet/samples/GettingStarted/AgentProviders/Agent_With_CustomImplementation/README.md

@@ -0,0 +1,16 @@
+# Agent with Custom Implementation
+
+This sample demonstrates how to create a fully custom agent implementation without relying on external AI services.
+
+## Overview
+
+The sample creates a simple "parrot" agent that:
+- Converts user input to uppercase
+- Supports both synchronous and streaming invocation modes
+- Demonstrates the complete implementation requirements for a custom agent
+
+This pattern is useful when you need to:
+- Integrate with custom AI models or services
+- Create rule-based agents without AI
+- Build agents with specific custom logic
+