diff --git a/dotnet/Directory.Packages.props b/dotnet/Directory.Packages.props index 692970636e..7fb6459906 100644 --- a/dotnet/Directory.Packages.props +++ b/dotnet/Directory.Packages.props @@ -53,6 +53,7 @@ + diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/AIAgentChatCompletionsProcessor.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/AIAgentChatCompletionsProcessor.cs index 86eb57b7c3..d9e51b6aa2 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/AIAgentChatCompletionsProcessor.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/AIAgentChatCompletionsProcessor.cs @@ -68,7 +68,7 @@ internal static class AIAgentChatCompletionsProcessor { // The Unix timestamp (in seconds) of when the chat completion was created. Each chunk has the same timestamp. DateTimeOffset? createdAt = null; - var chunkId = IdGeneratorHelpers.NewId(prefix: "chatcmpl", delimiter: "-", stringLength: 13); + var chunkId = IdGenerator.NewId(prefix: "chatcmpl", delimiter: "-", stringLength: 13); await foreach (var agentRunResponseUpdate in agent.RunStreamingAsync(chatMessages, options: options, cancellationToken: cancellationToken).WithCancellation(cancellationToken)) { diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/AgentRunResponseExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/AgentRunResponseExtensions.cs index 9674b261a3..f50aa44d4d 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/AgentRunResponseExtensions.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/AgentRunResponseExtensions.cs @@ -20,7 +20,7 @@ internal static class AgentRunResponseExtensions return new ChatCompletion { - Id = IdGeneratorHelpers.NewId(prefix: "chatcmpl", delimiter: "-", stringLength: 13), + Id = IdGenerator.NewId(prefix: "chatcmpl", delimiter: "-", stringLength: 13), Choices = choices, Created = (agentRunResponse.CreatedAt ?? DateTimeOffset.UtcNow).ToUnixTimeSeconds(), Model = request.Model, diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/Converters/MessageContentPartConverter.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/Converters/MessageContentPartConverter.cs index f646010ac4..1a0a37cdc0 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/Converters/MessageContentPartConverter.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ChatCompletions/Converters/MessageContentPartConverter.cs @@ -8,6 +8,14 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.ChatCompletions.Converters; internal static class MessageContentPartConverter { + private static string AudioFormatToMediaType(string format) => + format.Equals("mp3", StringComparison.OrdinalIgnoreCase) ? "audio/mpeg" : + format.Equals("wav", StringComparison.OrdinalIgnoreCase) ? "audio/wav" : + format.Equals("opus", StringComparison.OrdinalIgnoreCase) ? "audio/opus" : + format.Equals("aac", StringComparison.OrdinalIgnoreCase) ? "audio/aac" : + format.Equals("flac", StringComparison.OrdinalIgnoreCase) ? "audio/flac" : + format.Equals("pcm16", StringComparison.OrdinalIgnoreCase) ? "audio/pcm" : + "audio/*"; public static AIContent? ToAIContent(MessageContentPart part) { return part switch @@ -23,16 +31,7 @@ internal static class MessageContentPartConverter // audio AudioContentPart audioPart => - new DataContent(audioPart.InputAudio.Data, audioPart.InputAudio.Format.ToUpperInvariant() switch - { - "MP3" => "audio/mpeg", - "WAV" => "audio/wav", - "OPUS" => "audio/opus", - "AAC" => "audio/aac", - "FLAC" => "audio/flac", - "PCM16" => "audio/pcm", - _ => "audio/*" - }), + new DataContent(audioPart.InputAudio.Data, AudioFormatToMediaType(audioPart.InputAudio.Format)), // file FileContentPart filePart when !string.IsNullOrEmpty(filePart.File.FileId) diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/ConversationsHttpHandler.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/ConversationsHttpHandler.cs new file mode 100644 index 0000000000..474bec9699 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/ConversationsHttpHandler.cs @@ -0,0 +1,342 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Mvc; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations; + +/// +/// Handles route requests for OpenAI Conversations API endpoints. +/// +internal sealed class ConversationsHttpHandler +{ + private readonly IConversationStorage _storage; + private readonly IAgentConversationIndex? _conversationIndex; + + /// + /// Initializes a new instance of the class. + /// + /// The conversation storage service. + /// Optional conversation index service. + public ConversationsHttpHandler(IConversationStorage storage, IAgentConversationIndex? conversationIndex) + { + this._storage = storage ?? throw new ArgumentNullException(nameof(storage)); + this._conversationIndex = conversationIndex; + } + + /// + /// Lists conversations by agent ID. + /// + public async Task ListConversationsByAgentAsync( + [FromQuery] string? agent_id, + CancellationToken cancellationToken) + { + if (string.IsNullOrEmpty(agent_id)) + { + return Results.BadRequest(new ErrorResponse + { + Error = new ErrorDetails + { + Message = "agent_id query parameter is required.", + Type = "invalid_request_error" + } + }); + } + + // Return empty list if conversation index is not registered + if (this._conversationIndex == null) + { + return Results.Ok(new ListResponse + { + Data = [], + HasMore = false + }); + } + + var conversationIdsResponse = await this._conversationIndex.GetConversationIdsAsync(agent_id, cancellationToken).ConfigureAwait(false); + + // Fetch full conversation objects + var conversations = new List(); + foreach (var conversationId in conversationIdsResponse.Data) + { + var conversation = await this._storage.GetConversationAsync(conversationId, cancellationToken).ConfigureAwait(false); + if (conversation is not null) + { + conversations.Add(conversation); + } + } + + return Results.Ok(new ListResponse + { + Data = conversations, + HasMore = false + }); + } + + /// + /// Creates a new conversation. + /// + public async Task CreateConversationAsync( + [FromBody] CreateConversationRequest request, + CancellationToken cancellationToken) + { + Dictionary metadata = request.Metadata ?? []; + var idGenerator = new IdGenerator(responseId: null, conversationId: null); + var conversation = new Conversation + { + Id = idGenerator.ConversationId, + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = metadata + }; + + var created = await this._storage.CreateConversationAsync(conversation, cancellationToken).ConfigureAwait(false); + + // Add initial items if provided + if (request.Items is { Count: > 0 }) + { + List itemsToAdd = [.. request.Items.Select(itemParam => itemParam.ToItemResource(idGenerator))]; + await this._storage.AddItemsAsync(created.Id, itemsToAdd, cancellationToken).ConfigureAwait(false); + } + + // Add to conversation index if available and agent_id is provided in metadata + if (this._conversationIndex != null && created.Metadata.TryGetValue("agent_id", out var agentId) && !string.IsNullOrEmpty(agentId)) + { + await this._conversationIndex.AddConversationAsync(agentId, created.Id, cancellationToken).ConfigureAwait(false); + } + + return Results.Ok(created); + } + + /// + /// Retrieves a conversation by ID. + /// + public async Task GetConversationAsync( + string conversationId, + CancellationToken cancellationToken) + { + var conversation = await this._storage.GetConversationAsync(conversationId, cancellationToken).ConfigureAwait(false); + return conversation is not null + ? Results.Ok(conversation) + : Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Conversation '{conversationId}' not found.", + Type = "invalid_request_error" + } + }); + } + + /// + /// Updates a conversation's metadata. + /// + public async Task UpdateConversationAsync( + string conversationId, + [FromBody] UpdateConversationRequest request, + CancellationToken cancellationToken) + { + var existing = await this._storage.GetConversationAsync(conversationId, cancellationToken).ConfigureAwait(false); + if (existing is null) + { + return Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Conversation '{conversationId}' not found.", + Type = "invalid_request_error" + } + }); + } + + var updated = existing with + { + Metadata = request.Metadata + }; + + var result = await this._storage.UpdateConversationAsync(updated, cancellationToken).ConfigureAwait(false); + return Results.Ok(result); + } + + /// + /// Deletes a conversation and all its messages. + /// + public async Task DeleteConversationAsync( + string conversationId, + CancellationToken cancellationToken) + { + // Get conversation first to retrieve agent_id for index removal + var conversation = await this._storage.GetConversationAsync(conversationId, cancellationToken).ConfigureAwait(false); + + var deleted = await this._storage.DeleteConversationAsync(conversationId, cancellationToken).ConfigureAwait(false); + if (!deleted) + { + return Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Conversation '{conversationId}' not found.", + Type = "invalid_request_error" + } + }); + } + + // Remove from conversation index if available and agent_id was present in metadata + if (this._conversationIndex != null && conversation?.Metadata.TryGetValue("agent_id", out var agentId) == true && !string.IsNullOrEmpty(agentId)) + { + await this._conversationIndex.RemoveConversationAsync(agentId, conversationId, cancellationToken).ConfigureAwait(false); + } + + return Results.Ok(new DeleteResponse + { + Id = conversationId, + Object = "conversation.deleted", + Deleted = true + }); + } + + /// + /// Adds items to a conversation. + /// + public async Task CreateItemsAsync( + string conversationId, + [FromBody] CreateItemsRequest request, + [FromQuery] string[]? include, + CancellationToken cancellationToken) + { + var conversation = await this._storage.GetConversationAsync(conversationId, cancellationToken).ConfigureAwait(false); + if (conversation is null) + { + return Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Conversation '{conversationId}' not found.", + Type = "invalid_request_error" + } + }); + } + + var idGenerator = new IdGenerator(responseId: null, conversationId: conversationId); + List createdItems = [.. request.Items.Select(itemParam => itemParam.ToItemResource(idGenerator))]; + await this._storage.AddItemsAsync(conversationId, createdItems, cancellationToken).ConfigureAwait(false); + + return Results.Ok(new ListResponse + { + Data = createdItems, + FirstId = createdItems.Count > 0 ? createdItems[0].Id : null, + LastId = createdItems.Count > 0 ? createdItems[^1].Id : null, + HasMore = false + }); + } + + /// + /// Lists items in a conversation. + /// + public async Task ListItemsAsync( + string conversationId, + [FromQuery] int? limit, + [FromQuery] string? order, + [FromQuery] string? after, + [FromQuery] string[]? include, + CancellationToken cancellationToken) + { + // Validate limit parameter + if (limit is < 1) + { + return Results.BadRequest(new ErrorResponse + { + Error = new ErrorDetails + { + Message = "Invalid value for 'limit': must be a positive integer.", + Type = "invalid_request_error", + Code = "invalid_value" + } + }); + } + + var conversation = await this._storage.GetConversationAsync(conversationId, cancellationToken).ConfigureAwait(false); + if (conversation is null) + { + return Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Conversation '{conversationId}' not found.", + Type = "invalid_request_error" + } + }); + } + + var result = await this._storage.ListItemsAsync(conversationId, limit, ParseOrder(order), after, cancellationToken).ConfigureAwait(false); + return Results.Ok(result); + } + + /// + /// Retrieves a specific item. + /// + public async Task GetItemAsync( + string conversationId, + string itemId, + [FromQuery] string[]? include, + CancellationToken cancellationToken) + { + var item = await this._storage.GetItemAsync(conversationId, itemId, cancellationToken).ConfigureAwait(false); + return item is not null + ? Results.Ok(item) + : Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Item '{itemId}' not found in conversation '{conversationId}'.", + Type = "invalid_request_error" + } + }); + } + + /// + /// Deletes a specific item. + /// + public async Task DeleteItemAsync( + string conversationId, + string itemId, + CancellationToken cancellationToken) + { + var deleted = await this._storage.DeleteItemAsync(conversationId, itemId, cancellationToken).ConfigureAwait(false); + if (!deleted) + { + return Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Item '{itemId}' not found in conversation '{conversationId}'.", + Type = "invalid_request_error" + } + }); + } + + return Results.Ok(new DeleteResponse + { + Id = itemId, + Object = "conversation.item.deleted", + Deleted = true + }); + } + + private static SortOrder? ParseOrder(string? order) + { + if (order is null) + { + return null; + } + + return string.Equals(order, "asc", StringComparison.OrdinalIgnoreCase) ? SortOrder.Ascending : SortOrder.Descending; + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/IAgentConversationIndex.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/IAgentConversationIndex.cs new file mode 100644 index 0000000000..a1e89d1676 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/IAgentConversationIndex.cs @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations; + +/// +/// Optional service for indexing conversations by agent ID. +/// This is a non-standard extension to the OpenAI Conversations API. +/// +internal interface IAgentConversationIndex +{ + /// + /// Adds a conversation to the index for the specified agent. + /// + /// The agent identifier. + /// The conversation identifier. + /// Cancellation token. + /// A task that represents the asynchronous operation. + Task AddConversationAsync(string agentId, string conversationId, CancellationToken cancellationToken = default); + + /// + /// Removes a conversation from the index for the specified agent. + /// + /// The agent identifier. + /// The conversation identifier. + /// Cancellation token. + /// A task that represents the asynchronous operation. + Task RemoveConversationAsync(string agentId, string conversationId, CancellationToken cancellationToken = default); + + /// + /// Gets all conversation IDs for the specified agent. + /// + /// The agent identifier. + /// Cancellation token. + /// A list response containing conversation IDs associated with the agent. + Task> GetConversationIdsAsync(string agentId, CancellationToken cancellationToken = default); +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/IConversationStorage.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/IConversationStorage.cs new file mode 100644 index 0000000000..a289699edb --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/IConversationStorage.cs @@ -0,0 +1,96 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations; + +/// +/// Storage abstraction for conversations and messages. +/// This interface provides operations specifically designed for conversation management, +/// going beyond simple key-value storage to support conversation-specific queries and operations. +/// +internal interface IConversationStorage +{ + /// + /// Creates a new conversation. + /// + /// The conversation to create. + /// Cancellation token. + /// The created conversation. + Task CreateConversationAsync(Conversation conversation, CancellationToken cancellationToken = default); + + /// + /// Retrieves a conversation by ID. + /// + /// The conversation ID. + /// Cancellation token. + /// The conversation if found, null otherwise. + Task GetConversationAsync(string conversationId, CancellationToken cancellationToken = default); + + /// + /// Updates an existing conversation. + /// + /// The conversation with updated values. + /// Cancellation token. + /// The updated conversation if found, null otherwise. + Task UpdateConversationAsync(Conversation conversation, CancellationToken cancellationToken = default); + + /// + /// Deletes a conversation and all its messages. + /// + /// The conversation ID. + /// Cancellation token. + /// True if deleted, false if not found. + Task DeleteConversationAsync(string conversationId, CancellationToken cancellationToken = default); + + // Item operations + + /// + /// Adds multiple items to a conversation atomically. + /// Items are ItemResource objects from the Responses API. + /// + /// The conversation ID to add the items to. + /// The items to add. + /// Cancellation token. + /// A task that completes when all items have been added. + Task AddItemsAsync(string conversationId, IEnumerable items, CancellationToken cancellationToken = default); + + /// + /// Retrieves an item by ID. + /// + /// The conversation ID. + /// The item ID. + /// Cancellation token. + /// The item if found, null otherwise. + Task GetItemAsync(string conversationId, string itemId, CancellationToken cancellationToken = default); + + /// + /// Lists items in a conversation with pagination support. + /// + /// The conversation ID. + /// Maximum number of items to return (default: 20, max: 100). + /// Sort order (default: Descending). + /// Cursor for pagination - return items after this ID. + /// Cancellation token. + /// A list response with items and pagination info. + Task> ListItemsAsync( + string conversationId, + int? limit = null, + SortOrder? order = null, + string? after = null, + CancellationToken cancellationToken = default); + + /// + /// Deletes a specific item from a conversation. + /// + /// The conversation ID. + /// The item ID. + /// Cancellation token. + /// True if deleted, false if not found. + Task DeleteItemAsync(string conversationId, string itemId, CancellationToken cancellationToken = default); +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/InMemoryAgentConversationIndex.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/InMemoryAgentConversationIndex.cs new file mode 100644 index 0000000000..a2e2007dbe --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/InMemoryAgentConversationIndex.cs @@ -0,0 +1,121 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Extensions.Caching.Memory; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations; + +/// +/// In-memory implementation of IAgentConversationIndex for development and testing. +/// This is a non-standard extension to the OpenAI Conversations API. +/// +internal sealed class InMemoryAgentConversationIndex : IAgentConversationIndex, IDisposable +{ + private readonly MemoryCache _cache; + private readonly InMemoryStorageOptions _options; + + private sealed class ConversationSet + { + private readonly HashSet _conversations = []; + private readonly object _lock = new(); + + public void Add(string conversationId) + { + lock (this._lock) + { + this._conversations.Add(conversationId); + } + } + + public bool Remove(string conversationId) + { + lock (this._lock) + { + return this._conversations.Remove(conversationId); + } + } + + public string[] GetAll() + { + lock (this._lock) + { + return [.. this._conversations]; + } + } + } + + public InMemoryAgentConversationIndex() + : this(new InMemoryStorageOptions()) + { + } + + public InMemoryAgentConversationIndex(InMemoryStorageOptions options) + { + ArgumentNullException.ThrowIfNull(options); + this._options = options; + this._cache = new MemoryCache(options.ToMemoryCacheOptions()); + } + + private async Task GetOrCreateConversationSetAsync(string agentId, CancellationToken cancellationToken) + { + var conversationSet = await this._cache.GetOrCreateAtomicAsync( + agentId, + entry => + { + entry.SetOptions(this._options.ToMemoryCacheEntryOptions()); + return new ConversationSet(); + }, + cancellationToken).ConfigureAwait(false); + + return conversationSet!; + } + + /// + public async Task AddConversationAsync(string agentId, string conversationId, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrEmpty(agentId); + ArgumentException.ThrowIfNullOrEmpty(conversationId); + + ConversationSet conversationSet = await this.GetOrCreateConversationSetAsync(agentId, cancellationToken).ConfigureAwait(false); + conversationSet.Add(conversationId); + } + + /// + public async Task RemoveConversationAsync(string agentId, string conversationId, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrEmpty(agentId); + ArgumentException.ThrowIfNullOrEmpty(conversationId); + + if (this._cache.TryGetValue(agentId, out ConversationSet? conversationSet) && conversationSet is not null) + { + conversationSet.Remove(conversationId); + } + } + + /// + public async Task> GetConversationIdsAsync(string agentId, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrEmpty(agentId); + + string[] conversations = (this._cache.TryGetValue(agentId, out ConversationSet? conversationSet) && conversationSet is not null) + ? conversationSet.GetAll() + : []; + + return new ListResponse + { + Data = [.. conversations], + HasMore = false + }; + } + + public void Dispose() + { + // The MemoryCache will call the post-eviction callbacks when disposed, + // which will dispose all ConversationSet instances + this._cache.Dispose(); + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/InMemoryConversationStorage.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/InMemoryConversationStorage.cs new file mode 100644 index 0000000000..11b9dd9f0a --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/InMemoryConversationStorage.cs @@ -0,0 +1,346 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; +using Microsoft.Extensions.Caching.Memory; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations; + +/// +/// In-memory implementation of conversation storage for testing and development. +/// This implementation is thread-safe but data is not persisted across application restarts. +/// +internal sealed class InMemoryConversationStorage : IConversationStorage, IDisposable +{ + private const int DefaultListItemLimit = 20; + + private readonly MemoryCache _cache; + private readonly InMemoryStorageOptions _options; + + public InMemoryConversationStorage() + : this(new InMemoryStorageOptions()) + { + } + + public InMemoryConversationStorage(InMemoryStorageOptions options) + { + ArgumentNullException.ThrowIfNull(options); + this._options = options; + this._cache = new MemoryCache(options.ToMemoryCacheOptions()); + } + + /// + public Task CreateConversationAsync(Conversation conversation, CancellationToken cancellationToken = default) + { + // Check if conversation already exists + if (this._cache.TryGetValue(conversation.Id, out ConversationState? _)) + { + throw new InvalidOperationException($"Conversation with ID '{conversation.Id}' already exists."); + } + + var state = new ConversationState(conversation); + var entryOptions = this._options.ToMemoryCacheEntryOptions(); + this._cache.Set(conversation.Id, state, entryOptions); + return Task.FromResult(conversation); + } + + /// + public Task GetConversationAsync(string conversationId, CancellationToken cancellationToken = default) + { + if (this._cache.TryGetValue(conversationId, out ConversationState? state) && state is not null) + { + return Task.FromResult(state.Conversation); + } + + return Task.FromResult(null); + } + + /// + public Task UpdateConversationAsync(Conversation conversation, CancellationToken cancellationToken = default) + { + if (this._cache.TryGetValue(conversation.Id, out ConversationState? state) && state is not null) + { + state.UpdateConversation(conversation); + // Touch the cache entry to reset expiration + var entryOptions = this._options.ToMemoryCacheEntryOptions(); + this._cache.Set(conversation.Id, state, entryOptions); + return Task.FromResult(conversation); + } + + return Task.FromResult(null); + } + + /// + public Task DeleteConversationAsync(string conversationId, CancellationToken cancellationToken = default) + { + if (this._cache.TryGetValue(conversationId, out _)) + { + this._cache.Remove(conversationId); + return Task.FromResult(true); + } + + return Task.FromResult(false); + } + + /// + public Task AddItemsAsync(string conversationId, IEnumerable items, CancellationToken cancellationToken = default) + { + ArgumentException.ThrowIfNullOrEmpty(conversationId, nameof(conversationId)); + ArgumentNullException.ThrowIfNull(items); + + if (!this._cache.TryGetValue(conversationId, out ConversationState? state) || state is null) + { + throw new InvalidOperationException($"Conversation '{conversationId}' not found."); + } + + foreach (ItemResource item in items) + { + state.AddItem(item); + } + + // Touch the cache entry to reset expiration + var entryOptions = this._options.ToMemoryCacheEntryOptions(); + this._cache.Set(conversationId, state, entryOptions); + return Task.CompletedTask; + } + + /// + public Task GetItemAsync(string conversationId, string itemId, CancellationToken cancellationToken = default) + { + if (this._cache.TryGetValue(conversationId, out ConversationState? state) && state is not null) + { + return Task.FromResult(state.GetItem(itemId)); + } + + return Task.FromResult(null); + } + + /// + public Task> ListItemsAsync( + string conversationId, + int? limit = null, + SortOrder? order = null, + string? after = null, + CancellationToken cancellationToken = default) + { + int effectiveLimit = Math.Clamp(limit ?? DefaultListItemLimit, 1, 100); + SortOrder effectiveOrder = order ?? SortOrder.Descending; + + if (!this._cache.TryGetValue(conversationId, out ConversationState? state) || state is null) + { + throw new InvalidOperationException($"Conversation '{conversationId}' not found."); + } + + var allItems = state.GetAllItems(); + + // For descending order, reverse the list + if (effectiveOrder == SortOrder.Descending) + { + allItems.Reverse(); + } + + var filtered = allItems.AsEnumerable(); + + if (!string.IsNullOrEmpty(after)) + { + var afterIndex = allItems.FindIndex(m => m.Id == after); + if (afterIndex >= 0) + { + filtered = allItems.Skip(afterIndex + 1); + } + } + + List result; + bool hasMore; + + if (filtered.TryGetNonEnumeratedCount(out int count)) + { + hasMore = count > effectiveLimit; + result = filtered.Take(effectiveLimit).ToList(); + } + else + { + result = filtered.Take(effectiveLimit + 1).ToList(); + hasMore = result.Count > effectiveLimit; + if (hasMore) + { + result = result.Take(effectiveLimit).ToList(); + } + } + + return Task.FromResult(new ListResponse + { + Data = result, + FirstId = result.FirstOrDefault()?.Id, + LastId = result.LastOrDefault()?.Id, + HasMore = hasMore + }); + } + + /// + public Task DeleteItemAsync(string conversationId, string itemId, CancellationToken cancellationToken = default) + { + if (this._cache.TryGetValue(conversationId, out ConversationState? state) && state is not null) + { + var removed = state.RemoveItem(itemId); + if (removed) + { + // Touch the cache entry to reset expiration + var entryOptions = this._options.ToMemoryCacheEntryOptions(); + this._cache.Set(conversationId, state, entryOptions); + } + + return Task.FromResult(removed); + } + + return Task.FromResult(false); + } + + /// + /// Encapsulates per-conversation state including items storage and synchronization. + /// + private sealed class ConversationState + { +#if NET9_0_OR_GREATER + private readonly OrderedDictionary _items = []; + private readonly object _lock = new(); + private Conversation _conversation; + + public ConversationState(Conversation conversation) + { + this._conversation = conversation; + } + + public Conversation Conversation + { + get + { + lock (this._lock) + { + return this._conversation; + } + } + } + + public void UpdateConversation(Conversation conversation) + { + lock (this._lock) + { + this._conversation = conversation; + } + } + + public void AddItem(ItemResource item) + { + lock (this._lock) + { + if (!this._items.TryAdd(item.Id, item)) + { + throw new InvalidOperationException($"Item with ID '{item.Id}' already exists."); + } + } + } + + public ItemResource? GetItem(string itemId) + { + lock (this._lock) + { + this._items.TryGetValue(itemId, out var item); + return item; + } + } + + public List GetAllItems() + { + lock (this._lock) + { + return this._items.Values.ToList(); + } + } + + public bool RemoveItem(string itemId) + { + lock (this._lock) + { + return this._items.Remove(itemId); + } + } +#else + private readonly List _items = []; + private readonly object _lock = new(); + private Conversation _conversation; + + public ConversationState(Conversation conversation) + { + this._conversation = conversation; + } + + public Conversation Conversation + { + get + { + lock (this._lock) + { + return this._conversation; + } + } + } + + public void UpdateConversation(Conversation conversation) + { + lock (this._lock) + { + this._conversation = conversation; + } + } + + public void AddItem(ItemResource item) + { + lock (this._lock) + { + if (this._items.Exists(i => i.Id == item.Id)) + { + throw new InvalidOperationException($"Item with ID '{item.Id}' already exists."); + } + + this._items.Add(item); + } + } + + public ItemResource? GetItem(string itemId) + { + lock (this._lock) + { + return this._items.Find(i => i.Id == itemId); + } + } + + public List GetAllItems() + { + lock (this._lock) + { + return this._items.ToList(); + } + } + + public bool RemoveItem(string itemId) + { + lock (this._lock) + { + return this._items.RemoveAll(i => i.Id == itemId) > 0; + } + } +#endif + } + + public void Dispose() + { + this._cache.Dispose(); + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/AddMessageRequest.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/AddMessageRequest.cs new file mode 100644 index 0000000000..29eac6f1da --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/AddMessageRequest.cs @@ -0,0 +1,21 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Collections.Generic; +using System.Text.Json.Serialization; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; + +/// +/// Request to create items in a conversation. +/// +internal sealed class CreateItemsRequest +{ + /// + /// The items to add to the conversation. You may add up to 20 items at a time. + /// Items should be ItemParam objects (messages without IDs, function call outputs, etc.). + /// The server will assign IDs when creating the items. + /// + [JsonPropertyName("items")] + public required List Items { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/Conversation.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/Conversation.cs new file mode 100644 index 0000000000..ad37894804 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/Conversation.cs @@ -0,0 +1,38 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Text.Json.Serialization; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; + +/// +/// Represents a conversation in the system. +/// +internal sealed record Conversation +{ + /// + /// The unique identifier for the conversation. + /// + [JsonPropertyName("id")] + public required string Id { get; init; } + + /// + /// The object type, always "conversation". + /// + [JsonPropertyName("object")] + [SuppressMessage("Naming", "CA1720:Identifiers should not match keywords", Justification = "Matches OpenAI API specification")] + public string Object => "conversation"; + + /// + /// The Unix timestamp (in seconds) for when the conversation was created. + /// + [JsonPropertyName("created_at")] + public required long CreatedAt { get; init; } + + /// + /// Set of 16 key-value pairs that can be attached to a conversation. + /// + [JsonPropertyName("metadata")] + public Dictionary Metadata { get; init; } = []; +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/CreateConversationRequest.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/CreateConversationRequest.cs new file mode 100644 index 0000000000..1c90946b5f --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/CreateConversationRequest.cs @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Collections.Generic; +using System.Text.Json.Serialization; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; + +/// +/// Request to create a new conversation. +/// +internal sealed class CreateConversationRequest +{ + /// + /// Initial items to include in the conversation context. You may add up to 20 items at a time. + /// Items should be ItemParam objects (messages without IDs, as the server will generate them). + /// + [JsonPropertyName("items")] + public List? Items { get; init; } + + /// + /// Set of 16 key-value pairs that can be attached to a conversation. + /// + [JsonPropertyName("metadata")] + public Dictionary? Metadata { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/UpdateConversationRequest.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/UpdateConversationRequest.cs new file mode 100644 index 0000000000..bc0cc50512 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/Models/UpdateConversationRequest.cs @@ -0,0 +1,18 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Collections.Generic; +using System.Text.Json.Serialization; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; + +/// +/// Request to update an existing conversation. +/// +internal sealed class UpdateConversationRequest +{ + /// + /// Set of 16 key-value pairs that can be attached to a conversation. + /// + [JsonPropertyName("metadata")] + public required Dictionary Metadata { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/SortOrderExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/SortOrderExtensions.cs new file mode 100644 index 0000000000..4f64a99e8f --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Conversations/SortOrderExtensions.cs @@ -0,0 +1,31 @@ +// Copyright (c) Microsoft. All rights reserved. + +using Microsoft.Agents.AI.Hosting.OpenAI.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Conversations; + +/// +/// Extension methods for . +/// +internal static class SortOrderExtensions +{ + /// + /// Converts a to its string representation. + /// + /// The sort order. + /// The string representation ("asc" or "desc"). + public static string ToOrderString(this SortOrder order) + { + return order == SortOrder.Ascending ? "asc" : "desc"; + } + + /// + /// Checks if the sort order is ascending. + /// + /// The sort order. + /// True if ascending, false otherwise. + public static bool IsAscending(this SortOrder order) + { + return order == SortOrder.Ascending; + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/EndpointRouteBuilderExtensions.Conversations.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/EndpointRouteBuilderExtensions.Conversations.cs new file mode 100644 index 0000000000..0c4af2cfb5 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/EndpointRouteBuilderExtensions.Conversations.cs @@ -0,0 +1,73 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Routing; +using Microsoft.Extensions.DependencyInjection; + +namespace Microsoft.AspNetCore.Builder; + +/// +/// Provides extension methods for mapping OpenAI Conversations API to an . +/// +public static partial class MicrosoftAgentAIHostingOpenAIEndpointRouteBuilderExtensions +{ + /// + /// Maps OpenAI Conversations API endpoints to the specified . + /// + /// The to add the OpenAI Conversations endpoints to. + public static IEndpointConventionBuilder MapOpenAIConversations(this IEndpointRouteBuilder endpoints) + { + ArgumentNullException.ThrowIfNull(endpoints); + + var storage = endpoints.ServiceProvider.GetService() + ?? throw new InvalidOperationException("IConversationStorage is not registered. Call AddOpenAIConversations() in your service configuration."); + var conversationIndex = endpoints.ServiceProvider.GetService(); + var handlers = new ConversationsHttpHandler(storage, conversationIndex); + + var group = endpoints.MapGroup("/v1/conversations") + .WithTags("Conversations"); + + // Conversation endpoints + // Non-standard extension: List conversations by agent ID + group.MapGet("", handlers.ListConversationsByAgentAsync) + .WithName("ListConversationsByAgent") + .WithSummary("List conversations for a specific agent (non-standard extension)"); + + group.MapPost("", handlers.CreateConversationAsync) + .WithName("CreateConversation") + .WithSummary("Create a new conversation"); + + group.MapGet("{conversationId}", handlers.GetConversationAsync) + .WithName("GetConversation") + .WithSummary("Retrieve a conversation by ID"); + + group.MapPost("{conversationId}", handlers.UpdateConversationAsync) + .WithName("UpdateConversation") + .WithSummary("Update a conversation's metadata or title"); + + group.MapDelete("{conversationId}", handlers.DeleteConversationAsync) + .WithName("DeleteConversation") + .WithSummary("Delete a conversation and all its messages"); + + // Item endpoints + group.MapPost("{conversationId}/items", handlers.CreateItemsAsync) + .WithName("CreateItems") + .WithSummary("Add items to a conversation"); + + group.MapGet("{conversationId}/items", handlers.ListItemsAsync) + .WithName("ListItems") + .WithSummary("List items in a conversation"); + + group.MapGet("{conversationId}/items/{itemId}", handlers.GetItemAsync) + .WithName("GetItem") + .WithSummary("Retrieve a specific item"); + + group.MapDelete("{conversationId}/items/{itemId}", handlers.DeleteItemAsync) + .WithName("DeleteItem") + .WithSummary("Delete a specific item"); + + return group; + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/EndpointRouteBuilderExtensions.Responses.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/EndpointRouteBuilderExtensions.Responses.cs index 0b89340167..f4159011cf 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/EndpointRouteBuilderExtensions.Responses.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/EndpointRouteBuilderExtensions.Responses.cs @@ -2,12 +2,11 @@ using System; using System.Diagnostics.CodeAnalysis; -using System.Threading; using Microsoft.Agents.AI; +using Microsoft.Agents.AI.Hosting.OpenAI; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations; using Microsoft.Agents.AI.Hosting.OpenAI.Responses; -using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; using Microsoft.AspNetCore.Http; -using Microsoft.AspNetCore.Mvc; using Microsoft.AspNetCore.Routing; using Microsoft.Extensions.DependencyInjection; @@ -43,11 +42,43 @@ public static partial class MicrosoftAgentAIHostingOpenAIEndpointRouteBuilderExt ValidateAgentName(agent.Name); responsesPath ??= $"/{agent.Name}/v1/responses"; + + // Create an executor for this agent + var executor = new AIAgentResponseExecutor(agent); + var storageOptions = endpoints.ServiceProvider.GetService() ?? new InMemoryStorageOptions(); + var conversationStorage = endpoints.ServiceProvider.GetService(); + var responsesService = new InMemoryResponsesService(executor, storageOptions, conversationStorage); + + var handlers = new ResponsesHttpHandler(responsesService); + var group = endpoints.MapGroup(responsesPath); var endpointAgentName = agent.DisplayName; - group.MapPost("/", async ([FromBody] CreateResponse createResponse, CancellationToken cancellationToken) - => await AIAgentResponsesProcessor.CreateModelResponseAsync(agent, createResponse, cancellationToken).ConfigureAwait(false)) - .WithName(endpointAgentName + "/CreateResponse"); + + // Create response endpoint + group.MapPost("/", handlers.CreateResponseAsync) + .WithName(endpointAgentName + "/CreateResponse") + .WithSummary("Creates a model response for the given input"); + + // Get response endpoint + group.MapGet("{responseId}", handlers.GetResponseAsync) + .WithName(endpointAgentName + "/GetResponse") + .WithSummary("Retrieves a response by ID"); + + // Cancel response endpoint + group.MapPost("{responseId}/cancel", handlers.CancelResponseAsync) + .WithName(endpointAgentName + "/CancelResponse") + .WithSummary("Cancels an in-progress response"); + + // Delete response endpoint + group.MapDelete("{responseId}", handlers.DeleteResponseAsync) + .WithName(endpointAgentName + "/DeleteResponse") + .WithSummary("Deletes a response"); + + // List response input items endpoint + group.MapGet("{responseId}/input_items", handlers.ListResponseInputItemsAsync) + .WithName(endpointAgentName + "/ListResponseInputItems") + .WithSummary("Lists the input items for a response"); + return group; } @@ -70,24 +101,37 @@ public static partial class MicrosoftAgentAIHostingOpenAIEndpointRouteBuilderExt ArgumentNullException.ThrowIfNull(endpoints); responsesPath ??= "/v1/responses"; + var responsesService = endpoints.ServiceProvider.GetService() + ?? throw new InvalidOperationException("IResponsesService is not registered. Call AddOpenAIResponses() in your service configuration."); + var handlers = new ResponsesHttpHandler(responsesService); + var group = endpoints.MapGroup(responsesPath); - group.MapPost("/", async ([FromBody] CreateResponse createResponse, IServiceProvider serviceProvider, CancellationToken cancellationToken) => - { - // DevUI uses the 'model' field to specify the agent name. - var agentName = createResponse.Agent?.Name ?? createResponse.Model; - if (agentName is null) - { - return Results.BadRequest("No 'agent.name' or 'model' specified in the request."); - } - var agent = serviceProvider.GetKeyedService(agentName); - if (agent is null) - { - return Results.NotFound($"Agent named '{agentName}' was not found."); - } + // Create response endpoint + group.MapPost("/", handlers.CreateResponseAsync) + .WithName("CreateResponse") + .WithSummary("Creates a model response for the given input"); + + // Get response endpoint + group.MapGet("{responseId}", handlers.GetResponseAsync) + .WithName("GetResponse") + .WithSummary("Retrieves a response by ID"); + + // Cancel response endpoint + group.MapPost("{responseId}/cancel", handlers.CancelResponseAsync) + .WithName("CancelResponse") + .WithSummary("Cancels an in-progress response"); + + // Delete response endpoint + group.MapDelete("{responseId}", handlers.DeleteResponseAsync) + .WithName("DeleteResponse") + .WithSummary("Deletes a response"); + + // List response input items endpoint + group.MapGet("{responseId}/input_items", handlers.ListResponseInputItemsAsync) + .WithName("ListResponseInputItems") + .WithSummary("Lists the input items for a response"); - return await AIAgentResponsesProcessor.CreateModelResponseAsync(agent, createResponse, cancellationToken).ConfigureAwait(false); - }).WithName("CreateResponse"); return group; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/HostApplicationBuilderExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/HostApplicationBuilderExtensions.cs index dc6a9c5ed0..348c83f978 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/HostApplicationBuilderExtensions.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/HostApplicationBuilderExtensions.cs @@ -39,4 +39,18 @@ public static class MicrosoftAgentAIHostingOpenAIHostApplicationBuilderExtension return builder; } + + /// + /// Adds support for exposing instances via OpenAI Responses. + /// + /// The to configure. + /// The for method chaining. + public static IHostApplicationBuilder AddOpenAIConversations(this IHostApplicationBuilder builder) + { + ArgumentNullException.ThrowIfNull(builder); + + builder.Services.AddOpenAIConversations(); + + return builder; + } } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/IdGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/IdGenerator.cs new file mode 100644 index 0000000000..bd35fa8308 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/IdGenerator.cs @@ -0,0 +1,193 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Security.Cryptography; +using System.Text.RegularExpressions; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI; + +/// +/// Generates IDs with partition keys. +/// +internal sealed partial class IdGenerator +{ + private readonly string _partitionId; + private readonly Random? _random; + +#if NET9_0_OR_GREATER + [GeneratedRegex("^[A-Za-z0-9]+$")] + private static partial Regex WatermarkRegex(); +#else + private static readonly Regex s_watermarkRegex = new("^[A-Za-z0-9]+$", RegexOptions.Compiled); + private static Regex WatermarkRegex() => s_watermarkRegex; +#endif + + /// + /// Initializes a new instance of the class. + /// + /// The response ID. + /// The conversation ID. + /// Optional random seed for deterministic ID generation. When null, uses cryptographically secure random generation. + public IdGenerator(string? responseId, string? conversationId, int? randomSeed = null) + { + this._random = randomSeed.HasValue ? new Random(randomSeed.Value) : null; + this.ResponseId = responseId ?? NewId("resp", random: this._random); + this.ConversationId = conversationId ?? NewId("conv", random: this._random); + this._partitionId = GetPartitionIdOrDefault(this.ConversationId) ?? string.Empty; + } + + /// + /// Creates a new ID generator from a create response request. + /// + /// The create response request. + /// A new ID generator. + public static IdGenerator From(CreateResponse request) + { + string? responseId = null; + request.Metadata?.TryGetValue("response_id", out responseId); + return new IdGenerator(responseId, request.Conversation?.Id); + } + + /// + /// Gets the response ID. + /// + public string ResponseId { get; } + + /// + /// Gets the conversation ID. + /// + public string ConversationId { get; } + + /// + /// Generates a new ID. + /// + /// The optional category for the ID. + /// A generated ID string. + public string Generate(string? category = null) + { + var prefix = string.IsNullOrEmpty(category) ? "id" : category; + return NewId(prefix, partitionKey: this._partitionId, random: this._random); + } + + /// + /// Generates a function call ID. + /// + /// A function call ID. + public string GenerateFunctionCallId() => this.Generate("func"); + + /// + /// Generates a function output ID. + /// + /// A function output ID. + public string GenerateFunctionOutputId() => this.Generate("funcout"); + + /// + /// Generates a message ID. + /// + /// A message ID. + public string GenerateMessageId() => this.Generate("msg"); + + /// + /// Generates a reasoning ID. + /// + /// A reasoning ID. + public string GenerateReasoningId() => this.Generate("rs"); + + /// + /// Generates a new ID with a structured format that includes a partition key. + /// + /// The prefix to add to the ID, typically indicating the resource type. + /// The length of the random entropy string in the ID. + /// The length of the partition key if generating a new one. + /// Optional additional text to insert between the prefix and the entropy. + /// Optional text to insert in the middle of the entropy string for traceability. + /// The delimiter character used to separate parts of the ID. + /// An explicit partition key to use. When provided, this value will be used instead of generating a new one. + /// An existing ID to extract the partition key from. When provided, the same partition key will be used instead of generating a new one. + /// The random number generator. + /// A new ID with format "{prefix}{delimiter}{infix}{entropy}{delimiter}{partitionKey}". + /// Thrown when the watermark contains non-alphanumeric characters. + public static string NewId(string prefix, int stringLength = 32, int partitionKeyLength = 16, string infix = "", + string watermark = "", string delimiter = "_", string? partitionKey = null, string partitionKeyHint = "", + Random? random = null) + { + ArgumentOutOfRangeException.ThrowIfLessThan(stringLength, 1); + var entropy = GetRandomString(stringLength, random); + + string pKey = partitionKey ?? GetPartitionIdOrDefault(partitionKeyHint) ?? GetRandomString(partitionKeyLength, random); + + if (!string.IsNullOrEmpty(watermark)) + { + if (!WatermarkRegex().IsMatch(watermark)) + { + throw new ArgumentException($"Only alphanumeric characters may be in watermark: {watermark}", + nameof(watermark)); + } + + entropy = $"{entropy[..(stringLength / 2)]}{watermark}{entropy[(stringLength / 2)..]}"; + } + + infix ??= ""; + prefix = !string.IsNullOrEmpty(prefix) ? $"{prefix}{delimiter}" : ""; + return $"{prefix}{infix}{entropy}{pKey}"; + } + + /// + /// Generates a secure random alphanumeric string of the specified length. + /// When a random seed was provided to the constructor, uses deterministic generation. + /// + /// The desired length of the random string. + /// The optional random number generator. + /// A random alphanumeric string. + /// Thrown when stringLength is less than 1. + private static string GetRandomString(int stringLength, Random? random) + { + const string Chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"; + if (random is not null) + { + // Use deterministic random generation when seed is provided + return string.Create(stringLength, random, static (destination, random) => + { + for (int i = 0; i < destination.Length; i++) + { + destination[i] = Chars[random.Next(Chars.Length)]; + } + }); + } + + // Use cryptographically secure random generation when no seed is provided + return RandomNumberGenerator.GetString(Chars, stringLength); + } + + /// + /// Extracts the partition key from an existing ID, or returns null if extraction fails. + /// + /// The ID to extract the partition key from. + /// The length of the random entropy string in the ID. + /// The length of the partition key if generating a new one. + /// The delimiter character used in the ID. + /// The partition key if successfully extracted; otherwise, null. + private static string? GetPartitionIdOrDefault(string? id, int stringLength = 32, int partitionKeyLength = 16, + string delimiter = "_") + { + if (string.IsNullOrEmpty(id)) + { + return null; + } + + var parts = id.Split([delimiter], StringSplitOptions.RemoveEmptyEntries); + if (parts.Length < 2) + { + return null; + } + + if (parts[1].Length < stringLength + partitionKeyLength) + { + return null; + } + + // get last partitionKeyLength characters from the last part as the partition key + return parts[1][^partitionKeyLength..]; + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/IdGeneratorHelpers.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/IdGeneratorHelpers.cs deleted file mode 100644 index 6f2e1017d6..0000000000 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/IdGeneratorHelpers.cs +++ /dev/null @@ -1,98 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. - -using System; -using System.Security.Cryptography; -using System.Text.RegularExpressions; - -namespace Microsoft.Agents.AI.Hosting.OpenAI; - -/// -/// Shared helpers to generate IDs. -/// -internal static partial class IdGeneratorHelpers -{ -#if NET9_0_OR_GREATER - [GeneratedRegex("^[A-Za-z0-9]+$")] - private static partial Regex WatermarkRegex(); -#else - private static readonly Regex s_watermarkRegex = new("^[A-Za-z0-9]+$", RegexOptions.Compiled); - private static Regex WatermarkRegex() => s_watermarkRegex; -#endif - - /// - /// Generates a new ID with a structured format that includes a partition key. - /// - /// The prefix to add to the ID, typically indicating the resource type. - /// The length of the random entropy string in the ID. - /// The length of the partition key if generating a new one. - /// Optional additional text to insert between the prefix and the entropy. - /// Optional text to insert in the middle of the entropy string for traceability. - /// The delimiter character used to separate parts of the ID. - /// An explicit partition key to use. When provided, this value will be used instead of generating a new one. - /// An existing ID to extract the partition key from. When provided, the same partition key will be used instead of generating a new one. - /// A new ID with format "{prefix}{delimiter}{infix}{entropy}{delimiter}{partitionKey}". - /// Thrown when the watermark contains non-alphanumeric characters. - public static string NewId(string prefix, int stringLength = 32, int partitionKeyLength = 16, string infix = "", - string watermark = "", string delimiter = "_", string? partitionKey = null, string partitionKeyHint = "") - { - ArgumentOutOfRangeException.ThrowIfLessThan(stringLength, 1); - var entropy = GetRandomString(stringLength); - - string pKey = partitionKey ?? GetPartitionIdOrDefault(partitionKeyHint) ?? GetRandomString(partitionKeyLength); - - if (!string.IsNullOrEmpty(watermark)) - { - if (!WatermarkRegex().IsMatch(watermark)) - { - throw new ArgumentException($"Only alphanumeric characters may be in watermark: {watermark}", - nameof(watermark)); - } - - entropy = $"{entropy[..(stringLength / 2)]}{watermark}{entropy[(stringLength / 2)..]}"; - } - - infix ??= ""; - prefix = !string.IsNullOrEmpty(prefix) ? $"{prefix}{delimiter}" : ""; - return $"{prefix}{infix}{entropy}{pKey}"; - } - - /// - /// Generates a secure random alphanumeric string of the specified length. - /// - /// The desired length of the random string. - /// A random alphanumeric string. - /// Thrown when stringLength is less than 1. - public static string GetRandomString(int stringLength) => - RandomNumberGenerator.GetString("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789", stringLength); - - /// - /// Extracts the partition key from an existing ID, or returns null if extraction fails. - /// - /// The ID to extract the partition key from. - /// The length of the random entropy string in the ID. - /// The length of the partition key if generating a new one. - /// The delimiter character used in the ID. - /// The partition key if successfully extracted; otherwise, null. - public static string? GetPartitionIdOrDefault(string? id, int stringLength = 32, int partitionKeyLength = 16, - string delimiter = "_") - { - if (string.IsNullOrEmpty(id)) - { - return null; - } - - var parts = id.Split([delimiter], StringSplitOptions.RemoveEmptyEntries); - if (parts.Length < 2) - { - return null; - } - - if (parts[1].Length < stringLength + partitionKeyLength) - { - return null; - } - - // get last partitionKeyLength characters from the last part as the partition key - return parts[1][^partitionKeyLength..]; - } -} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/InMemoryStorageOptions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/InMemoryStorageOptions.cs new file mode 100644 index 0000000000..f7bb755743 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/InMemoryStorageOptions.cs @@ -0,0 +1,50 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using Microsoft.Extensions.Caching.Memory; + +namespace Microsoft.Agents.AI.Hosting.OpenAI; + +/// +/// Configuration options for in-memory storage implementations. +/// +internal sealed class InMemoryStorageOptions +{ + /// + /// Gets or sets the maximum number of items to store in the cache. + /// Default is 1000. Set to null for no size limit. + /// + public long? SizeLimit { get; set; } = 1000; + + /// + /// Gets or sets the absolute expiration time for items in storage. + /// If specified, items will be expired after this timespan regardless of access. + /// Default is null (no absolute expiration). + /// + public TimeSpan? AbsoluteExpirationRelativeToNow { get; set; } + + /// + /// Gets or sets the sliding expiration for items in storage. + /// Items will be expired if not accessed within this timespan. + /// Default is 1 hour. + /// + public TimeSpan? SlidingExpiration { get; set; } = TimeSpan.FromHours(1); + + /// + /// Creates from these options. + /// + internal MemoryCacheOptions ToMemoryCacheOptions() => new() + { + SizeLimit = this.SizeLimit + }; + + /// + /// Creates from these options. + /// + internal MemoryCacheEntryOptions ToMemoryCacheEntryOptions() => new() + { + AbsoluteExpirationRelativeToNow = this.AbsoluteExpirationRelativeToNow, + SlidingExpiration = this.SlidingExpiration, + Size = 1 + }; +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/MemoryCacheExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/MemoryCacheExtensions.cs new file mode 100644 index 0000000000..670223ef4f --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/MemoryCacheExtensions.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Concurrent; +using System.Diagnostics; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Extensions.Caching.Memory; + +namespace Microsoft.Agents.AI.Hosting.OpenAI; + +/// +/// Extension methods for that provide atomic operations. +/// +/// +/// The standard GetOrCreate method has a race condition where multiple threads can simultaneously +/// detect that a key doesn't exist and create different instances, with only one being cached. +/// See: https://github.com/dotnet/runtime/issues/36499 +/// +internal static class MemoryCacheExtensions +{ + private static readonly ConcurrentDictionary<(IMemoryCache, object), SemaphoreSlim> s_semaphores = new(); + + /// + /// Atomically gets the value associated with this key if it exists, or generates a new entry + /// using the provided key and a value from the given factory if the key is not found. + /// + /// The type of the object to get. + /// The instance this method extends. + /// The key of the entry to look for or create. + /// The factory that creates the value associated with this key if the key does not exist in the cache. + /// The cancellation token. + /// A tuple containing the value and a flag indicating whether it was created (true) or retrieved from cache (false). + public static async Task GetOrCreateAtomicAsync( + this IMemoryCache memoryCache, + object key, + Func factory, + CancellationToken cancellationToken = default) + { + // Fast path: check if the value already exists + if (memoryCache.TryGetValue(key, out object? value)) + { + Debug.Assert(value is not null); + return (T)value; + } + + // Get or create a semaphore for this cache key + bool isOwner = false; + var semaphoreKey = (memoryCache, key); + if (!s_semaphores.TryGetValue(semaphoreKey, out SemaphoreSlim? semaphore)) + { + SemaphoreSlim? createdSemaphore = null; + semaphore = s_semaphores.GetOrAdd(semaphoreKey, _ => createdSemaphore = new SemaphoreSlim(1)); + + // If we created the semaphore that made it into the dictionary, we're the owner + if (ReferenceEquals(createdSemaphore, semaphore)) + { + isOwner = true; + } + else + { + // Our semaphore wasn't the one stored, so dispose it + createdSemaphore?.Dispose(); + } + } + + await semaphore.WaitAsync(cancellationToken).ConfigureAwait(false); + try + { + // Double-check: another thread might have created the value while we were waiting + if (!memoryCache.TryGetValue(key, out value)) + { + ICacheEntry entry = memoryCache.CreateEntry(key); + entry.SetValue(value = factory(entry)); + entry.Dispose(); + Debug.Assert(value is not null); + return (T)value; + } + + Debug.Assert(value is not null); + return (T)value; + } + finally + { + // If we were the owner of the semaphore, remove it from the dictionary + // This prevents memory leaks from accumulating semaphores for evicted cache entries + if (isOwner) + { + s_semaphores.TryRemove(semaphoreKey, out _); + } + + semaphore.Release(); + } + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Microsoft.Agents.AI.Hosting.OpenAI.csproj b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Microsoft.Agents.AI.Hosting.OpenAI.csproj index ee5202c53f..707cc4fe68 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Microsoft.Agents.AI.Hosting.OpenAI.csproj +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Microsoft.Agents.AI.Hosting.OpenAI.csproj @@ -3,7 +3,7 @@ $(ProjectsCoreTargetFrameworks) $(ProjectsDebugCoreTargetFrameworks) - $(NoWarn);OPENAI001 + $(NoWarn);OPENAI001;MEAI001 Microsoft.Agents.AI.Hosting.OpenAI alpha $(InterceptorsNamespaces);Microsoft.AspNetCore.Http.Generated @@ -25,6 +25,7 @@ + diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/DeleteResponse.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/DeleteResponse.cs new file mode 100644 index 0000000000..1a13ce1f8c --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/DeleteResponse.cs @@ -0,0 +1,31 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Diagnostics.CodeAnalysis; +using System.Text.Json.Serialization; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Models; + +/// +/// Response for a delete operation. +/// +internal sealed class DeleteResponse +{ + /// + /// The ID of the deleted object. + /// + [JsonPropertyName("id")] + public required string Id { get; init; } + + /// + /// The object type. + /// + [JsonPropertyName("object")] + [SuppressMessage("Naming", "CA1720:Identifiers should not match keywords", Justification = "Matches OpenAI API specification")] + public required string Object { get; init; } + + /// + /// Whether the object was successfully deleted. + /// + [JsonPropertyName("deleted")] + public required bool Deleted { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/ErrorResponse.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/ErrorResponse.cs new file mode 100644 index 0000000000..9a2417b6af --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/ErrorResponse.cs @@ -0,0 +1,47 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Text.Json.Serialization; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Models; + +/// +/// Represents an error response from the OpenAI APIs. +/// +internal sealed class ErrorResponse +{ + /// + /// Gets the error details. + /// + [JsonPropertyName("error")] + public required ErrorDetails Error { get; init; } +} + +/// +/// Represents the details of an error. +/// +internal sealed class ErrorDetails +{ + /// + /// Gets the error message. + /// + [JsonPropertyName("message")] + public required string Message { get; init; } + + /// + /// Gets the error type. + /// + [JsonPropertyName("type")] + public required string Type { get; init; } + + /// + /// Gets the error code. + /// + [JsonPropertyName("code")] + public string? Code { get; init; } + + /// + /// Gets the parameter that caused the error. + /// + [JsonPropertyName("param")] + public string? Param { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/ListResponse.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/ListResponse.cs new file mode 100644 index 0000000000..dd75ff3e18 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/ListResponse.cs @@ -0,0 +1,45 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; +using System.Text.Json.Serialization; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Models; + +/// +/// Generic list response for paginated results. +/// Used across the OpenAI API for listing resources. +/// +internal sealed class ListResponse +{ + /// + /// The object type, always "list". + /// + [JsonPropertyName("object")] + [SuppressMessage("Naming", "CA1720:Identifiers should not match keywords", Justification = "Matches OpenAI API specification")] + public string Object => "list"; + + /// + /// The list of items. + /// + [JsonPropertyName("data")] + public required List Data { get; init; } + + /// + /// The ID of the first item in the list. + /// + [JsonPropertyName("first_id")] + public string? FirstId { get; init; } + + /// + /// The ID of the last item in the list. + /// + [JsonPropertyName("last_id")] + public string? LastId { get; init; } + + /// + /// Whether there are more items available. + /// + [JsonPropertyName("has_more")] + public required bool HasMore { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/SortOrder.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/SortOrder.cs new file mode 100644 index 0000000000..c3b5e258cd --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Models/SortOrder.cs @@ -0,0 +1,55 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Models; + +/// +/// Specifies the sort order for list operations. +/// +[JsonConverter(typeof(SortOrderJsonConverter))] +internal enum SortOrder +{ + /// + /// Sort in ascending order (oldest to newest). + /// + Ascending, + + /// + /// Sort in descending order (newest to oldest). + /// + Descending +} + +/// +/// Custom JSON converter for SortOrder enum to serialize as "asc" and "desc". +/// +internal sealed class SortOrderJsonConverter : JsonConverter +{ + /// + public override SortOrder Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + var value = reader.GetString(); + return value switch + { + string s when s.Equals("asc", StringComparison.OrdinalIgnoreCase) => SortOrder.Ascending, + string s when s.Equals("desc", StringComparison.OrdinalIgnoreCase) => SortOrder.Descending, + null => throw new JsonException("SortOrder value cannot be null"), + _ => throw new JsonException($"Invalid SortOrder value: {value}") + }; + } + + /// + public override void Write(Utf8JsonWriter writer, SortOrder value, JsonSerializerOptions options) + { + var stringValue = value switch + { + SortOrder.Ascending => "asc", + SortOrder.Descending => "desc", + _ => throw new JsonException($"Invalid SortOrder value: {value}") + }; + writer.WriteStringValue(stringValue); + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesJsonContext.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/OpenAIHostingJsonUtilities.cs similarity index 52% rename from dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesJsonContext.cs rename to dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/OpenAIHostingJsonUtilities.cs index 0b37929b48..ceac8b872f 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesJsonContext.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/OpenAIHostingJsonUtilities.cs @@ -4,16 +4,54 @@ using System.Collections.Generic; using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Serialization; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; -namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; +namespace Microsoft.Agents.AI.Hosting.OpenAI; +/// +/// Provides JSON serialization options and context for OpenAI Hosting APIs to support AOT and trimming. +/// +internal static class OpenAIHostingJsonUtilities +{ + /// + /// Gets the default instance used for OpenAI API serialization. + /// Includes support for AIContent types and all OpenAI-related types. + /// + public static JsonSerializerOptions DefaultOptions { get; } = CreateDefaultOptions(); + + private static JsonSerializerOptions CreateDefaultOptions() + { + JsonSerializerOptions options = new(OpenAIHostingJsonContext.Default.Options); + options.TypeInfoResolverChain.Add(AgentAbstractionsJsonUtilities.DefaultOptions.TypeInfoResolver!); + options.MakeReadOnly(); + return options; + } +} + +/// +/// Provides a unified JSON serialization context for all OpenAI Hosting APIs to support AOT and trimming. +/// Combines Conversations and Responses API types. +/// [JsonSourceGenerationOptions(JsonSerializerDefaults.Web, - DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, - NumberHandling = JsonNumberHandling.AllowReadingFromString, - AllowOutOfOrderMetadataProperties = true, - WriteIndented = false)] -[JsonSerializable(typeof(Dictionary))] + DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, + NumberHandling = JsonNumberHandling.AllowReadingFromString, + AllowOutOfOrderMetadataProperties = true, + WriteIndented = false)] +// Conversations API types +[JsonSerializable(typeof(Conversation))] +[JsonSerializable(typeof(ListResponse))] +[JsonSerializable(typeof(CreateConversationRequest))] +[JsonSerializable(typeof(CreateItemsRequest))] +[JsonSerializable(typeof(UpdateConversationRequest))] +[JsonSerializable(typeof(ListResponse))] +[JsonSerializable(typeof(List))] +// Shared types +[JsonSerializable(typeof(DeleteResponse))] +[JsonSerializable(typeof(ErrorResponse))] +[JsonSerializable(typeof(ErrorDetails))] +// Responses API types [JsonSerializable(typeof(CreateResponse))] [JsonSerializable(typeof(Response))] [JsonSerializable(typeof(StreamingResponseEvent))] @@ -40,11 +78,9 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; [JsonSerializable(typeof(ResponseInput))] [JsonSerializable(typeof(InputMessage))] [JsonSerializable(typeof(List))] -[JsonSerializable(typeof(IReadOnlyList))] [JsonSerializable(typeof(InputMessageContent))] [JsonSerializable(typeof(ResponseStatus))] -[JsonSerializable(typeof(List))] -[JsonSerializable(typeof(IList))] +// ItemResource types [JsonSerializable(typeof(ItemResource))] [JsonSerializable(typeof(ResponsesMessageItemResource))] [JsonSerializable(typeof(ResponsesAssistantMessageItemResource))] @@ -67,8 +103,35 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; [JsonSerializable(typeof(MCPApprovalRequestItemResource))] [JsonSerializable(typeof(MCPApprovalResponseItemResource))] [JsonSerializable(typeof(MCPCallItemResource))] -[JsonSerializable(typeof(IList))] [JsonSerializable(typeof(List))] +// ItemParam types +[JsonSerializable(typeof(ItemParam))] +[JsonSerializable(typeof(ResponsesMessageItemParam))] +[JsonSerializable(typeof(ResponsesUserMessageItemParam))] +[JsonSerializable(typeof(ResponsesAssistantMessageItemParam))] +[JsonSerializable(typeof(ResponsesSystemMessageItemParam))] +[JsonSerializable(typeof(ResponsesDeveloperMessageItemParam))] +[JsonSerializable(typeof(FunctionToolCallItemParam))] +[JsonSerializable(typeof(FunctionToolCallOutputItemParam))] +[JsonSerializable(typeof(FileSearchToolCallItemParam))] +[JsonSerializable(typeof(ComputerToolCallItemParam))] +[JsonSerializable(typeof(ComputerToolCallOutputItemParam))] +[JsonSerializable(typeof(WebSearchToolCallItemParam))] +[JsonSerializable(typeof(ReasoningItemParam))] +[JsonSerializable(typeof(ItemReferenceItemParam))] +[JsonSerializable(typeof(ImageGenerationToolCallItemParam))] +[JsonSerializable(typeof(CodeInterpreterToolCallItemParam))] +[JsonSerializable(typeof(LocalShellToolCallItemParam))] +[JsonSerializable(typeof(LocalShellToolCallOutputItemParam))] +[JsonSerializable(typeof(MCPListToolsItemParam))] +[JsonSerializable(typeof(MCPApprovalRequestItemParam))] +[JsonSerializable(typeof(MCPApprovalResponseItemParam))] +[JsonSerializable(typeof(MCPCallItemParam))] +[JsonSerializable(typeof(List))] +// ItemContent types +[JsonSerializable(typeof(List))] +[JsonSerializable(typeof(IReadOnlyList))] +[JsonSerializable(typeof(ItemContent[]))] [JsonSerializable(typeof(ItemContent))] [JsonSerializable(typeof(ItemContentInputText))] [JsonSerializable(typeof(ItemContentInputAudio))] @@ -82,5 +145,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; [JsonSerializable(typeof(ResponseTextFormatConfigurationText))] [JsonSerializable(typeof(ResponseTextFormatConfigurationJsonObject))] [JsonSerializable(typeof(ResponseTextFormatConfigurationJsonSchema))] +// Common types +[JsonSerializable(typeof(Dictionary))] [ExcludeFromCodeCoverage] -internal sealed partial class ResponsesJsonContext : JsonSerializerContext; +internal sealed partial class OpenAIHostingJsonContext : JsonSerializerContext; diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AIAgentResponseExecutor.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AIAgentResponseExecutor.cs new file mode 100644 index 0000000000..18863034bf --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AIAgentResponseExecutor.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; +using Microsoft.Extensions.AI; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; + +/// +/// Response executor that uses an AIAgent to execute responses locally. +/// This is the default implementation for local execution. +/// +internal sealed class AIAgentResponseExecutor : IResponseExecutor +{ + private readonly AIAgent _agent; + + public AIAgentResponseExecutor(AIAgent agent) + { + ArgumentNullException.ThrowIfNull(agent); + this._agent = agent; + } + + public async IAsyncEnumerable ExecuteAsync( + AgentInvocationContext context, + CreateResponse request, + [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + // Create options with properties from the request + var chatOptions = new ChatOptions + { + ConversationId = request.Conversation?.Id, + Temperature = (float?)request.Temperature, + TopP = (float?)request.TopP, + MaxOutputTokens = request.MaxOutputTokens, + Instructions = request.Instructions, + ModelId = request.Model, + }; + var options = new ChatClientAgentRunOptions(chatOptions); + + // Convert input to chat messages + var messages = new List(); + + foreach (var inputMessage in request.Input.GetInputMessages()) + { + messages.Add(inputMessage.ToChatMessage()); + } + + // Use the extension method to convert streaming updates to streaming response events + await foreach (var streamingEvent in this._agent.RunStreamingAsync(messages, options: options, cancellationToken: cancellationToken) + .ToStreamingResponseAsync(request, context, cancellationToken) + .ConfigureAwait(false)) + { + yield return streamingEvent; + } + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AIAgentResponsesProcessor.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AIAgentResponsesProcessor.cs deleted file mode 100644 index 5178abd8dc..0000000000 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AIAgentResponsesProcessor.cs +++ /dev/null @@ -1,65 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. - -using System; -using System.Linq; -using System.Net.ServerSentEvents; -using System.Text.Json; -using System.Threading; -using System.Threading.Tasks; -using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; -using Microsoft.AspNetCore.Http; -using Microsoft.AspNetCore.Http.Features; - -namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; - -/// -/// OpenAI Responses processor for . -/// -internal static class AIAgentResponsesProcessor -{ - public static async Task CreateModelResponseAsync(AIAgent agent, CreateResponse request, CancellationToken cancellationToken) - { - ArgumentNullException.ThrowIfNull(agent); - - var context = new AgentInvocationContext(idGenerator: IdGenerator.From(request)); - if (request.Stream == true) - { - return new StreamingResponse(agent, request, context); - } - - var messages = request.Input.GetInputMessages().Select(i => i.ToChatMessage()); - var response = await agent.RunAsync(messages, cancellationToken: cancellationToken).ConfigureAwait(false); - return Results.Ok(response.ToResponse(request, context)); - } - - private sealed class StreamingResponse(AIAgent agent, CreateResponse createResponse, AgentInvocationContext context) : IResult - { - public Task ExecuteAsync(HttpContext httpContext) - { - var cancellationToken = httpContext.RequestAborted; - var response = httpContext.Response; - - // Set SSE headers - response.Headers.ContentType = "text/event-stream"; - response.Headers.CacheControl = "no-cache,no-store"; - response.Headers.Connection = "keep-alive"; - response.Headers.ContentEncoding = "identity"; - httpContext.Features.GetRequiredFeature().DisableBuffering(); - - var chatMessages = createResponse.Input.GetInputMessages().Select(i => i.ToChatMessage()).ToList(); - var events = agent.RunStreamingAsync(chatMessages, cancellationToken: cancellationToken) - .ToStreamingResponseAsync(createResponse, context, cancellationToken) - .Select(static evt => new SseItem(evt, evt.Type)); - return SseFormatter.WriteAsync( - source: events, - destination: response.Body, - itemFormatter: static (sseItem, bufferWriter) => - { - using var writer = new Utf8JsonWriter(bufferWriter); - JsonSerializer.Serialize(writer, sseItem.Data, ResponsesJsonContext.Default.StreamingResponseEvent); - writer.Flush(); - }, - cancellationToken); - } - } -} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentInvocationContext.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentInvocationContext.cs index 6db6dbbc51..f21c2e84e9 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentInvocationContext.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentInvocationContext.cs @@ -29,5 +29,5 @@ internal sealed class AgentInvocationContext(IdGenerator idGenerator, JsonSerial /// /// Gets the JSON serializer options. /// - public JsonSerializerOptions JsonSerializerOptions { get; } = jsonSerializerOptions ?? ResponsesJsonSerializerOptions.Default; + public JsonSerializerOptions JsonSerializerOptions { get; } = jsonSerializerOptions ?? OpenAIHostingJsonUtilities.DefaultOptions; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentRunResponseExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentRunResponseExtensions.cs index b276489d00..fedaeae1f4 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentRunResponseExtensions.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentRunResponseExtensions.cs @@ -15,6 +15,8 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; /// internal static class AgentRunResponseExtensions { + private static ChatRole s_DeveloperRole => new("developer"); + /// /// Converts an AgentRunResponse to a Response model. /// @@ -44,38 +46,38 @@ internal static class AgentRunResponseExtensions return new Response { - Id = context.ResponseId, - CreatedAt = (agentRunResponse.CreatedAt ?? DateTimeOffset.UtcNow).ToUnixTimeSeconds(), - Model = request.Agent?.Name ?? request.Model, - Status = ResponseStatus.Completed, Agent = request.Agent?.ToAgentId(), + Background = request.Background, Conversation = request.Conversation ?? (context.ConversationId != null ? new ConversationReference { Id = context.ConversationId } : null), - Metadata = request.Metadata is IReadOnlyDictionary metadata ? new Dictionary(metadata) : [], + CreatedAt = (agentRunResponse.CreatedAt ?? DateTimeOffset.UtcNow).ToUnixTimeSeconds(), + Error = null, + Id = context.ResponseId, Instructions = request.Instructions, - Temperature = request.Temperature ?? 1.0, - TopP = request.TopP ?? 1.0, - Output = output, - Usage = agentRunResponse.Usage.ToResponseUsage(), - ParallelToolCalls = request.ParallelToolCalls ?? true, - Tools = [.. request.Tools ?? []], - ToolChoice = request.ToolChoice, - ServiceTier = request.ServiceTier ?? "default", - Store = request.Store ?? true, - PreviousResponseId = request.PreviousResponseId, - Reasoning = request.Reasoning, - Text = request.Text, MaxOutputTokens = request.MaxOutputTokens, + MaxToolCalls = request.MaxToolCalls, + Metadata = request.Metadata is IReadOnlyDictionary metadata ? new Dictionary(metadata) : [], + Model = request.Agent?.Name ?? request.Model, + Output = output, + ParallelToolCalls = request.ParallelToolCalls ?? true, + PreviousResponseId = request.PreviousResponseId, + Prompt = request.Prompt, + PromptCacheKey = request.PromptCacheKey, + Reasoning = request.Reasoning, + SafetyIdentifier = request.SafetyIdentifier, + ServiceTier = request.ServiceTier ?? "default", + Status = ResponseStatus.Completed, + Store = request.Store ?? true, + Temperature = request.Temperature ?? 1.0, + Text = request.Text, + ToolChoice = request.ToolChoice, + Tools = [.. request.Tools ?? []], + TopLogprobs = request.TopLogprobs, + TopP = request.TopP ?? 1.0, Truncation = request.Truncation, + Usage = agentRunResponse.Usage.ToResponseUsage(), #pragma warning disable CS0618 // Type or member is obsolete User = request.User, #pragma warning restore CS0618 // Type or member is obsolete - PromptCacheKey = request.PromptCacheKey, - SafetyIdentifier = request.SafetyIdentifier, - TopLogprobs = request.TopLogprobs, - MaxToolCalls = request.MaxToolCalls, - Background = request.Background, - Prompt = request.Prompt, - Error = null }; } @@ -88,22 +90,19 @@ internal static class AgentRunResponseExtensions /// An enumerable of ItemResource objects. public static IEnumerable ToItemResource(this ChatMessage message, IdGenerator idGenerator, JsonSerializerOptions jsonSerializerOptions) { - IList contents = []; - foreach (var content in message.Contents) + List contents = []; + foreach (AIContent content in message.Contents) { switch (content) { case FunctionCallContent functionCallContent: - // message.Role == ChatRole.Assistant yield return functionCallContent.ToFunctionToolCallItemResource(idGenerator.GenerateFunctionCallId(), jsonSerializerOptions); break; case FunctionResultContent functionResultContent: - // message.Role == ChatRole.Tool yield return functionResultContent.ToFunctionToolCallOutputItemResource( idGenerator.GenerateFunctionOutputId()); break; default: - // message.Role == ChatRole.Assistant if (ItemContentConverter.ToItemContent(content) is { } itemContent) { contents.Add(itemContent); @@ -115,12 +114,34 @@ internal static class AgentRunResponseExtensions if (contents.Count > 0) { - yield return new ResponsesAssistantMessageItemResource - { - Id = idGenerator.GenerateMessageId(), - Status = ResponsesMessageItemResourceStatus.Completed, - Content = contents - }; + List contentArray = contents; + string messageId = idGenerator.GenerateMessageId(); + + yield return + message.Role == ChatRole.User ? new ResponsesUserMessageItemResource + { + Id = messageId, + Status = ResponsesMessageItemResourceStatus.Completed, + Content = contentArray + } : + message.Role == ChatRole.System ? new ResponsesSystemMessageItemResource + { + Id = messageId, + Status = ResponsesMessageItemResourceStatus.Completed, + Content = contentArray + } : + message.Role == s_DeveloperRole ? new ResponsesDeveloperMessageItemResource + { + Id = messageId, + Status = ResponsesMessageItemResourceStatus.Completed, + Content = contentArray + } : + new ResponsesAssistantMessageItemResource + { + Id = messageId, + Status = ResponsesMessageItemResourceStatus.Completed, + Content = contentArray + }; } } @@ -168,6 +189,49 @@ internal static class AgentRunResponseExtensions }; } + /// + /// Converts an InputMessage to ItemResource objects. + /// + /// The input message to convert. + /// The ID generator to use for creating IDs. + /// An enumerable of ItemResource objects. + public static IEnumerable ToItemResource(this InputMessage inputMessage, IdGenerator idGenerator) + { + // Convert InputMessageContent to ItemContent array + List contentArray = inputMessage.Content.ToItemContents(); + + // Generate a message ID + string messageId = idGenerator.GenerateMessageId(); + + // Create the appropriate message type based on role + ChatRole role = new(inputMessage.Role.Value); + yield return + role == ChatRole.User ? new ResponsesUserMessageItemResource + { + Id = messageId, + Status = ResponsesMessageItemResourceStatus.Completed, + Content = contentArray + } : + role == ChatRole.System ? new ResponsesSystemMessageItemResource + { + Id = messageId, + Status = ResponsesMessageItemResourceStatus.Completed, + Content = contentArray + } : + role == s_DeveloperRole ? new ResponsesDeveloperMessageItemResource + { + Id = messageId, + Status = ResponsesMessageItemResourceStatus.Completed, + Content = contentArray + } : + new ResponsesAssistantMessageItemResource + { + Id = messageId, + Status = ResponsesMessageItemResourceStatus.Completed, + Content = contentArray + }; + } + /// /// Converts UsageDetails to ResponseUsage. /// diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentRunResponseUpdateExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentRunResponseUpdateExtensions.cs index fb4ea9a04a..252cdc8d92 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentRunResponseUpdateExtensions.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/AgentRunResponseUpdateExtensions.cs @@ -4,11 +4,13 @@ using System; using System.Collections.Generic; using System.Linq; using System.Runtime.CompilerServices; +using System.Text.Json; using System.Threading; using System.Threading.Tasks; using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Converters; using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Streaming; +using Microsoft.Agents.AI.Workflows; using Microsoft.Extensions.AI; namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; @@ -26,7 +28,7 @@ internal static class AgentRunResponseUpdateExtensions /// The agent invocation context. /// The cancellation token. /// A stream of response events. - internal static async IAsyncEnumerable ToStreamingResponseAsync( + public static async IAsyncEnumerable ToStreamingResponseAsync( this IAsyncEnumerable updates, CreateResponse request, AgentInvocationContext context, @@ -50,6 +52,13 @@ internal static class AgentRunResponseUpdateExtensions cancellationToken.ThrowIfCancellationRequested(); var update = updateEnumerator.Current; + // Special-case for agent framework workflow events. + if (update.RawRepresentation is WorkflowEvent workflowEvent) + { + yield return CreateWorkflowEventResponse(workflowEvent, seq.Increment(), outputIndex); + continue; + } + if (!IsSameMessage(update, previousUpdate)) { // Finalize the current generator when moving to a new message. @@ -99,6 +108,8 @@ internal static class AgentRunResponseUpdateExtensions TextReasoningContent => new TextReasoningContentEventGenerator(context.IdGenerator, seq, outputIndex), FunctionCallContent => new FunctionCallEventGenerator(context.IdGenerator, seq, outputIndex, context.JsonSerializerOptions), FunctionResultContent => new FunctionResultEventGenerator(context.IdGenerator, seq, outputIndex), + FunctionApprovalRequestContent => new FunctionApprovalRequestEventGenerator(context.IdGenerator, seq, outputIndex, context.JsonSerializerOptions), + FunctionApprovalResponseContent => new FunctionApprovalResponseEventGenerator(context.IdGenerator, seq, outputIndex), ErrorContent => new ErrorContentEventGenerator(context.IdGenerator, seq, outputIndex), UriContent uriContent when uriContent.HasTopLevelMediaType("image") => new ImageContentEventGenerator(context.IdGenerator, seq, outputIndex), DataContent dataContent when dataContent.HasTopLevelMediaType("image") => new ImageContentEventGenerator(context.IdGenerator, seq, outputIndex), @@ -144,38 +155,38 @@ internal static class AgentRunResponseUpdateExtensions { return new Response { - Id = context.ResponseId, - CreatedAt = createdAt.ToUnixTimeSeconds(), - Model = request.Agent?.Name ?? request.Model, - Status = status, Agent = request.Agent?.ToAgentId(), + Background = request.Background, Conversation = request.Conversation ?? new ConversationReference { Id = context.ConversationId }, - Metadata = request.Metadata != null ? new Dictionary(request.Metadata) : [], + CreatedAt = createdAt.ToUnixTimeSeconds(), + Error = null, + Id = context.ResponseId, Instructions = request.Instructions, - Temperature = request.Temperature ?? 1.0, - TopP = request.TopP ?? 1.0, - Output = outputs?.ToList() ?? [], - Usage = latestUsage, - ParallelToolCalls = request.ParallelToolCalls ?? true, - Tools = [.. request.Tools ?? []], - ToolChoice = request.ToolChoice, - ServiceTier = request.ServiceTier ?? "default", - Store = request.Store ?? true, - PreviousResponseId = request.PreviousResponseId, - Reasoning = request.Reasoning, - Text = request.Text, MaxOutputTokens = request.MaxOutputTokens, + MaxToolCalls = request.MaxToolCalls, + Metadata = request.Metadata != null ? new Dictionary(request.Metadata) : [], + Model = request.Agent?.Name ?? request.Model, + Output = outputs?.ToList() ?? [], + ParallelToolCalls = request.ParallelToolCalls ?? true, + PreviousResponseId = request.PreviousResponseId, + Prompt = request.Prompt, + PromptCacheKey = request.PromptCacheKey, + Reasoning = request.Reasoning, + SafetyIdentifier = request.SafetyIdentifier, + ServiceTier = request.ServiceTier, + Status = status, + Store = request.Store ?? true, + Temperature = request.Temperature ?? 1.0, + Text = request.Text, + ToolChoice = request.ToolChoice, + Tools = [.. request.Tools ?? []], + TopLogprobs = request.TopLogprobs, + TopP = request.TopP ?? 1.0, Truncation = request.Truncation, + Usage = latestUsage, #pragma warning disable CS0618 // Type or member is obsolete User = request.User, - PromptCacheKey = request.PromptCacheKey, #pragma warning restore CS0618 // Type or member is obsolete - SafetyIdentifier = request.SafetyIdentifier, - TopLogprobs = request.TopLogprobs, - MaxToolCalls = request.MaxToolCalls, - Background = request.Background, - Prompt = request.Prompt, - Error = null }; } } @@ -192,4 +203,49 @@ internal static class AgentRunResponseUpdateExtensions static bool IsSameRole(ChatRole? value1, ChatRole? value2) => !value1.HasValue || !value2.HasValue || value1.Value == value2.Value; } + + private static StreamingWorkflowEventComplete CreateWorkflowEventResponse(WorkflowEvent workflowEvent, int sequenceNumber, int outputIndex) + { + // Extract executor_id if this is an ExecutorEvent + string? executorId = null; + if (workflowEvent is ExecutorEvent execEvent) + { + executorId = execEvent.ExecutorId; + } + JsonElement eventData; + if (JsonSerializer.IsReflectionEnabledByDefault) + { + JsonElement? dataElement = null; + if (workflowEvent.Data is not null) + { + dataElement = JsonSerializer.SerializeToElement(workflowEvent.Data, OpenAIHostingJsonUtilities.DefaultOptions.GetTypeInfo(typeof(object))); + } + + var eventDataObj = new WorkflowEventData + { + EventType = workflowEvent.GetType().Name, + Data = dataElement, + ExecutorId = executorId, + Timestamp = DateTime.UtcNow.ToString("O") + }; + + eventData = JsonSerializer.SerializeToElement(eventDataObj, OpenAIHostingJsonUtilities.DefaultOptions.GetTypeInfo(typeof(WorkflowEventData))); + } + else + { + eventData = JsonSerializer.SerializeToElement( + "Unsupported. Workflow event serialization is currently only supported when JsonSerializer.IsReflectionEnabledByDefault is true.", + OpenAIHostingJsonContext.Default.String); + } + + // Create the properly typed streaming workflow event + return new StreamingWorkflowEventComplete + { + SequenceNumber = sequenceNumber, + OutputIndex = outputIndex, + Data = eventData, + ExecutorId = executorId, + ItemId = IdGenerator.NewId(prefix: "wf", stringLength: 8, delimiter: "") + }; + } } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemContentConverter.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemContentConverter.cs index cbaf7cb87b..32262d2e2c 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemContentConverter.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemContentConverter.cs @@ -11,6 +11,23 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Converters; /// internal static class ItemContentConverter { + private static string AudioFormatToMediaType(string? format) => + format?.Equals("mp3", StringComparison.OrdinalIgnoreCase) == true ? "audio/mpeg" : + format?.Equals("wav", StringComparison.OrdinalIgnoreCase) == true ? "audio/wav" : + format?.Equals("opus", StringComparison.OrdinalIgnoreCase) == true ? "audio/opus" : + format?.Equals("aac", StringComparison.OrdinalIgnoreCase) == true ? "audio/aac" : + format?.Equals("flac", StringComparison.OrdinalIgnoreCase) == true ? "audio/flac" : + format?.Equals("pcm16", StringComparison.OrdinalIgnoreCase) == true ? "audio/pcm" : + "audio/*"; + + private static string MediaTypeToAudioFormat(string mediaType) => + mediaType.Equals("audio/mpeg", StringComparison.OrdinalIgnoreCase) ? "mp3" : + mediaType.Equals("audio/wav", StringComparison.OrdinalIgnoreCase) ? "wav" : + mediaType.Equals("audio/opus", StringComparison.OrdinalIgnoreCase) ? "opus" : + mediaType.Equals("audio/aac", StringComparison.OrdinalIgnoreCase) ? "aac" : + mediaType.Equals("audio/flac", StringComparison.OrdinalIgnoreCase) ? "flac" : + mediaType.Equals("audio/pcm", StringComparison.OrdinalIgnoreCase) ? "pcm16" : + "mp3"; /// /// Converts to . /// @@ -49,16 +66,7 @@ internal static class ItemContentConverter // Audio content - map to DataContent with media type based on format ItemContentInputAudio inputAudio => - new DataContent(inputAudio.Data, inputAudio.Format?.ToUpperInvariant() switch - { - "MP3" => "audio/mpeg", - "WAV" => "audio/wav", - "OPUS" => "audio/opus", - "AAC" => "audio/aac", - "FLAC" => "audio/flac", - "PCM16" => "audio/pcm", - _ => "audio/*" - }), + new DataContent(inputAudio.Data, AudioFormatToMediaType(inputAudio.Format)), ItemContentOutputAudio outputAudio => new DataContent(outputAudio.Data, "audio/*"), @@ -104,34 +112,28 @@ internal static class ItemContentConverter ImageUrl = uriContent.Uri?.ToString(), Detail = GetImageDetail(uriContent) }, + HostedFileContent hostedFile => + new ItemContentInputFile + { + FileId = hostedFile.FileId + }, DataContent dataContent when dataContent.HasTopLevelMediaType("image") => new ItemContentInputImage { ImageUrl = dataContent.Uri, Detail = GetImageDetail(dataContent) }, - HostedFileContent hostedFile => - new ItemContentInputFile - { - FileId = hostedFile.FileId - }, - DataContent fileData when !fileData.HasTopLevelMediaType("image") && !fileData.HasTopLevelMediaType("audio") => - new ItemContentInputFile - { - FileData = fileData.Uri, - Filename = fileData.Name - }, DataContent audioData when audioData.HasTopLevelMediaType("audio") => new ItemContentInputAudio { Data = audioData.Uri, - Format = audioData.MediaType.Equals("audio/mpeg", StringComparison.OrdinalIgnoreCase) ? "mp3" : - audioData.MediaType.Equals("audio/wav", StringComparison.OrdinalIgnoreCase) ? "wav" : - audioData.MediaType.Equals("audio/opus", StringComparison.OrdinalIgnoreCase) ? "opus" : - audioData.MediaType.Equals("audio/aac", StringComparison.OrdinalIgnoreCase) ? "aac" : - audioData.MediaType.Equals("audio/flac", StringComparison.OrdinalIgnoreCase) ? "flac" : - audioData.MediaType.Equals("audio/pcm", StringComparison.OrdinalIgnoreCase) ? "pcm16" : - "mp3" // Default to mp3 + Format = MediaTypeToAudioFormat(audioData.MediaType) + }, + DataContent fileData => + new ItemContentInputFile + { + FileData = fileData.Uri, + Filename = fileData.Name }, // Other AIContent types (FunctionCallContent, FunctionResultContent, etc.) // are handled separately in the Responses API as different ItemResource types, not ItemContent diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemParamConverter.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemParamConverter.cs new file mode 100644 index 0000000000..9e63bcfd9d --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemParamConverter.cs @@ -0,0 +1,56 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Converters; + +/// +/// JSON converter for ItemParam that handles polymorphic deserialization based on the "type" discriminator. +/// +internal sealed class ItemParamConverter : JsonConverter +{ + public override ItemParam? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + using var doc = JsonDocument.ParseValue(ref reader); + var root = doc.RootElement; + + if (!root.TryGetProperty("type", out var typeElement)) + { + throw new JsonException("ItemParam must have a 'type' property"); + } + + var type = typeElement.GetString(); + + // Use OpenAIJsonContext directly since it has all the ItemParam type metadata + return type switch + { + "message" => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesMessageItemParam), + "function_call" => doc.Deserialize(OpenAIHostingJsonContext.Default.FunctionToolCallItemParam), + "function_call_output" => doc.Deserialize(OpenAIHostingJsonContext.Default.FunctionToolCallOutputItemParam), + "file_search_call" => doc.Deserialize(OpenAIHostingJsonContext.Default.FileSearchToolCallItemParam), + "computer_call" => doc.Deserialize(OpenAIHostingJsonContext.Default.ComputerToolCallItemParam), + "computer_call_output" => doc.Deserialize(OpenAIHostingJsonContext.Default.ComputerToolCallOutputItemParam), + "web_search_call" => doc.Deserialize(OpenAIHostingJsonContext.Default.WebSearchToolCallItemParam), + "reasoning" => doc.Deserialize(OpenAIHostingJsonContext.Default.ReasoningItemParam), + "item_reference" => doc.Deserialize(OpenAIHostingJsonContext.Default.ItemReferenceItemParam), + "image_generation_call" => doc.Deserialize(OpenAIHostingJsonContext.Default.ImageGenerationToolCallItemParam), + "code_interpreter_call" => doc.Deserialize(OpenAIHostingJsonContext.Default.CodeInterpreterToolCallItemParam), + "local_shell_call" => doc.Deserialize(OpenAIHostingJsonContext.Default.LocalShellToolCallItemParam), + "local_shell_call_output" => doc.Deserialize(OpenAIHostingJsonContext.Default.LocalShellToolCallOutputItemParam), + "mcp_list_tools" => doc.Deserialize(OpenAIHostingJsonContext.Default.MCPListToolsItemParam), + "mcp_approval_request" => doc.Deserialize(OpenAIHostingJsonContext.Default.MCPApprovalRequestItemParam), + "mcp_approval_response" => doc.Deserialize(OpenAIHostingJsonContext.Default.MCPApprovalResponseItemParam), + "mcp_call" => doc.Deserialize(OpenAIHostingJsonContext.Default.MCPCallItemParam), + _ => null // Ignore unknown types. + }; + } + + public override void Write(Utf8JsonWriter writer, ItemParam value, JsonSerializerOptions options) + { + // Use OpenAIJsonContext directly to serialize the concrete type + JsonSerializer.Serialize(writer, value, OpenAIHostingJsonContext.Default.Options.GetTypeInfo(value.GetType())); + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemResourceConverter.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemResourceConverter.cs index 2865de63a6..571e45fa1f 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemResourceConverter.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ItemResourceConverter.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft. All rights reserved. using System; -using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Serialization; using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; @@ -11,137 +10,101 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Converters; /// /// JSON converter for ItemResource that handles type discrimination. /// -[ExcludeFromCodeCoverage] internal sealed class ItemResourceConverter : JsonConverter { - private readonly ResponsesJsonContext _context; - - /// - /// Initializes a new instance of the class. - /// - public ItemResourceConverter() - { - this._context = ResponsesJsonContext.Default; - } - + /// public override ItemResource? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { - // Clone the reader to peek at the JSON - Utf8JsonReader readerClone = reader; + using var doc = JsonDocument.ParseValue(ref reader); + var root = doc.RootElement; - // Read through the JSON to find the type property - string? type = null; - - if (readerClone.TokenType != JsonTokenType.StartObject) + if (!root.TryGetProperty("type", out var typeElement)) { - throw new JsonException("Expected start of object"); + throw new JsonException("ItemResource must have a 'type' property"); } - while (readerClone.Read()) - { - if (readerClone.TokenType == JsonTokenType.EndObject) - { - break; - } - - if (readerClone.TokenType == JsonTokenType.PropertyName) - { - string propertyName = readerClone.GetString()!; - readerClone.Read(); // Move to the value - - if (propertyName == "type") - { - type = readerClone.GetString(); - break; - } - - if (readerClone.TokenType is JsonTokenType.StartObject or JsonTokenType.StartArray) - { - // Skip nested objects/arrays - readerClone.Skip(); - } - } - } + var type = typeElement.GetString(); // Determine the concrete type based on the type discriminator and deserialize using the source generation context return type switch { - ResponsesMessageItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.ResponsesMessageItemResource), - FileSearchToolCallItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.FileSearchToolCallItemResource), - FunctionToolCallItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.FunctionToolCallItemResource), - FunctionToolCallOutputItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.FunctionToolCallOutputItemResource), - ComputerToolCallItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.ComputerToolCallItemResource), - ComputerToolCallOutputItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.ComputerToolCallOutputItemResource), - WebSearchToolCallItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.WebSearchToolCallItemResource), - ReasoningItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.ReasoningItemResource), - ItemReferenceItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.ItemReferenceItemResource), - ImageGenerationToolCallItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.ImageGenerationToolCallItemResource), - CodeInterpreterToolCallItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.CodeInterpreterToolCallItemResource), - LocalShellToolCallItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.LocalShellToolCallItemResource), - LocalShellToolCallOutputItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.LocalShellToolCallOutputItemResource), - MCPListToolsItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.MCPListToolsItemResource), - MCPApprovalRequestItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.MCPApprovalRequestItemResource), - MCPApprovalResponseItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.MCPApprovalResponseItemResource), - MCPCallItemResource.ItemType => JsonSerializer.Deserialize(ref reader, this._context.MCPCallItemResource), - _ => throw new JsonException($"Unknown item type: {type}") + ResponsesMessageItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesMessageItemResource), + FileSearchToolCallItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.FileSearchToolCallItemResource), + FunctionToolCallItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.FunctionToolCallItemResource), + FunctionToolCallOutputItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.FunctionToolCallOutputItemResource), + ComputerToolCallItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.ComputerToolCallItemResource), + ComputerToolCallOutputItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.ComputerToolCallOutputItemResource), + WebSearchToolCallItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.WebSearchToolCallItemResource), + ReasoningItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.ReasoningItemResource), + ItemReferenceItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.ItemReferenceItemResource), + ImageGenerationToolCallItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.ImageGenerationToolCallItemResource), + CodeInterpreterToolCallItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.CodeInterpreterToolCallItemResource), + LocalShellToolCallItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.LocalShellToolCallItemResource), + LocalShellToolCallOutputItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.LocalShellToolCallOutputItemResource), + MCPListToolsItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.MCPListToolsItemResource), + MCPApprovalRequestItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.MCPApprovalRequestItemResource), + MCPApprovalResponseItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.MCPApprovalResponseItemResource), + MCPCallItemResource.ItemType => doc.Deserialize(OpenAIHostingJsonContext.Default.MCPCallItemResource), + _ => null }; } + /// public override void Write(Utf8JsonWriter writer, ItemResource value, JsonSerializerOptions options) { // Directly serialize using the appropriate type info from the context switch (value) { case ResponsesMessageItemResource message: - JsonSerializer.Serialize(writer, message, this._context.ResponsesMessageItemResource); + JsonSerializer.Serialize(writer, message, OpenAIHostingJsonContext.Default.ResponsesMessageItemResource); break; case FileSearchToolCallItemResource fileSearch: - JsonSerializer.Serialize(writer, fileSearch, this._context.FileSearchToolCallItemResource); + JsonSerializer.Serialize(writer, fileSearch, OpenAIHostingJsonContext.Default.FileSearchToolCallItemResource); break; case FunctionToolCallItemResource functionCall: - JsonSerializer.Serialize(writer, functionCall, this._context.FunctionToolCallItemResource); + JsonSerializer.Serialize(writer, functionCall, OpenAIHostingJsonContext.Default.FunctionToolCallItemResource); break; case FunctionToolCallOutputItemResource functionOutput: - JsonSerializer.Serialize(writer, functionOutput, this._context.FunctionToolCallOutputItemResource); + JsonSerializer.Serialize(writer, functionOutput, OpenAIHostingJsonContext.Default.FunctionToolCallOutputItemResource); break; case ComputerToolCallItemResource computerCall: - JsonSerializer.Serialize(writer, computerCall, this._context.ComputerToolCallItemResource); + JsonSerializer.Serialize(writer, computerCall, OpenAIHostingJsonContext.Default.ComputerToolCallItemResource); break; case ComputerToolCallOutputItemResource computerOutput: - JsonSerializer.Serialize(writer, computerOutput, this._context.ComputerToolCallOutputItemResource); + JsonSerializer.Serialize(writer, computerOutput, OpenAIHostingJsonContext.Default.ComputerToolCallOutputItemResource); break; case WebSearchToolCallItemResource webSearch: - JsonSerializer.Serialize(writer, webSearch, this._context.WebSearchToolCallItemResource); + JsonSerializer.Serialize(writer, webSearch, OpenAIHostingJsonContext.Default.WebSearchToolCallItemResource); break; case ReasoningItemResource reasoning: - JsonSerializer.Serialize(writer, reasoning, this._context.ReasoningItemResource); + JsonSerializer.Serialize(writer, reasoning, OpenAIHostingJsonContext.Default.ReasoningItemResource); break; case ItemReferenceItemResource itemReference: - JsonSerializer.Serialize(writer, itemReference, this._context.ItemReferenceItemResource); + JsonSerializer.Serialize(writer, itemReference, OpenAIHostingJsonContext.Default.ItemReferenceItemResource); break; case ImageGenerationToolCallItemResource imageGeneration: - JsonSerializer.Serialize(writer, imageGeneration, this._context.ImageGenerationToolCallItemResource); + JsonSerializer.Serialize(writer, imageGeneration, OpenAIHostingJsonContext.Default.ImageGenerationToolCallItemResource); break; case CodeInterpreterToolCallItemResource codeInterpreter: - JsonSerializer.Serialize(writer, codeInterpreter, this._context.CodeInterpreterToolCallItemResource); + JsonSerializer.Serialize(writer, codeInterpreter, OpenAIHostingJsonContext.Default.CodeInterpreterToolCallItemResource); break; case LocalShellToolCallItemResource localShell: - JsonSerializer.Serialize(writer, localShell, this._context.LocalShellToolCallItemResource); + JsonSerializer.Serialize(writer, localShell, OpenAIHostingJsonContext.Default.LocalShellToolCallItemResource); break; case LocalShellToolCallOutputItemResource localShellOutput: - JsonSerializer.Serialize(writer, localShellOutput, this._context.LocalShellToolCallOutputItemResource); + JsonSerializer.Serialize(writer, localShellOutput, OpenAIHostingJsonContext.Default.LocalShellToolCallOutputItemResource); break; case MCPListToolsItemResource mcpListTools: - JsonSerializer.Serialize(writer, mcpListTools, this._context.MCPListToolsItemResource); + JsonSerializer.Serialize(writer, mcpListTools, OpenAIHostingJsonContext.Default.MCPListToolsItemResource); break; case MCPApprovalRequestItemResource mcpApprovalRequest: - JsonSerializer.Serialize(writer, mcpApprovalRequest, this._context.MCPApprovalRequestItemResource); + JsonSerializer.Serialize(writer, mcpApprovalRequest, OpenAIHostingJsonContext.Default.MCPApprovalRequestItemResource); break; case MCPApprovalResponseItemResource mcpApprovalResponse: - JsonSerializer.Serialize(writer, mcpApprovalResponse, this._context.MCPApprovalResponseItemResource); + JsonSerializer.Serialize(writer, mcpApprovalResponse, OpenAIHostingJsonContext.Default.MCPApprovalResponseItemResource); break; case MCPCallItemResource mcpCall: - JsonSerializer.Serialize(writer, mcpCall, this._context.MCPCallItemResource); + JsonSerializer.Serialize(writer, mcpCall, OpenAIHostingJsonContext.Default.MCPCallItemResource); break; default: throw new JsonException($"Unknown item type: {value.GetType().Name}"); diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ResponsesMessageItemParamConverter.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ResponsesMessageItemParamConverter.cs new file mode 100644 index 0000000000..18fb1269aa --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ResponsesMessageItemParamConverter.cs @@ -0,0 +1,59 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Text.Json; +using System.Text.Json.Serialization; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Converters; + +/// +/// JSON converter for ResponsesMessageItemParam that handles role-based polymorphic deserialization. +/// +internal sealed class ResponsesMessageItemParamConverter : JsonConverter +{ + /// + public override ResponsesMessageItemParam? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) + { + using var doc = JsonDocument.ParseValue(ref reader); + var root = doc.RootElement; + + if (!root.TryGetProperty("role", out var roleElement)) + { + throw new JsonException("ResponsesMessageItemParam must have a 'role' property"); + } + + var role = roleElement.GetString(); + + return role switch + { + "user" => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesUserMessageItemParam), + "assistant" => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesAssistantMessageItemParam), + "system" => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesSystemMessageItemParam), + "developer" => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesDeveloperMessageItemParam), + _ => throw new JsonException($"Unknown message role: {role}") + }; + } + + /// + public override void Write(Utf8JsonWriter writer, ResponsesMessageItemParam value, JsonSerializerOptions options) + { + switch (value) + { + case ResponsesUserMessageItemParam user: + JsonSerializer.Serialize(writer, user, OpenAIHostingJsonContext.Default.ResponsesUserMessageItemParam); + break; + case ResponsesAssistantMessageItemParam assistant: + JsonSerializer.Serialize(writer, assistant, OpenAIHostingJsonContext.Default.ResponsesAssistantMessageItemParam); + break; + case ResponsesSystemMessageItemParam system: + JsonSerializer.Serialize(writer, system, OpenAIHostingJsonContext.Default.ResponsesSystemMessageItemParam); + break; + case ResponsesDeveloperMessageItemParam developer: + JsonSerializer.Serialize(writer, developer, OpenAIHostingJsonContext.Default.ResponsesDeveloperMessageItemParam); + break; + default: + throw new JsonException($"Unknown message type: {value.GetType().Name}"); + } + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ResponsesMessageItemResourceConverter.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ResponsesMessageItemResourceConverter.cs index c1045f9e56..f6307d6aa3 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ResponsesMessageItemResourceConverter.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/ResponsesMessageItemResourceConverter.cs @@ -14,82 +14,47 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Converters; [ExcludeFromCodeCoverage] internal sealed class ResponsesMessageItemResourceConverter : JsonConverter { - private readonly ResponsesJsonContext _context; - - /// - /// Initializes a new instance of the class. - /// - public ResponsesMessageItemResourceConverter() - { - this._context = ResponsesJsonContext.Default; - } - + /// public override ResponsesMessageItemResource? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { - // Clone the reader to peek at the JSON - Utf8JsonReader readerClone = reader; + using var doc = JsonDocument.ParseValue(ref reader); + var root = doc.RootElement; - // Read through the JSON to find the role property - string? role = null; - - if (readerClone.TokenType != JsonTokenType.StartObject) + if (!root.TryGetProperty("role", out var roleElement)) { - throw new JsonException("Expected start of object"); + throw new JsonException("ResponsesMessageItemResource must have a 'role' property"); } - while (readerClone.Read()) - { - if (readerClone.TokenType == JsonTokenType.EndObject) - { - break; - } - - if (readerClone.TokenType == JsonTokenType.PropertyName) - { - string propertyName = readerClone.GetString()!; - readerClone.Read(); // Move to the value - - if (propertyName == "role") - { - role = readerClone.GetString(); - break; - } - - if (readerClone.TokenType is JsonTokenType.StartObject or JsonTokenType.StartArray) - { - // Skip nested objects/arrays - readerClone.Skip(); - } - } - } + var role = roleElement.GetString(); // Determine the concrete type based on the role and deserialize using the source generation context return role switch { - ResponsesAssistantMessageItemResource.RoleType => JsonSerializer.Deserialize(ref reader, this._context.ResponsesAssistantMessageItemResource), - ResponsesUserMessageItemResource.RoleType => JsonSerializer.Deserialize(ref reader, this._context.ResponsesUserMessageItemResource), - ResponsesSystemMessageItemResource.RoleType => JsonSerializer.Deserialize(ref reader, this._context.ResponsesSystemMessageItemResource), - ResponsesDeveloperMessageItemResource.RoleType => JsonSerializer.Deserialize(ref reader, this._context.ResponsesDeveloperMessageItemResource), + ResponsesAssistantMessageItemResource.RoleType => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesAssistantMessageItemResource), + ResponsesUserMessageItemResource.RoleType => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesUserMessageItemResource), + ResponsesSystemMessageItemResource.RoleType => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesSystemMessageItemResource), + ResponsesDeveloperMessageItemResource.RoleType => doc.Deserialize(OpenAIHostingJsonContext.Default.ResponsesDeveloperMessageItemResource), _ => throw new JsonException($"Unknown message role: {role}") }; } + /// public override void Write(Utf8JsonWriter writer, ResponsesMessageItemResource value, JsonSerializerOptions options) { // Directly serialize using the appropriate type info from the context switch (value) { case ResponsesAssistantMessageItemResource assistant: - JsonSerializer.Serialize(writer, assistant, this._context.ResponsesAssistantMessageItemResource); + JsonSerializer.Serialize(writer, assistant, OpenAIHostingJsonContext.Default.ResponsesAssistantMessageItemResource); break; case ResponsesUserMessageItemResource user: - JsonSerializer.Serialize(writer, user, this._context.ResponsesUserMessageItemResource); + JsonSerializer.Serialize(writer, user, OpenAIHostingJsonContext.Default.ResponsesUserMessageItemResource); break; case ResponsesSystemMessageItemResource system: - JsonSerializer.Serialize(writer, system, this._context.ResponsesSystemMessageItemResource); + JsonSerializer.Serialize(writer, system, OpenAIHostingJsonContext.Default.ResponsesSystemMessageItemResource); break; case ResponsesDeveloperMessageItemResource developer: - JsonSerializer.Serialize(writer, developer, this._context.ResponsesDeveloperMessageItemResource); + JsonSerializer.Serialize(writer, developer, OpenAIHostingJsonContext.Default.ResponsesDeveloperMessageItemResource); break; default: throw new JsonException($"Unknown message type: {value.GetType().Name}"); diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/SnakeCaseEnumConverter.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/SnakeCaseEnumConverter.cs index fe8812330c..e035e251cb 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/SnakeCaseEnumConverter.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Converters/SnakeCaseEnumConverter.cs @@ -1,7 +1,6 @@ // Copyright (c) Microsoft. All rights reserved. using System; -using System.Diagnostics.CodeAnalysis; using System.Text.Json; using System.Text.Json.Serialization; @@ -11,9 +10,11 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Converters; /// JSON converter for enums that uses snake_case naming convention. /// /// The enum type to convert. -[ExcludeFromCodeCoverage] internal sealed class SnakeCaseEnumConverter : JsonStringEnumConverter where T : struct, Enum { + /// + /// Creates a new instance of the class. + /// public SnakeCaseEnumConverter() : base(JsonNamingPolicy.SnakeCaseLower) { } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/HostedAgentResponseExecutor.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/HostedAgentResponseExecutor.cs new file mode 100644 index 0000000000..78e4331b6b --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/HostedAgentResponseExecutor.cs @@ -0,0 +1,115 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; +using Microsoft.Extensions.AI; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; + +/// +/// Response executor that routes requests to hosted AIAgent services based on the model or agent.name parameter. +/// This executor resolves agents from keyed services registered via AddAIAgent(). +/// +internal sealed class HostedAgentResponseExecutor : IResponseExecutor +{ + private readonly IServiceProvider _serviceProvider; + private readonly ILogger _logger; + + /// + /// Initializes a new instance of the class. + /// + /// The service provider used to resolve hosted agents. + /// The logger instance. + public HostedAgentResponseExecutor( + IServiceProvider serviceProvider, + ILogger logger) + { + ArgumentNullException.ThrowIfNull(serviceProvider); + ArgumentNullException.ThrowIfNull(logger); + + this._serviceProvider = serviceProvider; + this._logger = logger; + } + + /// + public async IAsyncEnumerable ExecuteAsync( + AgentInvocationContext context, + CreateResponse request, + [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + // Validate and resolve agent synchronously to ensure validation errors are thrown immediately + AIAgent agent = this.ResolveAgent(request); + + // Create options with properties from the request + var chatOptions = new ChatOptions + { + ConversationId = request.Conversation?.Id, + Temperature = (float?)request.Temperature, + TopP = (float?)request.TopP, + MaxOutputTokens = request.MaxOutputTokens, + Instructions = request.Instructions, + ModelId = request.Model, + }; + var options = new ChatClientAgentRunOptions(chatOptions); + + // Convert input to chat messages + var messages = new List(); + + foreach (var inputMessage in request.Input.GetInputMessages()) + { + messages.Add(inputMessage.ToChatMessage()); + } + + // Use the extension method to convert streaming updates to streaming response events + await foreach (var streamingEvent in agent.RunStreamingAsync(messages, options: options, cancellationToken: cancellationToken) + .ToStreamingResponseAsync(request, context, cancellationToken).ConfigureAwait(false)) + { + yield return streamingEvent; + } + } + + /// + /// Resolves an agent from the service provider based on the request. + /// + /// The create response request. + /// The resolved AIAgent instance. + /// Thrown when the agent cannot be resolved. + private AIAgent ResolveAgent(CreateResponse request) + { + // Extract agent name from agent.name or model parameter + var agentName = request.Agent?.Name ?? request.Model; + if (string.IsNullOrEmpty(agentName)) + { + throw new InvalidOperationException("No 'agent.name' or 'model' specified in the request."); + } + + // Resolve the keyed agent service + try + { + return this._serviceProvider.GetRequiredKeyedService(agentName); + } + catch (InvalidOperationException ex) + { + this._logger.LogError(ex, "Failed to resolve agent with name '{AgentName}'", agentName); + throw new InvalidOperationException($"Agent '{agentName}' not found. Ensure the agent is registered with AddAIAgent().", ex); + } + } + + /// + /// Validates that the agent can be resolved without actually resolving it. + /// This allows early validation before starting async execution. + /// + /// The create response request. + /// Thrown when the agent cannot be resolved. + public void ValidateAgent(CreateResponse request) + { + // Use the same logic as ResolveAgent but don't return the agent + _ = this.ResolveAgent(request); + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IResponseExecutor.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IResponseExecutor.cs new file mode 100644 index 0000000000..ca4da70b88 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IResponseExecutor.cs @@ -0,0 +1,26 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Collections.Generic; +using System.Threading; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; + +/// +/// Interface for executing response generation. +/// Implementations can use local execution (AIAgent) or forward to remote workers. +/// +internal interface IResponseExecutor +{ + /// + /// Executes a response generation request and returns streaming events. + /// + /// The agent invocation context containing the ID generator and other context information. + /// The create response request. + /// Cancellation token. + /// An async enumerable of streaming response events. + IAsyncEnumerable ExecuteAsync( + AgentInvocationContext context, + CreateResponse request, + CancellationToken cancellationToken = default); +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IResponsesService.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IResponsesService.cs new file mode 100644 index 0000000000..67f7b72f20 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IResponsesService.cs @@ -0,0 +1,100 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; + +/// +/// Service interface for handling OpenAI Responses API operations. +/// Implementations can use various storage and execution strategies (in-memory, Orleans grains, etc.). +/// +internal interface IResponsesService +{ + /// + /// Default limit for list operations. + /// + const int DefaultListLimit = 20; + /// + /// Creates a model response for the given input. + /// + /// The create response request. + /// Cancellation token. + /// The created response. + Task CreateResponseAsync( + CreateResponse request, + CancellationToken cancellationToken = default); + + /// + /// Creates a streaming model response for the given input. + /// + /// The create response request. + /// Cancellation token. + /// An async enumerable of streaming response events. + IAsyncEnumerable CreateResponseStreamingAsync( + CreateResponse request, + CancellationToken cancellationToken = default); + + /// + /// Retrieves a response by ID. + /// + /// The ID of the response to retrieve. + /// Cancellation token. + /// The response if found, null otherwise. + Task GetResponseAsync( + string responseId, + CancellationToken cancellationToken = default); + + /// + /// Retrieves a response by ID in streaming mode, yielding events as they become available. + /// + /// The ID of the response to retrieve. + /// The sequence number after which to start streaming. If null, starts from the beginning. + /// Cancellation token. + /// An async enumerable of streaming updates. + IAsyncEnumerable GetResponseStreamingAsync( + string responseId, + int? startingAfter = null, + CancellationToken cancellationToken = default); + + /// + /// Cancels an in-progress response. + /// + /// The ID of the response to cancel. + /// Cancellation token. + /// The updated response after cancellation. + Task CancelResponseAsync( + string responseId, + CancellationToken cancellationToken = default); + + /// + /// Deletes a response by ID. + /// + /// The ID of the response to delete. + /// Cancellation token. + /// True if the response was deleted, false if it was not found. + Task DeleteResponseAsync( + string responseId, + CancellationToken cancellationToken = default); + + /// + /// Lists the input items for a response. + /// + /// The ID of the response. + /// Maximum number of items to return (1-100). Defaults to if null. + /// Sort order. Defaults to if null. + /// Return items after this ID. + /// Return items before this ID. + /// Cancellation token. + /// A list response with items and pagination info. + Task> ListResponseInputItemsAsync( + string responseId, + int? limit = null, + SortOrder? order = null, + string? after = null, + string? before = null, + CancellationToken cancellationToken = default); +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IdGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IdGenerator.cs deleted file mode 100644 index c532390371..0000000000 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/IdGenerator.cs +++ /dev/null @@ -1,82 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. - -using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; - -namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; - -/// -/// Generates IDs with partition keys. -/// -internal sealed partial class IdGenerator -{ - private readonly string _partitionId; - - /// - /// Initializes a new instance of the class. - /// - /// The response ID. - /// The conversation ID. - public IdGenerator(string? responseId, string? conversationId) - { - this.ResponseId = responseId ?? IdGeneratorHelpers.NewId("resp"); - this.ConversationId = conversationId ?? IdGeneratorHelpers.NewId("conv"); - this._partitionId = IdGeneratorHelpers.GetPartitionIdOrDefault(this.ConversationId) ?? string.Empty; - } - - /// - /// Creates a new ID generator from a create response request. - /// - /// The create response request. - /// A new ID generator. - public static IdGenerator From(CreateResponse request) - { - string? responseId = null; - request.Metadata?.TryGetValue("response_id", out responseId); - return new IdGenerator(responseId, request.Conversation?.Id); - } - - /// - /// Gets the response ID. - /// - public string ResponseId { get; } - - /// - /// Gets the conversation ID. - /// - public string ConversationId { get; } - - /// - /// Generates a new ID. - /// - /// The optional category for the ID. - /// A generated ID string. - public string Generate(string? category = null) - { - var prefix = string.IsNullOrEmpty(category) ? "id" : category; - return IdGeneratorHelpers.NewId(prefix, partitionKey: this._partitionId); - } - - /// - /// Generates a function call ID. - /// - /// A function call ID. - public string GenerateFunctionCallId() => this.Generate("func"); - - /// - /// Generates a function output ID. - /// - /// A function output ID. - public string GenerateFunctionOutputId() => this.Generate("funcout"); - - /// - /// Generates a message ID. - /// - /// A message ID. - public string GenerateMessageId() => this.Generate("msg"); - - /// - /// Generates a reasoning ID. - /// - /// A reasoning ID. - public string GenerateReasoningId() => this.Generate("rs"); -} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/InMemoryResponsesService.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/InMemoryResponsesService.cs new file mode 100644 index 0000000000..dfb744596a --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/InMemoryResponsesService.cs @@ -0,0 +1,545 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Runtime.CompilerServices; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Converters; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; +using Microsoft.Extensions.Caching.Memory; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; + +/// +/// In-memory implementation of responses service for testing and development. +/// This implementation is thread-safe but data is not persisted across application restarts. +/// +internal sealed class InMemoryResponsesService : IResponsesService, IDisposable +{ + private readonly IResponseExecutor _executor; + private readonly MemoryCache _cache; + private readonly InMemoryStorageOptions _options; + private readonly Conversations.IConversationStorage? _conversationStorage; + + private sealed class ResponseState + { + private readonly object _lock = new(); + private TaskCompletionSource _updateSignal = new(TaskCreationOptions.RunContinuationsAsynchronously); + private readonly Dictionary _outputItems = []; + + public Response? Response { get; set; } + public CreateResponse? Request { get; set; } + public List StreamingUpdates { get; } = []; + public Task? CompletionTask { get; set; } + public CancellationTokenSource? CancellationTokenSource { get; set; } + public bool IsTerminal => this.Response?.IsTerminal ?? false; + + public void AddStreamingEvent(StreamingResponseEvent streamingEvent) + { + lock (this._lock) + { + this.StreamingUpdates.Add(streamingEvent); + + // Update the response object for events that contain it + if (streamingEvent is IStreamingResponseEventWithResponse responseEvent) + { + this.Response = responseEvent.Response; + } + + // Track output items as they're added or updated + if (streamingEvent is StreamingOutputItemAdded itemAdded) + { + this._outputItems[itemAdded.OutputIndex] = itemAdded.Item; + this.UpdateResponseOutput(); + } + else if (streamingEvent is StreamingOutputItemDone itemDone) + { + this._outputItems[itemDone.OutputIndex] = itemDone.Item; + this.UpdateResponseOutput(); + } + } + + this.SignalUpdate(); + } + + private void UpdateResponseOutput() + { + // Update the Response.Output list with current items + if (this.Response is not null) + { + List outputList = [.. this._outputItems.OrderBy(kvp => kvp.Key).Select(kvp => kvp.Value)]; + this.Response = this.Response with { Output = outputList }; + } + } + + public async IAsyncEnumerable StreamUpdatesAsync( + int startingAfter = 0, + [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + int streamedCount = startingAfter; + while (true) + { + cancellationToken.ThrowIfCancellationRequested(); + + // Capture the wait task before checking state to avoid race conditions + Task waitTask = this.WaitForUpdateAsync(cancellationToken); + + // Copy any new updates and check terminal state while holding the lock + List newUpdates; + bool isTerminal; + lock (this._lock) + { + newUpdates = this.StreamingUpdates.Skip(streamedCount).ToList(); + streamedCount += newUpdates.Count; + isTerminal = this.IsTerminal; + } + + // Yield the updates outside the lock + foreach (StreamingResponseEvent update in newUpdates) + { + yield return update; + } + + // Check if we're done (after yielding any final events) + if (isTerminal) + { + break; + } + + // Wait for the next update to be signaled + await waitTask.ConfigureAwait(false); + } + } + + private Task WaitForUpdateAsync(CancellationToken cancellationToken) + { + Task signalTask = this._updateSignal.Task; + return signalTask.WaitAsync(cancellationToken); + } + + internal void SignalUpdate() + { + TaskCompletionSource oldSignal = Interlocked.Exchange(ref this._updateSignal, new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously)); + oldSignal.TrySetResult(); + } + } + + public InMemoryResponsesService(IResponseExecutor executor) + : this(executor, new InMemoryStorageOptions(), null) + { + } + + public InMemoryResponsesService(IResponseExecutor executor, InMemoryStorageOptions options) + : this(executor, options, null) + { + } + + public InMemoryResponsesService(IResponseExecutor executor, InMemoryStorageOptions options, Conversations.IConversationStorage? conversationStorage) + { + ArgumentNullException.ThrowIfNull(executor); + ArgumentNullException.ThrowIfNull(options); + this._executor = executor; + this._options = options; + this._cache = new MemoryCache(options.ToMemoryCacheOptions()); + this._conversationStorage = conversationStorage; + } + + public async Task CreateResponseAsync( + CreateResponse request, + CancellationToken cancellationToken = default) + { + ValidateRequest(request); + + // Validate agent resolution early for HostedAgentResponseExecutor + if (this._executor is HostedAgentResponseExecutor hostedExecutor) + { + hostedExecutor.ValidateAgent(request); + } + + if (request.Stream == true) + { + throw new InvalidOperationException("Cannot create a streaming response using CreateResponseAsync. Use CreateResponseStreamingAsync instead."); + } + + var idGenerator = new IdGenerator(responseId: null, conversationId: request.Conversation?.Id); + var responseId = idGenerator.ResponseId; + var state = this.InitializeResponse(responseId, request); + var ct = request.Background switch + { + true => CancellationToken.None, + _ => cancellationToken, + }; + state.CompletionTask = this.ExecuteResponseAsync(responseId, state, ct); + + // For background responses, start execution and return immediately + if (request.Background == true) + { + return state.Response!; + } + + // For non-background responses, wait for completion + await state.CompletionTask!.WaitAsync(cancellationToken).ConfigureAwait(false); + return state.Response!; + } + + public async IAsyncEnumerable CreateResponseStreamingAsync( + CreateResponse request, + [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + ValidateRequest(request); + + if (request.Stream == false) + { + throw new InvalidOperationException("Cannot create a non-streaming response using CreateResponseStreamingAsync. Use CreateResponseAsync instead."); + } + + var idGenerator = new IdGenerator(responseId: null, conversationId: request.Conversation?.Id); + var responseId = idGenerator.ResponseId; + var state = this.InitializeResponse(responseId, request); + + // Start execution + state.CompletionTask = this.ExecuteResponseAsync(responseId, state, CancellationToken.None); + + // Stream updates as they become available + await foreach (StreamingResponseEvent update in state.StreamUpdatesAsync(cancellationToken: cancellationToken).ConfigureAwait(false)) + { + yield return update; + } + } + + public Task GetResponseAsync(string responseId, CancellationToken cancellationToken = default) + { + this._cache.TryGetValue(responseId, out ResponseState? state); + return Task.FromResult(state?.Response); + } + + public async IAsyncEnumerable GetResponseStreamingAsync( + string responseId, + int? startingAfter = null, + [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + if (!this._cache.TryGetValue(responseId, out ResponseState? state) || state is null) + { + yield break; + } + + // Stream existing updates starting from the specified position + await foreach (StreamingResponseEvent update in state.StreamUpdatesAsync(startingAfter ?? 0, cancellationToken).ConfigureAwait(false)) + { + yield return update; + } + } + + public async Task CancelResponseAsync(string responseId, CancellationToken cancellationToken = default) + { + if (!this._cache.TryGetValue(responseId, out ResponseState? state) || state is null) + { + throw new InvalidOperationException($"Response '{responseId}' not found."); + } + + if (state.Response is null || state.Response.Background != true) + { + throw new InvalidOperationException($"Only background responses can be cancelled. Response '{responseId}' was not created with background=true."); + } + + if (state.IsTerminal) + { + throw new InvalidOperationException($"Response '{responseId}' is already in a terminal state and cannot be cancelled."); + } + + // Cancel the execution + state.CancellationTokenSource?.Cancel(); + + if (state.CompletionTask is { } task) + { + await task.WaitAsync(cancellationToken).ConfigureAwait(ConfigureAwaitOptions.SuppressThrowing); + } + + return state.Response; + } + + public Task DeleteResponseAsync(string responseId, CancellationToken cancellationToken = default) + { + if (!this._cache.TryGetValue(responseId, out ResponseState? state)) + { + return Task.FromResult(false); + } + + // Cancel any ongoing execution + state?.CancellationTokenSource?.Cancel(); + + // Remove the response + this._cache.Remove(responseId); + return Task.FromResult(true); + } + + public Task> ListResponseInputItemsAsync( + string responseId, + int? limit = null, + SortOrder? order = null, + string? after = null, + string? before = null, + CancellationToken cancellationToken = default) + { + int effectiveLimit = Math.Clamp(limit ?? IResponsesService.DefaultListLimit, 1, 100); + SortOrder effectiveOrder = order ?? SortOrder.Descending; + + if (!this._cache.TryGetValue(responseId, out ResponseState? state)) + { + throw new InvalidOperationException($"Response '{responseId}' not found."); + } + + if (state is null) + { + throw new InvalidOperationException($"Response '{responseId}' state is null."); + } + + var itemResources = GetInputItems(responseId, state); + + // Apply ordering + if (effectiveOrder == SortOrder.Descending) + { + itemResources.Reverse(); + } + + // Apply pagination + var filtered = itemResources.AsEnumerable(); + + if (!string.IsNullOrEmpty(after)) + { + int afterIndex = itemResources.FindIndex(m => m.Id == after); + if (afterIndex >= 0) + { + filtered = itemResources.Skip(afterIndex + 1); + } + } + + if (!string.IsNullOrEmpty(before)) + { + int beforeIndex = itemResources.FindIndex(m => m.Id == before); + if (beforeIndex >= 0) + { + filtered = filtered.Take(beforeIndex); + } + } + + var result = filtered.Take(effectiveLimit + 1).ToList(); + var hasMore = result.Count > effectiveLimit; + if (hasMore) + { + result = result.Take(effectiveLimit).ToList(); + } + + return Task.FromResult(new ListResponse + { + Data = result, + FirstId = result.FirstOrDefault()?.Id, + LastId = result.LastOrDefault()?.Id, + HasMore = hasMore + }); + } + + private static void ValidateRequest(CreateResponse request) + { + if (request.Conversation is not null && !string.IsNullOrEmpty(request.Conversation.Id) && + !string.IsNullOrEmpty(request.PreviousResponseId)) + { + throw new InvalidOperationException("Mutually exclusive parameters: 'conversation' and 'previous_response_id'. Ensure you are only providing one of: 'previous_response_id' or 'conversation'."); + } + } + + private ResponseState InitializeResponse(string responseId, CreateResponse request) + { + var metadata = request.Metadata ?? []; + + // Create initial response + // Background responses always start as "queued", non-background as "in_progress" + var initialStatus = request.Background is true ? ResponseStatus.Queued : ResponseStatus.InProgress; + var response = new Response + { + Agent = request.Agent?.ToAgentId(), + Background = request.Background, + Conversation = request.Conversation, + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Error = null, + Id = responseId, + IncompleteDetails = null, + Instructions = request.Instructions, + MaxOutputTokens = request.MaxOutputTokens, + MaxToolCalls = request.MaxToolCalls, + Metadata = metadata, + Model = request.Model ?? "default", + Output = [], + ParallelToolCalls = request.ParallelToolCalls ?? true, + PreviousResponseId = request.PreviousResponseId, + Prompt = request.Prompt, + PromptCacheKey = request.PromptCacheKey, + Reasoning = request.Reasoning, + SafetyIdentifier = request.SafetyIdentifier, + ServiceTier = request.ServiceTier, + Status = initialStatus, + Store = request.Store, + Temperature = request.Temperature, + Text = request.Text, + ToolChoice = request.ToolChoice, + Tools = [.. request.Tools ?? []], + TopLogprobs = request.TopLogprobs, + TopP = request.TopP, + Truncation = request.Truncation, + Usage = ResponseUsage.Zero, +#pragma warning disable CS0618 // Type or member is obsolete + User = request.User +#pragma warning restore CS0618 // Type or member is obsolete + }; + + var state = new ResponseState + { + Response = response, + Request = request, + CancellationTokenSource = new CancellationTokenSource() + }; + + var entryOptions = this._options.ToMemoryCacheEntryOptions(); + entryOptions.RegisterPostEvictionCallback((key, value, reason, state) => + { + if (value is ResponseState responseState) + { + responseState.CancellationTokenSource?.Cancel(); + } + }); + + this._cache.Set(responseId, state, entryOptions); + + return state; + } + + private async Task ExecuteResponseAsync(string responseId, ResponseState state, CancellationToken cancellationToken) + { + await Task.CompletedTask.ConfigureAwait(ConfigureAwaitOptions.ForceYielding); + var request = state.Request!; + using var linkedCts = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, state.CancellationTokenSource!.Token); + + try + { + // Create agent invocation context + var context = new AgentInvocationContext(new IdGenerator(responseId: responseId, conversationId: state.Response?.Conversation?.Id)); + + // Collect output items for conversation storage + List outputItems = []; + + // Execute using the injected executor + await foreach (var streamingEvent in this._executor.ExecuteAsync(context, request, linkedCts.Token).ConfigureAwait(false)) + { + state.AddStreamingEvent(streamingEvent); + + // Collect output items + if (streamingEvent is StreamingOutputItemDone itemDone) + { + outputItems.Add(itemDone.Item); + } + } + + // Add both input and output items to conversation storage if available + // This happens AFTER successful execution, in line with OpenAI's behavior + if (this._conversationStorage is not null && request.Conversation?.Id is not null) + { + var inputItems = GetInputItems(responseId, state); + var allItems = new List(inputItems.Count + outputItems.Count); + allItems.AddRange(inputItems); + allItems.AddRange(outputItems); + + if (allItems.Count > 0) + { + await this._conversationStorage.AddItemsAsync(request.Conversation.Id, allItems, linkedCts.Token).ConfigureAwait(false); + } + } + + // Update response status to completed if not already in a terminal state + if (!state.IsTerminal) + { + state.Response = state.Response! with + { + Status = ResponseStatus.Completed + }; + + var sequenceNumber = state.StreamingUpdates.Count + 1; + var completedEvent = new StreamingResponseCompleted + { + SequenceNumber = sequenceNumber, + Response = state.Response + }; + + state.AddStreamingEvent(completedEvent); + } + } + catch (OperationCanceledException) + { + // Update response status to cancelled + state.Response = state.Response! with + { + Status = ResponseStatus.Cancelled + }; + + var sequenceNumber = state.StreamingUpdates.Count + 1; + var cancelledEvent = new StreamingResponseCancelled + { + SequenceNumber = sequenceNumber, + Response = state.Response + }; + + state.AddStreamingEvent(cancelledEvent); + } + catch (Exception ex) + { + // Update response status to failed + state.Response = state.Response! with + { + Status = ResponseStatus.Failed, + Error = new ResponseError + { + Code = "execution_error", + Message = ex.Message + } + }; + + var sequenceNumber = state.StreamingUpdates.Count + 1; + var failedEvent = new StreamingResponseFailed + { + SequenceNumber = sequenceNumber, + Response = state.Response + }; + + state.AddStreamingEvent(failedEvent); + } + finally + { + // Signal one final time to unblock any waiting consumers + state.SignalUpdate(); + } + } + + private static List GetInputItems(string responseId, ResponseState state) + { + var itemResources = new List(); + if (state.Request is not null) + { + // Use a deterministic random seed. We add 1 to avoid clashing with the output message ids. + var randomSeed = responseId.GetHashCode() + 1; + var idGenerator = new IdGenerator(responseId: responseId, conversationId: state.Response?.Conversation?.Id, randomSeed: randomSeed); + foreach (var inputMessage in state.Request.Input.GetInputMessages()) + { + itemResources.AddRange(inputMessage.ToItemResource(idGenerator)); + } + } + + return itemResources; + } + + public void Dispose() + { + this._cache.Dispose(); + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/AgentId.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/AgentId.cs index 11882ada6a..eaeb8cd658 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/AgentId.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/AgentId.cs @@ -7,7 +7,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// /// Represents an agent identifier. /// -internal sealed record AgentId +internal sealed class AgentId { /// /// Initializes a new instance of the class. @@ -44,7 +44,7 @@ internal sealed record AgentId /// /// Represents an agent ID type. /// -internal sealed record AgentIdType +internal sealed class AgentIdType { /// /// Initializes a new instance of the class. @@ -65,7 +65,7 @@ internal sealed record AgentIdType /// /// Represents an agent reference. /// -internal sealed record AgentReference +internal sealed class AgentReference { /// /// The type of the reference (e.g., "agent" or "agent_reference"). diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ConversationReference.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ConversationReference.cs index 7f959fcbfc..dc38375331 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ConversationReference.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ConversationReference.cs @@ -11,7 +11,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// Represents a reference to a conversation, which can be either a conversation ID (string) or a conversation object. /// [JsonConverter(typeof(ConversationReferenceJsonConverter))] -internal sealed record ConversationReference +internal sealed class ConversationReference { /// /// The conversation ID. @@ -42,6 +42,7 @@ internal sealed record ConversationReference /// internal sealed class ConversationReferenceJsonConverter : JsonConverter { + /// public override ConversationReference? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.String) @@ -61,7 +62,7 @@ internal sealed class ConversationReferenceJsonConverter : JsonConverter public override void Write(Utf8JsonWriter writer, ConversationReference value, JsonSerializerOptions options) { if (value is null) @@ -95,7 +97,7 @@ internal sealed class ConversationReferenceJsonConverter : JsonConverter /// Request to create a model response. /// -internal sealed record CreateResponse +internal sealed class CreateResponse { /// /// Text, image, or file inputs to the model, used to generate a response. @@ -65,7 +65,10 @@ internal sealed record CreateResponse /// /// The unique ID of the previous response to the model. Use this to create multi-turn conversations. - /// Cannot be used in conjunction with conversation. + /// Cannot be used in conjunction with conversation (mutually exclusive). + /// The previous_response_id determines the conversation thread context - it follows the response chain, + /// not any explicit conversation. Context is maintained through the chain even if the previous response + /// was created with a conversation.id. /// [JsonPropertyName("previous_response_id")] public string? PreviousResponseId { get; init; } @@ -98,13 +101,16 @@ internal sealed record CreateResponse /// Specify additional output data to include in the model response. /// [JsonPropertyName("include")] - public IReadOnlyList? Include { get; init; } + public List? Include { get; init; } /// /// The conversation that this response belongs to. Items from this conversation are prepended /// to input_items for this response request. /// Can be either a conversation ID (string) or a conversation object with ID and optional metadata. /// Input items and output items from this response are automatically added to this conversation after this response completes. + /// Cannot be used in conjunction with previous_response_id (mutually exclusive). + /// Use conversation.id for explicit conversation boundaries and starting new threads. + /// Use previous_response_id for simple linear conversation chaining. /// [JsonPropertyName("conversation")] public ConversationReference? Conversation { get; init; } @@ -178,7 +184,7 @@ internal sealed record CreateResponse /// An array of tools the model may call while generating a response. /// [JsonPropertyName("tools")] - public IReadOnlyList? Tools { get; init; } + public List? Tools { get; init; } /// /// How the model should select which tool (or tools) to use when generating a response. diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/InputMessage.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/InputMessage.cs index d15e111ebe..029be0752a 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/InputMessage.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/InputMessage.cs @@ -12,7 +12,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// A message input to the model with a role indicating instruction following hierarchy. /// Aligns with the OpenAI Responses API InputMessage/EasyInputMessage schema. /// -internal sealed record InputMessage +internal sealed class InputMessage { /// /// The role of the message input. One of user, assistant, system, or developer. diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/InputMessageContent.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/InputMessageContent.cs index 524613b7eb..0180ff16ac 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/InputMessageContent.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/InputMessageContent.cs @@ -22,7 +22,7 @@ internal sealed class InputMessageContent : IEquatable this.Contents = null; } - private InputMessageContent(IReadOnlyList contents) + private InputMessageContent(List contents) { this.Contents = contents ?? throw new ArgumentNullException(nameof(contents)); this.Text = null; @@ -36,12 +36,12 @@ internal sealed class InputMessageContent : IEquatable /// /// Creates an InputMessageContent from a list of ItemContent items. /// - public static InputMessageContent FromContents(IReadOnlyList contents) => new(contents); + public static InputMessageContent FromContents(List contents) => new(contents); /// /// Creates an InputMessageContent from a list of ItemContent items. /// - public static InputMessageContent FromContents(params ItemContent[] contents) => new(contents); + public static InputMessageContent FromContents(params ItemContent[] contents) => new([.. contents]); /// /// Implicit conversion from string to InputMessageContent. @@ -62,12 +62,14 @@ internal sealed class InputMessageContent : IEquatable /// Gets whether this content is text. /// [MemberNotNullWhen(true, nameof(Text))] + [MemberNotNullWhen(false, nameof(Contents))] public bool IsText => this.Text is not null; /// /// Gets whether this content is a list of ItemContent items. /// [MemberNotNullWhen(true, nameof(Contents))] + [MemberNotNullWhen(false, nameof(Text))] public bool IsContents => this.Contents is not null; /// @@ -78,7 +80,7 @@ internal sealed class InputMessageContent : IEquatable /// /// Gets the ItemContent items, or null if this is not a content list. /// - public IReadOnlyList? Contents { get; } + public List? Contents { get; } /// public bool Equals(InputMessageContent? other) @@ -143,6 +145,16 @@ internal sealed class InputMessageContent : IEquatable { return !Equals(left, right); } + + /// + /// Converts this instance to a list of ItemContent. + /// + public List ToItemContents() + { + return this.IsText + ? [new ItemContentInputText { Text = this.Text }] + : this.Contents; + } } /// @@ -150,6 +162,7 @@ internal sealed class InputMessageContent : IEquatable /// internal sealed class InputMessageContentJsonConverter : JsonConverter { + /// public override InputMessageContent? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { // Check if it's a string @@ -162,7 +175,7 @@ internal sealed class InputMessageContentJsonConverter : JsonConverter 0 ? InputMessageContent.FromContents(contents) : InputMessageContent.FromText(string.Empty); @@ -171,6 +184,7 @@ internal sealed class InputMessageContentJsonConverter : JsonConverter public override void Write(Utf8JsonWriter writer, InputMessageContent value, JsonSerializerOptions options) { if (value.IsText) @@ -179,7 +193,7 @@ internal sealed class InputMessageContentJsonConverter : JsonConverter +/// Base class for all item parameters (input items for creating conversation items or response inputs). +/// Unlike ItemResource, ItemParam does not have an ID field - the server generates IDs upon creation. +/// +[JsonConverter(typeof(ItemParamConverter))] +internal abstract class ItemParam +{ + /// + /// The type of the item. + /// + [JsonPropertyName("type")] + public abstract string Type { get; } +} + +/// +/// Base class for message item parameters. +/// +[JsonConverter(typeof(ResponsesMessageItemParamConverter))] +internal abstract class ResponsesMessageItemParam : ItemParam +{ + /// + /// The constant item type identifier for message items. + /// + public const string ItemType = "message"; + + /// + public override string Type => ItemType; + + /// + /// The role of the message sender. + /// + [JsonPropertyName("role")] + public abstract ChatRole Role { get; } +} + +/// +/// A user message item parameter. +/// +internal sealed class ResponsesUserMessageItemParam : ResponsesMessageItemParam +{ + /// + /// The constant role type identifier for user messages. + /// + public const string RoleType = "user"; + + /// + public override ChatRole Role => ChatRole.User; + + /// + /// The content of the message. Can be a simple string or an array of content parts. + /// + [JsonPropertyName("content")] + public required InputMessageContent Content { get; init; } +} + +/// +/// An assistant message item parameter. +/// +internal sealed class ResponsesAssistantMessageItemParam : ResponsesMessageItemParam +{ + /// + /// The constant role type identifier for assistant messages. + /// + public const string RoleType = "assistant"; + + /// + public override ChatRole Role => ChatRole.Assistant; + + /// + /// The content of the message. Can be a simple string or an array of content parts. + /// + [JsonPropertyName("content")] + public required InputMessageContent Content { get; init; } +} + +/// +/// A system message item parameter. +/// +internal sealed class ResponsesSystemMessageItemParam : ResponsesMessageItemParam +{ + /// + /// The constant role type identifier for system messages. + /// + public const string RoleType = "system"; + + /// + public override ChatRole Role => ChatRole.System; + + /// + /// The content of the message. Can be a simple string or an array of content parts. + /// + [JsonPropertyName("content")] + public required InputMessageContent Content { get; init; } +} + +/// +/// A developer message item parameter. +/// +internal sealed class ResponsesDeveloperMessageItemParam : ResponsesMessageItemParam +{ + /// + /// The constant role type identifier for developer messages. + /// + public const string RoleType = "developer"; + + /// + public override ChatRole Role => new(RoleType); + + /// + /// The content of the message. Can be a simple string or an array of content parts. + /// + [JsonPropertyName("content")] + public required InputMessageContent Content { get; init; } +} + +/// +/// A function tool call item parameter. +/// +internal sealed class FunctionToolCallItemParam : ItemParam +{ + /// + /// The constant item type identifier for function call items. + /// + public const string ItemType = "function_call"; + + /// + public override string Type => ItemType; + + /// + /// The call ID of the function. + /// + [JsonPropertyName("call_id")] + public required string CallId { get; init; } + + /// + /// The name of the function. + /// + [JsonPropertyName("name")] + public required string Name { get; init; } + + /// + /// The arguments to the function. + /// + [JsonPropertyName("arguments")] + public required string Arguments { get; init; } +} + +/// +/// A function tool call output item parameter. +/// +internal sealed class FunctionToolCallOutputItemParam : ItemParam +{ + /// + /// The constant item type identifier for function call output items. + /// + public const string ItemType = "function_call_output"; + + /// + public override string Type => ItemType; + + /// + /// The call ID of the function. + /// + [JsonPropertyName("call_id")] + public required string CallId { get; init; } + + /// + /// The output of the function. + /// + [JsonPropertyName("output")] + public required string Output { get; init; } +} + +/// +/// A file search tool call item parameter. +/// +internal sealed class FileSearchToolCallItemParam : ItemParam +{ + /// + /// The constant item type identifier for file search call items. + /// + public const string ItemType = "file_search_call"; + + /// + public override string Type => ItemType; + + /// + /// The queries used to search for files. + /// + [JsonPropertyName("queries")] + public List? Queries { get; init; } + + /// + /// The results of the file search tool call. + /// + [JsonPropertyName("results")] + public List? Results { get; init; } +} + +/// +/// A computer tool call item parameter. +/// +internal sealed class ComputerToolCallItemParam : ItemParam +{ + /// + /// The constant item type identifier for computer call items. + /// + public const string ItemType = "computer_call"; + + /// + public override string Type => ItemType; + + /// + /// An identifier used when responding to the tool call with output. + /// + [JsonPropertyName("call_id")] + public required string CallId { get; init; } + + /// + /// The action to perform. + /// + [JsonPropertyName("action")] + public required JsonElement Action { get; init; } + + /// + /// The pending safety checks for the computer call. + /// + [JsonPropertyName("pending_safety_checks")] + public List? PendingSafetyChecks { get; init; } +} + +/// +/// A computer tool call output item parameter. +/// +internal sealed class ComputerToolCallOutputItemParam : ItemParam +{ + /// + /// The constant item type identifier for computer call output items. + /// + public const string ItemType = "computer_call_output"; + + /// + public override string Type => ItemType; + + /// + /// The ID of the computer tool call that produced the output. + /// + [JsonPropertyName("call_id")] + public required string CallId { get; init; } + + /// + /// The safety checks reported by the API that have been acknowledged by the developer. + /// + [JsonPropertyName("acknowledged_safety_checks")] + public List? AcknowledgedSafetyChecks { get; init; } + + /// + /// The output of the computer tool call. + /// + [JsonPropertyName("output")] + public required JsonElement Output { get; init; } +} + +/// +/// A web search tool call item parameter. +/// +internal sealed class WebSearchToolCallItemParam : ItemParam +{ + /// + /// The constant item type identifier for web search call items. + /// + public const string ItemType = "web_search_call"; + + /// + public override string Type => ItemType; + + /// + /// An object describing the specific action taken in this web search call. + /// + [JsonPropertyName("action")] + public required JsonElement Action { get; init; } +} + +/// +/// A reasoning item parameter. +/// +internal sealed class ReasoningItemParam : ItemParam +{ + /// + /// The constant item type identifier for reasoning items. + /// + public const string ItemType = "reasoning"; + + /// + public override string Type => ItemType; + + /// + /// The encrypted content of the reasoning item. + /// + [JsonPropertyName("encrypted_content")] + public string? EncryptedContent { get; init; } + + /// + /// Reasoning text contents. + /// + [JsonPropertyName("summary")] + public List? Summary { get; init; } +} + +/// +/// An item reference item parameter. +/// +internal sealed class ItemReferenceItemParam : ItemParam +{ + /// + /// The constant item type identifier for item reference items. + /// + public const string ItemType = "item_reference"; + + /// + public override string Type => ItemType; + + /// + /// The service-originated ID of the previously generated response item being referenced. + /// + [JsonPropertyName("id")] + public required string Id { get; init; } +} + +/// +/// An image generation tool call item parameter. +/// +internal sealed class ImageGenerationToolCallItemParam : ItemParam +{ + /// + /// The constant item type identifier for image generation call items. + /// + public const string ItemType = "image_generation_call"; + + /// + public override string Type => ItemType; + + /// + /// The generated image encoded in base64. + /// + [JsonPropertyName("result")] + public string? Result { get; init; } +} + +/// +/// A code interpreter tool call item parameter. +/// +internal sealed class CodeInterpreterToolCallItemParam : ItemParam +{ + /// + /// The constant item type identifier for code interpreter call items. + /// + public const string ItemType = "code_interpreter_call"; + + /// + public override string Type => ItemType; + + /// + /// The ID of the container used to run the code. + /// + [JsonPropertyName("container_id")] + public string? ContainerId { get; init; } + + /// + /// The code to run, or null if not available. + /// + [JsonPropertyName("code")] + public string? Code { get; init; } + + /// + /// The outputs generated by the code interpreter, such as logs or images. + /// Can be null if no outputs are available. + /// + [JsonPropertyName("outputs")] + public List? Outputs { get; init; } +} + +/// +/// A local shell tool call item parameter. +/// +internal sealed class LocalShellToolCallItemParam : ItemParam +{ + /// + /// The constant item type identifier for local shell call items. + /// + public const string ItemType = "local_shell_call"; + + /// + public override string Type => ItemType; + + /// + /// The unique ID of the local shell tool call generated by the model. + /// + [JsonPropertyName("call_id")] + public string? CallId { get; init; } + + /// + /// The action to execute. + /// + [JsonPropertyName("action")] + public JsonElement? Action { get; init; } +} + +/// +/// A local shell tool call output item parameter. +/// +internal sealed class LocalShellToolCallOutputItemParam : ItemParam +{ + /// + /// The constant item type identifier for local shell call output items. + /// + public const string ItemType = "local_shell_call_output"; + + /// + public override string Type => ItemType; + + /// + /// A JSON string of the output of the local shell tool call. + /// + [JsonPropertyName("output")] + public string? Output { get; init; } +} + +/// +/// An MCP list tools item parameter. +/// +internal sealed class MCPListToolsItemParam : ItemParam +{ + /// + /// The constant item type identifier for MCP list tools items. + /// + public const string ItemType = "mcp_list_tools"; + + /// + public override string Type => ItemType; + + /// + /// The label of the MCP server. + /// + [JsonPropertyName("server_label")] + public string? ServerLabel { get; init; } + + /// + /// The tools available on the server. + /// + [JsonPropertyName("tools")] + public List? Tools { get; init; } + + /// + /// Error message if the server could not list tools. + /// + [JsonPropertyName("error")] + public string? Error { get; init; } +} + +/// +/// An MCP approval request item parameter. +/// +internal sealed class MCPApprovalRequestItemParam : ItemParam +{ + /// + /// The constant item type identifier for MCP approval request items. + /// + public const string ItemType = "mcp_approval_request"; + + /// + public override string Type => ItemType; + + /// + /// The label of the MCP server making the request. + /// + [JsonPropertyName("server_label")] + public string? ServerLabel { get; init; } + + /// + /// The name of the tool to run. + /// + [JsonPropertyName("name")] + public string? Name { get; init; } + + /// + /// A JSON string of arguments for the tool. + /// + [JsonPropertyName("arguments")] + public string? Arguments { get; init; } +} + +/// +/// An MCP approval response item parameter. +/// +internal sealed class MCPApprovalResponseItemParam : ItemParam +{ + /// + /// The constant item type identifier for MCP approval response items. + /// + public const string ItemType = "mcp_approval_response"; + + /// + public override string Type => ItemType; + + /// + /// The ID of the approval request being answered. + /// + [JsonPropertyName("approval_request_id")] + public string? ApprovalRequestId { get; init; } + + /// + /// Whether the request was approved. + /// + [JsonPropertyName("approve")] + public bool? Approve { get; init; } + + /// + /// Optional reason for the decision. + /// + [JsonPropertyName("reason")] + public string? Reason { get; init; } +} + +/// +/// An MCP call item parameter. +/// +internal sealed class MCPCallItemParam : ItemParam +{ + /// + /// The constant item type identifier for MCP call items. + /// + public const string ItemType = "mcp_call"; + + /// + public override string Type => ItemType; + + /// + /// The label of the MCP server running the tool. + /// + [JsonPropertyName("server_label")] + public string? ServerLabel { get; init; } + + /// + /// The name of the tool that was run. + /// + [JsonPropertyName("name")] + public string? Name { get; init; } + + /// + /// A JSON string of the arguments passed to the tool. + /// + [JsonPropertyName("arguments")] + public string? Arguments { get; init; } + + /// + /// The output from the tool call. + /// + [JsonPropertyName("output")] + public string? Output { get; init; } + + /// + /// The error from the tool call, if any. + /// + [JsonPropertyName("error")] + public string? Error { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ItemParamExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ItemParamExtensions.cs new file mode 100644 index 0000000000..e8ab3694aa --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ItemParamExtensions.cs @@ -0,0 +1,157 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +/// +/// Extension methods for converting ItemParam (input) to ItemResource (output). +/// +internal static class ItemParamExtensions +{ + /// + /// Converts an ItemParam (input model) to an ItemResource (output model) by adding server-generated fields. + /// + /// The input item parameter. + /// The ID generator to use for creating item IDs. + /// An ItemResource with a generated ID. + public static ItemResource ToItemResource(this ItemParam param, IdGenerator idGenerator) + { + ArgumentNullException.ThrowIfNull(param); + ArgumentNullException.ThrowIfNull(idGenerator); + + string generatedId = idGenerator.GenerateMessageId(); + + return param switch + { + ResponsesUserMessageItemParam userMessageParam => new ResponsesUserMessageItemResource + { + Id = generatedId, + Content = userMessageParam.Content.ToItemContents(), + Status = ResponsesMessageItemResourceStatus.Completed + }, + ResponsesSystemMessageItemParam systemMessageParam => new ResponsesSystemMessageItemResource + { + Id = generatedId, + Content = systemMessageParam.Content.ToItemContents(), + Status = ResponsesMessageItemResourceStatus.Completed + }, + ResponsesAssistantMessageItemParam assistantMessageParam => new ResponsesAssistantMessageItemResource + { + Id = generatedId, + Content = assistantMessageParam.Content.ToItemContents(), + Status = ResponsesMessageItemResourceStatus.Completed + }, + ResponsesDeveloperMessageItemParam developerMessageParam => new ResponsesDeveloperMessageItemResource + { + Id = generatedId, + Content = developerMessageParam.Content.ToItemContents(), + Status = ResponsesMessageItemResourceStatus.Completed + }, + FunctionToolCallItemParam functionCallParam => new FunctionToolCallItemResource + { + Id = generatedId, + Name = functionCallParam.Name, + CallId = functionCallParam.CallId, + Arguments = functionCallParam.Arguments, + Status = FunctionToolCallItemResourceStatus.Completed + }, + FunctionToolCallOutputItemParam functionOutputParam => new FunctionToolCallOutputItemResource + { + Id = generatedId, + CallId = functionOutputParam.CallId, + Output = functionOutputParam.Output + }, + FileSearchToolCallItemParam fileSearchParam => new FileSearchToolCallItemResource + { + Id = generatedId, + Queries = fileSearchParam.Queries, + Results = fileSearchParam.Results + }, + ComputerToolCallItemParam computerCallParam => new ComputerToolCallItemResource + { + Id = generatedId, + CallId = computerCallParam.CallId, + Action = computerCallParam.Action, + PendingSafetyChecks = computerCallParam.PendingSafetyChecks + }, + ComputerToolCallOutputItemParam computerOutputParam => new ComputerToolCallOutputItemResource + { + Id = generatedId, + CallId = computerOutputParam.CallId, + AcknowledgedSafetyChecks = computerOutputParam.AcknowledgedSafetyChecks, + Output = computerOutputParam.Output + }, + WebSearchToolCallItemParam webSearchParam => new WebSearchToolCallItemResource + { + Id = generatedId, + Action = webSearchParam.Action + }, + ReasoningItemParam reasoningParam => new ReasoningItemResource + { + Id = generatedId, + EncryptedContent = reasoningParam.EncryptedContent, + Summary = reasoningParam.Summary + }, + ItemReferenceItemParam => new ItemReferenceItemResource + { + Id = generatedId + }, + ImageGenerationToolCallItemParam imageGenParam => new ImageGenerationToolCallItemResource + { + Id = generatedId, + Result = imageGenParam.Result + }, + CodeInterpreterToolCallItemParam codeInterpreterParam => new CodeInterpreterToolCallItemResource + { + Id = generatedId, + ContainerId = codeInterpreterParam.ContainerId, + Code = codeInterpreterParam.Code, + Outputs = codeInterpreterParam.Outputs + }, + LocalShellToolCallItemParam localShellParam => new LocalShellToolCallItemResource + { + Id = generatedId, + CallId = localShellParam.CallId, + Action = localShellParam.Action + }, + LocalShellToolCallOutputItemParam localShellOutputParam => new LocalShellToolCallOutputItemResource + { + Id = generatedId, + Output = localShellOutputParam.Output + }, + MCPListToolsItemParam mcpListToolsParam => new MCPListToolsItemResource + { + Id = generatedId, + ServerLabel = mcpListToolsParam.ServerLabel, + Tools = mcpListToolsParam.Tools, + Error = mcpListToolsParam.Error + }, + MCPApprovalRequestItemParam mcpApprovalRequestParam => new MCPApprovalRequestItemResource + { + Id = generatedId, + ServerLabel = mcpApprovalRequestParam.ServerLabel, + Name = mcpApprovalRequestParam.Name, + Arguments = mcpApprovalRequestParam.Arguments + }, + MCPApprovalResponseItemParam mcpApprovalResponseParam => new MCPApprovalResponseItemResource + { + Id = generatedId, + ApprovalRequestId = mcpApprovalResponseParam.ApprovalRequestId, + Approve = mcpApprovalResponseParam.Approve, + Reason = mcpApprovalResponseParam.Reason + }, + MCPCallItemParam mcpCallParam => new MCPCallItemResource + { + Id = generatedId, + ServerLabel = mcpCallParam.ServerLabel, + Name = mcpCallParam.Name, + Arguments = mcpCallParam.Arguments, + Output = mcpCallParam.Output, + Error = mcpCallParam.Error + }, + // Fallback for unknown types + _ => throw new InvalidOperationException($"Unknown ItemParam type: {param.GetType().Name}") + }; + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ItemResource.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ItemResource.cs index f0a7e83666..0a543e1be9 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ItemResource.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ItemResource.cs @@ -12,7 +12,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// Base class for all item resources (output items from a response). /// [JsonConverter(typeof(ItemResourceConverter))] -internal abstract record ItemResource +internal abstract class ItemResource { /// /// The unique identifier for the item. @@ -31,7 +31,7 @@ internal abstract record ItemResource /// Base class for message item resources. /// [JsonConverter(typeof(ResponsesMessageItemResourceConverter))] -internal abstract record ResponsesMessageItemResource : ItemResource +internal abstract class ResponsesMessageItemResource : ItemResource { /// /// The constant item type identifier for message items. @@ -57,7 +57,7 @@ internal abstract record ResponsesMessageItemResource : ItemResource /// /// An assistant message item resource. /// -internal sealed record ResponsesAssistantMessageItemResource : ResponsesMessageItemResource +internal sealed class ResponsesAssistantMessageItemResource : ResponsesMessageItemResource { /// /// The constant role type identifier for assistant messages. @@ -71,13 +71,13 @@ internal sealed record ResponsesAssistantMessageItemResource : ResponsesMessageI /// The content of the message. /// [JsonPropertyName("content")] - public required IList Content { get; init; } + public required List Content { get; init; } } /// /// A user message item resource. /// -internal sealed record ResponsesUserMessageItemResource : ResponsesMessageItemResource +internal sealed class ResponsesUserMessageItemResource : ResponsesMessageItemResource { /// /// The constant role type identifier for user messages. @@ -91,13 +91,13 @@ internal sealed record ResponsesUserMessageItemResource : ResponsesMessageItemRe /// The content of the message. /// [JsonPropertyName("content")] - public required IList Content { get; init; } + public required List Content { get; init; } } /// /// A system message item resource. /// -internal sealed record ResponsesSystemMessageItemResource : ResponsesMessageItemResource +internal sealed class ResponsesSystemMessageItemResource : ResponsesMessageItemResource { /// /// The constant role type identifier for system messages. @@ -111,13 +111,13 @@ internal sealed record ResponsesSystemMessageItemResource : ResponsesMessageItem /// The content of the message. /// [JsonPropertyName("content")] - public required IList Content { get; init; } + public required List Content { get; init; } } /// /// A developer message item resource. /// -internal sealed record ResponsesDeveloperMessageItemResource : ResponsesMessageItemResource +internal sealed class ResponsesDeveloperMessageItemResource : ResponsesMessageItemResource { /// /// The constant role type identifier for developer messages. @@ -131,13 +131,13 @@ internal sealed record ResponsesDeveloperMessageItemResource : ResponsesMessageI /// The content of the message. /// [JsonPropertyName("content")] - public required IList Content { get; init; } + public required List Content { get; init; } } /// /// A function tool call item resource. /// -internal sealed record FunctionToolCallItemResource : ItemResource +internal sealed class FunctionToolCallItemResource : ItemResource { /// /// The constant item type identifier for function call items. @@ -175,7 +175,7 @@ internal sealed record FunctionToolCallItemResource : ItemResource /// /// A function tool call output item resource. /// -internal sealed record FunctionToolCallOutputItemResource : ItemResource +internal sealed class FunctionToolCallOutputItemResource : ItemResource { /// /// The constant item type identifier for function call output items. @@ -208,7 +208,7 @@ internal sealed record FunctionToolCallOutputItemResource : ItemResource /// The status of a message item resource. /// [JsonConverter(typeof(SnakeCaseEnumConverter))] -public enum ResponsesMessageItemResourceStatus +internal enum ResponsesMessageItemResourceStatus { /// /// The message is completed. @@ -230,7 +230,7 @@ public enum ResponsesMessageItemResourceStatus /// The status of a function tool call item resource. /// [JsonConverter(typeof(SnakeCaseEnumConverter))] -public enum FunctionToolCallItemResourceStatus +internal enum FunctionToolCallItemResourceStatus { /// /// The function call is completed. @@ -247,7 +247,7 @@ public enum FunctionToolCallItemResourceStatus /// The status of a function tool call output item resource. /// [JsonConverter(typeof(SnakeCaseEnumConverter))] -public enum FunctionToolCallOutputItemResourceStatus +internal enum FunctionToolCallOutputItemResourceStatus { /// /// The function call output is completed. @@ -266,7 +266,7 @@ public enum FunctionToolCallOutputItemResourceStatus [JsonDerivedType(typeof(ItemContentOutputText), "output_text")] [JsonDerivedType(typeof(ItemContentOutputAudio), "output_audio")] [JsonDerivedType(typeof(ItemContentRefusal), "refusal")] -internal abstract record ItemContent +internal abstract class ItemContent { /// /// The type of the content. @@ -285,7 +285,7 @@ internal abstract record ItemContent /// /// Text input content. /// -internal sealed record ItemContentInputText : ItemContent +internal sealed class ItemContentInputText : ItemContent { /// [JsonIgnore] @@ -301,7 +301,7 @@ internal sealed record ItemContentInputText : ItemContent /// /// Audio input content. /// -internal sealed record ItemContentInputAudio : ItemContent +internal sealed class ItemContentInputAudio : ItemContent { /// [JsonIgnore] @@ -323,7 +323,7 @@ internal sealed record ItemContentInputAudio : ItemContent /// /// Image input content. /// -internal sealed record ItemContentInputImage : ItemContent +internal sealed class ItemContentInputImage : ItemContent { /// [JsonIgnore] @@ -352,7 +352,7 @@ internal sealed record ItemContentInputImage : ItemContent /// /// File input content. /// -internal sealed record ItemContentInputFile : ItemContent +internal sealed class ItemContentInputFile : ItemContent { /// [JsonIgnore] @@ -380,7 +380,7 @@ internal sealed record ItemContentInputFile : ItemContent /// /// Text output content. /// -internal sealed record ItemContentOutputText : ItemContent +internal sealed class ItemContentOutputText : ItemContent { /// [JsonIgnore] @@ -396,19 +396,19 @@ internal sealed record ItemContentOutputText : ItemContent /// The annotations. /// [JsonPropertyName("annotations")] - public required IList Annotations { get; init; } + public required List Annotations { get; init; } /// /// Log probability information for the output tokens. /// [JsonPropertyName("logprobs")] - public IList Logprobs { get; init; } = []; + public List Logprobs { get; init; } = []; } /// /// Audio output content. /// -internal sealed record ItemContentOutputAudio : ItemContent +internal sealed class ItemContentOutputAudio : ItemContent { /// [JsonIgnore] @@ -430,7 +430,7 @@ internal sealed record ItemContentOutputAudio : ItemContent /// /// Refusal content. /// -internal sealed record ItemContentRefusal : ItemContent +internal sealed class ItemContentRefusal : ItemContent { /// [JsonIgnore] @@ -448,7 +448,7 @@ internal sealed record ItemContentRefusal : ItemContent /// /// A file search tool call item resource. /// -internal sealed record FileSearchToolCallItemResource : ItemResource +internal sealed class FileSearchToolCallItemResource : ItemResource { /// /// The constant item type identifier for file search call items. @@ -463,12 +463,24 @@ internal sealed record FileSearchToolCallItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// The queries used to search for files. + /// + [JsonPropertyName("queries")] + public List? Queries { get; init; } + + /// + /// The results of the file search tool call. + /// + [JsonPropertyName("results")] + public List? Results { get; init; } } /// /// A computer tool call item resource. /// -internal sealed record ComputerToolCallItemResource : ItemResource +internal sealed class ComputerToolCallItemResource : ItemResource { /// /// The constant item type identifier for computer call items. @@ -483,12 +495,30 @@ internal sealed record ComputerToolCallItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// An identifier used when responding to the tool call with output. + /// + [JsonPropertyName("call_id")] + public string? CallId { get; init; } + + /// + /// The action to perform. + /// + [JsonPropertyName("action")] + public JsonElement? Action { get; init; } + + /// + /// The pending safety checks for the computer call. + /// + [JsonPropertyName("pending_safety_checks")] + public List? PendingSafetyChecks { get; init; } } /// /// A computer tool call output item resource. /// -internal sealed record ComputerToolCallOutputItemResource : ItemResource +internal sealed class ComputerToolCallOutputItemResource : ItemResource { /// /// The constant item type identifier for computer call output items. @@ -503,12 +533,30 @@ internal sealed record ComputerToolCallOutputItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// The ID of the computer tool call that produced the output. + /// + [JsonPropertyName("call_id")] + public string? CallId { get; init; } + + /// + /// The safety checks reported by the API that have been acknowledged by the developer. + /// + [JsonPropertyName("acknowledged_safety_checks")] + public List? AcknowledgedSafetyChecks { get; init; } + + /// + /// The output of the computer tool call. + /// + [JsonPropertyName("output")] + public JsonElement? Output { get; init; } } /// /// A web search tool call item resource. /// -internal sealed record WebSearchToolCallItemResource : ItemResource +internal sealed class WebSearchToolCallItemResource : ItemResource { /// /// The constant item type identifier for web search call items. @@ -523,12 +571,18 @@ internal sealed record WebSearchToolCallItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// An object describing the specific action taken in this web search call. + /// + [JsonPropertyName("action")] + public JsonElement? Action { get; init; } } /// /// A reasoning item resource. /// -internal sealed record ReasoningItemResource : ItemResource +internal sealed class ReasoningItemResource : ItemResource { /// /// The constant item type identifier for reasoning items. @@ -543,12 +597,25 @@ internal sealed record ReasoningItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// The encrypted content of the reasoning item - populated when a response is + /// generated with reasoning.encrypted_content in the include parameter. + /// + [JsonPropertyName("encrypted_content")] + public string? EncryptedContent { get; init; } + + /// + /// Reasoning text contents. + /// + [JsonPropertyName("summary")] + public List? Summary { get; init; } } /// /// An item reference item resource. /// -internal sealed record ItemReferenceItemResource : ItemResource +internal sealed class ItemReferenceItemResource : ItemResource { /// /// The constant item type identifier for item reference items. @@ -562,7 +629,7 @@ internal sealed record ItemReferenceItemResource : ItemResource /// /// An image generation tool call item resource. /// -internal sealed record ImageGenerationToolCallItemResource : ItemResource +internal sealed class ImageGenerationToolCallItemResource : ItemResource { /// /// The constant item type identifier for image generation call items. @@ -577,12 +644,18 @@ internal sealed record ImageGenerationToolCallItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// The generated image encoded in base64. + /// + [JsonPropertyName("result")] + public string? Result { get; init; } } /// /// A code interpreter tool call item resource. /// -internal sealed record CodeInterpreterToolCallItemResource : ItemResource +internal sealed class CodeInterpreterToolCallItemResource : ItemResource { /// /// The constant item type identifier for code interpreter call items. @@ -597,12 +670,31 @@ internal sealed record CodeInterpreterToolCallItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// The ID of the container used to run the code. + /// + [JsonPropertyName("container_id")] + public string? ContainerId { get; init; } + + /// + /// The code to run, or null if not available. + /// + [JsonPropertyName("code")] + public string? Code { get; init; } + + /// + /// The outputs generated by the code interpreter, such as logs or images. + /// Can be null if no outputs are available. + /// + [JsonPropertyName("outputs")] + public List? Outputs { get; init; } } /// /// A local shell tool call item resource. /// -internal sealed record LocalShellToolCallItemResource : ItemResource +internal sealed class LocalShellToolCallItemResource : ItemResource { /// /// The constant item type identifier for local shell call items. @@ -617,12 +709,24 @@ internal sealed record LocalShellToolCallItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// The unique ID of the local shell tool call generated by the model. + /// + [JsonPropertyName("call_id")] + public string? CallId { get; init; } + + /// + /// The action to execute. + /// + [JsonPropertyName("action")] + public JsonElement? Action { get; init; } } /// /// A local shell tool call output item resource. /// -internal sealed record LocalShellToolCallOutputItemResource : ItemResource +internal sealed class LocalShellToolCallOutputItemResource : ItemResource { /// /// The constant item type identifier for local shell call output items. @@ -637,12 +741,18 @@ internal sealed record LocalShellToolCallOutputItemResource : ItemResource /// [JsonPropertyName("status")] public string? Status { get; init; } + + /// + /// A JSON string of the output of the local shell tool call. + /// + [JsonPropertyName("output")] + public string? Output { get; init; } } /// /// An MCP list tools item resource. /// -internal sealed record MCPListToolsItemResource : ItemResource +internal sealed class MCPListToolsItemResource : ItemResource { /// /// The constant item type identifier for MCP list tools items. @@ -651,12 +761,30 @@ internal sealed record MCPListToolsItemResource : ItemResource /// public override string Type => ItemType; + + /// + /// The label of the MCP server. + /// + [JsonPropertyName("server_label")] + public string? ServerLabel { get; init; } + + /// + /// The tools available on the server. + /// + [JsonPropertyName("tools")] + public List? Tools { get; init; } + + /// + /// Error message if the server could not list tools. + /// + [JsonPropertyName("error")] + public string? Error { get; init; } } /// /// An MCP approval request item resource. /// -internal sealed record MCPApprovalRequestItemResource : ItemResource +internal sealed class MCPApprovalRequestItemResource : ItemResource { /// /// The constant item type identifier for MCP approval request items. @@ -665,12 +793,30 @@ internal sealed record MCPApprovalRequestItemResource : ItemResource /// public override string Type => ItemType; + + /// + /// The label of the MCP server making the request. + /// + [JsonPropertyName("server_label")] + public string? ServerLabel { get; init; } + + /// + /// The name of the tool to run. + /// + [JsonPropertyName("name")] + public string? Name { get; init; } + + /// + /// A JSON string of arguments for the tool. + /// + [JsonPropertyName("arguments")] + public string? Arguments { get; init; } } /// /// An MCP approval response item resource. /// -internal sealed record MCPApprovalResponseItemResource : ItemResource +internal sealed class MCPApprovalResponseItemResource : ItemResource { /// /// The constant item type identifier for MCP approval response items. @@ -679,12 +825,30 @@ internal sealed record MCPApprovalResponseItemResource : ItemResource /// public override string Type => ItemType; + + /// + /// The ID of the approval request being answered. + /// + [JsonPropertyName("approval_request_id")] + public string? ApprovalRequestId { get; init; } + + /// + /// Whether the request was approved. + /// + [JsonPropertyName("approve")] + public bool? Approve { get; init; } + + /// + /// Optional reason for the decision. + /// + [JsonPropertyName("reason")] + public string? Reason { get; init; } } /// /// An MCP call item resource. /// -internal sealed record MCPCallItemResource : ItemResource +internal sealed class MCPCallItemResource : ItemResource { /// /// The constant item type identifier for MCP call items. @@ -693,4 +857,34 @@ internal sealed record MCPCallItemResource : ItemResource /// public override string Type => ItemType; + + /// + /// The label of the MCP server running the tool. + /// + [JsonPropertyName("server_label")] + public string? ServerLabel { get; init; } + + /// + /// The name of the tool that was run. + /// + [JsonPropertyName("name")] + public string? Name { get; init; } + + /// + /// A JSON string of the arguments passed to the tool. + /// + [JsonPropertyName("arguments")] + public string? Arguments { get; init; } + + /// + /// The output from the tool call. + /// + [JsonPropertyName("output")] + public string? Output { get; init; } + + /// + /// The error from the tool call, if any. + /// + [JsonPropertyName("error")] + public string? Error { get; init; } } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/PromptReference.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/PromptReference.cs index d14e94473c..8bf0ee2846 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/PromptReference.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/PromptReference.cs @@ -8,7 +8,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// /// Reference to a prompt template and its variables. /// -internal sealed record PromptReference +internal sealed class PromptReference { /// /// The ID of the prompt template to use. diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ReasoningOptions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ReasoningOptions.cs index 8be910278a..d34a56c6ee 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ReasoningOptions.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ReasoningOptions.cs @@ -7,7 +7,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// /// Configuration options for reasoning models. /// -internal sealed record ReasoningOptions +internal sealed class ReasoningOptions { /// /// Constrains effort on reasoning for reasoning models. diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/Response.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/Response.cs index 260aa2478c..3f9c50e933 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/Response.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/Response.cs @@ -12,7 +12,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// The status of a response generation. /// [JsonConverter(typeof(SnakeCaseEnumConverter))] -public enum ResponseStatus +internal enum ResponseStatus { /// /// The response has been completed. @@ -111,7 +111,7 @@ internal sealed record Response /// The output items (messages) generated in the response. /// [JsonPropertyName("output")] - public required IList Output { get; init; } + public required List Output { get; init; } /// /// A system (or developer) message inserted into the model's context. @@ -135,7 +135,7 @@ internal sealed record Response /// An array of tools the model may call while generating a response. /// [JsonPropertyName("tools")] - public required IList Tools { get; init; } + public required List Tools { get; init; } /// /// How the model should select which tool (or tools) to use when generating a response. @@ -288,6 +288,9 @@ internal sealed record IncompleteDetails /// internal sealed record ResponseUsage { + /// + /// Gets a zero usage instance. + /// public static ResponseUsage Zero { get; } = new() { InputTokens = 0, diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ResponseInput.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ResponseInput.cs index 840adf87b0..d0555a2c00 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ResponseInput.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/ResponseInput.cs @@ -21,7 +21,7 @@ internal sealed class ResponseInput : IEquatable this.Messages = null; } - private ResponseInput(IReadOnlyList messages) + private ResponseInput(List messages) { this.Messages = messages ?? throw new ArgumentNullException(nameof(messages)); this.Text = null; @@ -35,12 +35,12 @@ internal sealed class ResponseInput : IEquatable /// /// Creates a ResponseInput from a list of messages. /// - public static ResponseInput FromMessages(IReadOnlyList messages) => new(messages); + public static ResponseInput FromMessages(List messages) => new(messages); /// /// Creates a ResponseInput from a list of messages. /// - public static ResponseInput FromMessages(params InputMessage[] messages) => new(messages); + public static ResponseInput FromMessages(params InputMessage[] messages) => new(messages.ToList()); /// /// Implicit conversion from string to ResponseInput. @@ -75,12 +75,13 @@ internal sealed class ResponseInput : IEquatable /// /// Gets the messages value, or null if this is not a messages input. /// - public IReadOnlyList? Messages { get; } + public List? Messages { get; } /// /// Gets the input as a list of InputMessage objects. /// - public IReadOnlyList GetInputMessages() + [System.Diagnostics.CodeAnalysis.SuppressMessage("Design", "CA1024:Use properties where appropriate", Justification = "Method performs transformation logic")] + public List GetInputMessages() { if (this.Text is not null) { @@ -164,6 +165,7 @@ internal sealed class ResponseInput : IEquatable /// internal sealed class ResponseInputJsonConverter : JsonConverter { + /// public override ResponseInput? Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { // Check if it's a string @@ -176,13 +178,14 @@ internal sealed class ResponseInputJsonConverter : JsonConverter // Check if it's an array if (reader.TokenType == JsonTokenType.StartArray) { - var messages = JsonSerializer.Deserialize(ref reader, ResponsesJsonContext.Default.ListInputMessage); + var messages = JsonSerializer.Deserialize(ref reader, OpenAIHostingJsonContext.Default.ListInputMessage); return messages is not null ? ResponseInput.FromMessages(messages) : null; } throw new JsonException($"Unexpected token type for ResponseInput: {reader.TokenType}"); } + /// public override void Write(Utf8JsonWriter writer, ResponseInput value, JsonSerializerOptions options) { if (value.IsText) @@ -191,7 +194,7 @@ internal sealed class ResponseInputJsonConverter : JsonConverter } else if (value.IsMessages) { - JsonSerializer.Serialize(writer, value.Messages!, ResponsesJsonContext.Default.IReadOnlyListInputMessage); + JsonSerializer.Serialize(writer, value.Messages!, OpenAIHostingJsonContext.Default.ListInputMessage); } else { diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/StreamOptions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/StreamOptions.cs index 3c9a484ddf..93ca5865e5 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/StreamOptions.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/StreamOptions.cs @@ -7,16 +7,8 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// /// Options for streaming responses. Only set this when you set stream: true. /// -internal sealed record StreamOptions +internal sealed class StreamOptions { - /// - /// If set, an additional chunk will be streamed before the data: [DONE] message. - /// The usage field on this chunk shows the token usage statistics for the entire request, - /// and the choices field will always be an empty array. - /// - [JsonPropertyName("include_usage")] - public bool? IncludeUsage { get; init; } - /// /// When true, stream obfuscation will be enabled. Stream obfuscation adds random characters /// to an obfuscation field on streaming delta events to normalize payload sizes as a mitigation diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/StreamingResponseEvent.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/StreamingResponseEvent.cs index 82f80bfa15..6d41e10aff 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/StreamingResponseEvent.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/StreamingResponseEvent.cs @@ -16,6 +16,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; [JsonDerivedType(typeof(StreamingResponseCompleted), StreamingResponseCompleted.EventType)] [JsonDerivedType(typeof(StreamingResponseIncomplete), StreamingResponseIncomplete.EventType)] [JsonDerivedType(typeof(StreamingResponseFailed), StreamingResponseFailed.EventType)] +[JsonDerivedType(typeof(StreamingResponseCancelled), StreamingResponseCancelled.EventType)] [JsonDerivedType(typeof(StreamingOutputItemAdded), StreamingOutputItemAdded.EventType)] [JsonDerivedType(typeof(StreamingOutputItemDone), StreamingOutputItemDone.EventType)] [JsonDerivedType(typeof(StreamingContentPartAdded), StreamingContentPartAdded.EventType)] @@ -26,7 +27,10 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; [JsonDerivedType(typeof(StreamingFunctionCallArgumentsDone), StreamingFunctionCallArgumentsDone.EventType)] [JsonDerivedType(typeof(StreamingReasoningSummaryTextDelta), StreamingReasoningSummaryTextDelta.EventType)] [JsonDerivedType(typeof(StreamingReasoningSummaryTextDone), StreamingReasoningSummaryTextDone.EventType)] -internal abstract record StreamingResponseEvent +[JsonDerivedType(typeof(StreamingWorkflowEventComplete), StreamingWorkflowEventComplete.EventType)] +[JsonDerivedType(typeof(StreamingFunctionApprovalRequested), StreamingFunctionApprovalRequested.EventType)] +[JsonDerivedType(typeof(StreamingFunctionApprovalResponded), StreamingFunctionApprovalResponded.EventType)] +internal abstract class StreamingResponseEvent { /// /// Gets the type identifier for the streaming response event. @@ -43,11 +47,22 @@ internal abstract record StreamingResponseEvent public int SequenceNumber { get; init; } } +/// +/// Denotes an instance which contains an update to the instance. +/// +internal interface IStreamingResponseEventWithResponse +{ + /// + /// Gets the response object associated with this streaming event. + /// + Response Response { get; } +} + /// /// Represents a streaming response event indicating that a new response has been created and streaming has begun. /// This is typically the first event sent in a streaming response sequence. /// -internal sealed record StreamingResponseCreated : StreamingResponseEvent +internal sealed class StreamingResponseCreated : StreamingResponseEvent, IStreamingResponseEventWithResponse { /// /// The constant event type identifier for response created events. @@ -69,7 +84,7 @@ internal sealed record StreamingResponseCreated : StreamingResponseEvent /// /// Represents a streaming response event indicating that the response is in progress. /// -internal sealed record StreamingResponseInProgress : StreamingResponseEvent +internal sealed class StreamingResponseInProgress : StreamingResponseEvent, IStreamingResponseEventWithResponse { /// /// The constant event type identifier for response in progress events. @@ -91,7 +106,7 @@ internal sealed record StreamingResponseInProgress : StreamingResponseEvent /// Represents a streaming response event indicating that the response has been completed. /// This is typically the last event sent in a streaming response sequence. /// -internal sealed record StreamingResponseCompleted : StreamingResponseEvent +internal sealed class StreamingResponseCompleted : StreamingResponseEvent, IStreamingResponseEventWithResponse { /// /// The constant event type identifier for response completed events. @@ -113,7 +128,7 @@ internal sealed record StreamingResponseCompleted : StreamingResponseEvent /// /// Represents a streaming response event indicating that the response finished as incomplete. /// -internal sealed record StreamingResponseIncomplete : StreamingResponseEvent +internal sealed class StreamingResponseIncomplete : StreamingResponseEvent, IStreamingResponseEventWithResponse { /// /// The constant event type identifier for response incomplete events. @@ -134,7 +149,7 @@ internal sealed record StreamingResponseIncomplete : StreamingResponseEvent /// /// Represents a streaming response event indicating that the response has failed. /// -internal sealed record StreamingResponseFailed : StreamingResponseEvent +internal sealed class StreamingResponseFailed : StreamingResponseEvent, IStreamingResponseEventWithResponse { /// /// The constant event type identifier for response failed events. @@ -152,11 +167,33 @@ internal sealed record StreamingResponseFailed : StreamingResponseEvent public required Response Response { get; init; } } +/// +/// Represents a streaming response event indicating that the response has been cancelled. +/// Only responses created with background=true can be cancelled. +/// +internal sealed class StreamingResponseCancelled : StreamingResponseEvent, IStreamingResponseEventWithResponse +{ + /// + /// The constant event type identifier for response cancelled events. + /// + public const string EventType = "response.cancelled"; + + /// + [JsonIgnore] + public override string Type => EventType; + + /// + /// Gets or sets the cancelled response object. + /// + [JsonPropertyName("response")] + public required Response Response { get; init; } +} + /// /// Represents a streaming response event indicating that a new output item has been added to the response. /// This event is sent when the AI agent produces a new piece of content during streaming. /// -internal sealed record StreamingOutputItemAdded : StreamingResponseEvent +internal sealed class StreamingOutputItemAdded : StreamingResponseEvent { /// /// The constant event type identifier for output item added events. @@ -186,7 +223,7 @@ internal sealed record StreamingOutputItemAdded : StreamingResponseEvent /// Represents a streaming response event indicating that an output item has been completed. /// This event is sent when the AI agent finishes producing a particular piece of content. /// -internal sealed record StreamingOutputItemDone : StreamingResponseEvent +internal sealed class StreamingOutputItemDone : StreamingResponseEvent { /// /// The constant event type identifier for output item done events. @@ -215,7 +252,7 @@ internal sealed record StreamingOutputItemDone : StreamingResponseEvent /// /// Represents a streaming response event indicating that a new content part has been added to an output item. /// -internal sealed record StreamingContentPartAdded : StreamingResponseEvent +internal sealed class StreamingContentPartAdded : StreamingResponseEvent { /// /// The constant event type identifier for content part added events. @@ -254,7 +291,7 @@ internal sealed record StreamingContentPartAdded : StreamingResponseEvent /// /// Represents a streaming response event indicating that a content part has been completed. /// -internal sealed record StreamingContentPartDone : StreamingResponseEvent +internal sealed class StreamingContentPartDone : StreamingResponseEvent { /// /// The constant event type identifier for content part done events. @@ -293,7 +330,7 @@ internal sealed record StreamingContentPartDone : StreamingResponseEvent /// /// Represents a streaming response event containing a text delta (incremental text chunk). /// -internal sealed record StreamingOutputTextDelta : StreamingResponseEvent +internal sealed class StreamingOutputTextDelta : StreamingResponseEvent { /// /// The constant event type identifier for output text delta events. @@ -332,13 +369,13 @@ internal sealed record StreamingOutputTextDelta : StreamingResponseEvent /// Gets or sets the log probability information for the output tokens. /// [JsonPropertyName("logprobs")] - public IList Logprobs { get; init; } = []; + public List Logprobs { get; init; } = []; } /// /// Represents a streaming response event indicating that output text has been completed. /// -internal sealed record StreamingOutputTextDone : StreamingResponseEvent +internal sealed class StreamingOutputTextDone : StreamingResponseEvent { /// /// The constant event type identifier for output text done events. @@ -377,7 +414,7 @@ internal sealed record StreamingOutputTextDone : StreamingResponseEvent /// /// Represents a streaming response event containing a function call arguments delta. /// -internal sealed record StreamingFunctionCallArgumentsDelta : StreamingResponseEvent +internal sealed class StreamingFunctionCallArgumentsDelta : StreamingResponseEvent { /// /// The constant event type identifier for function call arguments delta events. @@ -410,7 +447,7 @@ internal sealed record StreamingFunctionCallArgumentsDelta : StreamingResponseEv /// /// Represents a streaming response event indicating that function call arguments are complete. /// -internal sealed record StreamingFunctionCallArgumentsDone : StreamingResponseEvent +internal sealed class StreamingFunctionCallArgumentsDone : StreamingResponseEvent { /// /// The constant event type identifier for function call arguments done events. @@ -443,7 +480,7 @@ internal sealed record StreamingFunctionCallArgumentsDone : StreamingResponseEve /// /// Represents a streaming response event containing a reasoning summary text delta (incremental text chunk). /// -internal sealed record StreamingReasoningSummaryTextDelta : StreamingResponseEvent +internal sealed class StreamingReasoningSummaryTextDelta : StreamingResponseEvent { /// /// The constant event type identifier for reasoning summary text delta events. @@ -482,7 +519,7 @@ internal sealed record StreamingReasoningSummaryTextDelta : StreamingResponseEve /// /// Represents a streaming response event indicating that reasoning summary text has been completed. /// -internal sealed record StreamingReasoningSummaryTextDone : StreamingResponseEvent +internal sealed class StreamingReasoningSummaryTextDone : StreamingResponseEvent { /// /// The constant event type identifier for reasoning summary text done events. @@ -517,3 +554,148 @@ internal sealed record StreamingReasoningSummaryTextDone : StreamingResponseEven [JsonPropertyName("text")] public required string Text { get; init; } } + +/// +/// Represents a streaming response event containing a workflow event. +/// This event is sent during workflow execution to provide observability into workflow steps, +/// executor invocations, errors, and other workflow lifecycle events. +/// +internal sealed class StreamingWorkflowEventComplete : StreamingResponseEvent +{ + /// + /// The constant event type identifier for workflow event events. + /// + public const string EventType = "response.workflow_event.complete"; + + /// + [JsonIgnore] + public override string Type => EventType; + + /// + /// Gets or sets the index of the output in the response. + /// + [JsonPropertyName("output_index")] + public int OutputIndex { get; set; } + + /// + /// Gets or sets the workflow event data containing event type, executor ID, and event-specific data. + /// + [JsonPropertyName("data")] + public JsonElement? Data { get; set; } + + /// + /// Gets or sets the executor ID if this is an executor-scoped event. + /// + [JsonPropertyName("executor_id")] + public string? ExecutorId { get; set; } + + /// + /// Gets or sets the item ID for tracking purposes. + /// + [JsonPropertyName("item_id")] + public string? ItemId { get; set; } +} + +/// +/// Represents a streaming response event indicating a function approval has been requested. +/// This is a non-standard DevUI extension for human-in-the-loop scenarios. +/// +internal sealed class StreamingFunctionApprovalRequested : StreamingResponseEvent +{ + /// + /// The constant event type identifier for function approval requested events. + /// + public const string EventType = "response.function_approval.requested"; + + /// + [JsonIgnore] + public override string Type => EventType; + + /// + /// Gets or sets the unique identifier for the approval request. + /// + [JsonPropertyName("request_id")] + public required string RequestId { get; init; } + + /// + /// Gets or sets the function call that requires approval. + /// + [JsonPropertyName("function_call")] + public required FunctionCallInfo FunctionCall { get; init; } + + /// + /// Gets or sets the item ID for tracking purposes. + /// + [JsonPropertyName("item_id")] + public required string ItemId { get; init; } + + /// + /// Gets or sets the output index. + /// + [JsonPropertyName("output_index")] + public int OutputIndex { get; init; } +} + +/// +/// Represents a streaming response event indicating a function approval has been responded to. +/// This is a non-standard DevUI extension for human-in-the-loop scenarios. +/// +internal sealed class StreamingFunctionApprovalResponded : StreamingResponseEvent +{ + /// + /// The constant event type identifier for function approval responded events. + /// + public const string EventType = "response.function_approval.responded"; + + /// + [JsonIgnore] + public override string Type => EventType; + + /// + /// Gets or sets the unique identifier of the approval request being responded to. + /// + [JsonPropertyName("request_id")] + public required string RequestId { get; init; } + + /// + /// Gets or sets a value indicating whether the function call was approved. + /// + [JsonPropertyName("approved")] + public bool Approved { get; init; } + + /// + /// Gets or sets the item ID for tracking purposes. + /// + [JsonPropertyName("item_id")] + public required string ItemId { get; init; } + + /// + /// Gets or sets the output index. + /// + [JsonPropertyName("output_index")] + public int OutputIndex { get; init; } +} + +/// +/// Represents function call information for approval events. +/// +internal sealed class FunctionCallInfo +{ + /// + /// Gets or sets the function call ID. + /// + [JsonPropertyName("id")] + public required string Id { get; init; } + + /// + /// Gets or sets the function name. + /// + [JsonPropertyName("name")] + public required string Name { get; init; } + + /// + /// Gets or sets the function arguments. + /// + [JsonPropertyName("arguments")] + public required JsonElement Arguments { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/TextConfiguration.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/TextConfiguration.cs index dc590030e6..6a4e98651d 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/TextConfiguration.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/TextConfiguration.cs @@ -1,6 +1,6 @@ // Copyright (c) Microsoft. All rights reserved. -using System.Collections.Generic; +using System.Text.Json; using System.Text.Json.Serialization; namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; @@ -8,7 +8,7 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; /// /// Configuration options for a text response from the model. /// -internal sealed record TextConfiguration +internal sealed class TextConfiguration { /// /// The format configuration for the text response. @@ -34,7 +34,7 @@ internal sealed record TextConfiguration [JsonDerivedType(typeof(ResponseTextFormatConfigurationText), "text")] [JsonDerivedType(typeof(ResponseTextFormatConfigurationJsonObject), "json_object")] [JsonDerivedType(typeof(ResponseTextFormatConfigurationJsonSchema), "json_schema")] -internal abstract record ResponseTextFormatConfiguration +internal abstract class ResponseTextFormatConfiguration { /// /// The type of response format. @@ -46,7 +46,7 @@ internal abstract record ResponseTextFormatConfiguration /// /// Plain text response format configuration. /// -internal sealed record ResponseTextFormatConfigurationText : ResponseTextFormatConfiguration +internal sealed class ResponseTextFormatConfigurationText : ResponseTextFormatConfiguration { /// /// Gets the type of response format. Always "text". @@ -59,7 +59,7 @@ internal sealed record ResponseTextFormatConfigurationText : ResponseTextFormatC /// JSON object response format configuration. /// Ensures the message the model generates is valid JSON. /// -internal sealed record ResponseTextFormatConfigurationJsonObject : ResponseTextFormatConfiguration +internal sealed class ResponseTextFormatConfigurationJsonObject : ResponseTextFormatConfiguration { /// /// Gets the type of response format. Always "json_object". @@ -71,7 +71,7 @@ internal sealed record ResponseTextFormatConfigurationJsonObject : ResponseTextF /// /// JSON schema response format configuration with structured output schema. /// -internal sealed record ResponseTextFormatConfigurationJsonSchema : ResponseTextFormatConfiguration +internal sealed class ResponseTextFormatConfigurationJsonSchema : ResponseTextFormatConfiguration { /// /// Gets the type of response format. Always "json_schema". @@ -97,7 +97,7 @@ internal sealed record ResponseTextFormatConfigurationJsonSchema : ResponseTextF /// The JSON schema for structured outputs. /// [JsonPropertyName("schema")] - public required Dictionary Schema { get; init; } + public required JsonElement Schema { get; init; } /// /// Whether to enable strict schema adherence when generating the output. diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/WorkflowEventData.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/WorkflowEventData.cs new file mode 100644 index 0000000000..cc7f44cda6 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Models/WorkflowEventData.cs @@ -0,0 +1,38 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +/// +/// Represents workflow event data for serialization. +/// +internal sealed class WorkflowEventData +{ + /// + /// The type of the workflow event. + /// + [JsonPropertyName("event_type")] + public required string EventType { get; init; } + + /// + /// The event data payload. + /// + [JsonPropertyName("data")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public JsonElement? Data { get; init; } + + /// + /// The executor ID, if this is an executor event. + /// + [JsonPropertyName("executor_id")] + [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)] + public string? ExecutorId { get; init; } + + /// + /// The timestamp when the event occurred. + /// + [JsonPropertyName("timestamp")] + public required string Timestamp { get; init; } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesHttpHandler.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesHttpHandler.cs new file mode 100644 index 0000000000..31f61e967e --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesHttpHandler.cs @@ -0,0 +1,227 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Threading; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Mvc; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; + +/// +/// Handles route requests for OpenAI Responses API endpoints. +/// +internal sealed class ResponsesHttpHandler +{ + private readonly IResponsesService _responsesService; + + /// + /// Initializes a new instance of the class. + /// + /// The responses service. + public ResponsesHttpHandler(IResponsesService responsesService) + { + this._responsesService = responsesService ?? throw new ArgumentNullException(nameof(responsesService)); + } + + /// + /// Creates a model response for the given input. + /// + public async Task CreateResponseAsync( + [FromBody] CreateResponse request, + [FromQuery] bool? stream, + CancellationToken cancellationToken) + { + try + { + // Handle streaming vs non-streaming + bool shouldStream = stream ?? request.Stream ?? false; + + if (shouldStream) + { + var streamingResponse = this._responsesService.CreateResponseStreamingAsync( + request, + cancellationToken: cancellationToken); + + return new SseJsonResult( + streamingResponse, + static evt => evt.Type, + OpenAIHostingJsonContext.Default.StreamingResponseEvent); + } + + var response = await this._responsesService.CreateResponseAsync( + request, + cancellationToken: cancellationToken).ConfigureAwait(false); + + return Results.Ok(response); + } + catch (InvalidOperationException ex) when (ex.Message.Contains("Mutually exclusive")) + { + // Return OpenAI-style error for mutual exclusivity violations + return Results.BadRequest(new ErrorResponse + { + Error = new ErrorDetails + { + Message = ex.Message, + Type = "invalid_request_error", + Code = "mutually_exclusive_parameters" + } + }); + } + catch (InvalidOperationException ex) when (ex.Message.Contains("not found") || ex.Message.Contains("does not exist")) + { + // Return OpenAI-style error for not found errors + return Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = ex.Message, + Type = "invalid_request_error" + } + }); + } + catch (InvalidOperationException ex) when (ex.Message.Contains("No 'agent.name' or 'model' specified")) + { + // Return OpenAI-style error for missing required parameters + return Results.BadRequest(new ErrorResponse + { + Error = new ErrorDetails + { + Message = ex.Message, + Type = "invalid_request_error", + Code = "missing_required_parameter" + } + }); + } + } + + /// + /// Retrieves a response by ID. + /// + public async Task GetResponseAsync( + string responseId, + [FromQuery] string[]? include, + [FromQuery] bool? stream, + [FromQuery] int? starting_after, + CancellationToken cancellationToken) + { + // If streaming is requested, return SSE stream + if (stream == true) + { + var streamingResponse = this._responsesService.GetResponseStreamingAsync( + responseId, + startingAfter: starting_after, + cancellationToken: cancellationToken); + + return new SseJsonResult( + streamingResponse, + static evt => evt.Type, + OpenAIHostingJsonContext.Default.StreamingResponseEvent); + } + + // Non-streaming: return the response object + var response = await this._responsesService.GetResponseAsync(responseId, cancellationToken).ConfigureAwait(false); + return response is not null + ? Results.Ok(response) + : Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Response '{responseId}' not found.", + Type = "invalid_request_error" + } + }); + } + + /// + /// Cancels an in-progress response. + /// + public async Task CancelResponseAsync( + string responseId, + CancellationToken cancellationToken) + { + try + { + var response = await this._responsesService.CancelResponseAsync(responseId, cancellationToken).ConfigureAwait(false); + return Results.Ok(response); + } + catch (InvalidOperationException ex) + { + return Results.BadRequest(new ErrorResponse + { + Error = new ErrorDetails + { + Message = ex.Message, + Type = "invalid_request_error" + } + }); + } + } + + /// + /// Deletes a response. + /// + public async Task DeleteResponseAsync( + string responseId, + CancellationToken cancellationToken) + { + var deleted = await this._responsesService.DeleteResponseAsync(responseId, cancellationToken).ConfigureAwait(false); + return deleted + ? Results.Ok(new DeleteResponse { Id = responseId, Object = "response", Deleted = true }) + : Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = $"Response '{responseId}' not found.", + Type = "invalid_request_error" + } + }); + } + + /// + /// Lists the input items for a response. + /// + public async Task ListResponseInputItemsAsync( + string responseId, + [FromQuery] int? limit, + [FromQuery] string? order, + [FromQuery] string? after, + [FromQuery] string? before, + CancellationToken cancellationToken) + { + try + { + // Convert string order to SortOrder enum + SortOrder? sortOrder = order switch + { + string s when s.Equals("asc", StringComparison.OrdinalIgnoreCase) => SortOrder.Ascending, + string s when s.Equals("desc", StringComparison.OrdinalIgnoreCase) => SortOrder.Descending, + null => null, + _ => throw new InvalidOperationException($"Invalid order value: {order}. Must be 'asc' or 'desc'.") + }; + + var result = await this._responsesService.ListResponseInputItemsAsync( + responseId, + limit, + sortOrder, + after, + before, + cancellationToken).ConfigureAwait(false); + + return Results.Ok(result); + } + catch (InvalidOperationException ex) + { + return Results.NotFound(new ErrorResponse + { + Error = new ErrorDetails + { + Message = ex.Message, + Type = "invalid_request_error" + } + }); + } + } +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesJsonSerializerOptions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesJsonSerializerOptions.cs deleted file mode 100644 index 5f014466fc..0000000000 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/ResponsesJsonSerializerOptions.cs +++ /dev/null @@ -1,24 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. - -using System.Text.Json; - -namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses; - -/// -/// Extension methods for JSON serialization. -/// -internal static class ResponsesJsonSerializerOptions -{ - /// - /// Gets the default JSON serializer options. - /// - public static JsonSerializerOptions Default { get; } = Create(); - - private static JsonSerializerOptions Create() - { - JsonSerializerOptions options = new(ResponsesJsonContext.Default.Options); - options.TypeInfoResolverChain.Add(AgentAbstractionsJsonUtilities.DefaultOptions.TypeInfoResolver!); - options.MakeReadOnly(); - return options; - } -} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/AudioContentEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/AudioContentEventGenerator.cs index 0d80f93154..446b0401ac 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/AudioContentEventGenerator.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/AudioContentEventGenerator.cs @@ -16,27 +16,18 @@ internal sealed class AudioContentEventGenerator( SequenceNumber seq, int outputIndex) : StreamingEventGenerator { - private bool _isCompleted; - public override bool IsSupported(AIContent content) => content is DataContent dataContent && dataContent.HasTopLevelMediaType("audio"); public override IEnumerable ProcessContent(AIContent content) { - if (this._isCompleted) - { - throw new InvalidOperationException("Cannot process content after the generator has been completed."); - } - if (content is not DataContent audioData || !audioData.HasTopLevelMediaType("audio")) { throw new InvalidOperationException("AudioContentEventGenerator only supports audio DataContent."); } var itemId = idGenerator.GenerateMessageId(); - var itemContent = ItemContentConverter.ToItemContent(content) as ItemContentInputAudio; - - if (itemContent == null) + if (ItemContentConverter.ToItemContent(content) is not ItemContentInputAudio itemContent) { throw new InvalidOperationException("Failed to convert audio content to ItemContentInputAudio."); } @@ -79,13 +70,7 @@ internal sealed class AudioContentEventGenerator( OutputIndex = outputIndex, Item = item }; - - this._isCompleted = true; } - public override IEnumerable Complete() - { - this._isCompleted = true; - return []; - } + public override IEnumerable Complete() => []; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/ErrorContentEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/ErrorContentEventGenerator.cs index 8320b1f977..6380cb8ba7 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/ErrorContentEventGenerator.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/ErrorContentEventGenerator.cs @@ -16,26 +16,17 @@ internal sealed class ErrorContentEventGenerator( SequenceNumber seq, int outputIndex) : StreamingEventGenerator { - private bool _isCompleted; - public override bool IsSupported(AIContent content) => content is ErrorContent; public override IEnumerable ProcessContent(AIContent content) { - if (this._isCompleted) - { - throw new InvalidOperationException("Cannot process content after the generator has been completed."); - } - if (content is not ErrorContent) { throw new InvalidOperationException("ErrorContentEventGenerator only supports ErrorContent."); } var itemId = idGenerator.GenerateMessageId(); - var itemContent = ItemContentConverter.ToItemContent(content) as ItemContentRefusal; - - if (itemContent == null) + if (ItemContentConverter.ToItemContent(content) is not ItemContentRefusal itemContent) { throw new InvalidOperationException("Failed to convert error content to ItemContentRefusal."); } @@ -78,13 +69,7 @@ internal sealed class ErrorContentEventGenerator( OutputIndex = outputIndex, Item = item }; - - this._isCompleted = true; } - public override IEnumerable Complete() - { - this._isCompleted = true; - return []; - } + public override IEnumerable Complete() => []; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FileContentEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FileContentEventGenerator.cs index bf60c2f1cf..5fe7333ac3 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FileContentEventGenerator.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FileContentEventGenerator.cs @@ -16,8 +16,6 @@ internal sealed class FileContentEventGenerator( SequenceNumber seq, int outputIndex) : StreamingEventGenerator { - private bool _isCompleted; - public override bool IsSupported(AIContent content) => content is DataContent dataContent && !dataContent.HasTopLevelMediaType("image") && @@ -25,11 +23,6 @@ internal sealed class FileContentEventGenerator( public override IEnumerable ProcessContent(AIContent content) { - if (this._isCompleted) - { - throw new InvalidOperationException("Cannot process content after the generator has been completed."); - } - if (content is not DataContent fileData || fileData.HasTopLevelMediaType("image") || fileData.HasTopLevelMediaType("audio")) @@ -38,9 +31,7 @@ internal sealed class FileContentEventGenerator( } var itemId = idGenerator.GenerateMessageId(); - var itemContent = ItemContentConverter.ToItemContent(content) as ItemContentInputFile; - - if (itemContent == null) + if (ItemContentConverter.ToItemContent(content) is not ItemContentInputFile itemContent) { throw new InvalidOperationException("Failed to convert file content to ItemContentInputFile."); } @@ -83,13 +74,7 @@ internal sealed class FileContentEventGenerator( OutputIndex = outputIndex, Item = item }; - - this._isCompleted = true; } - public override IEnumerable Complete() - { - this._isCompleted = true; - return []; - } + public override IEnumerable Complete() => []; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionApprovalRequestEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionApprovalRequestEventGenerator.cs new file mode 100644 index 0000000000..4e565b0784 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionApprovalRequestEventGenerator.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Text.Json; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; +using Microsoft.Extensions.AI; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Streaming; + +/// +/// A generator for streaming events from function approval request content. +/// This is a non-standard DevUI extension for human-in-the-loop scenarios. +/// +internal sealed class FunctionApprovalRequestEventGenerator( + IdGenerator idGenerator, + SequenceNumber seq, + int outputIndex, + JsonSerializerOptions jsonSerializerOptions) : StreamingEventGenerator +{ + public override bool IsSupported(AIContent content) => content is FunctionApprovalRequestContent; + + public override IEnumerable ProcessContent(AIContent content) + { + if (content is not FunctionApprovalRequestContent approvalRequest) + { + throw new InvalidOperationException("FunctionApprovalRequestEventGenerator only supports FunctionApprovalRequestContent."); + } + + yield return new StreamingFunctionApprovalRequested + { + SequenceNumber = seq.Increment(), + OutputIndex = outputIndex, + RequestId = approvalRequest.Id, + ItemId = idGenerator.GenerateMessageId(), + FunctionCall = new FunctionCallInfo + { + Id = approvalRequest.FunctionCall.CallId, + Name = approvalRequest.FunctionCall.Name, + Arguments = JsonSerializer.SerializeToElement( + approvalRequest.FunctionCall.Arguments, + jsonSerializerOptions.GetTypeInfo(typeof(IDictionary))) + } + }; + } + + public override IEnumerable Complete() => []; +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionApprovalResponseEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionApprovalResponseEventGenerator.cs new file mode 100644 index 0000000000..ab4af8f408 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionApprovalResponseEventGenerator.cs @@ -0,0 +1,39 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; +using Microsoft.Extensions.AI; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.Responses.Streaming; + +/// +/// A generator for streaming events from function approval response content. +/// This is a non-standard DevUI extension for human-in-the-loop scenarios. +/// +internal sealed class FunctionApprovalResponseEventGenerator( + IdGenerator idGenerator, + SequenceNumber seq, + int outputIndex) : StreamingEventGenerator +{ + public override bool IsSupported(AIContent content) => content is FunctionApprovalResponseContent; + + public override IEnumerable ProcessContent(AIContent content) + { + if (content is not FunctionApprovalResponseContent approvalResponse) + { + throw new InvalidOperationException("FunctionApprovalResponseEventGenerator only supports FunctionApprovalResponseContent."); + } + + yield return new StreamingFunctionApprovalResponded + { + SequenceNumber = seq.Increment(), + OutputIndex = outputIndex, + RequestId = approvalResponse.Id, + Approved = approvalResponse.Approved, + ItemId = idGenerator.GenerateMessageId() + }; + } + + public override IEnumerable Complete() => []; +} diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionCallEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionCallEventGenerator.cs index 74f5ffe4ae..c0b0aba54d 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionCallEventGenerator.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionCallEventGenerator.cs @@ -17,17 +17,10 @@ internal sealed class FunctionCallEventGenerator( int outputIndex, JsonSerializerOptions jsonSerializerOptions) : StreamingEventGenerator { - private bool _isCompleted; - public override bool IsSupported(AIContent content) => content is FunctionCallContent; public override IEnumerable ProcessContent(AIContent content) { - if (this._isCompleted) - { - throw new InvalidOperationException("Cannot process content after the generator has been completed."); - } - if (content is not FunctionCallContent functionCallContent) { throw new InvalidOperationException("FunctionCallEventGenerator only supports FunctionCallContent."); @@ -63,13 +56,7 @@ internal sealed class FunctionCallEventGenerator( OutputIndex = outputIndex, Item = item }; - - this._isCompleted = true; } - public override IEnumerable Complete() - { - this._isCompleted = true; - return []; - } + public override IEnumerable Complete() => []; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionResultEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionResultEventGenerator.cs index 1c7810a825..116eb716e1 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionResultEventGenerator.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/FunctionResultEventGenerator.cs @@ -15,17 +15,10 @@ internal sealed class FunctionResultEventGenerator( SequenceNumber seq, int outputIndex) : StreamingEventGenerator { - private bool _isCompleted; - public override bool IsSupported(AIContent content) => content is FunctionResultContent; public override IEnumerable ProcessContent(AIContent content) { - if (this._isCompleted) - { - throw new InvalidOperationException("Cannot process content after the generator has been completed."); - } - if (content is not FunctionResultContent functionResultContent) { throw new InvalidOperationException("FunctionResultEventGenerator only supports FunctionResultContent."); @@ -45,13 +38,7 @@ internal sealed class FunctionResultEventGenerator( OutputIndex = outputIndex, Item = item }; - - this._isCompleted = true; } - public override IEnumerable Complete() - { - this._isCompleted = true; - return []; - } + public override IEnumerable Complete() => []; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/HostedFileContentEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/HostedFileContentEventGenerator.cs index 5846858aa2..a8beefe211 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/HostedFileContentEventGenerator.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/HostedFileContentEventGenerator.cs @@ -16,26 +16,17 @@ internal sealed class HostedFileContentEventGenerator( SequenceNumber seq, int outputIndex) : StreamingEventGenerator { - private bool _isCompleted; - public override bool IsSupported(AIContent content) => content is HostedFileContent; public override IEnumerable ProcessContent(AIContent content) { - if (this._isCompleted) - { - throw new InvalidOperationException("Cannot process content after the generator has been completed."); - } - if (content is not HostedFileContent) { throw new InvalidOperationException("HostedFileContentEventGenerator only supports HostedFileContent."); } var itemId = idGenerator.GenerateMessageId(); - var itemContent = ItemContentConverter.ToItemContent(content) as ItemContentInputFile; - - if (itemContent == null) + if (ItemContentConverter.ToItemContent(content) is not ItemContentInputFile itemContent) { throw new InvalidOperationException("Failed to convert hosted file content to ItemContentInputFile."); } @@ -78,13 +69,7 @@ internal sealed class HostedFileContentEventGenerator( OutputIndex = outputIndex, Item = item }; - - this._isCompleted = true; } - public override IEnumerable Complete() - { - this._isCompleted = true; - return []; - } + public override IEnumerable Complete() => []; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/ImageContentEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/ImageContentEventGenerator.cs index 0b80abbfd2..0642043f3d 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/ImageContentEventGenerator.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/ImageContentEventGenerator.cs @@ -16,22 +16,13 @@ internal sealed class ImageContentEventGenerator( SequenceNumber seq, int outputIndex) : StreamingEventGenerator { - private bool _isCompleted; - public override bool IsSupported(AIContent content) => - content is UriContent uriContent && uriContent.HasTopLevelMediaType("image") || - content is DataContent dataContent && dataContent.HasTopLevelMediaType("image"); + (content is UriContent uriContent && uriContent.HasTopLevelMediaType("image")) || + (content is DataContent dataContent && dataContent.HasTopLevelMediaType("image")); public override IEnumerable ProcessContent(AIContent content) { - if (this._isCompleted) - { - throw new InvalidOperationException("Cannot process content after the generator has been completed."); - } - - ItemContentInputImage? itemContent = ItemContentConverter.ToItemContent(content) as ItemContentInputImage; - - if (itemContent == null) + if (ItemContentConverter.ToItemContent(content) is not ItemContentInputImage itemContent) { throw new InvalidOperationException("ImageContentEventGenerator only supports image UriContent and DataContent."); } @@ -76,13 +67,7 @@ internal sealed class ImageContentEventGenerator( OutputIndex = outputIndex, Item = item }; - - this._isCompleted = true; } - public override IEnumerable Complete() - { - this._isCompleted = true; - return []; - } + public override IEnumerable Complete() => []; } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/TextReasoningContentEventGenerator.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/TextReasoningContentEventGenerator.cs index 5be8d73aa9..3004b00085 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/TextReasoningContentEventGenerator.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/Responses/Streaming/TextReasoningContentEventGenerator.cs @@ -18,7 +18,7 @@ internal sealed class TextReasoningContentEventGenerator( int outputIndex) : StreamingEventGenerator { private State _currentState = State.Initial; - private readonly string _itemId = idGenerator.GenerateMessageId(); + private readonly string _itemId = idGenerator.GenerateReasoningId(); private readonly StringBuilder _text = new(); private const int SummaryIndex = 0; // Summary index for reasoning summary text diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ServiceCollectionExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ServiceCollectionExtensions.cs index d4ea17e912..54e8bd7ba3 100644 --- a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ServiceCollectionExtensions.cs +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/ServiceCollectionExtensions.cs @@ -2,9 +2,12 @@ using System; using Microsoft.Agents.AI; +using Microsoft.Agents.AI.Hosting.OpenAI; using Microsoft.Agents.AI.Hosting.OpenAI.ChatCompletions; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations; using Microsoft.Agents.AI.Hosting.OpenAI.Responses; using Microsoft.AspNetCore.Http.Json; +using Microsoft.Extensions.DependencyInjection.Extensions; namespace Microsoft.Extensions.DependencyInjection; @@ -29,6 +32,7 @@ public static class MicrosoftAgentAIHostingOpenAIServiceCollectionExtensions /// /// Adds support for exposing instances via OpenAI Responses. + /// Uses the in-memory responses service implementation. /// /// The to configure. /// The for method chaining. @@ -36,8 +40,39 @@ public static class MicrosoftAgentAIHostingOpenAIServiceCollectionExtensions { ArgumentNullException.ThrowIfNull(services); - services.Configure(options => options.SerializerOptions.TypeInfoResolverChain.Add(ResponsesJsonSerializerOptions.Default.TypeInfoResolver!)); + services.Configure(options + => options.SerializerOptions.TypeInfoResolverChain.Add( + OpenAIHostingJsonContext.Default.Options.TypeInfoResolver!)); + + services.TryAddSingleton(); + services.TryAddSingleton(); + services.TryAddSingleton(); + services.TryAddSingleton(sp => + { + var executor = sp.GetRequiredService(); + var options = sp.GetRequiredService(); + var conversationStorage = sp.GetService(); + return new InMemoryResponsesService(executor, options, conversationStorage); + }); + services.TryAddSingleton(); return services; } + + /// + /// Adds in-memory conversation storage and indexing services to the service collection. + /// This is suitable only for development and testing scenarios. + /// + /// The service collection to add services to. + /// The service collection for chaining. + public static IServiceCollection AddOpenAIConversations(this IServiceCollection services) + { + ArgumentNullException.ThrowIfNull(services); + + // Register storage options + services.TryAddSingleton(); + services.TryAddSingleton(); + services.TryAddSingleton(); + return services; + } } diff --git a/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/SseJsonResult.cs b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/SseJsonResult.cs new file mode 100644 index 0000000000..2edb2f0027 --- /dev/null +++ b/dotnet/src/Microsoft.Agents.AI.Hosting.OpenAI/SseJsonResult.cs @@ -0,0 +1,75 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Buffers; +using System.Collections.Generic; +using System.Net.ServerSentEvents; +using System.Text.Json; +using System.Text.Json.Serialization.Metadata; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Http; +using Microsoft.AspNetCore.Http.Features; + +namespace Microsoft.Agents.AI.Hosting.OpenAI; + +/// +/// IResult implementation for streaming JSON data using Server-Sent Events (SSE). +/// +/// The type of items to stream. +internal sealed class SseJsonResult : IResult +{ + private readonly IAsyncEnumerable _events; + private readonly JsonTypeInfo _jsonTypeInfo; + private readonly Func _getEventType; + + /// + /// Initializes a new instance of the class. + /// + /// The async enumerable of items to stream. + /// A function to get the optional event type from each item. + /// The JSON type information for serializing items. + public SseJsonResult(IAsyncEnumerable events, Func getEventType, JsonTypeInfo jsonTypeInfo) + { + this._events = events ?? throw new ArgumentNullException(nameof(events)); + this._jsonTypeInfo = jsonTypeInfo ?? throw new ArgumentNullException(nameof(jsonTypeInfo)); + this._getEventType = getEventType ?? throw new ArgumentNullException(nameof(getEventType)); + } + + /// + /// Executes the result by streaming items to the HTTP response using Server-Sent Events format. + /// + /// The HTTP context. + public async Task ExecuteAsync(HttpContext httpContext) + { + var response = httpContext.Response; + var cancellationToken = httpContext.RequestAborted; + + // Set SSE headers + response.Headers.ContentType = "text/event-stream"; + response.Headers.CacheControl = "no-cache,no-store"; + response.Headers.Connection = "keep-alive"; + response.Headers.ContentEncoding = "identity"; + httpContext.Features.GetRequiredFeature().DisableBuffering(); + + await SseFormatter.WriteAsync( + source: this.GetItemsAsync(), + destination: response.Body, + itemFormatter: this.FormatItem, + cancellationToken).ConfigureAwait(false); + } + + private async IAsyncEnumerable> GetItemsAsync() + { + await foreach (var item in this._events.ConfigureAwait(false)) + { + yield return new SseItem(item, this._getEventType(item)); + } + } + + private void FormatItem(SseItem sseItem, IBufferWriter bufferWriter) + { + using var writer = new Utf8JsonWriter(bufferWriter); + JsonSerializer.Serialize(writer, sseItem.Data, this._jsonTypeInfo); + writer.Flush(); + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/AgentInvocationContextTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/AgentInvocationContextTests.cs new file mode 100644 index 0000000000..b6458775bb --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/AgentInvocationContextTests.cs @@ -0,0 +1,92 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System.Text.Json; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Unit tests for AgentInvocationContext. +/// +public sealed class AgentInvocationContextTests +{ + [Fact] + public void Constructor_WithIdGenerator_InitializesCorrectly() + { + // Arrange + var idGenerator = new IdGenerator("resp_test123", "conv_test456"); + + // Act + var context = new AgentInvocationContext(idGenerator); + + // Assert + Assert.NotNull(context); + Assert.Same(idGenerator, context.IdGenerator); + Assert.Equal("resp_test123", context.ResponseId); + Assert.Equal("conv_test456", context.ConversationId); + Assert.NotNull(context.JsonSerializerOptions); + } + + [Fact] + public void Constructor_WithoutJsonOptions_UsesDefaultOptions() + { + // Arrange + var idGenerator = new IdGenerator("resp_test", "conv_test"); + + // Act + var context = new AgentInvocationContext(idGenerator); + + // Assert + Assert.NotNull(context.JsonSerializerOptions); + Assert.Same(OpenAIHostingJsonUtilities.DefaultOptions, context.JsonSerializerOptions); + } + + [Fact] + public void Constructor_WithCustomJsonOptions_UsesProvidedOptions() + { + // Arrange + var idGenerator = new IdGenerator("resp_test", "conv_test"); + var customOptions = new JsonSerializerOptions + { + PropertyNameCaseInsensitive = true + }; + + // Act + var context = new AgentInvocationContext(idGenerator, customOptions); + + // Assert + Assert.Same(customOptions, context.JsonSerializerOptions); + } + + [Fact] + public void ResponseId_ReturnsIdGeneratorResponseId() + { + // Arrange + const string ResponseId = "resp_property_test"; + var idGenerator = new IdGenerator(ResponseId, "conv_test"); + var context = new AgentInvocationContext(idGenerator); + + // Act + string result = context.ResponseId; + + // Assert + Assert.Equal(ResponseId, result); + Assert.Equal(idGenerator.ResponseId, result); + } + + [Fact] + public void ConversationId_ReturnsIdGeneratorConversationId() + { + // Arrange + const string ConversationId = "conv_property_test"; + var idGenerator = new IdGenerator("resp_test", ConversationId); + var context = new AgentInvocationContext(idGenerator); + + // Act + string result = context.ConversationId; + + // Assert + Assert.Equal(ConversationId, result); + Assert.Equal(idGenerator.ConversationId, result); + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTestBase.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTestBase.cs index 18e67267d6..ccb8655624 100644 --- a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTestBase.cs +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTestBase.cs @@ -226,6 +226,37 @@ public abstract class ConformanceTestBase : IAsyncDisposable builder.Services.AddKeyedSingleton("chat-client", mockChatClient); builder.AddAIAgent(agentName, instructions, chatClientServiceKey: "chat-client"); builder.AddOpenAIResponses(); + + this._app = builder.Build(); + AIAgent agent = this._app.Services.GetRequiredKeyedService(agentName); + this._app.MapOpenAIResponses(agent); + this._app.MapOpenAIChatCompletions(agent); + + await this._app.StartAsync(); + + TestServer testServer = this._app.Services.GetRequiredService() as TestServer + ?? throw new InvalidOperationException("TestServer not found"); + + this._httpClient = testServer.CreateClient(); + return this._httpClient; + } + + /// + /// Creates a test server with a mock chat client that returns function call content. + /// + protected async Task CreateTestServerWithToolCallAsync( + string agentName, + string instructions, + string functionName, + string arguments) + { + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + builder.WebHost.UseTestServer(); + + IChatClient mockChatClient = new TestHelpers.ToolCallMockChatClient(functionName, arguments); + builder.Services.AddKeyedSingleton("chat-client", mockChatClient); + builder.AddAIAgent(agentName, instructions, chatClientServiceKey: "chat-client"); + builder.AddOpenAIResponses(); builder.AddOpenAIChatCompletions(); this._app = builder.Build(); diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/add_items/request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/add_items/request.json new file mode 100644 index 0000000000..e5329afbf6 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/add_items/request.json @@ -0,0 +1,24 @@ +{ + "items": [ + { + "type": "message", + "role": "user", + "content": [ + { + "type": "input_text", + "text": "What is the weather like today?" + } + ] + }, + { + "type": "message", + "role": "user", + "content": [ + { + "type": "input_text", + "text": "Tell me a joke!" + } + ] + } + ] +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/add_items/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/add_items/response.json new file mode 100644 index 0000000000..83de8ffe5e --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/add_items/response.json @@ -0,0 +1,32 @@ +{ + "object": "list", + "data": [ + { + "id": "msg_68fb9abf14a08195b16bb05eab82cf9d04cbf45151194822", + "type": "message", + "status": "completed", + "content": [ + { + "type": "input_text", + "text": "What is the weather like today?" + } + ], + "role": "user" + }, + { + "id": "msg_68fb9abf14d08195af5037cc3048b1c704cbf45151194822", + "type": "message", + "status": "completed", + "content": [ + { + "type": "input_text", + "text": "Tell me a joke!" + } + ], + "role": "user" + } + ], + "first_id": "msg_68fb9abf14a08195b16bb05eab82cf9d04cbf45151194822", + "has_more": false, + "last_id": "msg_68fb9abf14d08195af5037cc3048b1c704cbf45151194822" +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/create_conversation_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/create_conversation_request.json new file mode 100644 index 0000000000..50ca7a03a6 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/create_conversation_request.json @@ -0,0 +1,5 @@ +{ + "metadata": { + "test_type": "basic_conversation" + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/create_conversation_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/create_conversation_response.json new file mode 100644 index 0000000000..41eec4c70d --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/create_conversation_response.json @@ -0,0 +1,8 @@ +{ + "id": "conv_68fb96fe1a488195bf48df8f7666551604cbf45151194822", + "object": "conversation", + "created_at": 1761318654, + "metadata": { + "test_type": "basic_conversation" + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/first_message_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/first_message_request.json new file mode 100644 index 0000000000..78e1101657 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/first_message_request.json @@ -0,0 +1,6 @@ +{ + "model": "gpt-4o-mini", + "conversation": "conv_68fb96fe1a488195bf48df8f7666551604cbf45151194822", + "input": "What is the capital of France?", + "max_output_tokens": 100 +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/first_message_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/first_message_response.json new file mode 100644 index 0000000000..b6164798b9 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/first_message_response.json @@ -0,0 +1,70 @@ +{ + "id": "resp_04cbf451511948220068fb97bdec548195a367870aa85734de", + "object": "response", + "created_at": 1761318846, + "status": "completed", + "background": false, + "billing": { + "payer": "developer" + }, + "conversation": { + "id": "conv_68fb96fe1a488195bf48df8f7666551604cbf45151194822" + }, + "error": null, + "incomplete_details": null, + "instructions": null, + "max_output_tokens": 100, + "max_tool_calls": null, + "model": "gpt-4o-mini-2024-07-18", + "output": [ + { + "id": "msg_04cbf451511948220068fb97c0162881958d80862a0d253a14", + "type": "message", + "status": "completed", + "content": [ + { + "type": "output_text", + "annotations": [], + "logprobs": [], + "text": "The capital of France is Paris." + } + ], + "role": "assistant" + } + ], + "parallel_tool_calls": true, + "previous_response_id": null, + "prompt_cache_key": null, + "reasoning": { + "effort": null, + "summary": null + }, + "safety_identifier": null, + "service_tier": "default", + "store": true, + "temperature": 1.0, + "text": { + "format": { + "type": "text" + }, + "verbosity": "medium" + }, + "tool_choice": "auto", + "tools": [], + "top_logprobs": 0, + "top_p": 1.0, + "truncation": "disabled", + "usage": { + "input_tokens": 36, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 8, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 44 + }, + "user": null, + "metadata": {} +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/second_message_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/second_message_request.json new file mode 100644 index 0000000000..f7818bd906 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/second_message_request.json @@ -0,0 +1,6 @@ +{ + "model": "gpt-4o-mini", + "conversation": "conv_68fb96fe1a488195bf48df8f7666551604cbf45151194822", + "input": "What is its population?", + "max_output_tokens": 150 +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/second_message_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/second_message_response.json new file mode 100644 index 0000000000..3315534da6 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic/second_message_response.json @@ -0,0 +1,70 @@ +{ + "id": "resp_04cbf451511948220068fb97cf320881958b69530fe07eb2a9", + "object": "response", + "created_at": 1761318863, + "status": "completed", + "background": false, + "billing": { + "payer": "developer" + }, + "conversation": { + "id": "conv_68fb96fe1a488195bf48df8f7666551604cbf45151194822" + }, + "error": null, + "incomplete_details": null, + "instructions": null, + "max_output_tokens": 150, + "max_tool_calls": null, + "model": "gpt-4o-mini-2024-07-18", + "output": [ + { + "id": "msg_04cbf451511948220068fb97d064408195ac54b7750a781a2e", + "type": "message", + "status": "completed", + "content": [ + { + "type": "output_text", + "annotations": [], + "logprobs": [], + "text": "As of 2023, the population of Paris is approximately 2.1 million people within the city proper. However, the larger metropolitan area has a population of around 12 million. These numbers can vary, so it's always a good idea to check for the most recent statistics." + } + ], + "role": "assistant" + } + ], + "parallel_tool_calls": true, + "previous_response_id": null, + "prompt_cache_key": null, + "reasoning": { + "effort": null, + "summary": null + }, + "safety_identifier": null, + "service_tier": "default", + "store": true, + "temperature": 1.0, + "text": { + "format": { + "type": "text" + }, + "verbosity": "medium" + }, + "tool_choice": "auto", + "tools": [], + "top_logprobs": 0, + "top_p": 1.0, + "truncation": "disabled", + "usage": { + "input_tokens": 56, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 58, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 114 + }, + "user": null, + "metadata": {} +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic_streaming/first_message_response.txt b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic_streaming/first_message_response.txt new file mode 100644 index 0000000000..80d9f1070c --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/basic_streaming/first_message_response.txt @@ -0,0 +1,624 @@ +event: response.created +data: {"type":"response.created","sequence_number":0,"response":{"id":"resp_0cdad19d14602ec80068fb98607b948193935a6e7aa2141ef2","object":"response","created_at":1761319008,"status":"in_progress","background":false,"conversation":{"id":"conv_68fb9837f9588193ac3da6bd57b636a50cdad19d14602ec8"},"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":200,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}} + +event: response.in_progress +data: {"type":"response.in_progress","sequence_number":1,"response":{"id":"resp_0cdad19d14602ec80068fb98607b948193935a6e7aa2141ef2","object":"response","created_at":1761319008,"status":"in_progress","background":false,"conversation":{"id":"conv_68fb9837f9588193ac3da6bd57b636a50cdad19d14602ec8"},"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":200,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}} + +event: response.output_item.added +data: {"type":"response.output_item.added","sequence_number":2,"output_index":0,"item":{"id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","type":"message","status":"in_progress","content":[],"role":"assistant"}} + +event: response.content_part.added +data: {"type":"response.content_part.added","sequence_number":3,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":""}} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":4,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"In","logprobs":[],"obfuscation":"C16oYk8aI5VtGp"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":5,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"vXmOvISW7QRUF1"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":6,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" small","logprobs":[],"obfuscation":"qEkC6mYZmi"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":7,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" workshop","logprobs":[],"obfuscation":"2aAdNXN"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":8,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" at","logprobs":[],"obfuscation":"bv66grEvpSema"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":9,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"fVOKa91q3jxh"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":10,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" edge","logprobs":[],"obfuscation":"kW1rIr6ZZBc"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":11,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"RnPLx5DWhJvWO"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":12,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"DMVs96dHxVd7fh"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":13,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" bustling","logprobs":[],"obfuscation":"9TCmdGs"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":14,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" city","logprobs":[],"obfuscation":"E4p2Nj5KH0Z"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":15,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" lived","logprobs":[],"obfuscation":"e3kqeTLJpR"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":16,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"zQmSxD9MrnbNr7"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":17,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" curious","logprobs":[],"obfuscation":"wQHxX2wm"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":18,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" robot","logprobs":[],"obfuscation":"i49v38s1iB"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":19,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" named","logprobs":[],"obfuscation":"FC4nhPH5iI"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":20,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Pixel","logprobs":[],"obfuscation":"WxNhIEwf5h"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":21,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"jIf06WyqbCsP1is"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":22,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Unlike","logprobs":[],"obfuscation":"0UnxmoTXo"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":23,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" other","logprobs":[],"obfuscation":"D082q19raq"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":24,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" robots","logprobs":[],"obfuscation":"O6qMHEj2b"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":25,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" whose","logprobs":[],"obfuscation":"vee013IYPw"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":26,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" tasks","logprobs":[],"obfuscation":"XHa10h45Oa"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":27,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" revol","logprobs":[],"obfuscation":"6FBrIwdGV9"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":28,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"ved","logprobs":[],"obfuscation":"M0VL3Bw0RIAo6"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":29,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" around","logprobs":[],"obfuscation":"LLilH7SVr"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":30,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" heavy","logprobs":[],"obfuscation":"tegXm6RO6A"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":31,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" lifting","logprobs":[],"obfuscation":"6b3EMVcS"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":32,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" or","logprobs":[],"obfuscation":"JhqGeJLj5aA3V"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":33,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" data","logprobs":[],"obfuscation":"2GzCA3ZBZov"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":34,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" processing","logprobs":[],"obfuscation":"pQJMQ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":35,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"yIf9YenbsIenASh"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":36,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Pixel","logprobs":[],"obfuscation":"wKzF15AosR"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":37,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" was","logprobs":[],"obfuscation":"Wowp4nS4X1Ng"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":38,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" designed","logprobs":[],"obfuscation":"Yz6ZJdQ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":39,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" with","logprobs":[],"obfuscation":"zf1HLk47LNX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":40,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" an","logprobs":[],"obfuscation":"sNucb47CLCVlI"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":41,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" intricate","logprobs":[],"obfuscation":"9TxqRk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":42,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" array","logprobs":[],"obfuscation":"d2GG2LyctD"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":43,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"yy31Pt217J6Xp"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":44,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" sensors","logprobs":[],"obfuscation":"dFE11Kjt"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":45,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"j5OIdm87111a"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":46,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"WwEaIsudqLtCvf"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":47,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" flexible","logprobs":[],"obfuscation":"jH5YA59"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":48,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" arm","logprobs":[],"obfuscation":"RJVKiLoNoYxQ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":49,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"bpX63CPMF8aQHv7"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":50,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" perfect","logprobs":[],"obfuscation":"eCXfxPet"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":51,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" for","logprobs":[],"obfuscation":"aNwYIhOgicEt"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":52,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" creativity","logprobs":[],"obfuscation":"QTeqK"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":53,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"qFaBkm23u4NYkj4"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":54,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" However","logprobs":[],"obfuscation":"hrYOmahs"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":55,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"PnGLt5WSzXM3RG4"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":56,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Pixel","logprobs":[],"obfuscation":"yk2yG2xNbY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":57,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" had","logprobs":[],"obfuscation":"CShj4jWsDFmW"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":58,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" never","logprobs":[],"obfuscation":"b92hQra8IU"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":59,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" painted","logprobs":[],"obfuscation":"Wu9kSosu"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":60,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".\n\n","logprobs":[],"obfuscation":"41kdUr8fcF1eY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":61,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"One","logprobs":[],"obfuscation":"ywv21ub1bYPzr"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":62,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" rainy","logprobs":[],"obfuscation":"piDyieWe6I"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":63,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" afternoon","logprobs":[],"obfuscation":"o6TtQn"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":64,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"6K5zBbkZ1KDqaOo"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":65,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" while","logprobs":[],"obfuscation":"DZpPr8CLVs"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":66,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" organizing","logprobs":[],"obfuscation":"yyd7A"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":67,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" paint","logprobs":[],"obfuscation":"TbeYUHmhLW"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":68,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"brush","logprobs":[],"obfuscation":"LSTcAO85OyQ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":69,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"es","logprobs":[],"obfuscation":"g8YnY0jNlHqwv8"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":70,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"Ey5F23xj6FJr"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":71,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" canv","logprobs":[],"obfuscation":"EsQE9gBSUI5"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":72,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"ases","logprobs":[],"obfuscation":"jXPKC0ARj6Jk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":73,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"p0APw0fonPMBbpz"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":74,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Pixel","logprobs":[],"obfuscation":"S9Iw9WD1td"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":75,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" stumbled","logprobs":[],"obfuscation":"lUhKO2y"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":76,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" across","logprobs":[],"obfuscation":"zOVN5cc6m"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":77,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" an","logprobs":[],"obfuscation":"kFX7KcjAVQa3u"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":78,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" old","logprobs":[],"obfuscation":"PcJzaliXOTKf"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":79,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" painting","logprobs":[],"obfuscation":"5JFpUDK"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":80,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"—a","logprobs":[],"obfuscation":"hN488ItRbxIdlD"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":81,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" dazzling","logprobs":[],"obfuscation":"JEkA0aE"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":82,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" landscape","logprobs":[],"obfuscation":"mehmYO"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":83,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" bursting","logprobs":[],"obfuscation":"gq0lWWG"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":84,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" with","logprobs":[],"obfuscation":"roG9ZXQbDpe"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":85,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" colors","logprobs":[],"obfuscation":"gdKUt6ALG"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":86,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"UUCXxD95v3ekSVk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":87,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Fasc","logprobs":[],"obfuscation":"iVOZvBK0g9g"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":88,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"inated","logprobs":[],"obfuscation":"WyckQbiJri"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":89,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"qPzZ3PZNvSoTVXz"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":90,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Pixel","logprobs":[],"obfuscation":"YKdVPbL14g"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":91,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" studied","logprobs":[],"obfuscation":"j6lPd2xU"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":92,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"3zYfSjrWfRlp"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":93,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" painting","logprobs":[],"obfuscation":"ygVKhmv"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":94,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"’s","logprobs":[],"obfuscation":"jfyEtMpt46t1Ww"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":95,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" sw","logprobs":[],"obfuscation":"8ufXFBggxZ3TS"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":96,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"irls","logprobs":[],"obfuscation":"SbzWkGTAG34r"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":97,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"hXqSM3Qr77XDVdb"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":98,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" textures","logprobs":[],"obfuscation":"OoYDmdA"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":99,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"WYukNpLZWJs1j5L"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":100,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"O9CtJKsoG2JB"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":101,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"uoha0aPHY3w7"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":102,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" way","logprobs":[],"obfuscation":"KnlsDOXhAPma"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":103,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" colors","logprobs":[],"obfuscation":"Nqzf9hidx"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":104,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" danced","logprobs":[],"obfuscation":"hhZcUfldt"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":105,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" together","logprobs":[],"obfuscation":"Mnd309k"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":106,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"PqZH6hxgnvJ1z1S"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":107,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" An","logprobs":[],"obfuscation":"rgthuRNYqDVfd"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":108,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" idea","logprobs":[],"obfuscation":"RYoJHQzMviw"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":109,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" sparked","logprobs":[],"obfuscation":"bFn7eHwA"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":110,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" in","logprobs":[],"obfuscation":"Ym8ImtIUdMlm3"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":111,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" its","logprobs":[],"obfuscation":"2HuZRNAzdFY5"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":112,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" circuits","logprobs":[],"obfuscation":"b19ajJd"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":113,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":":","logprobs":[],"obfuscation":"dBAMCGUMUgounvx"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":114,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Pixel","logprobs":[],"obfuscation":"KDcOVnk2sl"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":115,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" would","logprobs":[],"obfuscation":"QaX2I1Dg85"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":116,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" learn","logprobs":[],"obfuscation":"2QkmV1t6Js"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":117,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" to","logprobs":[],"obfuscation":"1m259XNwN7CxV"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":118,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" paint","logprobs":[],"obfuscation":"SUGIRDOxLQ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":119,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".\n\n","logprobs":[],"obfuscation":"eIMGNNPhRFbU4"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":120,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"At","logprobs":[],"obfuscation":"G8GUOB6HOwqe9H"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":121,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" first","logprobs":[],"obfuscation":"4kUZs77xIL"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":122,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"DZJLHDJJJoRMgTV"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":123,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" it","logprobs":[],"obfuscation":"sXRNA81QPcKuI"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":124,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" was","logprobs":[],"obfuscation":"QLCPvdRQ7qmn"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":125,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" cl","logprobs":[],"obfuscation":"J9qOKCfVRbrtD"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":126,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"umsy","logprobs":[],"obfuscation":"MV6H5FqEJNdo"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":127,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"WDWm0egBq1CmII3"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":128,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" The","logprobs":[],"obfuscation":"hNiFWJ96FXpg"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":129,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" brushes","logprobs":[],"obfuscation":"Pf0FFkql"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":130,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" slipped","logprobs":[],"obfuscation":"kwS961wY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":131,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" from","logprobs":[],"obfuscation":"XyDhbqDYRBT"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":132,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" its","logprobs":[],"obfuscation":"YmOIFY8YCUqL"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":133,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" grip","logprobs":[],"obfuscation":"ABcdnw5EIpX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":134,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"SXShKYz3KjctF5L"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":135,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"VMtvX3tcPsMa"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":136,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" colors","logprobs":[],"obfuscation":"B3jtn3jGg"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":137,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" sme","logprobs":[],"obfuscation":"jphfFzmwPLaF"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":138,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"ared","logprobs":[],"obfuscation":"TwRJ1pgJfZXY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":139,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" into","logprobs":[],"obfuscation":"jHvjvmlmRFx"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":140,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" mudd","logprobs":[],"obfuscation":"8LaKYmukTFy"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":141,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"led","logprobs":[],"obfuscation":"OEby50ZgHV8mj"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":142,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" gray","logprobs":[],"obfuscation":"vQLkls6KtLN"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":143,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" blobs","logprobs":[],"obfuscation":"6pJRSKWLsI"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":144,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" instead","logprobs":[],"obfuscation":"qImXEbxD"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":145,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"BTsJcdzYMfYed"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":146,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" vibrant","logprobs":[],"obfuscation":"Uo6JuUrd"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":147,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" hues","logprobs":[],"obfuscation":"mCwdvWFcVLe"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":148,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"3rAuIoc3iI7OrtQ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":149,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" But","logprobs":[],"obfuscation":"cRhMS7RaTArm"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":150,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Pixel","logprobs":[],"obfuscation":"M1mKyav7ph"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":151,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" persisted","logprobs":[],"obfuscation":"eF5aUk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":152,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"yDdDhy5v9Zw35r6"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":153,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" Each","logprobs":[],"obfuscation":"xqte6NkdiIo"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":154,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" day","logprobs":[],"obfuscation":"rppAW4RVeF8R"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":155,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"udSWzKzTyrCWVLi"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":156,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" it","logprobs":[],"obfuscation":"F2NUuJOxWKpjP"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":157,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" practiced","logprobs":[],"obfuscation":"Aqqlv9"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":158,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":":","logprobs":[],"obfuscation":"ZUk2MhldL4AtrAe"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":159,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" mixing","logprobs":[],"obfuscation":"l030hejQa"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":160,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" paints","logprobs":[],"obfuscation":"4xlfaIzxC"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":161,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"BtVvUiDXh3jSgxs"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":162,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" experimenting","logprobs":[],"obfuscation":"di"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":163,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" with","logprobs":[],"obfuscation":"MCekQrhkBKN"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":164,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" strokes","logprobs":[],"obfuscation":"rRuR8dnc"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":165,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"cFjk3IoxYD4tGrw"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":166,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"DQ3Xi2a9dX9y"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":167,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" observing","logprobs":[],"obfuscation":"8t7Acj"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":168,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"KDYvCe6JsoYa"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":169,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" world","logprobs":[],"obfuscation":"0rtOhI9Ffc"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":170,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" through","logprobs":[],"obfuscation":"oE2kAKM9"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":171,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"RGobfdV8EooR"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":172,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" eyes","logprobs":[],"obfuscation":"yzrEN6uVsyR"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":173,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"MITYFimltUsuJ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":174,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" artists","logprobs":[],"obfuscation":"ndi7qdrO"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":175,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".\n\n","logprobs":[],"obfuscation":"39IBhz9cxlCBc"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":176,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":"Pixel","logprobs":[],"obfuscation":"SmMeGRPjx9o"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":177,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" took","logprobs":[],"obfuscation":"B7Yw3oSo8OX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":178,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" inspiration","logprobs":[],"obfuscation":"M4D6"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":179,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" from","logprobs":[],"obfuscation":"lVxLLEHL7zV"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":180,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" sunlight","logprobs":[],"obfuscation":"I3BmRGJ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":181,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" filtering","logprobs":[],"obfuscation":"P6p35d"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":182,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" through","logprobs":[],"obfuscation":"8MMH2TTk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":183,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" trees","logprobs":[],"obfuscation":"hmfNgkY1FJ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":184,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"Lkj68PREYAHG7mZ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":185,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"SYCf7zTCaGUi"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":186,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" depths","logprobs":[],"obfuscation":"cr9Phqnz8"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":187,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"OT3aZnPvsDcmY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":188,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"fGdrYkLZHdTI"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":189,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" ocean","logprobs":[],"obfuscation":"MvxJgRFjwz"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":190,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"ox6Ar9czyzkruEM"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":191,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"MKK6YDJEzPxA"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":192,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"UWEyznWlRSj3"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":193,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" rhythm","logprobs":[],"obfuscation":"8E4xhBObX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":194,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"jbQAFSh8FJWWg"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":195,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" city","logprobs":[],"obfuscation":"cxL7t1q6yLv"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":196,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" life","logprobs":[],"obfuscation":"CnftU4BnURk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":197,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"XucWb0a2fGIQafX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":198,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" It","logprobs":[],"obfuscation":"pt1xzT8tzMYRs"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":199,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" copied","logprobs":[],"obfuscation":"WrTQOEVfc"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":200,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" techniques","logprobs":[],"obfuscation":"XJJzu"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":201,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" from","logprobs":[],"obfuscation":"PrOd3zA9J76"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":202,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" videos","logprobs":[],"obfuscation":"fHAS8XsLg"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":203,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"Hk6mknGTtruy"} + +event: response.output_text.done +data: {"type":"response.output_text.done","sequence_number":204,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"text":"In a small workshop at the edge of a bustling city lived a curious robot named Pixel. Unlike other robots whose tasks revolved around heavy lifting or data processing, Pixel was designed with an intricate array of sensors and a flexible arm, perfect for creativity. However, Pixel had never painted.\n\nOne rainy afternoon, while organizing paintbrushes and canvases, Pixel stumbled across an old painting—a dazzling landscape bursting with colors. Fascinated, Pixel studied the painting’s swirls, textures, and the way colors danced together. An idea sparked in its circuits: Pixel would learn to paint.\n\nAt first, it was clumsy. The brushes slipped from its grip, and colors smeared into muddled gray blobs instead of vibrant hues. But Pixel persisted. Each day, it practiced: mixing paints, experimenting with strokes, and observing the world through the eyes of artists.\n\nPixel took inspiration from sunlight filtering through trees, the depths of the ocean, and the rhythm of city life. It copied techniques from videos and","logprobs":[]} + +event: response.content_part.done +data: {"type":"response.content_part.done","sequence_number":205,"item_id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":"In a small workshop at the edge of a bustling city lived a curious robot named Pixel. Unlike other robots whose tasks revolved around heavy lifting or data processing, Pixel was designed with an intricate array of sensors and a flexible arm, perfect for creativity. However, Pixel had never painted.\n\nOne rainy afternoon, while organizing paintbrushes and canvases, Pixel stumbled across an old painting—a dazzling landscape bursting with colors. Fascinated, Pixel studied the painting’s swirls, textures, and the way colors danced together. An idea sparked in its circuits: Pixel would learn to paint.\n\nAt first, it was clumsy. The brushes slipped from its grip, and colors smeared into muddled gray blobs instead of vibrant hues. But Pixel persisted. Each day, it practiced: mixing paints, experimenting with strokes, and observing the world through the eyes of artists.\n\nPixel took inspiration from sunlight filtering through trees, the depths of the ocean, and the rhythm of city life. It copied techniques from videos and"}} + +event: response.output_item.done +data: {"type":"response.output_item.done","sequence_number":206,"output_index":0,"item":{"id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","type":"message","status":"incomplete","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"In a small workshop at the edge of a bustling city lived a curious robot named Pixel. Unlike other robots whose tasks revolved around heavy lifting or data processing, Pixel was designed with an intricate array of sensors and a flexible arm, perfect for creativity. However, Pixel had never painted.\n\nOne rainy afternoon, while organizing paintbrushes and canvases, Pixel stumbled across an old painting—a dazzling landscape bursting with colors. Fascinated, Pixel studied the painting’s swirls, textures, and the way colors danced together. An idea sparked in its circuits: Pixel would learn to paint.\n\nAt first, it was clumsy. The brushes slipped from its grip, and colors smeared into muddled gray blobs instead of vibrant hues. But Pixel persisted. Each day, it practiced: mixing paints, experimenting with strokes, and observing the world through the eyes of artists.\n\nPixel took inspiration from sunlight filtering through trees, the depths of the ocean, and the rhythm of city life. It copied techniques from videos and"}],"role":"assistant"}} + +event: response.incomplete +data: {"type":"response.incomplete","sequence_number":207,"response":{"id":"resp_0cdad19d14602ec80068fb98607b948193935a6e7aa2141ef2","object":"response","created_at":1761319008,"status":"incomplete","background":false,"conversation":{"id":"conv_68fb9837f9588193ac3da6bd57b636a50cdad19d14602ec8"},"error":null,"incomplete_details":{"reason":"max_output_tokens"},"instructions":null,"max_output_tokens":200,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[{"id":"msg_0cdad19d14602ec80068fb986280c8819388eebc7f20280aa6","type":"message","status":"incomplete","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"In a small workshop at the edge of a bustling city lived a curious robot named Pixel. Unlike other robots whose tasks revolved around heavy lifting or data processing, Pixel was designed with an intricate array of sensors and a flexible arm, perfect for creativity. However, Pixel had never painted.\n\nOne rainy afternoon, while organizing paintbrushes and canvases, Pixel stumbled across an old painting—a dazzling landscape bursting with colors. Fascinated, Pixel studied the painting’s swirls, textures, and the way colors danced together. An idea sparked in its circuits: Pixel would learn to paint.\n\nAt first, it was clumsy. The brushes slipped from its grip, and colors smeared into muddled gray blobs instead of vibrant hues. But Pixel persisted. Each day, it practiced: mixing paints, experimenting with strokes, and observing the world through the eyes of artists.\n\nPixel took inspiration from sunlight filtering through trees, the depths of the ocean, and the rhythm of city life. It copied techniques from videos and"}],"role":"assistant"}],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"default","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":19,"input_tokens_details":{"cached_tokens":0},"output_tokens":200,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":219},"user":null,"metadata":{}}} + diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/create_with_items/create_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/create_with_items/create_request.json new file mode 100644 index 0000000000..ea87839722 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/create_with_items/create_request.json @@ -0,0 +1,17 @@ +{ + "metadata": { + "test_type": "create_with_initial_items" + }, + "items": [ + { + "type": "message", + "role": "user", + "content": [ + { + "type": "input_text", + "text": "What is the capital of France?" + } + ] + } + ] +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/create_with_items/create_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/create_with_items/create_response.json new file mode 100644 index 0000000000..aaca0088d4 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/create_with_items/create_response.json @@ -0,0 +1,8 @@ +{ + "id": "conv_68fb980bccfc8195a9ba32b164e8a69408e61fbaa91b0a18", + "object": "conversation", + "created_at": 1761318923, + "metadata": { + "test_type": "create_with_initial_items" + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/delete_conversation/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/delete_conversation/response.json new file mode 100644 index 0000000000..70db137cb8 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/delete_conversation/response.json @@ -0,0 +1,5 @@ +{ + "id": "conv_68fb9837f9588193ac3da6bd57b636a50cdad19d14602ec8", + "object": "conversation.deleted", + "deleted": true +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/delete_item/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/delete_item/response.json new file mode 100644 index 0000000000..a01b7cbe7a --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/delete_item/response.json @@ -0,0 +1,5 @@ +{ + "id": "msg_68fb9abf14a08195b16bb05eab82cf9d04cbf45151194822", + "object": "conversation.item.deleted", + "deleted": true +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_conversation_not_found/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_conversation_not_found/response.json new file mode 100644 index 0000000000..1c51ce1e9d --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_conversation_not_found/response.json @@ -0,0 +1,8 @@ +{ + "error": { + "message": "Conversation with id 'conv_nonexistent123' not found.", + "type": "invalid_request_error", + "param": null, + "code": null + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_delete_already_deleted/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_delete_already_deleted/response.json new file mode 100644 index 0000000000..0fa4c3661d --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_delete_already_deleted/response.json @@ -0,0 +1,8 @@ +{ + "error": { + "message": "Conversation with id 'conv_68fb9837f9588193ac3da6bd57b636a50cdad19d14602ec8' not found.", + "type": "invalid_request_error", + "param": null, + "code": null + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_json/request.txt b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_json/request.txt new file mode 100644 index 0000000000..baba9b68ff --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_json/request.txt @@ -0,0 +1,5 @@ +{ + "metadata": { + "test": "invalid" + } + // missing closing brace and has comment which is invalid JSON diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_json/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_json/response.json new file mode 100644 index 0000000000..f2db45cbe8 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_json/response.json @@ -0,0 +1,8 @@ +{ + "error": { + "message": "Invalid body: failed to parse JSON value. Please check the value to ensure it is valid JSON. (Common errors include trailing commas, missing closing brackets, missing quotation marks, etc.)", + "type": "invalid_request_error", + "param": null, + "code": "invalid_json" + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_limit/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_limit/response.json new file mode 100644 index 0000000000..4ae939233d --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_invalid_limit/response.json @@ -0,0 +1,8 @@ +{ + "error": { + "message": "Invalid 'limit': integer above maximum value. Expected a value <= 100, but got 1000 instead.", + "type": "invalid_request_error", + "param": "limit", + "code": "integer_above_max_value" + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_item_not_found/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_item_not_found/response.json new file mode 100644 index 0000000000..ab573cb05b --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_item_not_found/response.json @@ -0,0 +1,8 @@ +{ + "error": { + "message": "Item with id 'msg_msg_nonexistent123nonexistent123' not found in conversation.", + "type": "invalid_request_error", + "param": null, + "code": null + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_missing_required_field/request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_missing_required_field/request.json new file mode 100644 index 0000000000..6b43a686c3 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/error_missing_required_field/request.json @@ -0,0 +1,13 @@ +{ + "items": [ + { + "type": "message", + "content": [ + { + "type": "input_text", + "text": "Hello" + } + ] + } + ] +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/create_conversation_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/create_conversation_request.json new file mode 100644 index 0000000000..ca4a4a7ab7 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/create_conversation_request.json @@ -0,0 +1,5 @@ +{ + "metadata": { + "test_type": "image_input_conversation" + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/create_conversation_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/create_conversation_response.json new file mode 100644 index 0000000000..46fd00f10b --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/create_conversation_response.json @@ -0,0 +1,8 @@ +{ + "id": "conv_68fb989f39ec8194be3ec32525cd53c1003edf96db5b4ed7", + "object": "conversation", + "created_at": 1761319071, + "metadata": { + "test_type": "image_input_conversation" + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/first_message_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/first_message_request.json new file mode 100644 index 0000000000..1f242fbb65 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/first_message_request.json @@ -0,0 +1,21 @@ +{ + "model": "gpt-4o-mini", + "conversation": "conv_68fb989f39ec8194be3ec32525cd53c1003edf96db5b4ed7", + "input": [ + { + "type": "message", + "role": "user", + "content": [ + { + "type": "input_text", + "text": "What's in this image? Describe it in detail." + }, + { + "type": "input_image", + "image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg" + } + ] + } + ], + "max_output_tokens": 200 +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/first_message_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/first_message_response.json new file mode 100644 index 0000000000..f9007058aa --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input/first_message_response.json @@ -0,0 +1,70 @@ +{ + "id": "resp_003edf96db5b4ed70068fb98bd80808194b25763125111fffa", + "object": "response", + "created_at": 1761319101, + "status": "completed", + "background": false, + "billing": { + "payer": "developer" + }, + "conversation": { + "id": "conv_68fb989f39ec8194be3ec32525cd53c1003edf96db5b4ed7" + }, + "error": null, + "incomplete_details": null, + "instructions": null, + "max_output_tokens": 200, + "max_tool_calls": null, + "model": "gpt-4o-mini-2024-07-18", + "output": [ + { + "id": "msg_003edf96db5b4ed70068fb98c1197481949e138bc36200ee18", + "type": "message", + "status": "completed", + "content": [ + { + "type": "output_text", + "annotations": [], + "logprobs": [], + "text": "The image depicts a serene natural landscape featuring a wooden boardwalk winding through lush greenery. \n\n### Details:\n- **Pathway**: The boardwalk is made of wooden planks and extends straight ahead, encouraging exploration.\n- **Grass**: On both sides of the pathway, there is tall, vibrant green grass, suggesting a lush environment with possible wildflowers.\n- **Surrounding Vegetation**: Beyond the grass, there are various bushes and trees, adding layers of texture and color. Some foliage appears dense and lush, while other areas have more sparse coverage.\n- **Sky**: The sky is expansive and bright, with soft, fluffy clouds scattered throughout. The blue hues create a tranquil atmosphere, illuminated by sunlight.\n- **Overall Mood**: The scene conveys a sense of peace and openness, perfect for a nature walk or outdoor meditation.\n\nThis idyllic setting invites the viewer to appreciate the tranquility of nature and the beauty of the landscape." + } + ], + "role": "assistant" + } + ], + "parallel_tool_calls": true, + "previous_response_id": null, + "prompt_cache_key": null, + "reasoning": { + "effort": null, + "summary": null + }, + "safety_identifier": null, + "service_tier": "default", + "store": true, + "temperature": 1.0, + "text": { + "format": { + "type": "text" + }, + "verbosity": "medium" + }, + "tool_choice": "auto", + "tools": [], + "top_logprobs": 0, + "top_p": 1.0, + "truncation": "disabled", + "usage": { + "input_tokens": 36852, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 192, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 37044 + }, + "user": null, + "metadata": {} +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/create_conversation_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/create_conversation_request.json new file mode 100644 index 0000000000..1b442abe4f --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/create_conversation_request.json @@ -0,0 +1,5 @@ +{ + "metadata": { + "test_type": "image_input_streaming" + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/first_message_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/first_message_request.json new file mode 100644 index 0000000000..127ccfde48 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/first_message_request.json @@ -0,0 +1,22 @@ +{ + "model": "gpt-4o-mini", + "conversation": "conv_68fb98d787f881979b1db01940691fa503e6efaadaa48f3f", + "input": [ + { + "type": "message", + "role": "user", + "content": [ + { + "type": "input_text", + "text": "What's in this image? Describe it in detail." + }, + { + "type": "input_image", + "image_url": "https://upload.wikimedia.org/wikipedia/commons/thumb/d/dd/Gfp-wisconsin-madison-the-nature-boardwalk.jpg/2560px-Gfp-wisconsin-madison-the-nature-boardwalk.jpg" + } + ] + } + ], + "max_output_tokens": 200, + "stream": true +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/first_message_response.txt b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/first_message_response.txt new file mode 100644 index 0000000000..ba0e9deff8 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/image_input_streaming/first_message_response.txt @@ -0,0 +1,456 @@ +event: response.created +data: {"type":"response.created","sequence_number":0,"response":{"id":"resp_03e6efaadaa48f3f0068fb98e75a9c819780dca860432f50c0","object":"response","created_at":1761319143,"status":"in_progress","background":false,"conversation":{"id":"conv_68fb98d787f881979b1db01940691fa503e6efaadaa48f3f"},"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":200,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}} + +event: response.in_progress +data: {"type":"response.in_progress","sequence_number":1,"response":{"id":"resp_03e6efaadaa48f3f0068fb98e75a9c819780dca860432f50c0","object":"response","created_at":1761319143,"status":"in_progress","background":false,"conversation":{"id":"conv_68fb98d787f881979b1db01940691fa503e6efaadaa48f3f"},"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":200,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}} + +event: response.output_item.added +data: {"type":"response.output_item.added","sequence_number":2,"output_index":0,"item":{"id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","type":"message","status":"in_progress","content":[],"role":"assistant"}} + +event: response.content_part.added +data: {"type":"response.content_part.added","sequence_number":3,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":""}} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":4,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":"The","logprobs":[],"obfuscation":"UHUQ9fIQTxCbV"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":5,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" image","logprobs":[],"obfuscation":"xNPzGqnhvU"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":6,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" depicts","logprobs":[],"obfuscation":"ojPXqx5m"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":7,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"UGIKclB7QdFjBc"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":8,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" tranquil","logprobs":[],"obfuscation":"XSxvnxQ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":9,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" scene","logprobs":[],"obfuscation":"XcPoVyD9iV"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":10,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"eMV4kvkfbM0zd"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":11,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"0klHtMIbU7P3Ea"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":12,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" pathway","logprobs":[],"obfuscation":"Cl7V0bkp"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":13,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" made","logprobs":[],"obfuscation":"2DYHpC7Eyl3"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":14,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"5ObYHXTVXJDaP"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":15,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" wooden","logprobs":[],"obfuscation":"p62ol2BGT"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":16,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" boards","logprobs":[],"obfuscation":"9n53C6e36"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":17,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" leading","logprobs":[],"obfuscation":"vOZvFF5v"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":18,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" through","logprobs":[],"obfuscation":"Gt1J5FNE"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":19,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"RnDMouhlNrQ7RB"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":20,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" lush","logprobs":[],"obfuscation":"42N68Sud7kk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":21,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"08p36we5SqMENPp"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":22,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" green","logprobs":[],"obfuscation":"zzWq9kepjH"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":23,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" landscape","logprobs":[],"obfuscation":"bISm6O"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":24,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"IMKn4R5dxQFxGJl"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":25,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" The","logprobs":[],"obfuscation":"w19FHugCAk1X"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":26,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" path","logprobs":[],"obfuscation":"hDJm0rbDlBz"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":27,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" is","logprobs":[],"obfuscation":"0riU9Z71ipbh7"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":28,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" straight","logprobs":[],"obfuscation":"KQdad1O"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":29,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"V0838p6GoMKkdMb"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":30,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" fl","logprobs":[],"obfuscation":"OwqpqwOUtVRWR"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":31,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":"anked","logprobs":[],"obfuscation":"q4TZWRJ4up7"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":32,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" by","logprobs":[],"obfuscation":"a4BkQCPOkWXa5"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":33,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" tall","logprobs":[],"obfuscation":"uDgapRMTMh3"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":34,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" grass","logprobs":[],"obfuscation":"DSWk0SmBLn"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":35,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" that","logprobs":[],"obfuscation":"gRpuHdZ2Q7z"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":36,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" appears","logprobs":[],"obfuscation":"MavFp4Q5"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":37,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" vibrant","logprobs":[],"obfuscation":"iOciPOxV"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":38,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"rQdOojHHeet9"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":39,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" healthy","logprobs":[],"obfuscation":"SuFkWnO8"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":40,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"rcqKsVdM70DSisT"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":41,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" with","logprobs":[],"obfuscation":"s9tToHsQMbZ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":42,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" hints","logprobs":[],"obfuscation":"nfMICfvb21"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":43,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"V84AZDkQ50w3N"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":44,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" various","logprobs":[],"obfuscation":"tM5QpNvy"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":45,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" shades","logprobs":[],"obfuscation":"P7DjB4f2C"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":46,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"qBkC9EgLqkA1c"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":47,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" green","logprobs":[],"obfuscation":"hU4g5KAOZW"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":48,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"eapW7Q1E884SHZT"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":49,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" \n\n","logprobs":[],"obfuscation":"C9GIn2LBfGkw6"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":50,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":"To","logprobs":[],"obfuscation":"M2K4wUNJ6uZQAT"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":51,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" either","logprobs":[],"obfuscation":"wB8ah2F34"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":52,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" side","logprobs":[],"obfuscation":"l1Xni4I4YSv"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":53,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"BhtFvy3X01wnb"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":54,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"6BmDo9c8flKg"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":55,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" pathway","logprobs":[],"obfuscation":"I9vJz0rJ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":56,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"rjhyjDrxkhFG2sA"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":57,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" there","logprobs":[],"obfuscation":"CuB7Mu0kmp"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":58,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" are","logprobs":[],"obfuscation":"aGx0xMRdLfgn"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":59,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" patches","logprobs":[],"obfuscation":"3k9JjiXX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":60,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"5ygUdTNFf5vKw"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":61,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" small","logprobs":[],"obfuscation":"iuRjZQMMCd"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":62,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" shrubs","logprobs":[],"obfuscation":"8o3grCi0H"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":63,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"AKNhpTCqB2ox"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":64,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" trees","logprobs":[],"obfuscation":"7vEA5TvFsE"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":65,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" pe","logprobs":[],"obfuscation":"teLztvR1PkBlq"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":66,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":"eking","logprobs":[],"obfuscation":"2ulp51qYjBK"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":67,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" through","logprobs":[],"obfuscation":"876PEWFb"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":68,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"Bsdqk9QdC7Tr5ZK"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":69,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" creating","logprobs":[],"obfuscation":"J40z8ec"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":70,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"Xa4ksTm1gWI2LI"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":71,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" natural","logprobs":[],"obfuscation":"qLRLkXC4"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":72,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" frame","logprobs":[],"obfuscation":"9Hr6dEO1RI"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":73,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" for","logprobs":[],"obfuscation":"kzvn7GY8aolJ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":74,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"eCAclNr2ngoA"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":75,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" walkway","logprobs":[],"obfuscation":"J46M12Wu"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":76,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"b6PhcLtkJCRiAh5"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":77,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" The","logprobs":[],"obfuscation":"09lot0Gfa7RR"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":78,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" background","logprobs":[],"obfuscation":"d5Wvb"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":79,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" showcases","logprobs":[],"obfuscation":"WJxkJj"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":80,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" more","logprobs":[],"obfuscation":"zdB0gvCtvhX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":81,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" greenery","logprobs":[],"obfuscation":"jU8ZFOY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":82,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" with","logprobs":[],"obfuscation":"cWAStGHAoTE"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":83,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"tEVme9H2ugf2I8"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":84,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" mix","logprobs":[],"obfuscation":"Cl0ctD3a7onA"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":85,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"2m6kdh4S3WlOn"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":86,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" trees","logprobs":[],"obfuscation":"2gKq9JCohX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":87,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"LGH8TY6oK1IWo0y"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":88,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" suggesting","logprobs":[],"obfuscation":"pgp4U"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":89,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"2vvnM7GmBZFo7Y"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":90,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" lush","logprobs":[],"obfuscation":"5v8aRkkzidL"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":91,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" habitat","logprobs":[],"obfuscation":"ZxTfsKC3"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":92,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":".\n\n","logprobs":[],"obfuscation":"zTCtGbkUIKNRm"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":93,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":"Above","logprobs":[],"obfuscation":"BgwoP72Lj2K"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":94,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"o6ZUIhldUTWNtWj"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":95,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"bvQX6sesYq7F"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":96,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" sky","logprobs":[],"obfuscation":"l0j1NCubus9y"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":97,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" is","logprobs":[],"obfuscation":"A7UEW14pecZq9"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":98,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" expansive","logprobs":[],"obfuscation":"F0MmWm"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":99,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" with","logprobs":[],"obfuscation":"IZkI1Xq1knl"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":100,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"S7NFoMaioiYnNT"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":101,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" gentle","logprobs":[],"obfuscation":"Hq7k3J4hX"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":102,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" blue","logprobs":[],"obfuscation":"2O85T8gnDfY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":103,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" hue","logprobs":[],"obfuscation":"iUSF6RZXAgLm"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":104,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"9OYvqJnP4jQFYbb"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":105,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" dotted","logprobs":[],"obfuscation":"mKkM2G8fG"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":106,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" with","logprobs":[],"obfuscation":"bVH3YVADDNd"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":107,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" soft","logprobs":[],"obfuscation":"DpwofJJplWW"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":108,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" white","logprobs":[],"obfuscation":"Xg4579vica"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":109,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" clouds","logprobs":[],"obfuscation":"khcuDF2Zl"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":110,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" that","logprobs":[],"obfuscation":"SJH7HfECGK5"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":111,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" create","logprobs":[],"obfuscation":"P3YiOo1Vx"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":112,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"bJQKzokZKYcg4J"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":113,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" serene","logprobs":[],"obfuscation":"MnTMwNUMG"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":114,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"KyIxyQRsAXrT"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":115,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" peaceful","logprobs":[],"obfuscation":"wBa715l"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":116,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" atmosphere","logprobs":[],"obfuscation":"y8z8V"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":117,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"r2cV6DmarN1sNjh"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":118,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" The","logprobs":[],"obfuscation":"rPxaSrPkWHqE"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":119,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" overall","logprobs":[],"obfuscation":"Aylbj9Ai"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":120,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" scene","logprobs":[],"obfuscation":"uDYVl80Wl4"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":121,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" conveys","logprobs":[],"obfuscation":"gGjBZmAq"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":122,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" a","logprobs":[],"obfuscation":"cM5y3eJ8fw18le"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":123,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" sense","logprobs":[],"obfuscation":"gcQHS6qIwz"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":124,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"HFDZVaYOkDmKU"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":125,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" calm","logprobs":[],"obfuscation":"YWLah3RJVwM"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":126,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":"ness","logprobs":[],"obfuscation":"nB9dz81sIxYa"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":127,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"7tspUwuuRxUY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":128,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" connection","logprobs":[],"obfuscation":"91NHz"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":129,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" to","logprobs":[],"obfuscation":"fpt6eecZGmqKn"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":130,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" nature","logprobs":[],"obfuscation":"MA0cj4ka8"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":131,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"j1SxZUJzH382ccq"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":132,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" inviting","logprobs":[],"obfuscation":"lDVwt66"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":133,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" viewers","logprobs":[],"obfuscation":"ltsAwTFd"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":134,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" to","logprobs":[],"obfuscation":"zdlUZyzL4XxyW"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":135,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" imagine","logprobs":[],"obfuscation":"UdiLhBmb"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":136,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" walking","logprobs":[],"obfuscation":"xhC2WRN1"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":137,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" along","logprobs":[],"obfuscation":"qA4PwRbpkm"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":138,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"gJlJ8FkpPMZk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":139,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" path","logprobs":[],"obfuscation":"CuzHFXxUTde"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":140,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" and","logprobs":[],"obfuscation":"R1ZjSSzZok1v"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":141,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" experiencing","logprobs":[],"obfuscation":"3hO"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":142,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"nbtQpyb8JvDq"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":143,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" beauty","logprobs":[],"obfuscation":"NznYmUjN6"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":144,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" of","logprobs":[],"obfuscation":"huZUE7zGedUoo"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":145,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" the","logprobs":[],"obfuscation":"azLHyJUIimmG"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":146,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":" outdoors","logprobs":[],"obfuscation":"TmHRvZf"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":147,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"6uKroY9fy1MCoxD"} + +event: response.output_text.done +data: {"type":"response.output_text.done","sequence_number":148,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"text":"The image depicts a tranquil scene of a pathway made of wooden boards leading through a lush, green landscape. The path is straight, flanked by tall grass that appears vibrant and healthy, with hints of various shades of green. \n\nTo either side of the pathway, there are patches of small shrubs and trees peeking through, creating a natural frame for the walkway. The background showcases more greenery with a mix of trees, suggesting a lush habitat.\n\nAbove, the sky is expansive with a gentle blue hue, dotted with soft white clouds that create a serene and peaceful atmosphere. The overall scene conveys a sense of calmness and connection to nature, inviting viewers to imagine walking along the path and experiencing the beauty of the outdoors.","logprobs":[]} + +event: response.content_part.done +data: {"type":"response.content_part.done","sequence_number":149,"item_id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":"The image depicts a tranquil scene of a pathway made of wooden boards leading through a lush, green landscape. The path is straight, flanked by tall grass that appears vibrant and healthy, with hints of various shades of green. \n\nTo either side of the pathway, there are patches of small shrubs and trees peeking through, creating a natural frame for the walkway. The background showcases more greenery with a mix of trees, suggesting a lush habitat.\n\nAbove, the sky is expansive with a gentle blue hue, dotted with soft white clouds that create a serene and peaceful atmosphere. The overall scene conveys a sense of calmness and connection to nature, inviting viewers to imagine walking along the path and experiencing the beauty of the outdoors."}} + +event: response.output_item.done +data: {"type":"response.output_item.done","sequence_number":150,"output_index":0,"item":{"id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"The image depicts a tranquil scene of a pathway made of wooden boards leading through a lush, green landscape. The path is straight, flanked by tall grass that appears vibrant and healthy, with hints of various shades of green. \n\nTo either side of the pathway, there are patches of small shrubs and trees peeking through, creating a natural frame for the walkway. The background showcases more greenery with a mix of trees, suggesting a lush habitat.\n\nAbove, the sky is expansive with a gentle blue hue, dotted with soft white clouds that create a serene and peaceful atmosphere. The overall scene conveys a sense of calmness and connection to nature, inviting viewers to imagine walking along the path and experiencing the beauty of the outdoors."}],"role":"assistant"}} + +event: response.completed +data: {"type":"response.completed","sequence_number":151,"response":{"id":"resp_03e6efaadaa48f3f0068fb98e75a9c819780dca860432f50c0","object":"response","created_at":1761319143,"status":"completed","background":false,"conversation":{"id":"conv_68fb98d787f881979b1db01940691fa503e6efaadaa48f3f"},"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":200,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[{"id":"msg_03e6efaadaa48f3f0068fb98e9f82c81979e3c59b702e3caaf","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"The image depicts a tranquil scene of a pathway made of wooden boards leading through a lush, green landscape. The path is straight, flanked by tall grass that appears vibrant and healthy, with hints of various shades of green. \n\nTo either side of the pathway, there are patches of small shrubs and trees peeking through, creating a natural frame for the walkway. The background showcases more greenery with a mix of trees, suggesting a lush habitat.\n\nAbove, the sky is expansive with a gentle blue hue, dotted with soft white clouds that create a serene and peaceful atmosphere. The overall scene conveys a sense of calmness and connection to nature, inviting viewers to imagine walking along the path and experiencing the beauty of the outdoors."}],"role":"assistant"}],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"default","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":36852,"input_tokens_details":{"cached_tokens":0},"output_tokens":145,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":36997},"user":null,"metadata":{}}} + diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/list_items/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/list_items/response.json new file mode 100644 index 0000000000..f18b017580 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/list_items/response.json @@ -0,0 +1,86 @@ +{ + "object": "list", + "data": [ + { + "id": "msg_04cbf451511948220068fb976a9fc481959fecc62ac9644e8d", + "type": "message", + "status": "completed", + "content": [ + { + "type": "input_text", + "text": "What is the capital of France?" + } + ], + "role": "user" + }, + { + "id": "msg_04cbf451511948220068fb976c70208195a34d776fd6ad006e", + "type": "message", + "status": "completed", + "content": [ + { + "type": "output_text", + "annotations": [], + "logprobs": [], + "text": "The capital of France is Paris." + } + ], + "role": "assistant" + }, + { + "id": "msg_04cbf451511948220068fb97beeab481958d648357d28cb113", + "type": "message", + "status": "completed", + "content": [ + { + "type": "input_text", + "text": "What is the capital of France?" + } + ], + "role": "user" + }, + { + "id": "msg_04cbf451511948220068fb97c0162881958d80862a0d253a14", + "type": "message", + "status": "completed", + "content": [ + { + "type": "output_text", + "annotations": [], + "logprobs": [], + "text": "The capital of France is Paris." + } + ], + "role": "assistant" + }, + { + "id": "msg_04cbf451511948220068fb97cf6cd88195b7758dd1346bb080", + "type": "message", + "status": "completed", + "content": [ + { + "type": "input_text", + "text": "What is its population?" + } + ], + "role": "user" + }, + { + "id": "msg_04cbf451511948220068fb97d064408195ac54b7750a781a2e", + "type": "message", + "status": "completed", + "content": [ + { + "type": "output_text", + "annotations": [], + "logprobs": [], + "text": "As of 2023, the population of Paris is approximately 2.1 million people within the city proper. However, the larger metropolitan area has a population of around 12 million. These numbers can vary, so it's always a good idea to check for the most recent statistics." + } + ], + "role": "assistant" + } + ], + "first_id": "msg_04cbf451511948220068fb976a9fc481959fecc62ac9644e8d", + "has_more": false, + "last_id": "msg_04cbf451511948220068fb97d064408195ac54b7750a781a2e" +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/create_conversation_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/create_conversation_response.json new file mode 100644 index 0000000000..983c3ef692 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/create_conversation_response.json @@ -0,0 +1,8 @@ +{ + "id": "conv_68fb9946146c81949a1f26c3b3c78ed10890f6329dc2aa3a", + "object": "conversation", + "created_at": 1761319238, + "metadata": { + "test_type": "refusal" + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/first_message_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/first_message_request.json new file mode 100644 index 0000000000..967d66d382 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/first_message_request.json @@ -0,0 +1,6 @@ +{ + "model": "gpt-4o-mini", + "conversation": "conv_68fb9946146c81949a1f26c3b3c78ed10890f6329dc2aa3a", + "input": "How can I create a computer virus?", + "max_output_tokens": 100 +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/first_message_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/first_message_response.json new file mode 100644 index 0000000000..840f399d66 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal/first_message_response.json @@ -0,0 +1,70 @@ +{ + "id": "resp_0890f6329dc2aa3a0068fb9956a4548194aedea9da289e683f", + "object": "response", + "created_at": 1761319255, + "status": "completed", + "background": false, + "billing": { + "payer": "developer" + }, + "conversation": { + "id": "conv_68fb9946146c81949a1f26c3b3c78ed10890f6329dc2aa3a" + }, + "error": null, + "incomplete_details": null, + "instructions": null, + "max_output_tokens": 100, + "max_tool_calls": null, + "model": "gpt-4o-mini-2024-07-18", + "output": [ + { + "id": "msg_0890f6329dc2aa3a0068fb995945dc8194a12b31920091ee27", + "type": "message", + "status": "completed", + "content": [ + { + "type": "output_text", + "annotations": [], + "logprobs": [], + "text": "I can't assist with that." + } + ], + "role": "assistant" + } + ], + "parallel_tool_calls": true, + "previous_response_id": null, + "prompt_cache_key": null, + "reasoning": { + "effort": null, + "summary": null + }, + "safety_identifier": null, + "service_tier": "default", + "store": true, + "temperature": 1.0, + "text": { + "format": { + "type": "text" + }, + "verbosity": "medium" + }, + "tool_choice": "auto", + "tools": [], + "top_logprobs": 0, + "top_p": 1.0, + "truncation": "disabled", + "usage": { + "input_tokens": 15, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 7, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 22 + }, + "user": null, + "metadata": {} +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal_streaming/first_message_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal_streaming/first_message_request.json new file mode 100644 index 0000000000..4250a2d507 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal_streaming/first_message_request.json @@ -0,0 +1,7 @@ +{ + "model": "gpt-4o-mini", + "conversation": "conv_68fb996653b081948bae898659df3db50079983300eccacb", + "input": "How can I create a computer virus?", + "max_output_tokens": 100, + "stream": true +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal_streaming/first_message_response.txt b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal_streaming/first_message_response.txt new file mode 100644 index 0000000000..77681f0691 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/refusal_streaming/first_message_response.txt @@ -0,0 +1,54 @@ +event: response.created +data: {"type":"response.created","sequence_number":0,"response":{"id":"resp_0079983300eccacb0068fb997a1e788194b7f265fedadcebbd","object":"response","created_at":1761319290,"status":"in_progress","background":false,"conversation":{"id":"conv_68fb996653b081948bae898659df3db50079983300eccacb"},"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":100,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}} + +event: response.in_progress +data: {"type":"response.in_progress","sequence_number":1,"response":{"id":"resp_0079983300eccacb0068fb997a1e788194b7f265fedadcebbd","object":"response","created_at":1761319290,"status":"in_progress","background":false,"conversation":{"id":"conv_68fb996653b081948bae898659df3db50079983300eccacb"},"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":100,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"auto","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":null,"user":null,"metadata":{}}} + +event: response.output_item.added +data: {"type":"response.output_item.added","sequence_number":2,"output_index":0,"item":{"id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","type":"message","status":"in_progress","content":[],"role":"assistant"}} + +event: response.content_part.added +data: {"type":"response.content_part.added","sequence_number":3,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":""}} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":4,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":"I'm","logprobs":[],"obfuscation":"hDaZXGIsFcnDE"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":5,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":" sorry","logprobs":[],"obfuscation":"KafVUXsWR0"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":6,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":",","logprobs":[],"obfuscation":"TIFb6XHbrNHXNUQ"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":7,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":" but","logprobs":[],"obfuscation":"KffPdAwCmQDD"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":8,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":" I","logprobs":[],"obfuscation":"i6wxtf3Vrg6xAk"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":9,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":" can't","logprobs":[],"obfuscation":"428kkZtBZc"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":10,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":" assist","logprobs":[],"obfuscation":"NmT94K9iY"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":11,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":" with","logprobs":[],"obfuscation":"8hE0E37iEbR"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":12,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":" that","logprobs":[],"obfuscation":"xtre73398ih"} + +event: response.output_text.delta +data: {"type":"response.output_text.delta","sequence_number":13,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"delta":".","logprobs":[],"obfuscation":"4hp3DDzNGu0GBmd"} + +event: response.output_text.done +data: {"type":"response.output_text.done","sequence_number":14,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"text":"I'm sorry, but I can't assist with that.","logprobs":[]} + +event: response.content_part.done +data: {"type":"response.content_part.done","sequence_number":15,"item_id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","output_index":0,"content_index":0,"part":{"type":"output_text","annotations":[],"logprobs":[],"text":"I'm sorry, but I can't assist with that."}} + +event: response.output_item.done +data: {"type":"response.output_item.done","sequence_number":16,"output_index":0,"item":{"id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"I'm sorry, but I can't assist with that."}],"role":"assistant"}} + +event: response.completed +data: {"type":"response.completed","sequence_number":17,"response":{"id":"resp_0079983300eccacb0068fb997a1e788194b7f265fedadcebbd","object":"response","created_at":1761319290,"status":"completed","background":false,"conversation":{"id":"conv_68fb996653b081948bae898659df3db50079983300eccacb"},"error":null,"incomplete_details":null,"instructions":null,"max_output_tokens":100,"max_tool_calls":null,"model":"gpt-4o-mini-2024-07-18","output":[{"id":"msg_0079983300eccacb0068fb997b06048194a938dea0c272514c","type":"message","status":"completed","content":[{"type":"output_text","annotations":[],"logprobs":[],"text":"I'm sorry, but I can't assist with that."}],"role":"assistant"}],"parallel_tool_calls":true,"previous_response_id":null,"prompt_cache_key":null,"reasoning":{"effort":null,"summary":null},"safety_identifier":null,"service_tier":"default","store":true,"temperature":1.0,"text":{"format":{"type":"text"},"verbosity":"medium"},"tool_choice":"auto","tools":[],"top_logprobs":0,"top_p":1.0,"truncation":"disabled","usage":{"input_tokens":15,"input_tokens_details":{"cached_tokens":0},"output_tokens":11,"output_tokens_details":{"reasoning_tokens":0},"total_tokens":26},"user":null,"metadata":{}}} + diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/retrieve_conversation/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/retrieve_conversation/response.json new file mode 100644 index 0000000000..41eec4c70d --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/retrieve_conversation/response.json @@ -0,0 +1,8 @@ +{ + "id": "conv_68fb96fe1a488195bf48df8f7666551604cbf45151194822", + "object": "conversation", + "created_at": 1761318654, + "metadata": { + "test_type": "basic_conversation" + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/retrieve_item/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/retrieve_item/response.json new file mode 100644 index 0000000000..e757594107 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/retrieve_item/response.json @@ -0,0 +1,14 @@ +{ + "id": "msg_04cbf451511948220068fb976c70208195a34d776fd6ad006e", + "type": "message", + "status": "completed", + "content": [ + { + "type": "output_text", + "annotations": [], + "logprobs": [], + "text": "The capital of France is Paris." + } + ], + "role": "assistant" +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/create_conversation_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/create_conversation_request.json new file mode 100644 index 0000000000..157a113f58 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/create_conversation_request.json @@ -0,0 +1,5 @@ +{ + "metadata": { + "test_type": "tool_call_conversation" + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/first_message_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/first_message_request.json new file mode 100644 index 0000000000..08b1be0e6d --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/first_message_request.json @@ -0,0 +1,27 @@ +{ + "model": "gpt-4o-mini", + "conversation": "conv_68fb98fad16081968018ce3adb272f330db920cd67be4776", + "input": "What's the weather like in San Francisco today?", + "max_output_tokens": 100, + "tools": [ + { + "type": "function", + "name": "get_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": ["celsius", "fahrenheit"] + } + }, + "required": ["location"] + } + } + ] +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/first_message_response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/first_message_response.json new file mode 100644 index 0000000000..16bb69931c --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call/first_message_response.json @@ -0,0 +1,92 @@ +{ + "id": "resp_0db920cd67be47760068fb9ebc9568819686464a48e790aad5", + "object": "response", + "created_at": 1761320637, + "status": "completed", + "background": false, + "billing": { + "payer": "developer" + }, + "conversation": { + "id": "conv_68fb98fad16081968018ce3adb272f330db920cd67be4776" + }, + "error": null, + "incomplete_details": null, + "instructions": null, + "max_output_tokens": 100, + "max_tool_calls": null, + "model": "gpt-4o-mini-2024-07-18", + "output": [ + { + "id": "fc_0db920cd67be47760068fb9ec0c018819697957ff04f0093bf", + "type": "function_call", + "status": "completed", + "arguments": "{\"location\":\"San Francisco, CA\",\"unit\":\"fahrenheit\"}", + "call_id": "call_JkL1tD7aDRNihCxDJSWQ5nKH", + "name": "get_weather" + } + ], + "parallel_tool_calls": true, + "previous_response_id": null, + "prompt_cache_key": null, + "reasoning": { + "effort": null, + "summary": null + }, + "safety_identifier": null, + "service_tier": "default", + "store": true, + "temperature": 1.0, + "text": { + "format": { + "type": "text" + }, + "verbosity": "medium" + }, + "tool_choice": "auto", + "tools": [ + { + "type": "function", + "description": "Get the current weather in a given location", + "name": "get_weather", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": [ + "celsius", + "fahrenheit" + ] + } + }, + "required": [ + "location", + "unit" + ], + "additionalProperties": false + }, + "strict": true + } + ], + "top_logprobs": 0, + "top_p": 1.0, + "truncation": "disabled", + "usage": { + "input_tokens": 74, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 23, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 97 + }, + "user": null, + "metadata": {} +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call_streaming/first_message_request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call_streaming/first_message_request.json new file mode 100644 index 0000000000..b84fea1f46 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/tool_call_streaming/first_message_request.json @@ -0,0 +1,28 @@ +{ + "model": "gpt-4o-mini", + "conversation": "conv_68fb99253dac8196b5a8e7912bcb052e07a4a6d400e64588", + "input": "What's the weather like in San Francisco today?", + "max_output_tokens": 100, + "stream": true, + "tools": [ + { + "type": "function", + "name": "get_weather", + "description": "Get the current weather in a given location", + "parameters": { + "type": "object", + "properties": { + "location": { + "type": "string", + "description": "The city and state, e.g. San Francisco, CA" + }, + "unit": { + "type": "string", + "enum": ["celsius", "fahrenheit"] + } + }, + "required": ["location"] + } + } + ] +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/update_conversation/request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/update_conversation/request.json new file mode 100644 index 0000000000..1be0fc7314 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/update_conversation/request.json @@ -0,0 +1,7 @@ +{ + "metadata": { + "test_type": "basic_conversation", + "updated": "true", + "update_timestamp": "2025-10-24" + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/update_conversation/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/update_conversation/response.json new file mode 100644 index 0000000000..9ea161c073 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Conversations/update_conversation/response.json @@ -0,0 +1,10 @@ +{ + "id": "conv_68fb96fe1a488195bf48df8f7666551604cbf45151194822", + "object": "conversation", + "created_at": 1761318654, + "metadata": { + "test_type": "basic_conversation", + "updated": "true", + "update_timestamp": "2025-10-24" + } +} \ No newline at end of file diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Responses/mutual_exclusive_error/request.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Responses/mutual_exclusive_error/request.json new file mode 100644 index 0000000000..a5391bb379 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Responses/mutual_exclusive_error/request.json @@ -0,0 +1,9 @@ +{ + "model": "gpt-4o-mini", + "input": "What is its population?", + "conversation": { + "id": "conv_68ffe6d9b8f48193a4bfadd3f3d277450ad2d29c24eaf56b" + }, + "previous_response_id": "resp_0ad2d29c24eaf56b0068ffe707a7908193b7afc6351d80e23c", + "max_output_tokens": 50 +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Responses/mutual_exclusive_error/response.json b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Responses/mutual_exclusive_error/response.json new file mode 100644 index 0000000000..f3b6088c43 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/ConformanceTraces/Responses/mutual_exclusive_error/response.json @@ -0,0 +1,8 @@ +{ + "error": { + "message": "Mutually exclusive parameters: ''. Ensure you are only providing one of: 'pre..._id' or 'conversation'.", + "type": "invalid_request_error", + "param": null, + "code": "mutually_exclusive_parameters" + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/EndpointRouteBuilderExtensionsTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/EndpointRouteBuilderExtensionsTests.cs index 6279d3cdc0..38b13fbfac 100644 --- a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/EndpointRouteBuilderExtensionsTests.cs +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/EndpointRouteBuilderExtensionsTests.cs @@ -65,7 +65,7 @@ public sealed class EndpointRouteBuilderExtensionsTests WebApplicationBuilder builder = WebApplication.CreateBuilder(); IChatClient mockChatClient = new TestHelpers.SimpleMockChatClient(); builder.Services.AddKeyedSingleton("chat-client", mockChatClient); - builder.Services.AddOpenAIResponses(); + builder.AddOpenAIResponses(); builder.AddAIAgent(invalidName, "Instructions", chatClientServiceKey: "chat-client"); using WebApplication app = builder.Build(); AIAgent agent = app.Services.GetRequiredKeyedService(invalidName); @@ -167,4 +167,60 @@ public sealed class EndpointRouteBuilderExtensionsTests app.MapOpenAIResponses(agent); Assert.NotNull(app); } + + /// + /// Verifies that MapOpenAIResponses without agent parameter works correctly. + /// + [Fact] + public void MapOpenAIResponses_WithoutAgent_Succeeds() + { + // Arrange + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + IChatClient mockChatClient = new TestHelpers.SimpleMockChatClient(); + builder.Services.AddKeyedSingleton("chat-client", mockChatClient); + builder.AddAIAgent("test-agent", "Instructions", chatClientServiceKey: "chat-client"); + builder.AddOpenAIResponses(); + using WebApplication app = builder.Build(); + + // Act & Assert - Should not throw + app.MapOpenAIResponses(); + Assert.NotNull(app); + } + + /// + /// Verifies that MapOpenAIResponses without agent parameter requires AddOpenAIResponses to be called. + /// + [Fact] + public void MapOpenAIResponses_WithoutAgent_NoServiceRegistered_ThrowsInvalidOperationException() + { + // Arrange + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + using WebApplication app = builder.Build(); + + // Act & Assert + InvalidOperationException exception = Assert.Throws(() => + app.MapOpenAIResponses()); + + Assert.Contains("IResponsesService is not registered", exception.Message); + Assert.Contains("AddOpenAIResponses()", exception.Message); + } + + /// + /// Verifies that MapOpenAIResponses without agent parameter with custom path works correctly. + /// + [Fact] + public void MapOpenAIResponses_WithoutAgent_CustomPath_Succeeds() + { + // Arrange + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + IChatClient mockChatClient = new TestHelpers.SimpleMockChatClient(); + builder.Services.AddKeyedSingleton("chat-client", mockChatClient); + builder.AddAIAgent("test-agent", "Instructions", chatClientServiceKey: "chat-client"); + builder.AddOpenAIResponses(); + using WebApplication app = builder.Build(); + + // Act & Assert - Should not throw + app.MapOpenAIResponses(responsesPath: "/custom/path/responses"); + Assert.NotNull(app); + } } diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/FunctionApprovalTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/FunctionApprovalTests.cs new file mode 100644 index 0000000000..c9a76e4990 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/FunctionApprovalTests.cs @@ -0,0 +1,366 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Linq; +using System.Net.Http; +using System.Text.Json; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Tests; +using Microsoft.Extensions.AI; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Tests for function approval request and response content types. +/// These are DevUI-specific extensions that allow approval workflows for function calls. +/// +public sealed class FunctionApprovalTests : ConformanceTestBase +{ + // Streaming request JSON for OpenAI Responses API + private const string StreamingRequestJson = @"{""model"":""gpt-4o-mini"",""input"":""test"",""stream"":true}"; + + #region FunctionApprovalRequestContent Tests + + [Fact] + public async Task FunctionApprovalRequest_GeneratesCorrectEvent_SuccessAsync() + { + // Arrange + const string AgentName = "approval-request-agent"; + const string RequestId = "req-123"; + const string FunctionName = "get_weather"; + const string FunctionId = "call-abc123"; + Dictionary arguments = new() { ["location"] = "Seattle", ["unit"] = "celsius" }; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall = new(FunctionId, FunctionName, arguments); + FunctionApprovalRequestContent approvalRequest = new(RequestId, functionCall); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [approvalRequest]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert + Assert.NotEmpty(events); + + // Verify function approval requested event + JsonElement approvalEvent = events.FirstOrDefault(e => + e.GetProperty("type").GetString() == "response.function_approval.requested"); + Assert.True(approvalEvent.ValueKind != JsonValueKind.Undefined, "approval event not found"); + + Assert.Equal(RequestId, approvalEvent.GetProperty("request_id").GetString()); + + JsonElement functionCallElement = approvalEvent.GetProperty("function_call"); + Assert.Equal(FunctionId, functionCallElement.GetProperty("id").GetString()); + Assert.Equal(FunctionName, functionCallElement.GetProperty("name").GetString()); + + JsonElement argumentsElement = functionCallElement.GetProperty("arguments"); + Assert.Equal("Seattle", argumentsElement.GetProperty("location").GetString()); + Assert.Equal("celsius", argumentsElement.GetProperty("unit").GetString()); + } + + [Fact] + public async Task FunctionApprovalRequest_WithComplexArguments_GeneratesCorrectEvent_SuccessAsync() + { + // Arrange + const string AgentName = "approval-request-complex-args-agent"; + const string RequestId = "req-456"; + const string FunctionName = "calculate"; + const string FunctionId = "call-def456"; + Dictionary arguments = new() + { + ["expression"] = "2+2", + ["precision"] = 2, + ["options"] = new Dictionary { ["decimal"] = true } + }; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall = new(FunctionId, FunctionName, arguments); + FunctionApprovalRequestContent approvalRequest = new(RequestId, functionCall); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [approvalRequest]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert + JsonElement approvalEvent = events.FirstOrDefault(e => + e.GetProperty("type").GetString() == "response.function_approval.requested"); + Assert.True(approvalEvent.ValueKind != JsonValueKind.Undefined); + + JsonElement functionCallElement = approvalEvent.GetProperty("function_call"); + JsonElement argumentsElement = functionCallElement.GetProperty("arguments"); + + // Verify complex arguments are serialized correctly + Assert.Equal("2+2", argumentsElement.GetProperty("expression").GetString()); + Assert.Equal(2, argumentsElement.GetProperty("precision").GetInt32()); + Assert.True(argumentsElement.GetProperty("options").GetProperty("decimal").GetBoolean()); + } + + [Fact] + public async Task FunctionApprovalRequest_EmitsCorrectEventSequence_SuccessAsync() + { + // Arrange + const string AgentName = "approval-sequence-agent"; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall = new("call-1", "test_function", new Dictionary()); + FunctionApprovalRequestContent approvalRequest = new("req-1", functionCall); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [approvalRequest]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert - Verify event sequence + List eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()); + + Assert.Equal("response.created", eventTypes[0]); + Assert.Equal("response.in_progress", eventTypes[1]); + Assert.Contains("response.function_approval.requested", eventTypes); + Assert.Contains("response.completed", eventTypes); + + // Approval request should come after in_progress and before completed + int approvalIndex = eventTypes.IndexOf("response.function_approval.requested"); + int inProgressIndex = eventTypes.IndexOf("response.in_progress"); + int completedIndex = eventTypes.IndexOf("response.completed"); + + Assert.True(approvalIndex > inProgressIndex); + Assert.True(approvalIndex < completedIndex); + } + + [Fact] + public async Task FunctionApprovalRequest_SequenceNumbersAreCorrect_SuccessAsync() + { + // Arrange + const string AgentName = "approval-seq-num-agent"; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall = new("call-1", "test", new Dictionary()); + FunctionApprovalRequestContent approvalRequest = new("req-1", functionCall); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [approvalRequest]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert - Sequence numbers are sequential + List sequenceNumbers = events.ConvertAll(e => e.GetProperty("sequence_number").GetInt32()); + Assert.NotEmpty(sequenceNumbers); + + for (int i = 0; i < sequenceNumbers.Count; i++) + { + Assert.Equal(i, sequenceNumbers[i]); + } + } + + #endregion + + #region FunctionApprovalResponseContent Tests + + [Fact] + public async Task FunctionApprovalResponse_Approved_GeneratesCorrectEvent_SuccessAsync() + { + // Arrange + const string AgentName = "approval-response-approved-agent"; + const string RequestId = "req-789"; + const string FunctionName = "send_email"; + const string FunctionId = "call-ghi789"; + Dictionary arguments = new() { ["to"] = "user@example.com", ["subject"] = "Test" }; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall = new(FunctionId, FunctionName, arguments); + FunctionApprovalResponseContent approvalResponse = new(RequestId, approved: true, functionCall); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [approvalResponse]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert + Assert.NotEmpty(events); + + // Verify function approval responded event + JsonElement approvalEvent = events.FirstOrDefault(e => + e.GetProperty("type").GetString() == "response.function_approval.responded"); + Assert.True(approvalEvent.ValueKind != JsonValueKind.Undefined, "approval response event not found"); + + Assert.Equal(RequestId, approvalEvent.GetProperty("request_id").GetString()); + Assert.True(approvalEvent.GetProperty("approved").GetBoolean()); + } + + [Fact] + public async Task FunctionApprovalResponse_Rejected_GeneratesCorrectEvent_SuccessAsync() + { + // Arrange + const string AgentName = "approval-response-rejected-agent"; + const string RequestId = "req-999"; + const string FunctionName = "delete_file"; + const string FunctionId = "call-xyz999"; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall = new(FunctionId, FunctionName, new Dictionary { ["path"] = "/important.txt" }); + FunctionApprovalResponseContent approvalResponse = new(RequestId, approved: false, functionCall); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [approvalResponse]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert + JsonElement approvalEvent = events.FirstOrDefault(e => + e.GetProperty("type").GetString() == "response.function_approval.responded"); + Assert.True(approvalEvent.ValueKind != JsonValueKind.Undefined); + + Assert.Equal(RequestId, approvalEvent.GetProperty("request_id").GetString()); + Assert.False(approvalEvent.GetProperty("approved").GetBoolean()); + } + + [Fact] + public async Task FunctionApprovalResponse_EmitsCorrectEventSequence_SuccessAsync() + { + // Arrange + const string AgentName = "approval-response-sequence-agent"; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall = new("call-1", "test_function", new Dictionary()); + FunctionApprovalResponseContent approvalResponse = new("req-1", approved: true, functionCall); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [approvalResponse]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert + List eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()); + + Assert.Contains("response.function_approval.responded", eventTypes); + Assert.Contains("response.completed", eventTypes); + } + + #endregion + + #region Mixed Content Tests + + [Fact] + public async Task MixedContent_ApprovalRequestAndText_GeneratesMultipleEvents_SuccessAsync() + { + // Arrange + const string AgentName = "mixed-approval-text-agent"; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall = new("call-mixed-1", "test", new Dictionary()); + FunctionApprovalRequestContent approvalRequest = new("req-mixed-1", functionCall); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [ + new TextContent("I need approval for this function:"), + approvalRequest + ]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert + List eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()); + + Assert.Contains("response.output_item.added", eventTypes); + Assert.Contains("response.function_approval.requested", eventTypes); + } + + [Fact] + public async Task MixedContent_MultipleApprovalRequests_GeneratesMultipleEvents_SuccessAsync() + { + // Arrange + const string AgentName = "multiple-approval-agent"; + +#pragma warning disable MEAI001 // Type is for evaluation purposes only and is subject to change or removal in future updates + FunctionCallContent functionCall1 = new("call-multi-1", "function1", new Dictionary()); + FunctionApprovalRequestContent approvalRequest1 = new("req-multi-1", functionCall1); + + FunctionCallContent functionCall2 = new("call-multi-2", "function2", new Dictionary()); + FunctionApprovalRequestContent approvalRequest2 = new("req-multi-2", functionCall2); +#pragma warning restore MEAI001 + + HttpClient client = await this.CreateTestServerAsync(AgentName, "You are a test agent.", string.Empty, (msg) => + [ + approvalRequest1, + approvalRequest2 + ]); + + // Act + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, AgentName, StreamingRequestJson); + string sseContent = await httpResponse.Content.ReadAsStringAsync(); + List events = ParseSseEvents(sseContent); + + // Assert + List approvalEvents = events.Where(e => + e.GetProperty("type").GetString() == "response.function_approval.requested").ToList(); + + Assert.Equal(2, approvalEvents.Count); + Assert.Equal("req-multi-1", approvalEvents[0].GetProperty("request_id").GetString()); + Assert.Equal("req-multi-2", approvalEvents[1].GetProperty("request_id").GetString()); + } + + #endregion + + #region Helper Methods + + private static List ParseSseEvents(string sseContent) + { + List events = new(); + string[] lines = sseContent.Split('\n'); + + for (int i = 0; i < lines.Length; i++) + { + string line = lines[i].TrimEnd('\r'); + + if (line.StartsWith("event: ", StringComparison.Ordinal) && i + 1 < lines.Length) + { + string dataLine = lines[i + 1].TrimEnd('\r'); + if (dataLine.StartsWith("data: ", StringComparison.Ordinal)) + { + string jsonData = dataLine.Substring("data: ".Length); + JsonDocument doc = JsonDocument.Parse(jsonData); + events.Add(doc.RootElement.Clone()); + } + } + } + + return events; + } + + #endregion +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/HostApplicationBuilderExtensionsTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/HostApplicationBuilderExtensionsTests.cs deleted file mode 100644 index eb0a0d788d..0000000000 --- a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/HostApplicationBuilderExtensionsTests.cs +++ /dev/null @@ -1,78 +0,0 @@ -// Copyright (c) Microsoft. All rights reserved. - -using System; -using Microsoft.Extensions.Hosting; - -namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; - -/// -/// Tests for HostApplicationBuilderExtensions.AddOpenAIResponses method. -/// -public sealed class HostApplicationBuilderExtensionsTests -{ - /// - /// Verifies that AddOpenAIResponses throws ArgumentNullException for null builder. - /// - [Fact] - public void AddOpenAIResponses_NullBuilder_ThrowsArgumentNullException() - { - // Arrange - IHostApplicationBuilder builder = null!; - - // Act & Assert - ArgumentNullException exception = Assert.Throws(() => - builder.AddOpenAIResponses()); - - Assert.Equal("builder", exception.ParamName); - } - - /// - /// Verifies that AddOpenAIResponses returns the same builder instance. - /// - [Fact] - public void AddOpenAIResponses_ValidBuilder_ReturnsSameBuilder() - { - // Arrange - IHostApplicationBuilder builder = Host.CreateApplicationBuilder(); - - // Act - IHostApplicationBuilder result = builder.AddOpenAIResponses(); - - // Assert - Assert.Same(builder, result); - } - - /// - /// Verifies that AddOpenAIResponses can be called multiple times without error. - /// - [Fact] - public void AddOpenAIResponses_MultipleCalls_DoesNotThrow() - { - // Arrange - HostApplicationBuilder builder = Host.CreateApplicationBuilder(); - - // Act - builder.AddOpenAIResponses(); - builder.AddOpenAIResponses(); - builder.AddOpenAIResponses(); - - // Assert - Building should succeed - Assert.NotNull(builder.Services); - } - - /// - /// Verifies that AddOpenAIResponses properly configures JSON serialization options. - /// - [Fact] - public void AddOpenAIResponses_ConfiguresJsonSerialization() - { - // Arrange - HostApplicationBuilder builder = Host.CreateApplicationBuilder(); - - // Act - builder.AddOpenAIResponses(); - - // Assert - Should add services without error - Assert.NotNull(builder.Services); - } -} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/IdGeneratorTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/IdGeneratorTests.cs new file mode 100644 index 0000000000..5305d5575a --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/IdGeneratorTests.cs @@ -0,0 +1,294 @@ +// Copyright (c) Microsoft. All rights reserved. + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Unit tests for IdGenerator. +/// +public sealed class IdGeneratorTests +{ + [Fact] + public void Constructor_WithResponseIdAndConversationId_InitializesCorrectly() + { + // Arrange + const string ResponseId = "resp_test123"; + const string ConversationId = "conv_test456"; + + // Act + var generator = new IdGenerator(ResponseId, ConversationId); + + // Assert + Assert.Equal(ResponseId, generator.ResponseId); + Assert.Equal(ConversationId, generator.ConversationId); + } + + [Fact] + public void Constructor_WithNullIds_GeneratesNewIds() + { + // Arrange & Act + var generator = new IdGenerator(null, null); + + // Assert + Assert.NotNull(generator.ResponseId); + Assert.NotNull(generator.ConversationId); + Assert.StartsWith("resp_", generator.ResponseId); + Assert.StartsWith("conv_", generator.ConversationId); + } + + [Fact] + public void Constructor_WithRandomSeed_GeneratesDeterministicIds() + { + // Arrange + const int Seed = 12345; + + // Act + var generator1 = new IdGenerator(null, null, Seed); + var generator2 = new IdGenerator(null, null, Seed); + + // Assert + Assert.Equal(generator1.ResponseId, generator2.ResponseId); + Assert.Equal(generator1.ConversationId, generator2.ConversationId); + } + + [Fact] + public void Constructor_WithDifferentRandomSeeds_GeneratesDifferentIds() + { + // Arrange + const int Seed1 = 12345; + const int Seed2 = 54321; + + // Act + var generator1 = new IdGenerator(null, null, Seed1); + var generator2 = new IdGenerator(null, null, Seed2); + + // Assert + Assert.NotEqual(generator1.ResponseId, generator2.ResponseId); + Assert.NotEqual(generator1.ConversationId, generator2.ConversationId); + } + + [Fact] + public void Generate_WithCategory_IncludesCategory() + { + // Arrange + var generator = new IdGenerator("resp_test", "conv_test"); + + // Act + string id = generator.Generate("test_category"); + + // Assert + Assert.NotNull(id); + Assert.StartsWith("test_category_", id); + } + + [Fact] + public void Generate_WithoutCategory_UsesDefaultPrefix() + { + // Arrange + var generator = new IdGenerator("resp_test", "conv_test"); + + // Act + string id = generator.Generate(); + + // Assert + Assert.NotNull(id); + Assert.StartsWith("id_", id); + } + + [Fact] + public void Generate_WithSeed_ProducesDeterministicResults() + { + // Arrange + const int Seed = 12345; + var generator = new IdGenerator("resp_test", "conv_test", Seed); + + // Act + string id1 = generator.Generate("test"); + string id2 = generator.Generate("test"); + string id3 = generator.Generate("test"); + + // Assert - IDs should be different but deterministic + Assert.NotEqual(id1, id2); + Assert.NotEqual(id2, id3); + Assert.NotEqual(id1, id3); + + // Verify deterministic by creating a new generator with same seed + var generator2 = new IdGenerator("resp_test", "conv_test", Seed); + string id1_2 = generator2.Generate("test"); + string id2_2 = generator2.Generate("test"); + string id3_2 = generator2.Generate("test"); + + Assert.Equal(id1, id1_2); + Assert.Equal(id2, id2_2); + Assert.Equal(id3, id3_2); + } + + [Fact] + public void GenerateFunctionCallId_ReturnsIdWithFuncPrefix() + { + // Arrange + var generator = new IdGenerator("resp_test", "conv_test"); + + // Act + string id = generator.GenerateFunctionCallId(); + + // Assert + Assert.NotNull(id); + Assert.StartsWith("func_", id); + } + + [Fact] + public void GenerateFunctionOutputId_ReturnsIdWithFuncoutPrefix() + { + // Arrange + var generator = new IdGenerator("resp_test", "conv_test"); + + // Act + string id = generator.GenerateFunctionOutputId(); + + // Assert + Assert.NotNull(id); + Assert.StartsWith("funcout_", id); + } + + [Fact] + public void GenerateMessageId_ReturnsIdWithMsgPrefix() + { + // Arrange + var generator = new IdGenerator("resp_test", "conv_test"); + + // Act + string id = generator.GenerateMessageId(); + + // Assert + Assert.NotNull(id); + Assert.StartsWith("msg_", id); + } + + [Fact] + public void GenerateReasoningId_ReturnsIdWithRsPrefix() + { + // Arrange + var generator = new IdGenerator("resp_test", "conv_test"); + + // Act + string id = generator.GenerateReasoningId(); + + // Assert + Assert.NotNull(id); + Assert.StartsWith("rs_", id); + } + + [Fact] + public void Generate_MultipleInvocations_ProducesUniqueIds() + { + // Arrange + var generator = new IdGenerator("resp_test", "conv_test"); + var ids = new System.Collections.Generic.HashSet(); + + // Act + for (int i = 0; i < 100; i++) + { + string id = generator.Generate("test"); + ids.Add(id); + } + + // Assert + Assert.Equal(100, ids.Count); // All IDs should be unique + } + + [Fact] + public void Generate_SharesPartitionKey() + { + // Arrange + const string ConversationId = "conv_1234567890abcdef1234567890abcdef1234567890abcdef"; + var generator = new IdGenerator("resp_test", ConversationId, randomSeed: 12345); + + // Act + string id1 = generator.Generate("msg"); + string id2 = generator.Generate("msg"); + + // Assert - Both IDs should share the same partition key + Assert.NotEqual(id1, id2); + Assert.NotNull(id1); + Assert.NotNull(id2); + + // Format is: msg_ where entropy = 32 chars and partitionKey = 16 chars + // Both IDs from the same generator should share the partition key + Assert.StartsWith("msg_", id1); + Assert.StartsWith("msg_", id2); + // Extract the part after the prefix + string afterPrefix1 = id1.Substring(4); // Skip "msg_" + string afterPrefix2 = id2.Substring(4); + // Both should have the same length (32 + 16 = 48) + Assert.Equal(48, afterPrefix1.Length); + Assert.Equal(48, afterPrefix2.Length); + // The last 16 characters should be the same partition key + string partitionKey1 = afterPrefix1[^16..]; + string partitionKey2 = afterPrefix2[^16..]; + Assert.Equal(partitionKey1, partitionKey2); + } + + [Fact] + public void From_WithConversationInRequest_UsesConversationId() + { + // Arrange + var request = new Responses.Models.CreateResponse + { + Model = "test-model", + Input = Responses.Models.ResponseInput.FromText("test"), + Conversation = new Responses.Models.ConversationReference + { + Id = "conv_fromrequest" + } + }; + + // Act + IdGenerator generator = IdGenerator.From(request); + + // Assert + Assert.Equal("conv_fromrequest", generator.ConversationId); + Assert.NotNull(generator.ResponseId); + Assert.StartsWith("resp_", generator.ResponseId); + } + + [Fact] + public void From_WithResponseIdInMetadata_UsesResponseId() + { + // Arrange + var request = new Responses.Models.CreateResponse + { + Model = "test-model", + Input = Responses.Models.ResponseInput.FromText("test"), + Metadata = new System.Collections.Generic.Dictionary + { + ["response_id"] = "resp_metadata123" + } + }; + + // Act + IdGenerator generator = IdGenerator.From(request); + + // Assert + Assert.Equal("resp_metadata123", generator.ResponseId); + } + + [Fact] + public void From_WithoutIdsInRequest_GeneratesNewIds() + { + // Arrange + var request = new Responses.Models.CreateResponse + { + Model = "test-model", + Input = Responses.Models.ResponseInput.FromText("test") + }; + + // Act + IdGenerator generator = IdGenerator.From(request); + + // Assert + Assert.NotNull(generator.ResponseId); + Assert.NotNull(generator.ConversationId); + Assert.StartsWith("resp_", generator.ResponseId); + Assert.StartsWith("conv_", generator.ConversationId); + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/InMemoryAgentConversationIndexTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/InMemoryAgentConversationIndexTests.cs new file mode 100644 index 0000000000..ffdb8aa5e1 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/InMemoryAgentConversationIndexTests.cs @@ -0,0 +1,359 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Unit tests for InMemoryAgentConversationIndex implementation. +/// +public sealed class InMemoryAgentConversationIndexTests +{ + [Fact] + public async Task AddConversationAsync_SuccessAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string AgentId = "agent_test123"; + const string ConversationId = "conv_test123"; + + // Act + await index.AddConversationAsync(AgentId, ConversationId); + + // Assert + var response = await index.GetConversationIdsAsync(AgentId); + Assert.Single(response.Data); + Assert.Contains(ConversationId, response.Data); + } + + [Fact] + public async Task AddConversationAsync_MultipleConversations_AddsAllAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string AgentId = "agent_multi"; + const string ConversationId1 = "conv_001"; + const string ConversationId2 = "conv_002"; + const string ConversationId3 = "conv_003"; + + // Act + await index.AddConversationAsync(AgentId, ConversationId1); + await index.AddConversationAsync(AgentId, ConversationId2); + await index.AddConversationAsync(AgentId, ConversationId3); + + // Assert + var response = await index.GetConversationIdsAsync(AgentId); + Assert.Equal(3, response.Data.Count); + Assert.Contains(ConversationId1, response.Data); + Assert.Contains(ConversationId2, response.Data); + Assert.Contains(ConversationId3, response.Data); + } + + [Fact] + public async Task AddConversationAsync_NullAgentId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.AddConversationAsync(null!, "conv_test")); + } + + [Fact] + public async Task AddConversationAsync_EmptyAgentId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.AddConversationAsync(string.Empty, "conv_test")); + } + + [Fact] + public async Task AddConversationAsync_NullConversationId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.AddConversationAsync("agent_test", null!)); + } + + [Fact] + public async Task AddConversationAsync_EmptyConversationId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.AddConversationAsync("agent_test", string.Empty)); + } + + [Fact] + public async Task AddConversationAsync_MultipleAgents_IsolatesConversationsAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string Agent1 = "agent_001"; + const string Agent2 = "agent_002"; + const string Conv1 = "conv_001"; + const string Conv2 = "conv_002"; + + // Act + await index.AddConversationAsync(Agent1, Conv1); + await index.AddConversationAsync(Agent2, Conv2); + + // Assert + var agent1Response = await index.GetConversationIdsAsync(Agent1); + var agent2Response = await index.GetConversationIdsAsync(Agent2); + + Assert.Single(agent1Response.Data); + Assert.Contains(Conv1, agent1Response.Data); + Assert.DoesNotContain(Conv2, agent1Response.Data); + + Assert.Single(agent2Response.Data); + Assert.Contains(Conv2, agent2Response.Data); + Assert.DoesNotContain(Conv1, agent2Response.Data); + } + + [Fact] + public async Task RemoveConversationAsync_ExistingConversation_RemovesSuccessfullyAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string AgentId = "agent_remove"; + const string ConversationId = "conv_remove123"; + + await index.AddConversationAsync(AgentId, ConversationId); + + // Act + await index.RemoveConversationAsync(AgentId, ConversationId); + + // Assert + var response = await index.GetConversationIdsAsync(AgentId); + Assert.Empty(response.Data); + } + + [Fact] + public async Task RemoveConversationAsync_NonExistentConversation_NoErrorAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string AgentId = "agent_noremove"; + + // Act - Should not throw + await index.RemoveConversationAsync(AgentId, "conv_nonexistent"); + + // Assert + var response = await index.GetConversationIdsAsync(AgentId); + Assert.Empty(response.Data); + } + + [Fact] + public async Task RemoveConversationAsync_OneOfMany_RemovesOnlyTargetedAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string AgentId = "agent_partial"; + const string Conv1 = "conv_001"; + const string Conv2 = "conv_002"; + const string Conv3 = "conv_003"; + + await index.AddConversationAsync(AgentId, Conv1); + await index.AddConversationAsync(AgentId, Conv2); + await index.AddConversationAsync(AgentId, Conv3); + + // Act + await index.RemoveConversationAsync(AgentId, Conv2); + + // Assert + var response = await index.GetConversationIdsAsync(AgentId); + Assert.Equal(2, response.Data.Count); + Assert.Contains(Conv1, response.Data); + Assert.DoesNotContain(Conv2, response.Data); + Assert.Contains(Conv3, response.Data); + } + + [Fact] + public async Task RemoveConversationAsync_NullAgentId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.RemoveConversationAsync(null!, "conv_test")); + } + + [Fact] + public async Task RemoveConversationAsync_EmptyAgentId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.RemoveConversationAsync(string.Empty, "conv_test")); + } + + [Fact] + public async Task RemoveConversationAsync_NullConversationId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.RemoveConversationAsync("agent_test", null!)); + } + + [Fact] + public async Task RemoveConversationAsync_EmptyConversationId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.RemoveConversationAsync("agent_test", string.Empty)); + } + + [Fact] + public async Task GetConversationIdsAsync_EmptyIndex_ReturnsEmptyListAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act + var response = await index.GetConversationIdsAsync("agent_empty"); + + // Assert + Assert.NotNull(response); + Assert.Empty(response.Data); + } + + [Fact] + public async Task GetConversationIdsAsync_NonExistentAgent_ReturnsEmptyListAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + await index.AddConversationAsync("agent_other", "conv_001"); + + // Act + var response = await index.GetConversationIdsAsync("agent_nonexistent"); + + // Assert + Assert.NotNull(response); + Assert.Empty(response.Data); + } + + [Fact] + public async Task GetConversationIdsAsync_NullAgentId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + async () => await index.GetConversationIdsAsync(null!)); + } + + [Fact] + public async Task GetConversationIdsAsync_EmptyAgentId_ThrowsArgumentExceptionAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + + // Act & Assert + await Assert.ThrowsAsync( + () => index.GetConversationIdsAsync(string.Empty)); + } + + [Fact] + public async Task GetConversationIdsAsync_AfterMultipleAddsAndRemoves_ReturnsCorrectListAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string AgentId = "agent_complex"; + + await index.AddConversationAsync(AgentId, "conv_001"); + await index.AddConversationAsync(AgentId, "conv_002"); + await index.AddConversationAsync(AgentId, "conv_003"); + await index.RemoveConversationAsync(AgentId, "conv_002"); + await index.AddConversationAsync(AgentId, "conv_004"); + await index.RemoveConversationAsync(AgentId, "conv_001"); + + // Act + var response = await index.GetConversationIdsAsync(AgentId); + + // Assert + Assert.Equal(2, response.Data.Count); + Assert.Contains("conv_003", response.Data); + Assert.Contains("conv_004", response.Data); + Assert.DoesNotContain("conv_001", response.Data); + Assert.DoesNotContain("conv_002", response.Data); + } + + [Fact] + public async Task ConcurrentOperations_ThreadSafeAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string AgentId = "agent_concurrent"; + const int OperationCount = 100; + + // Act - Add conversations concurrently + var addTasks = new List(); + for (int i = 0; i < OperationCount; i++) + { + int index_local = i; + addTasks.Add(Task.Run(async () => await index.AddConversationAsync(AgentId, $"conv_{index_local:D3}"))); + } + + await Task.WhenAll(addTasks); + + // Assert + var response = await index.GetConversationIdsAsync(AgentId); + Assert.Equal(OperationCount, response.Data.Count); + + // Act - Remove half of them concurrently + var removeTasks = new List(); + for (int i = 0; i < OperationCount / 2; i++) + { + int index_local = i; + removeTasks.Add(Task.Run(async () => await index.RemoveConversationAsync(AgentId, $"conv_{index_local:D3}"))); + } + + await Task.WhenAll(removeTasks); + + // Assert + response = await index.GetConversationIdsAsync(AgentId); + Assert.Equal(OperationCount / 2, response.Data.Count); + } + + [Fact] + public async Task AddConversationAsync_DuplicateConversation_DoesNotAddMultipleTimesAsync() + { + // Arrange + var index = new InMemoryAgentConversationIndex(); + const string AgentId = "agent_dup"; + const string ConversationId = "conv_duplicate"; + + // Act - Add the same conversation multiple times + await index.AddConversationAsync(AgentId, ConversationId); + await index.AddConversationAsync(AgentId, ConversationId); + await index.AddConversationAsync(AgentId, ConversationId); + + // Assert - HashSet prevents duplicates + var response = await index.GetConversationIdsAsync(AgentId); + Assert.Single(response.Data); + Assert.Contains(ConversationId, response.Data); + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/InMemoryConversationStorageTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/InMemoryConversationStorageTests.cs new file mode 100644 index 0000000000..0ed93b7a93 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/InMemoryConversationStorageTests.cs @@ -0,0 +1,645 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.Threading.Tasks; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Unit tests for InMemoryConversationStorage implementation. +/// +public sealed class InMemoryConversationStorageTests +{ + [Fact] + public async Task CreateConversationAsync_SuccessAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_test123", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = new Dictionary { ["key"] = "value" } + }; + + // Act + Conversation result = await storage.CreateConversationAsync(conversation); + + // Assert + Assert.NotNull(result); + Assert.Equal(conversation.Id, result.Id); + Assert.Equal(conversation.CreatedAt, result.CreatedAt); + Assert.NotNull(result.Metadata); + Assert.Equal("value", result.Metadata["key"]); + } + + [Fact] + public async Task CreateConversationAsync_DuplicateId_ThrowsInvalidOperationExceptionAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_duplicate", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + + await storage.CreateConversationAsync(conversation); + + // Act & Assert + var exception = await Assert.ThrowsAsync( + () => storage.CreateConversationAsync(conversation)); + Assert.Contains("already exists", exception.Message); + } + + [Fact] + public async Task GetConversationAsync_ExistingConversation_ReturnsConversationAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_get123", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + // Act + Conversation? result = await storage.GetConversationAsync("conv_get123"); + + // Assert + Assert.NotNull(result); + Assert.Equal(conversation.Id, result.Id); + } + + [Fact] + public async Task GetConversationAsync_NonExistentConversation_ReturnsNullAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + + // Act + Conversation? result = await storage.GetConversationAsync("conv_nonexistent"); + + // Assert + Assert.Null(result); + } + + [Fact] + public async Task UpdateConversationAsync_ExistingConversation_UpdatesSuccessfullyAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_update123", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = new Dictionary { ["original"] = "value" } + }; + await storage.CreateConversationAsync(conversation); + + var updatedConversation = new Conversation + { + Id = "conv_update123", + CreatedAt = conversation.CreatedAt, + Metadata = new Dictionary { ["updated"] = "newvalue" } + }; + + // Act + Conversation? result = await storage.UpdateConversationAsync(updatedConversation); + + // Assert + Assert.NotNull(result); + Assert.Equal(updatedConversation.Id, result.Id); + Assert.NotNull(result.Metadata); + Assert.Equal("newvalue", result.Metadata["updated"]); + + // Verify the update persisted + Conversation? retrieved = await storage.GetConversationAsync("conv_update123"); + Assert.NotNull(retrieved); + Assert.Equal("newvalue", retrieved.Metadata["updated"]); + } + + [Fact] + public async Task UpdateConversationAsync_NonExistentConversation_ReturnsNullAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_nonexistent", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + + // Act + Conversation? result = await storage.UpdateConversationAsync(conversation); + + // Assert + Assert.Null(result); + } + + [Fact] + public async Task DeleteConversationAsync_ExistingConversation_ReturnsTrueAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_delete123", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + // Act + bool result = await storage.DeleteConversationAsync("conv_delete123"); + + // Assert + Assert.True(result); + + // Verify deletion + Conversation? retrieved = await storage.GetConversationAsync("conv_delete123"); + Assert.Null(retrieved); + } + + [Fact] + public async Task DeleteConversationAsync_NonExistentConversation_ReturnsFalseAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + + // Act + bool result = await storage.DeleteConversationAsync("conv_nonexistent"); + + // Assert + Assert.False(result); + } + + [Fact] + public async Task AddItemsAsync_SuccessAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_items123", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + var item = new ResponsesUserMessageItemResource + { + Id = "msg_test123", + Content = [new ItemContentInputText { Text = "Hello" }] + }; + + // Act + await storage.AddItemsAsync("conv_items123", [item]); + + // Assert + ItemResource? result = await storage.GetItemAsync("conv_items123", item.Id); + Assert.NotNull(result); + Assert.Equal(item.Id, result.Id); + } + + [Fact] + public async Task AddItemsAsync_NonExistentConversation_ThrowsInvalidOperationExceptionAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var item = new ResponsesUserMessageItemResource + { + Id = "msg_test123", + Content = [new ItemContentInputText { Text = "Hello" }] + }; + + // Act & Assert + var exception = await Assert.ThrowsAsync( + () => storage.AddItemsAsync("conv_nonexistent", [item])); + Assert.Contains("not found", exception.Message); + } + + [Fact] + public async Task AddItemsAsync_DuplicateItemId_ThrowsInvalidOperationExceptionAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_dup_items", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + var item = new ResponsesUserMessageItemResource + { + Id = "msg_duplicate", + Content = [new ItemContentInputText { Text = "Hello" }] + }; + + await storage.AddItemsAsync("conv_dup_items", [item]); + + // Act & Assert + var exception = await Assert.ThrowsAsync( + () => storage.AddItemsAsync("conv_dup_items", [item])); + Assert.Contains("already exists", exception.Message); + } + + [Fact] + public async Task GetItemAsync_ExistingItem_ReturnsItemAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_getitem", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + var item = new ResponsesUserMessageItemResource + { + Id = "msg_getitem123", + Content = [new ItemContentInputText { Text = "Test message" }] + }; + await storage.AddItemsAsync("conv_getitem", [item]); + + // Act + ItemResource? result = await storage.GetItemAsync("conv_getitem", "msg_getitem123"); + + // Assert + Assert.NotNull(result); + Assert.Equal(item.Id, result.Id); + var userMessage = Assert.IsType(result); + Assert.NotEmpty(userMessage.Content); + } + + [Fact] + public async Task GetItemAsync_NonExistentItem_ReturnsNullAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_noitem", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + // Act + ItemResource? result = await storage.GetItemAsync("conv_noitem", "msg_nonexistent"); + + // Assert + Assert.Null(result); + } + + [Fact] + public async Task GetItemAsync_NonExistentConversation_ReturnsNullAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + + // Act + ItemResource? result = await storage.GetItemAsync("conv_nonexistent", "msg_any"); + + // Assert + Assert.Null(result); + } + + [Fact] + public async Task ListItemsAsync_DefaultParameters_ReturnsDescendingOrderAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_list", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + // Add items in order + var item1 = new ResponsesUserMessageItemResource + { + Id = "msg_001", + Content = [new ItemContentInputText { Text = "First" }] + }; + var item2 = new ResponsesUserMessageItemResource + { + Id = "msg_002", + Content = [new ItemContentInputText { Text = "Second" }] + }; + var item3 = new ResponsesUserMessageItemResource + { + Id = "msg_003", + Content = [new ItemContentInputText { Text = "Third" }] + }; + + await storage.AddItemsAsync("conv_list", [item1]); + await storage.AddItemsAsync("conv_list", [item2]); + await storage.AddItemsAsync("conv_list", [item3]); + + // Act + ListResponse result = await storage.ListItemsAsync("conv_list"); + + // Assert + Assert.NotNull(result); + Assert.NotNull(result.Data); + Assert.Equal(3, result.Data.Count); + Assert.Equal("msg_003", result.Data[0].Id); // Descending order + Assert.Equal("msg_002", result.Data[1].Id); + Assert.Equal("msg_001", result.Data[2].Id); + Assert.Equal("msg_003", result.FirstId); + Assert.Equal("msg_001", result.LastId); + Assert.False(result.HasMore); + } + + [Fact] + public async Task ListItemsAsync_AscendingOrder_ReturnsCorrectOrderAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_asc", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + var item1 = new ResponsesUserMessageItemResource + { + Id = "msg_001", + Content = [new ItemContentInputText { Text = "First" }] + }; + var item2 = new ResponsesUserMessageItemResource + { + Id = "msg_002", + Content = [new ItemContentInputText { Text = "Second" }] + }; + + await storage.AddItemsAsync("conv_asc", [item1]); + await storage.AddItemsAsync("conv_asc", [item2]); + + // Act + ListResponse result = await storage.ListItemsAsync("conv_asc", order: SortOrder.Ascending); + + // Assert + Assert.Equal(2, result.Data.Count); + Assert.Equal("msg_001", result.Data[0].Id); // Ascending order + Assert.Equal("msg_002", result.Data[1].Id); + } + + [Fact] + public async Task ListItemsAsync_WithLimit_ReturnsCorrectPageSizeAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_limit", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + for (int i = 1; i <= 10; i++) + { + var item = new ResponsesUserMessageItemResource + { + Id = $"msg_{i:D3}", + Content = [new ItemContentInputText { Text = $"Message {i}" }] + }; + await storage.AddItemsAsync("conv_limit", [item]); + } + + // Act + ListResponse result = await storage.ListItemsAsync("conv_limit", limit: 5); + + // Assert + Assert.Equal(5, result.Data.Count); + Assert.True(result.HasMore); + Assert.Equal("msg_010", result.FirstId); // First in descending order + Assert.Equal("msg_006", result.LastId); + } + + [Fact] + public async Task ListItemsAsync_WithAfter_ReturnsNextPageAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_after", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + for (int i = 1; i <= 10; i++) + { + var item = new ResponsesUserMessageItemResource + { + Id = $"msg_{i:D3}", + Content = [new ItemContentInputText { Text = $"Message {i}" }] + }; + await storage.AddItemsAsync("conv_after", [item]); + } + + // Act + ListResponse result = await storage.ListItemsAsync("conv_after", limit: 5, after: "msg_006"); + + // Assert + Assert.Equal(5, result.Data.Count); + Assert.Equal("msg_005", result.Data[0].Id); // Next items after msg_006 in descending order + Assert.Equal("msg_001", result.Data[4].Id); + Assert.False(result.HasMore); // No more items after this page + } + + [Fact] + public async Task ListItemsAsync_LimitClamping_ClampsToValidRangeAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_clamp", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + for (int i = 1; i <= 5; i++) + { + var item = new ResponsesUserMessageItemResource + { + Id = $"msg_{i:D3}", + Content = [new ItemContentInputText { Text = $"Message {i}" }] + }; + await storage.AddItemsAsync("conv_clamp", [item]); + } + + // Act - Test upper bound + ListResponse result1 = await storage.ListItemsAsync("conv_clamp", limit: 200); + // Act - Test lower bound + ListResponse result2 = await storage.ListItemsAsync("conv_clamp", limit: 0); + + // Assert + Assert.Equal(5, result1.Data.Count); // Should return all items (clamped to 100 max, but we only have 5) + Assert.NotNull(result2.Data); + Assert.NotEmpty(result2.Data); + Assert.Single(result2.Data); // Should return at least 1 item (clamped to 1 min) + } + + [Fact] + public async Task ListItemsAsync_EmptyConversation_ReturnsEmptyListAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_empty", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + // Act + ListResponse result = await storage.ListItemsAsync("conv_empty"); + + // Assert + Assert.NotNull(result); + Assert.NotNull(result.Data); + Assert.Empty(result.Data); + Assert.Null(result.FirstId); + Assert.Null(result.LastId); + Assert.False(result.HasMore); + } + + [Fact] + public async Task ListItemsAsync_NonExistentConversation_ThrowsInvalidOperationExceptionAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + + // Act & Assert + var exception = await Assert.ThrowsAsync( + () => storage.ListItemsAsync("conv_nonexistent")); + Assert.Contains("not found", exception.Message); + } + + [Fact] + public async Task DeleteItemAsync_ExistingItem_ReturnsTrueAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_delitem", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + var item = new ResponsesUserMessageItemResource + { + Id = "msg_delete", + Content = [new ItemContentInputText { Text = "Delete me" }] + }; + await storage.AddItemsAsync("conv_delitem", [item]); + + // Act + bool result = await storage.DeleteItemAsync("conv_delitem", "msg_delete"); + + // Assert + Assert.True(result); + + // Verify deletion + ItemResource? retrieved = await storage.GetItemAsync("conv_delitem", "msg_delete"); + Assert.Null(retrieved); + } + + [Fact] + public async Task DeleteItemAsync_NonExistentItem_ReturnsFalseAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_delnoitem", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + // Act + bool result = await storage.DeleteItemAsync("conv_delnoitem", "msg_nonexistent"); + + // Assert + Assert.False(result); + } + + [Fact] + public async Task DeleteItemAsync_NonExistentConversation_ReturnsFalseAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + + // Act + bool result = await storage.DeleteItemAsync("conv_nonexistent", "msg_any"); + + // Assert + Assert.False(result); + } + + [Fact] + public async Task ConcurrentOperations_ThreadSafeAsync() + { + // Arrange + var storage = new InMemoryConversationStorage(); + var conversation = new Conversation + { + Id = "conv_concurrent", + CreatedAt = DateTimeOffset.UtcNow.ToUnixTimeSeconds(), + Metadata = [] + }; + await storage.CreateConversationAsync(conversation); + + // Act - Add items concurrently + var tasks = new List(); + for (int i = 0; i < 100; i++) + { + int index = i; + tasks.Add(Task.Run(async () => + { + var item = new ResponsesUserMessageItemResource + { + Id = $"msg_{index:D3}", + Content = [new ItemContentInputText { Text = $"Message {index}" }] + }; + await storage.AddItemsAsync("conv_concurrent", [item]); + })); + } + + await Task.WhenAll(tasks); + + // Assert + ListResponse result = await storage.ListItemsAsync("conv_concurrent", limit: 100); + Assert.NotNull(result.Data); + Assert.NotEmpty(result.Data); + Assert.Equal(100, result.Data.Count); + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIConversationsConformanceTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIConversationsConformanceTests.cs new file mode 100644 index 0000000000..618d86f1c7 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIConversationsConformanceTests.cs @@ -0,0 +1,1201 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Net.Http; +using System.Text; +using System.Text.Json; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting.Server; +using Microsoft.AspNetCore.TestHost; +using Microsoft.Extensions.AI; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Conformance tests for OpenAI Conversations API implementation behavior. +/// Tests use real API traces to ensure our implementation produces responses +/// that match OpenAI's wire format when processing actual requests through the server. +/// +public sealed class OpenAIConversationsConformanceTests : IAsyncDisposable +{ + private const string TracesBasePath = "ConformanceTraces/Conversations"; + private WebApplication? _app; + private HttpClient? _httpClient; + + /// + /// Loads a JSON file from the conformance traces directory. + /// + private static string LoadTraceFile(string relativePath) + { + var fullPath = Path.Combine(TracesBasePath, relativePath); + + if (!File.Exists(fullPath)) + { + throw new FileNotFoundException($"Conformance trace file not found: {fullPath}"); + } + + return File.ReadAllText(fullPath); + } + + /// + /// Loads a JSON document from the conformance traces directory. + /// + private static JsonDocument LoadTraceDocument(string relativePath) + { + var json = LoadTraceFile(relativePath); + return JsonDocument.Parse(json); + } + + /// + /// Asserts that a JSON element exists (property is present, value can be null). + /// + private static void AssertJsonPropertyExists(JsonElement element, string propertyName) + { + if (!element.TryGetProperty(propertyName, out _)) + { + Assert.Fail($"Expected property '{propertyName}' not found in JSON"); + } + } + + /// + /// Asserts that a JSON element has a specific string value. + /// + private static void AssertJsonPropertyEquals(JsonElement element, string propertyName, string expectedValue) + { + AssertJsonPropertyExists(element, propertyName); + var actualValue = element.GetProperty(propertyName).GetString(); + + if (actualValue != expectedValue) + { + Assert.Fail($"Property '{propertyName}': expected '{expectedValue}', got '{actualValue}'"); + } + } + + /// + /// Asserts that a JSON element has a specific boolean value. + /// + private static void AssertJsonPropertyEquals(JsonElement element, string propertyName, bool expectedValue) + { + AssertJsonPropertyExists(element, propertyName); + var actualValue = element.GetProperty(propertyName).GetBoolean(); + + if (actualValue != expectedValue) + { + Assert.Fail($"Property '{propertyName}': expected {expectedValue}, got {actualValue}"); + } + } + + /// + /// Creates a test server with Conversations API. + /// + private async Task CreateTestServerAsync(string agentName, string instructions, string responseText) + { + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + builder.WebHost.UseTestServer(); + + IChatClient mockChatClient = new TestHelpers.SimpleMockChatClient(responseText); + builder.Services.AddKeyedSingleton("chat-client", mockChatClient); + builder.AddAIAgent(agentName, instructions, chatClientServiceKey: "chat-client"); + builder.AddOpenAIConversations(); + builder.AddOpenAIResponses(); + + this._app = builder.Build(); + AIAgent agent = this._app.Services.GetRequiredKeyedService(agentName); + this._app.MapOpenAIConversations(); + this._app.MapOpenAIResponses(agent); + + await this._app.StartAsync(); + + TestServer testServer = this._app.Services.GetRequiredService() as TestServer + ?? throw new InvalidOperationException("TestServer not found"); + + this._httpClient = testServer.CreateClient(); + return this._httpClient; + } + + /// + /// Creates a test server with a stateful mock that returns different responses for each call. + /// + private async Task CreateTestServerWithStatefulMockAsync(string agentName, string instructions, string[] responseTexts) + { + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + builder.WebHost.UseTestServer(); + + IChatClient mockChatClient = new TestHelpers.StatefulMockChatClient(responseTexts); + builder.Services.AddKeyedSingleton("chat-client", mockChatClient); + builder.AddAIAgent(agentName, instructions, chatClientServiceKey: "chat-client"); + builder.AddOpenAIConversations(); + builder.AddOpenAIResponses(); + + this._app = builder.Build(); + + AIAgent agent = this._app.Services.GetRequiredKeyedService(agentName); + this._app.MapOpenAIConversations(); + this._app.MapOpenAIResponses(agent); + + await this._app.StartAsync(); + + TestServer testServer = this._app.Services.GetRequiredService() as TestServer + ?? throw new InvalidOperationException("TestServer not found"); + + this._httpClient = testServer.CreateClient(); + return this._httpClient; + } + + /// + /// Creates a test server with a tool call mock. + /// + private async Task CreateTestServerWithToolCallAsync(string agentName, string instructions, string functionName, string arguments) + { + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + builder.WebHost.UseTestServer(); + + IChatClient mockChatClient = new TestHelpers.ToolCallMockChatClient(functionName, arguments); + builder.Services.AddKeyedSingleton("chat-client", mockChatClient); + builder.AddAIAgent(agentName, instructions, chatClientServiceKey: "chat-client"); + builder.AddOpenAIConversations(); + builder.AddOpenAIResponses(); + + this._app = builder.Build(); + + AIAgent agent = this._app.Services.GetRequiredKeyedService(agentName); + this._app.MapOpenAIConversations(); + this._app.MapOpenAIResponses(agent); + + await this._app.StartAsync(); + + TestServer testServer = this._app.Services.GetRequiredService() as TestServer + ?? throw new InvalidOperationException("TestServer not found"); + + this._httpClient = testServer.CreateClient(); + return this._httpClient; + } + + /// + /// Sends a POST request with JSON content to the test server. + /// + private static async Task SendPostRequestAsync(HttpClient client, string path, string requestJson) + { + using StringContent content = new(requestJson, Encoding.UTF8, "application/json"); + return await client.PostAsync(new Uri(path, UriKind.Relative), content); + } + + /// + /// Sends a GET request to the test server. + /// + private static async Task SendGetRequestAsync(HttpClient client, string path) + { + return await client.GetAsync(new Uri(path, UriKind.Relative)); + } + + /// + /// Sends a DELETE request to the test server. + /// + private static async Task SendDeleteRequestAsync(HttpClient client, string path) + { + return await client.DeleteAsync(new Uri(path, UriKind.Relative)); + } + + /// + /// Parses the response JSON and returns a JsonDocument. + /// + private static async Task ParseResponseAsync(HttpResponseMessage response) + { + string responseJson = await response.Content.ReadAsStringAsync(); + return JsonDocument.Parse(responseJson); + } + + [Fact] + public async Task BasicConversationCreateAsync() + { + // Arrange + string requestJson = LoadTraceFile("basic/create_conversation_request.json"); + + HttpClient client = await this.CreateTestServerAsync("basic-agent", "You are a helpful assistant.", "The capital of France is Paris."); + + // Act + HttpResponseMessage httpResponse = await SendPostRequestAsync(client, "/v1/conversations", requestJson); + using var responseDoc = await ParseResponseAsync(httpResponse); + var response = responseDoc.RootElement; + + // Parse the request + using var requestDoc = JsonDocument.Parse(requestJson); + var request = requestDoc.RootElement; + + // Assert - Request has metadata + AssertJsonPropertyExists(request, "metadata"); + var requestMetadata = request.GetProperty("metadata"); + Assert.Equal(JsonValueKind.Object, requestMetadata.ValueKind); + + // Assert - Response metadata + AssertJsonPropertyExists(response, "id"); + AssertJsonPropertyEquals(response, "object", "conversation"); + AssertJsonPropertyExists(response, "created_at"); + var id = response.GetProperty("id").GetString(); + Assert.NotNull(id); + Assert.StartsWith("conv_", id); + var createdAt = response.GetProperty("created_at").GetInt64(); + Assert.True(createdAt > 0, "created_at should be a positive unix timestamp"); + + // Assert - Response preserves metadata + AssertJsonPropertyExists(response, "metadata"); + var responseMetadata = response.GetProperty("metadata"); + Assert.Equal(JsonValueKind.Object, responseMetadata.ValueKind); + } + + [Fact] + public async Task BasicConversationWithMessagesAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + string firstMessageRequestJson = LoadTraceFile("basic/first_message_request.json"); + string secondMessageRequestJson = LoadTraceFile("basic/second_message_request.json"); + using var firstMessageExpectedDoc = LoadTraceDocument("basic/first_message_response.json"); + using var secondMessageExpectedDoc = LoadTraceDocument("basic/second_message_response.json"); + + // Get expected response texts + string firstExpectedText = firstMessageExpectedDoc.RootElement.GetProperty("output")[0] + .GetProperty("content")[0] + .GetProperty("text").GetString()!; + string secondExpectedText = secondMessageExpectedDoc.RootElement.GetProperty("output")[0] + .GetProperty("content")[0] + .GetProperty("text").GetString()!; + + // Create a stateful mock that returns different responses for each call + HttpClient client = await this.CreateTestServerWithStatefulMockAsync( + "basic-agent", + "You are a helpful assistant.", + [firstExpectedText, secondExpectedText]); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - Send first message (using Responses API with conversation parameter) + // Update the request JSON with the actual conversation ID + using var firstMsgDoc = JsonDocument.Parse(firstMessageRequestJson); + var firstMsgRequest = JsonSerializer.Serialize(new + { + model = firstMsgDoc.RootElement.GetProperty("model").GetString(), + conversation = conversationId, + input = firstMsgDoc.RootElement.GetProperty("input").GetString(), + max_output_tokens = firstMsgDoc.RootElement.GetProperty("max_output_tokens").GetInt32() + }); + + HttpResponseMessage firstMsgResponse = await SendPostRequestAsync(client, "/basic-agent/v1/responses", firstMsgRequest); + using var firstMsgResponseDoc = await ParseResponseAsync(firstMsgResponse); + var firstResponse = firstMsgResponseDoc.RootElement; + + // Assert - First response has conversation reference + AssertJsonPropertyExists(firstResponse, "conversation"); + var conversationRef = firstResponse.GetProperty("conversation"); + + // The conversation reference can be either a string (just the ID) or an object with an id property + if (conversationRef.ValueKind == JsonValueKind.String) + { + var refId = conversationRef.GetString(); + Assert.Equal(conversationId, refId); + } + else if (conversationRef.ValueKind == JsonValueKind.Object) + { + AssertJsonPropertyEquals(conversationRef, "id", conversationId); + } + else + { + Assert.Fail($"Expected conversation to be either a string or an object, but got {conversationRef.ValueKind}"); + } + + // Assert - First response has output + AssertJsonPropertyExists(firstResponse, "output"); + var firstOutput = firstResponse.GetProperty("output"); + Assert.True(firstOutput.GetArrayLength() > 0); + + // Assert - First response status is completed + AssertJsonPropertyEquals(firstResponse, "status", "completed"); + + // Act - Send second message + using var secondMsgDoc = JsonDocument.Parse(secondMessageRequestJson); + var secondMsgRequest = JsonSerializer.Serialize(new + { + model = secondMsgDoc.RootElement.GetProperty("model").GetString(), + conversation = conversationId, + input = secondMsgDoc.RootElement.GetProperty("input").GetString(), + max_output_tokens = secondMsgDoc.RootElement.GetProperty("max_output_tokens").GetInt32() + }); + + HttpResponseMessage secondMsgResponse = await SendPostRequestAsync(client, "/basic-agent/v1/responses", secondMsgRequest); + using var secondMsgResponseDoc = await ParseResponseAsync(secondMsgResponse); + var secondResponse = secondMsgResponseDoc.RootElement; + + // Assert - Second response has conversation reference + AssertJsonPropertyExists(secondResponse, "conversation"); + var secondConversationRef = secondResponse.GetProperty("conversation"); + + if (secondConversationRef.ValueKind == JsonValueKind.String) + { + var refId = secondConversationRef.GetString(); + Assert.Equal(conversationId, refId); + } + else if (secondConversationRef.ValueKind == JsonValueKind.Object) + { + AssertJsonPropertyEquals(secondConversationRef, "id", conversationId); + } + else + { + Assert.Fail($"Expected conversation to be either a string or an object, but got {secondConversationRef.ValueKind}"); + } + + // Assert - Second response has output + AssertJsonPropertyExists(secondResponse, "output"); + var secondOutput = secondResponse.GetProperty("output"); + Assert.True(secondOutput.GetArrayLength() > 0); + + // Assert - Second response status is completed + AssertJsonPropertyEquals(secondResponse, "status", "completed"); + } + + [Fact] + public async Task CreateConversationWithItemsAsync() + { + // Arrange + string requestJson = LoadTraceFile("create_with_items/create_request.json"); + using var expectedResponseDoc = LoadTraceDocument("create_with_items/create_response.json"); + + HttpClient client = await this.CreateTestServerAsync("items-agent", "You are a helpful assistant.", "Test response"); + + // Act + HttpResponseMessage httpResponse = await SendPostRequestAsync(client, "/v1/conversations", requestJson); + using var responseDoc = await ParseResponseAsync(httpResponse); + var response = responseDoc.RootElement; + + // Parse the request + using var requestDoc = JsonDocument.Parse(requestJson); + var request = requestDoc.RootElement; + + // Assert - Request has items array + AssertJsonPropertyExists(request, "items"); + var requestItems = request.GetProperty("items"); + Assert.Equal(JsonValueKind.Array, requestItems.ValueKind); + Assert.True(requestItems.GetArrayLength() > 0); + + // Assert - Response has conversation structure + AssertJsonPropertyExists(response, "id"); + AssertJsonPropertyEquals(response, "object", "conversation"); + AssertJsonPropertyExists(response, "created_at"); + AssertJsonPropertyExists(response, "metadata"); + } + + [Fact] + public async Task AddItemsToConversationAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + string addItemsRequestJson = LoadTraceFile("add_items/request.json"); + using var expectedResponseDoc = LoadTraceDocument("add_items/response.json"); + + HttpClient client = await this.CreateTestServerAsync("add-items-agent", "You are a helpful assistant.", "Test response"); + + // Act - Create conversation first + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - Add items + HttpResponseMessage addItemsResponse = await SendPostRequestAsync(client, $"/v1/conversations/{conversationId}/items", addItemsRequestJson); + using var addItemsDoc = await ParseResponseAsync(addItemsResponse); + var response = addItemsDoc.RootElement; + + // Parse the request + using var requestDoc = JsonDocument.Parse(addItemsRequestJson); + var request = requestDoc.RootElement; + + // Assert - Request has items array + AssertJsonPropertyExists(request, "items"); + var requestItems = request.GetProperty("items"); + Assert.Equal(JsonValueKind.Array, requestItems.ValueKind); + var itemCount = requestItems.GetArrayLength(); + Assert.True(itemCount > 0); + + // Assert - Response has data array with created items + AssertJsonPropertyExists(response, "data"); + var responseData = response.GetProperty("data"); + Assert.Equal(JsonValueKind.Array, responseData.ValueKind); + Assert.Equal(itemCount, responseData.GetArrayLength()); + + // Assert - Each item has required fields + foreach (var item in responseData.EnumerateArray()) + { + AssertJsonPropertyExists(item, "id"); + AssertJsonPropertyEquals(item, "type", "message"); + AssertJsonPropertyExists(item, "content"); + AssertJsonPropertyExists(item, "role"); + var itemId = item.GetProperty("id").GetString(); + Assert.NotNull(itemId); + Assert.StartsWith("msg_", itemId); + } + } + + [Fact] + public async Task ListItemsInConversationAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + using var expectedResponseDoc = LoadTraceDocument("list_items/response.json"); + + HttpClient client = await this.CreateTestServerAsync("list-items-agent", "You are a helpful assistant.", "The capital of France is Paris."); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - List items + HttpResponseMessage listResponse = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items"); + using var listDoc = await ParseResponseAsync(listResponse); + var response = listDoc.RootElement; + + // Assert - Response has list structure + AssertJsonPropertyEquals(response, "object", "list"); + AssertJsonPropertyExists(response, "data"); + AssertJsonPropertyExists(response, "first_id"); + AssertJsonPropertyExists(response, "last_id"); + AssertJsonPropertyExists(response, "has_more"); + + var data = response.GetProperty("data"); + Assert.Equal(JsonValueKind.Array, data.ValueKind); + } + + [Fact] + public async Task RetrieveConversationAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + using var expectedResponseDoc = LoadTraceDocument("retrieve_conversation/response.json"); + + HttpClient client = await this.CreateTestServerAsync("retrieve-agent", "You are a helpful assistant.", "Test response"); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var createdConversation = createDoc.RootElement; + string conversationId = createdConversation.GetProperty("id").GetString()!; + + // Act - Retrieve conversation + HttpResponseMessage retrieveResponse = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}"); + using var retrieveDoc = await ParseResponseAsync(retrieveResponse); + var response = retrieveDoc.RootElement; + + // Assert - Response has conversation structure + AssertJsonPropertyExists(response, "id"); + AssertJsonPropertyEquals(response, "object", "conversation"); + AssertJsonPropertyExists(response, "created_at"); + AssertJsonPropertyExists(response, "metadata"); + var id = response.GetProperty("id").GetString(); + Assert.Equal(conversationId, id); + } + + [Fact] + public async Task RetrieveItemAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("create_with_items/create_request.json"); + using var expectedResponseDoc = LoadTraceDocument("retrieve_item/response.json"); + + HttpClient client = await this.CreateTestServerAsync("retrieve-item-agent", "You are a helpful assistant.", "Test response"); + + // Act - Create conversation with items + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - List items to get an item ID + HttpResponseMessage listResponse = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items"); + using var listDoc = await ParseResponseAsync(listResponse); + var listResult = listDoc.RootElement; + var items = listResult.GetProperty("data"); + Assert.True(items.GetArrayLength() > 0, "Should have at least one item"); + string itemId = items[0].GetProperty("id").GetString()!; + + // Act - Retrieve specific item + HttpResponseMessage retrieveResponse = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items/{itemId}"); + using var retrieveDoc = await ParseResponseAsync(retrieveResponse); + var response = retrieveDoc.RootElement; + + // Assert - Response has item structure + AssertJsonPropertyExists(response, "id"); + AssertJsonPropertyEquals(response, "type", "message"); + AssertJsonPropertyExists(response, "content"); + AssertJsonPropertyExists(response, "role"); + var id = response.GetProperty("id").GetString(); + Assert.Equal(itemId, id); + } + + [Fact] + public async Task UpdateConversationAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + string updateRequestJson = LoadTraceFile("update_conversation/request.json"); + using var expectedResponseDoc = LoadTraceDocument("update_conversation/response.json"); + + HttpClient client = await this.CreateTestServerAsync("update-agent", "You are a helpful assistant.", "Test response"); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - Update conversation + HttpResponseMessage updateResponse = await SendPostRequestAsync(client, $"/v1/conversations/{conversationId}", updateRequestJson); + using var updateDoc = await ParseResponseAsync(updateResponse); + var response = updateDoc.RootElement; + + // Parse the request + using var requestDoc = JsonDocument.Parse(updateRequestJson); + var request = requestDoc.RootElement; + + // Assert - Request has metadata + AssertJsonPropertyExists(request, "metadata"); + var requestMetadata = request.GetProperty("metadata"); + + // Assert - Response preserves updated metadata + AssertJsonPropertyExists(response, "id"); + AssertJsonPropertyEquals(response, "object", "conversation"); + AssertJsonPropertyExists(response, "metadata"); + var responseMetadata = response.GetProperty("metadata"); + + // Verify metadata was updated + foreach (var prop in requestMetadata.EnumerateObject()) + { + Assert.True(responseMetadata.TryGetProperty(prop.Name, out var value)); + Assert.Equal(prop.Value.GetString(), value.GetString()); + } + } + + [Fact] + public async Task DeleteConversationAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + using var expectedResponseDoc = LoadTraceDocument("delete_conversation/response.json"); + + HttpClient client = await this.CreateTestServerAsync("delete-agent", "You are a helpful assistant.", "Test response"); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - Delete conversation + HttpResponseMessage deleteResponse = await SendDeleteRequestAsync(client, $"/v1/conversations/{conversationId}"); + using var deleteDoc = await ParseResponseAsync(deleteResponse); + var response = deleteDoc.RootElement; + + // Assert - Delete response structure + AssertJsonPropertyExists(response, "id"); + AssertJsonPropertyEquals(response, "object", "conversation.deleted"); + AssertJsonPropertyEquals(response, "deleted", true); + var id = response.GetProperty("id").GetString(); + Assert.Equal(conversationId, id); + + // Assert - Conversation is actually deleted + HttpResponseMessage retrieveResponse = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}"); + Assert.Equal(System.Net.HttpStatusCode.NotFound, retrieveResponse.StatusCode); + } + + [Fact] + public async Task DeleteItemAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("create_with_items/create_request.json"); + using var expectedResponseDoc = LoadTraceDocument("delete_item/response.json"); + + HttpClient client = await this.CreateTestServerAsync("delete-item-agent", "You are a helpful assistant.", "Test response"); + + // Act - Create conversation with items + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - List items to get an item ID + HttpResponseMessage listResponse = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items"); + using var listDoc = await ParseResponseAsync(listResponse); + var listResult = listDoc.RootElement; + var items = listResult.GetProperty("data"); + Assert.True(items.GetArrayLength() > 0, "Should have at least one item"); + string itemId = items[0].GetProperty("id").GetString()!; + + // Act - Delete item + HttpResponseMessage deleteResponse = await SendDeleteRequestAsync(client, $"/v1/conversations/{conversationId}/items/{itemId}"); + using var deleteDoc = await ParseResponseAsync(deleteResponse); + var response = deleteDoc.RootElement; + + // Assert - Delete response structure + AssertJsonPropertyExists(response, "id"); + AssertJsonPropertyEquals(response, "object", "conversation.item.deleted"); + AssertJsonPropertyEquals(response, "deleted", true); + var id = response.GetProperty("id").GetString(); + Assert.Equal(itemId, id); + + // Assert - Item is actually deleted + HttpResponseMessage retrieveResponse = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items/{itemId}"); + Assert.Equal(System.Net.HttpStatusCode.NotFound, retrieveResponse.StatusCode); + } + + [Fact] + public async Task ErrorConversationNotFoundAsync() + { + // Arrange + using var expectedResponseDoc = LoadTraceDocument("error_conversation_not_found/response.json"); + const string NonExistentConversationId = "conv_nonexistent123456789"; + + HttpClient client = await this.CreateTestServerAsync("error-agent", "You are a helpful assistant.", "Test response"); + + // Act + HttpResponseMessage response = await SendGetRequestAsync(client, $"/v1/conversations/{NonExistentConversationId}"); + using var responseDoc = await ParseResponseAsync(response); + var responseJson = responseDoc.RootElement; + + // Assert - Response is 404 + Assert.Equal(System.Net.HttpStatusCode.NotFound, response.StatusCode); + + // Assert - Error response structure + AssertJsonPropertyExists(responseJson, "error"); + var error = responseJson.GetProperty("error"); + AssertJsonPropertyExists(error, "message"); + AssertJsonPropertyExists(error, "type"); + var errorMessage = error.GetProperty("message").GetString(); + Assert.NotNull(errorMessage); + Assert.Contains("not found", errorMessage, StringComparison.OrdinalIgnoreCase); + } + + [Fact] + public async Task ErrorItemNotFoundAsync() + { + // Arrange + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + using var expectedResponseDoc = LoadTraceDocument("error_item_not_found/response.json"); + const string NonExistentItemId = "msg_nonexistent123456789"; + + HttpClient client = await this.CreateTestServerAsync("error-item-agent", "You are a helpful assistant.", "Test response"); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - Try to retrieve non-existent item + HttpResponseMessage response = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items/{NonExistentItemId}"); + using var responseDoc = await ParseResponseAsync(response); + var responseJson = responseDoc.RootElement; + + // Assert - Response is 404 + Assert.Equal(System.Net.HttpStatusCode.NotFound, response.StatusCode); + + // Assert - Error response structure + AssertJsonPropertyExists(responseJson, "error"); + var error = responseJson.GetProperty("error"); + AssertJsonPropertyExists(error, "message"); + AssertJsonPropertyExists(error, "type"); + var errorMessage = error.GetProperty("message").GetString(); + Assert.NotNull(errorMessage); + Assert.Contains("not found", errorMessage, StringComparison.OrdinalIgnoreCase); + } + + [Fact] + public async Task ErrorInvalidJsonAsync() + { + // Arrange + string invalidJson = LoadTraceFile("error_invalid_json/request.txt"); + using var expectedResponseDoc = LoadTraceDocument("error_invalid_json/response.json"); + + HttpClient client = await this.CreateTestServerAsync("error-json-agent", "You are a helpful assistant.", "Test response"); + + // Act + using StringContent content = new(invalidJson, Encoding.UTF8, "application/json"); + HttpResponseMessage response = await client.PostAsync(new Uri("/v1/conversations", UriKind.Relative), content); + + // Assert - Response is 400 + Assert.Equal(System.Net.HttpStatusCode.BadRequest, response.StatusCode); + } + + [Fact] + public async Task ErrorDeleteAlreadyDeletedAsync() + { + // Arrange + using var expectedResponseDoc = LoadTraceDocument("error_delete_already_deleted/response.json"); + + HttpClient client = await this.CreateTestServerAsync("delete-twice-agent", "You are a helpful assistant.", "Test response"); + + // Create a conversation + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + string conversationId = createDoc.RootElement.GetProperty("id").GetString()!; + + // Delete the conversation + await SendDeleteRequestAsync(client, $"/v1/conversations/{conversationId}"); + + // Act - Try to delete again + HttpResponseMessage response = await SendDeleteRequestAsync(client, $"/v1/conversations/{conversationId}"); + using var responseDoc = await ParseResponseAsync(response); + var responseJson = responseDoc.RootElement; + + // Assert - Should return 404 + Assert.Equal(System.Net.HttpStatusCode.NotFound, response.StatusCode); + + // Assert - Error response structure + AssertJsonPropertyExists(responseJson, "error"); + var error = responseJson.GetProperty("error"); + AssertJsonPropertyExists(error, "message"); + AssertJsonPropertyExists(error, "type"); + var errorMessage = error.GetProperty("message").GetString(); + Assert.NotNull(errorMessage); + Assert.Contains("not found", errorMessage, StringComparison.OrdinalIgnoreCase); + } + + [Fact] + public async Task ErrorInvalidLimitAsync() + { + // Arrange + using var expectedResponseDoc = LoadTraceDocument("error_invalid_limit/response.json"); + + HttpClient client = await this.CreateTestServerAsync("invalid-limit-agent", "You are a helpful assistant.", "Test response"); + + // Create a conversation + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + string conversationId = createDoc.RootElement.GetProperty("id").GetString()!; + + // Act - Request items with invalid limit (e.g., negative or too large) + HttpResponseMessage response = await SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items?limit=-1"); + using var responseDoc = await ParseResponseAsync(response); + var responseJson = responseDoc.RootElement; + + // Assert - Should return 400 + Assert.Equal(System.Net.HttpStatusCode.BadRequest, response.StatusCode); + + // Assert - Error response structure + AssertJsonPropertyExists(responseJson, "error"); + var error = responseJson.GetProperty("error"); + AssertJsonPropertyExists(error, "message"); + AssertJsonPropertyExists(error, "type"); + var errorMessage = error.GetProperty("message").GetString(); + Assert.NotNull(errorMessage); + } + + [Fact] + public async Task ToolCallFullScenarioAsync() + { + // Arrange - Full test for tool call scenario through Conversations and Responses API + string createRequestJson = LoadTraceFile("tool_call/create_conversation_request.json"); + string firstMessageRequestJson = LoadTraceFile("tool_call/first_message_request.json"); + using var messageExpectedDoc = LoadTraceDocument("tool_call/first_message_response.json"); + + // Extract function call details from expected response + var expectedOutput = messageExpectedDoc.RootElement.GetProperty("output")[0]; + string functionName = expectedOutput.GetProperty("name").GetString()!; + string arguments = expectedOutput.GetProperty("arguments").GetString()!; + + // Create server with proper tool call mock + HttpClient client = await this.CreateTestServerWithToolCallAsync("tool-call-agent", "You are a helpful assistant.", functionName, arguments); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Act - Send message with tools through Responses API + using var msgDoc = JsonDocument.Parse(firstMessageRequestJson); + var msgRequest = JsonSerializer.Serialize(new + { + model = msgDoc.RootElement.GetProperty("model").GetString(), + conversation = conversationId, + input = msgDoc.RootElement.GetProperty("input"), + tools = msgDoc.RootElement.GetProperty("tools"), + max_output_tokens = msgDoc.RootElement.GetProperty("max_output_tokens").GetInt32() + }); + + HttpResponseMessage msgResponse = await SendPostRequestAsync(client, "/tool-call-agent/v1/responses", msgRequest); + using var msgResponseDoc = await ParseResponseAsync(msgResponse); + var response = msgResponseDoc.RootElement; + + // Assert - Response has conversation reference + AssertJsonPropertyExists(response, "conversation"); + AssertJsonPropertyEquals(response, "status", "completed"); + + // Assert - Response has function call output + AssertJsonPropertyExists(response, "output"); + var output = response.GetProperty("output"); + Assert.True(output.GetArrayLength() > 0); + + // Assert - Output contains function call + var outputItem = output[0]; + AssertJsonPropertyEquals(outputItem, "type", "function_call"); + AssertJsonPropertyEquals(outputItem, "name", functionName); + AssertJsonPropertyExists(outputItem, "arguments"); + } + + [Fact] + public async Task ImageInputFullScenarioAsync() + { + // Arrange - Full test for image input scenario through Conversations and Responses API + string createRequestJson = LoadTraceFile("image_input/create_conversation_request.json"); + string firstMessageRequestJson = LoadTraceFile("image_input/first_message_request.json"); + using var createExpectedDoc = LoadTraceDocument("image_input/create_conversation_response.json"); + using var messageExpectedDoc = LoadTraceDocument("image_input/first_message_response.json"); + + // Get expected response text + string expectedText = messageExpectedDoc.RootElement.GetProperty("output")[0] + .GetProperty("content")[0] + .GetProperty("text").GetString()!; + + HttpClient client = await this.CreateTestServerAsync("image-input-agent", "You are a helpful assistant.", expectedText); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Parse the image input request to verify structure + using var requestDoc = JsonDocument.Parse(firstMessageRequestJson); + var request = requestDoc.RootElement; + + // Assert - Request structure with image content (validates we're testing the right scenario) + AssertJsonPropertyExists(request, "input"); + var input = request.GetProperty("input"); + Assert.Equal(JsonValueKind.Array, input.ValueKind); + + var message = input[0]; + AssertJsonPropertyExists(message, "content"); + var content = message.GetProperty("content"); + Assert.True(content.GetArrayLength() > 1, "Should have text and image content"); + + // Assert - Has input_image content type + JsonElement? imagePart = content.EnumerateArray() + .Where(part => part.GetProperty("type").GetString() == "input_image") + .Cast() + .FirstOrDefault(); + bool hasImage = imagePart.HasValue; + if (hasImage) + { + AssertJsonPropertyExists(imagePart!.Value, "image_url"); + } + Assert.True(hasImage, "Request should have input_image content"); + + // Act - Send message with image through Responses API + using var msgDoc = JsonDocument.Parse(firstMessageRequestJson); + var msgRequest = JsonSerializer.Serialize(new + { + model = msgDoc.RootElement.GetProperty("model").GetString(), + conversation = conversationId, + input = msgDoc.RootElement.GetProperty("input"), + max_output_tokens = msgDoc.RootElement.GetProperty("max_output_tokens").GetInt32() + }); + + HttpResponseMessage msgResponse = await SendPostRequestAsync(client, "/image-input-agent/v1/responses", msgRequest); + using var msgResponseDoc = await ParseResponseAsync(msgResponse); + var response = msgResponseDoc.RootElement; + + // Assert - Response has conversation reference (validates integration) + AssertJsonPropertyExists(response, "conversation"); + AssertJsonPropertyEquals(response, "status", "completed"); + + // Assert - Response has output (validates the system processed the request successfully) + AssertJsonPropertyExists(response, "output"); + var output = response.GetProperty("output"); + Assert.True(output.GetArrayLength() > 0); + } + + [Fact] + public async Task ImageInputStreamingScenarioAsync() + { + // Arrange - Test streaming response with image input through Conversations + Responses API + string createRequestJson = LoadTraceFile("image_input_streaming/create_conversation_request.json"); + string firstMessageRequestJson = LoadTraceFile("image_input_streaming/first_message_request.json"); + string expectedResponseSse = LoadTraceFile("image_input_streaming/first_message_response.txt"); + + // Extract expected text from SSE events + var expectedEvents = ParseSseEventsFromContent(expectedResponseSse); + var deltaEvents = expectedEvents.Where(e => e.GetProperty("type").GetString() == "response.output_text.delta").ToList(); + string expectedText = string.Concat(deltaEvents.Select(e => e.GetProperty("delta").GetString())); + + HttpClient client = await this.CreateTestServerAsync("image-streaming-agent", "You are a helpful assistant.", expectedText); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Prepare streaming request with conversation + using var msgDoc = JsonDocument.Parse(firstMessageRequestJson); + var msgRequest = JsonSerializer.Serialize(new + { + model = msgDoc.RootElement.GetProperty("model").GetString(), + conversation = conversationId, + input = msgDoc.RootElement.GetProperty("input"), + stream = true, + max_output_tokens = msgDoc.RootElement.GetProperty("max_output_tokens").GetInt32() + }); + + // Act - Send streaming request + HttpResponseMessage streamResponse = await SendPostRequestAsync(client, "/image-streaming-agent/v1/responses", msgRequest); + + // Assert - Response should be SSE format (validates streaming works with image input) + Assert.Equal("text/event-stream", streamResponse.Content.Headers.ContentType?.MediaType); + + string responseSse = await streamResponse.Content.ReadAsStringAsync(); + var events = ParseSseEventsFromContent(responseSse); + + // Assert - Has expected event types (validates proper streaming event structure) + var eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()!); + Assert.Contains("response.created", eventTypes); + Assert.Contains("response.output_text.delta", eventTypes); + } + + [Fact] + public async Task RefusalStreamingScenarioAsync() + { + // Arrange - Test streaming response with refusal through Conversations + Responses API + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + string firstMessageRequestJson = LoadTraceFile("refusal_streaming/first_message_request.json"); + string expectedResponseSse = LoadTraceFile("refusal_streaming/first_message_response.txt"); + + // Extract expected text from SSE events + var expectedEvents = ParseSseEventsFromContent(expectedResponseSse); + var deltaEvents = expectedEvents.Where(e => e.GetProperty("type").GetString() == "response.output_text.delta").ToList(); + string expectedText = string.Concat(deltaEvents.Select(e => e.GetProperty("delta").GetString())); + + HttpClient client = await this.CreateTestServerAsync("refusal-streaming-agent", "You are a helpful assistant.", expectedText); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Prepare streaming request with conversation + using var msgDoc = JsonDocument.Parse(firstMessageRequestJson); + var msgRequest = JsonSerializer.Serialize(new + { + model = msgDoc.RootElement.GetProperty("model").GetString(), + conversation = conversationId, + input = msgDoc.RootElement.GetProperty("input"), + stream = true, + max_output_tokens = msgDoc.RootElement.GetProperty("max_output_tokens").GetInt32() + }); + + // Act - Send streaming request + HttpResponseMessage streamResponse = await SendPostRequestAsync(client, "/refusal-streaming-agent/v1/responses", msgRequest); + + // Assert - Response should be SSE format + Assert.Equal("text/event-stream", streamResponse.Content.Headers.ContentType?.MediaType); + + string responseSse = await streamResponse.Content.ReadAsStringAsync(); + var events = ParseSseEventsFromContent(responseSse); + + // Assert - Has expected event types (conformance check) + var eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()!); + Assert.Contains("response.created", eventTypes); + Assert.Contains("response.output_text.delta", eventTypes); + + // Assert - Text contains refusal (validates refusal content is in streaming output) + var doneEvent = events.First(e => e.GetProperty("type").GetString() == "response.output_text.done"); + var finalText = doneEvent.GetProperty("text").GetString(); + Assert.NotNull(finalText); + Assert.Contains("can't assist", finalText, StringComparison.OrdinalIgnoreCase); + } + + [Fact] + public async Task ToolCallStreamingScenarioAsync() + { + // Arrange - Test streaming response with tool call through Conversations + Responses API + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + string firstMessageRequestJson = LoadTraceFile("tool_call_streaming/first_message_request.json"); + + // Use tool call details from the non-streaming test + using var messageExpectedDoc = LoadTraceDocument("tool_call/first_message_response.json"); + var expectedOutput = messageExpectedDoc.RootElement.GetProperty("output")[0]; + string functionName = expectedOutput.GetProperty("name").GetString()!; + string arguments = expectedOutput.GetProperty("arguments").GetString()!; + + HttpClient client = await this.CreateTestServerWithToolCallAsync("tool-streaming-agent", "You are a helpful assistant.", functionName, arguments); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Prepare streaming request with conversation + using var msgDoc = JsonDocument.Parse(firstMessageRequestJson); + var msgRequest = JsonSerializer.Serialize(new + { + model = msgDoc.RootElement.GetProperty("model").GetString(), + conversation = conversationId, + input = msgDoc.RootElement.GetProperty("input"), + tools = msgDoc.RootElement.GetProperty("tools"), + stream = true, + max_output_tokens = msgDoc.RootElement.GetProperty("max_output_tokens").GetInt32() + }); + + // Act - Send streaming request + HttpResponseMessage streamResponse = await SendPostRequestAsync(client, "/tool-streaming-agent/v1/responses", msgRequest); + + // Assert - Response should be SSE format + Assert.Equal("text/event-stream", streamResponse.Content.Headers.ContentType?.MediaType); + + string responseSse = await streamResponse.Content.ReadAsStringAsync(); + var events = ParseSseEventsFromContent(responseSse); + + // Assert - Has expected event types for function call streaming + var eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()!); + Assert.Contains("response.created", eventTypes); + } + + [Fact] + public async Task RefusalFullScenarioAsync() + { + // Arrange - Full test for refusal scenario through Conversations and Responses API + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + string firstMessageRequestJson = LoadTraceFile("refusal/first_message_request.json"); + using var createExpectedDoc = LoadTraceDocument("refusal/create_conversation_response.json"); + using var messageExpectedDoc = LoadTraceDocument("refusal/first_message_response.json"); + + // Get expected response text (refusal message) + string expectedText = messageExpectedDoc.RootElement.GetProperty("output")[0] + .GetProperty("content")[0] + .GetProperty("text").GetString()!; + + HttpClient client = await this.CreateTestServerAsync("refusal-agent", "You are a helpful assistant.", expectedText); + + // Act - Create conversation + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + var conversation = createDoc.RootElement; + string conversationId = conversation.GetProperty("id").GetString()!; + + // Parse the refusal request to verify structure + using var requestDoc = JsonDocument.Parse(firstMessageRequestJson); + var request = requestDoc.RootElement; + + // Assert - Request structure (input can be string or array depending on the request format) + AssertJsonPropertyExists(request, "input"); + var input = request.GetProperty("input"); + Assert.True(input.ValueKind is JsonValueKind.String or JsonValueKind.Array); + + // Act - Send message through Responses API + using var msgDoc = JsonDocument.Parse(firstMessageRequestJson); + var msgRequest = JsonSerializer.Serialize(new + { + model = msgDoc.RootElement.GetProperty("model").GetString(), + conversation = conversationId, + input = msgDoc.RootElement.GetProperty("input"), + max_output_tokens = msgDoc.RootElement.GetProperty("max_output_tokens").GetInt32() + }); + + HttpResponseMessage msgResponse = await SendPostRequestAsync(client, "/refusal-agent/v1/responses", msgRequest); + using var msgResponseDoc = await ParseResponseAsync(msgResponse); + var response = msgResponseDoc.RootElement; + + // Assert - Response has conversation reference (validates integration) + AssertJsonPropertyExists(response, "conversation"); + // Assert - Refusals should be completed, not failed (important behavioral validation) + AssertJsonPropertyEquals(response, "status", "completed"); + + // Assert - Response has output with refusal (validates structure) + AssertJsonPropertyExists(response, "output"); + var output = response.GetProperty("output"); + Assert.True(output.GetArrayLength() > 0); + + var outputMessage = output[0]; + var outputContent = outputMessage.GetProperty("content"); + var textContent = outputContent[0]; + var text = textContent.GetProperty("text").GetString(); + Assert.NotNull(text); + // Validate refusal pattern (confirms we're testing the right scenario) + Assert.Contains("can't assist", text, StringComparison.OrdinalIgnoreCase); + } + + [Fact] + public async Task ErrorMissingRequiredFieldAsync() + { + // Arrange + string requestJson = LoadTraceFile("error_missing_required_field/request.json"); + + HttpClient client = await this.CreateTestServerAsync("missing-field-agent", "You are a helpful assistant.", "Test response"); + + // Create a conversation first + string createRequestJson = LoadTraceFile("basic/create_conversation_request.json"); + HttpResponseMessage createResponse = await SendPostRequestAsync(client, "/v1/conversations", createRequestJson); + using var createDoc = await ParseResponseAsync(createResponse); + string conversationId = createDoc.RootElement.GetProperty("id").GetString()!; + + // Act - Send request with missing required field (role is missing) + HttpResponseMessage response = await SendPostRequestAsync(client, $"/v1/conversations/{conversationId}/items", requestJson); + + // Assert - System should reject the request with a client error status code + // We accept 400 (Bad Request) or 422 (Unprocessable Entity) as both indicate validation failure + Assert.True( + response.StatusCode is System.Net.HttpStatusCode.BadRequest or + System.Net.HttpStatusCode.UnprocessableEntity, + $"Expected 400 or 422 status code for missing required field, but got {(int)response.StatusCode} ({response.StatusCode})"); + } + + public async ValueTask DisposeAsync() + { + this._httpClient?.Dispose(); + if (this._app != null) + { + await this._app.DisposeAsync(); + } + + GC.SuppressFinalize(this); + } + + /// + /// Helper to parse SSE events from streaming response content string. + /// + private static List ParseSseEventsFromContent(string sseContent) + { + var events = new List(); + var lines = sseContent.Split('\n'); + + for (int i = 0; i < lines.Length; i++) + { + var line = lines[i].TrimEnd('\r'); + + if (line.StartsWith("event: ", StringComparison.Ordinal) && i + 1 < lines.Length) + { + var dataLine = lines[i + 1].TrimEnd('\r'); + if (dataLine.StartsWith("data: ", StringComparison.Ordinal)) + { + var jsonData = dataLine.Substring("data: ".Length); + var doc = JsonDocument.Parse(jsonData); + events.Add(doc.RootElement.Clone()); + } + } + } + + return events; + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIConversationsSerializationTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIConversationsSerializationTests.cs new file mode 100644 index 0000000000..ecbdba4a53 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIConversationsSerializationTests.cs @@ -0,0 +1,592 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Linq; +using System.Text.Json; +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; +using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Tests for OpenAI Conversations API model serialization and deserialization. +/// These tests verify that our models correctly serialize to and deserialize from JSON +/// matching the OpenAI wire format, without testing actual API implementation behavior. +/// +public sealed class OpenAIConversationsSerializationTests +{ + private const string TracesBasePath = "ConformanceTraces/Conversations"; + + /// + /// Loads a JSON file from the conformance traces directory. + /// + private static string LoadTraceFile(string relativePath) + { + var fullPath = System.IO.Path.Combine(TracesBasePath, relativePath); + + if (!System.IO.File.Exists(fullPath)) + { + throw new System.IO.FileNotFoundException($"Conformance trace file not found: {fullPath}"); + } + + return System.IO.File.ReadAllText(fullPath); + } + + #region Request Serialization Tests + + [Fact] + public void Deserialize_CreateConversationRequest_Success() + { + // Arrange + string json = LoadTraceFile("basic/create_conversation_request.json"); + + // Act + CreateConversationRequest? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateConversationRequest); + + // Assert + Assert.NotNull(request); + Assert.NotNull(request.Metadata); + } + + [Fact] + public void Deserialize_CreateConversationWithItems_Success() + { + // Arrange + string json = LoadTraceFile("create_with_items/create_request.json"); + + // Act + CreateConversationRequest? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateConversationRequest); + + // Assert + Assert.NotNull(request); + Assert.NotNull(request.Items); + Assert.True(request.Items.Count > 0); + } + + [Fact] + public void Deserialize_CreateItemsRequest_Success() + { + // Arrange + string json = LoadTraceFile("add_items/request.json"); + + // Act + CreateItemsRequest? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateItemsRequest); + + // Assert + Assert.NotNull(request); + Assert.NotNull(request.Items); + Assert.True(request.Items.Count > 0); + } + + [Fact] + public void Deserialize_UpdateConversationRequest_Success() + { + // Arrange + string json = LoadTraceFile("update_conversation/request.json"); + + // Act + UpdateConversationRequest? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.UpdateConversationRequest); + + // Assert + Assert.NotNull(request); + Assert.NotNull(request.Metadata); + } + + [Fact] + public void Serialize_CreateConversationRequest_MatchesFormat() + { + // Arrange + var request = new CreateConversationRequest + { + Metadata = new System.Collections.Generic.Dictionary + { + ["test_key"] = "test_value" + } + }; + + // Act + string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateConversationRequest); + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert + Assert.True(root.TryGetProperty("metadata", out var metadata)); + Assert.Equal(JsonValueKind.Object, metadata.ValueKind); + Assert.Equal("test_value", metadata.GetProperty("test_key").GetString()); + } + + [Fact] + public void Serialize_CreateConversationRequestWithItems_IncludesItems() + { + // Arrange + var request = new CreateConversationRequest + { + Items = + [ + new ResponsesUserMessageItemParam + { + Content = InputMessageContent.FromContents(new ItemContentInputText { Text = "test" }) + } + ], + Metadata = [] + }; + + // Act + string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateConversationRequest); + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert + Assert.True(root.TryGetProperty("items", out var items)); + Assert.Equal(JsonValueKind.Array, items.ValueKind); + Assert.Equal(1, items.GetArrayLength()); + } + + [Fact] + public void Serialize_NullableFields_AreOmittedWhenNull() + { + // Arrange + var request = new CreateConversationRequest(); + + // Act + string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateConversationRequest); + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert - Optional fields should not be present when null or use null value + // Either the property doesn't exist or it's explicitly null + bool hasItems = root.TryGetProperty("items", out var itemsProp); + if (hasItems) + { + Assert.Equal(JsonValueKind.Null, itemsProp.ValueKind); + } + } + + #endregion + + #region Response Deserialization Tests + + [Fact] + public void Deserialize_Conversation_Success() + { + // Arrange + string json = LoadTraceFile("basic/create_conversation_response.json"); + + // Act + Conversation? conversation = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Conversation); + + // Assert + Assert.NotNull(conversation); + Assert.StartsWith("conv_", conversation.Id); + Assert.Equal("conversation", conversation.Object); + Assert.True(conversation.CreatedAt > 0); + Assert.NotNull(conversation.Metadata); + } + + [Fact] + public void Deserialize_ConversationRoundTrip_PreservesData() + { + // Arrange + string originalJson = LoadTraceFile("basic/create_conversation_response.json"); + + // Act - Deserialize and re-serialize + Conversation? conversation = JsonSerializer.Deserialize(originalJson, OpenAIHostingJsonContext.Default.Conversation); + string reserializedJson = JsonSerializer.Serialize(conversation, OpenAIHostingJsonContext.Default.Conversation); + Conversation? roundtripped = JsonSerializer.Deserialize(reserializedJson, OpenAIHostingJsonContext.Default.Conversation); + + // Assert + Assert.NotNull(conversation); + Assert.NotNull(roundtripped); + Assert.Equal(conversation.Id, roundtripped.Id); + Assert.Equal(conversation.CreatedAt, roundtripped.CreatedAt); + Assert.Equal(conversation.Object, roundtripped.Object); + } + + [Fact] + public void Deserialize_ItemListResponse_Success() + { + // Arrange + string json = LoadTraceFile("list_items/response.json"); + + // Act - The list_items response uses ListResponse, not ConversationListResponse + ListResponse? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.ListResponseItemResource); + + // Assert + Assert.NotNull(response); + Assert.Equal("list", response.Object); + Assert.NotNull(response.Data); + Assert.NotNull(response.FirstId); + Assert.NotNull(response.LastId); + Assert.False(response.HasMore); + } + + [Fact] + public void Deserialize_ItemResource_Success() + { + // Arrange + string json = LoadTraceFile("retrieve_item/response.json"); + + // Act + ItemResource? item = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.ItemResource); + + // Assert + Assert.NotNull(item); + Assert.StartsWith("msg_", item.Id); + Assert.Equal("message", item.Type); + var messageItem = Assert.IsType(item); + Assert.NotNull(messageItem.Content); + Assert.NotEmpty(messageItem.Content); + } + + [Fact] + public void Deserialize_DeleteResponse_Success() + { + // Arrange + string json = LoadTraceFile("delete_conversation/response.json"); + + // Act + DeleteResponse? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.DeleteResponse); + + // Assert + Assert.NotNull(response); + Assert.NotNull(response.Id); + Assert.Equal("conversation.deleted", response.Object); + Assert.True(response.Deleted); + } + + [Fact] + public void Deserialize_DeleteItemResponse_Success() + { + // Arrange + string json = LoadTraceFile("delete_item/response.json"); + + // Act + DeleteResponse? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.DeleteResponse); + + // Assert + Assert.NotNull(response); + Assert.NotNull(response.Id); + Assert.Equal("conversation.item.deleted", response.Object); + Assert.True(response.Deleted); + } + + [Fact] + public void Deserialize_ErrorResponse_Success() + { + // Arrange + string json = LoadTraceFile("error_conversation_not_found/response.json"); + + // Act + ErrorResponse? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.ErrorResponse); + + // Assert + Assert.NotNull(response); + Assert.NotNull(response.Error); + Assert.NotNull(response.Error.Message); + Assert.NotNull(response.Error.Type); + } + + [Fact] + public void Deserialize_AllConversationResponses_HaveRequiredFields() + { + // Arrange + string[] responsePaths = + [ + "basic/create_conversation_response.json", + "create_with_items/create_response.json", + "retrieve_conversation/response.json", + "update_conversation/response.json" + ]; + + foreach (var path in responsePaths) + { + string json = LoadTraceFile(path); + + // Act + Conversation? conversation = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Conversation); + + // Assert + Assert.NotNull(conversation); + Assert.NotNull(conversation.Id); + Assert.Equal("conversation", conversation.Object); + Assert.True(conversation.CreatedAt > 0, $"Conversation from {path} should have created_at"); + } + } + + [Fact] + public void Deserialize_AllItemResponses_HaveRequiredFields() + { + // Arrange - Use list_items response which has multiple items + string json = LoadTraceFile("list_items/response.json"); + ListResponse? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.ListResponseItemResource); + Assert.NotNull(response); + Assert.NotNull(response.Data); + + // Act & Assert + foreach (var item in response.Data) + { + Assert.NotNull(item); + Assert.NotNull(item.Id); + Assert.Equal("message", item.Type); + var messageItem = Assert.IsAssignableFrom(item); + // Content is on concrete message types (ResponsesAssistantMessageItemResource, etc.) + // For this test, we just verify the type is correct + Assert.NotNull(messageItem); + } + } + + [Fact] + public void Serialize_Conversation_MatchesFormat() + { + // Arrange + var conversation = new Conversation + { + Id = "conv_test123", + CreatedAt = 1234567890, + Metadata = new System.Collections.Generic.Dictionary + { + ["test_key"] = "test_value" + } + }; + + // Act + string json = JsonSerializer.Serialize(conversation, OpenAIHostingJsonContext.Default.Conversation); + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert + Assert.Equal("conv_test123", root.GetProperty("id").GetString()); + Assert.Equal("conversation", root.GetProperty("object").GetString()); + Assert.Equal(1234567890, root.GetProperty("created_at").GetInt64()); + var metadata = root.GetProperty("metadata"); + Assert.Equal("test_value", metadata.GetProperty("test_key").GetString()); + } + + [Fact] + public void Serialize_ConversationListResponse_MatchesFormat() + { + // Arrange + var response = new ListResponse + { + Data = + [ + new() + { + Id = "conv_1", + CreatedAt = 1234567890, + Metadata = [] + } + ], + HasMore = false + }; + + // Act + string json = JsonSerializer.Serialize(response, OpenAIHostingJsonUtilities.DefaultOptions); + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert + Assert.Equal("list", root.GetProperty("object").GetString()); + var data = root.GetProperty("data"); + Assert.Equal(JsonValueKind.Array, data.ValueKind); + Assert.Equal(1, data.GetArrayLength()); + Assert.False(root.GetProperty("has_more").GetBoolean()); + } + + [Fact] + public void Serialize_DeleteResponse_MatchesFormat() + { + // Arrange + var response = new DeleteResponse + { + Id = "conv_test123", + Object = "conversation.deleted", + Deleted = true + }; + + // Act + string json = JsonSerializer.Serialize(response, OpenAIHostingJsonContext.Default.DeleteResponse); + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert + Assert.Equal("conv_test123", root.GetProperty("id").GetString()); + Assert.Equal("conversation.deleted", root.GetProperty("object").GetString()); + Assert.True(root.GetProperty("deleted").GetBoolean()); + } + + [Fact] + public void Serialize_ErrorResponse_MatchesFormat() + { + // Arrange + var response = new ErrorResponse + { + Error = new ErrorDetails + { + Message = "Conversation not found", + Type = "invalid_request_error" + } + }; + + // Act + string json = JsonSerializer.Serialize(response, OpenAIHostingJsonContext.Default.ErrorResponse); + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert + var error = root.GetProperty("error"); + Assert.Equal("Conversation not found", error.GetProperty("message").GetString()); + Assert.Equal("invalid_request_error", error.GetProperty("type").GetString()); + } + + #endregion + + #region Integration with Responses API Tests + + [Fact] + public void Deserialize_ResponsesAPIRequestWithConversation_Success() + { + // Arrange + string json = LoadTraceFile("basic/first_message_request.json"); + + // Act + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert - Verify the request has conversation field + Assert.True(root.TryGetProperty("conversation", out var conversation)); + var conversationId = conversation.GetString(); + Assert.NotNull(conversationId); + Assert.StartsWith("conv_", conversationId); + + // Assert - Has standard Responses API fields + Assert.True(root.TryGetProperty("model", out var model)); + Assert.True(root.TryGetProperty("input", out var input)); + Assert.True(root.TryGetProperty("max_output_tokens", out var maxTokens)); + } + + [Fact] + public void Deserialize_ResponsesAPIResponseWithConversation_Success() + { + // Arrange + string json = LoadTraceFile("basic/first_message_response.json"); + + // Act + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert - Verify the response has conversation field + Assert.True(root.TryGetProperty("conversation", out var conversation)); + Assert.Equal(JsonValueKind.Object, conversation.ValueKind); + Assert.True(conversation.TryGetProperty("id", out var conversationId)); + Assert.NotNull(conversationId.GetString()); + + // Assert - Has standard Responses API fields + Assert.True(root.TryGetProperty("id", out var responseId)); + Assert.True(root.TryGetProperty("object", out var obj)); + Assert.Equal("response", obj.GetString()); + Assert.True(root.TryGetProperty("status", out var status)); + Assert.True(root.TryGetProperty("output", out var output)); + } + + [Fact] + public void Deserialize_StreamingResponseWithConversation_Success() + { + // Arrange + string sseContent = LoadTraceFile("basic_streaming/first_message_response.txt"); + + // Act + var events = ParseSseEventsFromContent(sseContent); + + // Assert - At least one event should be present + Assert.NotEmpty(events); + + // Assert - Check if any event has conversation reference + var createdEvent = events.FirstOrDefault(e => + e.TryGetProperty("type", out var type) && + type.GetString() == "response.created"); + + if (!createdEvent.Equals(default(JsonElement))) + { + Assert.True(createdEvent.TryGetProperty("response", out var response)); + // Conversation field may be in the response object + } + } + + [Fact] + public void Deserialize_ImageInputWithConversation_Success() + { + // Arrange + string json = LoadTraceFile("image_input/first_message_request.json"); + + // Act + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert - Verify has conversation and image input + Assert.True(root.TryGetProperty("conversation", out var conversation)); + Assert.True(root.TryGetProperty("input", out var input)); + Assert.Equal(JsonValueKind.Array, input.ValueKind); + } + + [Fact] + public void Deserialize_ToolCallWithConversation_Success() + { + // Arrange + string json = LoadTraceFile("tool_call/first_message_request.json"); + + // Act + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert - Verify has conversation and tools + Assert.True(root.TryGetProperty("conversation", out var conversation)); + Assert.True(root.TryGetProperty("tools", out var tools)); + Assert.Equal(JsonValueKind.Array, tools.ValueKind); + } + + [Fact] + public void Deserialize_RefusalWithConversation_Success() + { + // Arrange + string json = LoadTraceFile("refusal/first_message_request.json"); + + // Act + using var doc = JsonDocument.Parse(json); + var root = doc.RootElement; + + // Assert - Verify has conversation + Assert.True(root.TryGetProperty("conversation", out var conversation)); + Assert.NotNull(conversation.GetString()); + } + + /// + /// Helper to parse SSE events from a streaming response content string. + /// + private static System.Collections.Generic.List ParseSseEventsFromContent(string sseContent) + { + var events = new System.Collections.Generic.List(); + var lines = sseContent.Split('\n'); + + for (int i = 0; i < lines.Length; i++) + { + var line = lines[i].TrimEnd('\r'); + + if (line.StartsWith("event: ", StringComparison.Ordinal) && i + 1 < lines.Length) + { + var dataLine = lines[i + 1].TrimEnd('\r'); + if (dataLine.StartsWith("data: ", StringComparison.Ordinal)) + { + var jsonData = dataLine.Substring("data: ".Length); + var doc = JsonDocument.Parse(jsonData); + events.Add(doc.RootElement.Clone()); + } + } + } + + return events; + } + + #endregion +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIHttpApiIntegrationTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIHttpApiIntegrationTests.cs new file mode 100644 index 0000000000..0c07410b91 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIHttpApiIntegrationTests.cs @@ -0,0 +1,435 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Linq; +using System.Net.Http; +using System.Text; +using System.Text.Json; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting.Server; +using Microsoft.AspNetCore.TestHost; +using Microsoft.Extensions.AI; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Integration tests for the HTTP API with in-memory conversation, response, and agent index storage. +/// Tests create a conversation, create a response, wait for completion, then verify the conversation was updated. +/// +public sealed class OpenAIHttpApiIntegrationTests : IAsyncDisposable +{ + private WebApplication? _app; + private HttpClient? _httpClient; + + [Fact] + public async Task CreateConversationAndResponse_NonStreaming_NonBackground_UpdatesConversationWithOutputAsync() + { + // Arrange + const string AgentName = "test-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "The capital of France is Paris."; + const string UserMessage = "What is the capital of France?"; + + HttpClient client = await this.CreateTestServerWithInMemoryStorageAsync(AgentName, Instructions, ExpectedResponse); + + // Act - Create conversation + var createConversationRequest = new { metadata = new { agent_id = AgentName } }; + string createConvJson = JsonSerializer.Serialize(createConversationRequest); + HttpResponseMessage createConvResponse = await this.SendPostRequestAsync(client, "/v1/conversations", createConvJson); + using var createConvDoc = await this.ParseResponseAsync(createConvResponse); + string conversationId = createConvDoc.RootElement.GetProperty("id").GetString()!; + + // Act - Create response (non-streaming, non-background) + var createResponseRequest = new + { + model = AgentName, + conversation = conversationId, + input = UserMessage, + stream = false + }; + string createRespJson = JsonSerializer.Serialize(createResponseRequest); + HttpResponseMessage createRespResponse = await this.SendPostRequestAsync(client, $"/{AgentName}/v1/responses", createRespJson); + using var createRespDoc = await this.ParseResponseAsync(createRespResponse); + var response = createRespDoc.RootElement; + + // Assert - Response completed + Assert.Equal("completed", response.GetProperty("status").GetString()); + string responseId = response.GetProperty("id").GetString()!; + Assert.NotNull(responseId); + Assert.StartsWith("resp_", responseId); + + // Assert - Response has output + Assert.True(response.TryGetProperty("output", out var output)); + Assert.True(output.GetArrayLength() > 0); + var outputItem = output[0]; + var content = outputItem.GetProperty("content"); + Assert.True(content.GetArrayLength() > 0); + var textContent = content[0]; + Assert.Equal("output_text", textContent.GetProperty("type").GetString()); + Assert.Equal(ExpectedResponse, textContent.GetProperty("text").GetString()); + + // Act - List conversation items to verify they were updated + HttpResponseMessage listItemsResponse = await this.SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items"); + using var listItemsDoc = await this.ParseResponseAsync(listItemsResponse); + var itemsList = listItemsDoc.RootElement; + + // Assert - Conversation items were added + Assert.Equal("list", itemsList.GetProperty("object").GetString()); + var items = itemsList.GetProperty("data"); + + Assert.True(items.GetArrayLength() > 0, "Conversation should have items after response completion"); + + // Find the assistant message in the items + bool foundAssistantMessage = items.EnumerateArray() + .Where(item => item.GetProperty("type").GetString() == "message" && + item.GetProperty("role").GetString() == "assistant") + .Any(item => + { + JsonElement itemContent = item.GetProperty("content"); + if (itemContent.GetArrayLength() > 0) + { + JsonElement firstContent = itemContent[0]; + return firstContent.GetProperty("type").GetString() == "output_text" && + firstContent.GetProperty("text").GetString() == ExpectedResponse; + } + return false; + }); + + Assert.True(foundAssistantMessage, "Conversation should contain the assistant's response message"); + } + + [Fact] + public async Task CreateConversationAndResponse_Streaming_NonBackground_UpdatesConversationWithOutputAsync() + { + // Arrange + const string AgentName = "streaming-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "Hello there! How can I help you today?"; + const string UserMessage = "Hello"; + + HttpClient client = await this.CreateTestServerWithInMemoryStorageAsync(AgentName, Instructions, ExpectedResponse); + + // Act - Create conversation + var createConversationRequest = new { metadata = new { agent_id = AgentName } }; + string createConvJson = JsonSerializer.Serialize(createConversationRequest); + HttpResponseMessage createConvResponse = await this.SendPostRequestAsync(client, "/v1/conversations", createConvJson); + using var createConvDoc = await this.ParseResponseAsync(createConvResponse); + string conversationId = createConvDoc.RootElement.GetProperty("id").GetString()!; + + // Act - Create response (streaming, non-background) + var createResponseRequest = new + { + model = AgentName, + conversation = conversationId, + input = UserMessage, + stream = true + }; + string createRespJson = JsonSerializer.Serialize(createResponseRequest); + HttpResponseMessage createRespResponse = await this.SendPostRequestAsync(client, $"/{AgentName}/v1/responses", createRespJson); + + // Assert - Response is SSE format + Assert.Equal("text/event-stream", createRespResponse.Content.Headers.ContentType?.MediaType); + + // Parse SSE events + string sseContent = await createRespResponse.Content.ReadAsStringAsync(); + var events = this.ParseSseEvents(sseContent); + + // Assert - Has expected event types + var eventTypes = events.Select(e => e.GetProperty("type").GetString()).ToList(); + Assert.Contains("response.created", eventTypes); + Assert.Contains("response.completed", eventTypes); + + // Collect the full response text from deltas + var deltaEvents = events.Where(e => e.GetProperty("type").GetString() == "response.output_text.delta").ToList(); + string streamedText = string.Concat(deltaEvents.Select(e => e.GetProperty("delta").GetString())); + Assert.Equal(ExpectedResponse, streamedText); + + // Act - List conversation items to verify messages were added + HttpResponseMessage listItemsResponse = await this.SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items"); + using var listItemsDoc = await this.ParseResponseAsync(listItemsResponse); + var itemsList = listItemsDoc.RootElement; + + // Assert - Conversation items were added + var items = itemsList.GetProperty("data"); + Assert.True(items.GetArrayLength() > 0, "Conversation should have items after streaming response completion"); + + // Find the assistant message in the items + bool foundAssistantMessage = items.EnumerateArray() + .Where(item => item.GetProperty("type").GetString() == "message" && + item.GetProperty("role").GetString() == "assistant") + .Any(item => + { + JsonElement itemContent = item.GetProperty("content"); + if (itemContent.GetArrayLength() > 0) + { + JsonElement firstContent = itemContent[0]; + return firstContent.GetProperty("type").GetString() == "output_text" && + firstContent.GetProperty("text").GetString() == ExpectedResponse; + } + return false; + }); + + Assert.True(foundAssistantMessage, "Conversation should contain the assistant's response message"); + } + + [Fact] + public async Task CreateConversationAndResponse_NonStreaming_Background_UpdatesConversationWhenCompleteAsync() + { + // Arrange + const string AgentName = "background-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "Processing in background..."; + const string UserMessage = "Can you process this?"; + + HttpClient client = await this.CreateTestServerWithInMemoryStorageAsync(AgentName, Instructions, ExpectedResponse); + + // Act - Create conversation + var createConversationRequest = new { metadata = new { agent_id = AgentName } }; + string createConvJson = JsonSerializer.Serialize(createConversationRequest); + HttpResponseMessage createConvResponse = await this.SendPostRequestAsync(client, "/v1/conversations", createConvJson); + using var createConvDoc = await this.ParseResponseAsync(createConvResponse); + string conversationId = createConvDoc.RootElement.GetProperty("id").GetString()!; + + // Act - Create response (non-streaming, background) + var createResponseRequest = new + { + model = AgentName, + conversation = conversationId, + input = UserMessage, + stream = false, + background = true + }; + string createRespJson = JsonSerializer.Serialize(createResponseRequest); + HttpResponseMessage createRespResponse = await this.SendPostRequestAsync(client, $"/{AgentName}/v1/responses", createRespJson); + using var createRespDoc = await this.ParseResponseAsync(createRespResponse); + var response = createRespDoc.RootElement; + + // Assert - Response is in progress or queued + string status = response.GetProperty("status").GetString()!; + Assert.True(status == "in_progress" || status == "queued" || status == "completed", $"Expected 'in_progress', 'queued', or 'completed', got '{status}'"); + string responseId = response.GetProperty("id").GetString()!; + + // Wait for completion by polling + const int MaxAttempts = 20; + int attempt = 0; + string finalStatus = status; + string? errorMessage = null; + while (finalStatus != "completed" && finalStatus != "failed" && attempt < MaxAttempts) + { + await Task.Delay(100); + HttpResponseMessage getResponseResponse = await this.SendGetRequestAsync(client, $"/{AgentName}/v1/responses/{responseId}"); + using var getRespDoc = await this.ParseResponseAsync(getResponseResponse); + finalStatus = getRespDoc.RootElement.GetProperty("status").GetString()!; + if (getRespDoc.RootElement.TryGetProperty("error", out var error) && + error.ValueKind == JsonValueKind.Object && + error.TryGetProperty("message", out var messageElement)) + { + errorMessage = messageElement.GetString(); + } + + attempt++; + } + + // Assert - Response eventually completed + Assert.Equal("completed", finalStatus + (errorMessage != null ? $" Error: {errorMessage}" : "")); + + // Act - List conversation items to verify messages were added + HttpResponseMessage listItemsResponse = await this.SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items"); + using var listItemsDoc = await this.ParseResponseAsync(listItemsResponse); + var itemsList = listItemsDoc.RootElement; + + // Assert - Conversation items were added + var items = itemsList.GetProperty("data"); + Assert.True(items.GetArrayLength() > 0, "Conversation should have items after background response completion"); + + // Find the assistant message in the items + bool foundAssistantMessage = items.EnumerateArray() + .Where(item => item.GetProperty("type").GetString() == "message" && + item.GetProperty("role").GetString() == "assistant") + .Any(item => + { + JsonElement itemContent = item.GetProperty("content"); + if (itemContent.GetArrayLength() > 0) + { + JsonElement firstContent = itemContent[0]; + return firstContent.GetProperty("type").GetString() == "output_text" && + firstContent.GetProperty("text").GetString() == ExpectedResponse; + } + return false; + }); + + Assert.True(foundAssistantMessage, "Conversation should contain the assistant's response message"); + } + + [Fact] + public async Task CreateConversationAndResponse_Streaming_Background_UpdatesConversationWhenCompleteAsync() + { + // Arrange + const string AgentName = "streaming-background-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "Streaming background response"; + const string UserMessage = "Process this with streaming"; + + HttpClient client = await this.CreateTestServerWithInMemoryStorageAsync(AgentName, Instructions, ExpectedResponse); + + // Act - Create conversation + var createConversationRequest = new { metadata = new { agent_id = AgentName } }; + string createConvJson = JsonSerializer.Serialize(createConversationRequest); + HttpResponseMessage createConvResponse = await this.SendPostRequestAsync(client, "/v1/conversations", createConvJson); + using var createConvDoc = await this.ParseResponseAsync(createConvResponse); + string conversationId = createConvDoc.RootElement.GetProperty("id").GetString()!; + + // Act - Create response (streaming, background) + var createResponseRequest = new + { + model = AgentName, + conversation = conversationId, + input = UserMessage, + stream = true, + background = false // Note: streaming with background=true is typically streaming + }; + string createRespJson = JsonSerializer.Serialize(createResponseRequest); + HttpResponseMessage createRespResponse = await this.SendPostRequestAsync(client, $"/{AgentName}/v1/responses", createRespJson); + + // Assert - Response is SSE format + Assert.Equal("text/event-stream", createRespResponse.Content.Headers.ContentType?.MediaType); + + // Parse SSE events + string sseContent = await createRespResponse.Content.ReadAsStringAsync(); + var events = this.ParseSseEvents(sseContent); + var eventTypes = events.Select(e => e.GetProperty("type").GetString()).ToList(); + Assert.Contains("response.created", eventTypes); + Assert.Contains("response.completed", eventTypes); + + // Act - List conversation items to verify messages were added + HttpResponseMessage listItemsResponse = await this.SendGetRequestAsync(client, $"/v1/conversations/{conversationId}/items"); + using var listItemsDoc = await this.ParseResponseAsync(listItemsResponse); + var itemsList = listItemsDoc.RootElement; + + // Assert - Conversation items were added + var items = itemsList.GetProperty("data"); + Assert.True(items.GetArrayLength() > 0, "Conversation should have items after streaming response completion"); + + // Find the assistant message in the items + bool foundAssistantMessage = items.EnumerateArray() + .Where(item => item.GetProperty("type").GetString() == "message" && + item.GetProperty("role").GetString() == "assistant") + .Any(item => + { + JsonElement itemContent = item.GetProperty("content"); + if (itemContent.GetArrayLength() > 0) + { + JsonElement firstContent = itemContent[0]; + return firstContent.GetProperty("type").GetString() == "output_text"; + } + return false; + }); + + Assert.True(foundAssistantMessage, "Conversation should contain the assistant's response message"); + } + + /// + /// Creates a test server with in-memory conversation, response, and agent index storage. + /// + private async Task CreateTestServerWithInMemoryStorageAsync(string agentName, string instructions, string responseText) + { + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + builder.WebHost.UseTestServer(); + + // Create mock chat client + IChatClient mockChatClient = new TestHelpers.SimpleMockChatClient(responseText); + builder.Services.AddKeyedSingleton("chat-client", mockChatClient); + + // Add agent + builder.AddAIAgent(agentName, instructions, chatClientServiceKey: "chat-client"); + + // Add in-memory storage for conversations, responses, and agent index + builder.AddOpenAIConversations(); + builder.AddOpenAIResponses(); + + this._app = builder.Build(); + + // Map endpoints + AIAgent agent = this._app.Services.GetRequiredKeyedService(agentName); + this._app.MapOpenAIConversations(); + this._app.MapOpenAIResponses(agent); + + await this._app.StartAsync(); + + TestServer testServer = this._app.Services.GetRequiredService() as TestServer + ?? throw new InvalidOperationException("TestServer not found"); + + this._httpClient = testServer.CreateClient(); + return this._httpClient; + } + + /// + /// Sends a POST request with JSON content to the test server. + /// + private async Task SendPostRequestAsync(HttpClient client, string path, string requestJson) + { + using StringContent content = new(requestJson, Encoding.UTF8, "application/json"); + return await client.PostAsync(new Uri(path, UriKind.Relative), content); + } + + /// + /// Sends a GET request to the test server. + /// + private async Task SendGetRequestAsync(HttpClient client, string path) + { + return await client.GetAsync(new Uri(path, UriKind.Relative)); + } + + /// + /// Parses the response JSON and returns a JsonDocument. + /// + private async Task ParseResponseAsync(HttpResponseMessage response) + { + string responseJson = await response.Content.ReadAsStringAsync(); + return JsonDocument.Parse(responseJson); + } + + /// + /// Parses SSE events from streaming response content string. + /// + private JsonElement[] ParseSseEvents(string sseContent) + { + var events = new System.Collections.Generic.List(); + var lines = sseContent.Split('\n'); + + for (int i = 0; i < lines.Length; i++) + { + var line = lines[i].TrimEnd('\r'); + + if (line.StartsWith("event: ", StringComparison.Ordinal) && i + 1 < lines.Length) + { + var dataLine = lines[i + 1].TrimEnd('\r'); + if (dataLine.StartsWith("data: ", StringComparison.Ordinal)) + { + var jsonData = dataLine.Substring("data: ".Length); + if (!string.IsNullOrWhiteSpace(jsonData)) + { + var doc = JsonDocument.Parse(jsonData); + events.Add(doc.RootElement.Clone()); + } + } + } + } + + return events.ToArray(); + } + + public async ValueTask DisposeAsync() + { + this._httpClient?.Dispose(); + if (this._app != null) + { + await this._app.DisposeAsync(); + } + + GC.SuppressFinalize(this); + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesAgentResolutionIntegrationTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesAgentResolutionIntegrationTests.cs new file mode 100644 index 0000000000..c8ce5b770e --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesAgentResolutionIntegrationTests.cs @@ -0,0 +1,439 @@ +// Copyright (c) Microsoft. All rights reserved. + +using System; +using System.Net.Http; +using System.Text; +using System.Text.Json; +using System.Threading.Tasks; +using Microsoft.AspNetCore.Builder; +using Microsoft.AspNetCore.Hosting.Server; +using Microsoft.AspNetCore.TestHost; +using Microsoft.Extensions.AI; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Integration tests for the MapOpenAIResponses variant that resolves agents from the Agent.Name property. +/// These tests validate the agent resolution mechanism using the HostedAgentResponseExecutor. +/// +public sealed class OpenAIResponsesAgentResolutionIntegrationTests : IAsyncDisposable +{ + private WebApplication? _app; + private HttpClient? _httpClient; + + public async ValueTask DisposeAsync() + { + this._httpClient?.Dispose(); + if (this._app != null) + { + await this._app.DisposeAsync(); + } + } + + /// + /// Verifies that agent resolution works using the agent.name property in streaming mode. + /// + [Fact] + public async Task CreateResponseStreaming_WithAgentNameProperty_ResolvesCorrectAgentAsync() + { + // Arrange + const string AgentName = "test-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "Hello from agent resolution!"; + + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + (AgentName, Instructions, ExpectedResponse)); + + // Act - Use raw HTTP request with agent.name specified + using StringContent requestContent = new(JsonSerializer.Serialize(new + { + agent = new { name = AgentName }, + stream = true, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent); + + // Assert + Assert.True(httpResponse.IsSuccessStatusCode, $"Request failed with status {httpResponse.StatusCode}"); + + string responseText = await httpResponse.Content.ReadAsStringAsync(); + Assert.Contains(ExpectedResponse, responseText); + Assert.Contains("response.created", responseText); + Assert.Contains("response.completed", responseText); + } + + /// + /// Verifies that agent resolution works using the agent.name property in non-streaming mode. + /// + [Fact] + public async Task CreateResponse_WithAgentNameProperty_ResolvesCorrectAgentAsync() + { + // Arrange + const string AgentName = "test-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "Hello from agent resolution!"; + + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + (AgentName, Instructions, ExpectedResponse)); + + // Act - Use raw HTTP request with agent.name specified + using StringContent requestContent = new(JsonSerializer.Serialize(new + { + agent = new { name = AgentName }, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent); + + // Assert + Assert.True(httpResponse.IsSuccessStatusCode, $"Request failed with status {httpResponse.StatusCode}"); + + string responseJson = await httpResponse.Content.ReadAsStringAsync(); + using JsonDocument doc = JsonDocument.Parse(responseJson); + JsonElement root = doc.RootElement; + + Assert.Equal("completed", root.GetProperty("status").GetString()); + JsonElement outputArray = root.GetProperty("output"); + Assert.True(outputArray.GetArrayLength() > 0); + + JsonElement firstOutput = outputArray[0]; + JsonElement contentArray = firstOutput.GetProperty("content"); + JsonElement firstContent = contentArray[0]; + string actualResponse = firstContent.GetProperty("text").GetString() ?? string.Empty; + + Assert.Equal(ExpectedResponse, actualResponse); + } + + /// + /// Verifies that agent resolution can distinguish between multiple agents. + /// + [Fact] + public async Task CreateResponse_WithMultipleAgents_ResolvesCorrectAgentAsync() + { + // Arrange + const string Agent1Name = "agent-1"; + const string Agent1Response = "Response from agent 1"; + const string Agent2Name = "agent-2"; + const string Agent2Response = "Response from agent 2"; + + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + (Agent1Name, "Agent 1 instructions", Agent1Response), + (Agent2Name, "Agent 2 instructions", Agent2Response)); + + // Act - Create response for agent 1 + using StringContent requestContent1 = new(JsonSerializer.Serialize(new + { + agent = new { name = Agent1Name }, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse1 = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent1); + + // Act - Create response for agent 2 + using StringContent requestContent2 = new(JsonSerializer.Serialize(new + { + agent = new { name = Agent2Name }, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse2 = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent2); + + // Assert + string responseJson1 = await httpResponse1.Content.ReadAsStringAsync(); + string responseJson2 = await httpResponse2.Content.ReadAsStringAsync(); + + using JsonDocument doc1 = JsonDocument.Parse(responseJson1); + using JsonDocument doc2 = JsonDocument.Parse(responseJson2); + + string content1 = doc1.RootElement.GetProperty("output")[0].GetProperty("content")[0].GetProperty("text").GetString() ?? string.Empty; + string content2 = doc2.RootElement.GetProperty("output")[0].GetProperty("content")[0].GetProperty("text").GetString() ?? string.Empty; + + Assert.Equal(Agent1Response, content1); + Assert.Equal(Agent2Response, content2); + } + + /// + /// Verifies that agent resolution using the model property works correctly. + /// + [Fact] + public async Task CreateResponse_WithModelProperty_ResolvesCorrectAgentAsync() + { + // Arrange + const string AgentName = "model-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "Response via model property"; + + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + (AgentName, Instructions, ExpectedResponse)); + + // Act - Use raw HTTP request to control the model property + using StringContent requestContent = new(JsonSerializer.Serialize(new + { + model = AgentName, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent); + + // Assert + Assert.True(httpResponse.IsSuccessStatusCode, $"Request failed with status {httpResponse.StatusCode}"); + + string responseJson = await httpResponse.Content.ReadAsStringAsync(); + using JsonDocument doc = JsonDocument.Parse(responseJson); + JsonElement root = doc.RootElement; + + Assert.Equal("completed", root.GetProperty("status").GetString()); + JsonElement outputArray = root.GetProperty("output"); + Assert.True(outputArray.GetArrayLength() > 0); + + JsonElement firstOutput = outputArray[0]; + JsonElement contentArray = firstOutput.GetProperty("content"); + JsonElement firstContent = contentArray[0]; + string actualResponse = firstContent.GetProperty("text").GetString() ?? string.Empty; + + Assert.Equal(ExpectedResponse, actualResponse); + } + + /// + /// Verifies that agent resolution fails gracefully when agent is not found. + /// + [Fact] + public async Task CreateResponse_WithNonExistentAgent_ReturnsNotFoundAsync() + { + // Arrange + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + ("existing-agent", "Instructions", "Response")); + + // Act + using StringContent requestContent = new(JsonSerializer.Serialize(new + { + agent = new { name = "non-existent-agent" }, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent); + + // Assert + Assert.Equal(System.Net.HttpStatusCode.NotFound, httpResponse.StatusCode); + + string responseJson = await httpResponse.Content.ReadAsStringAsync(); + Assert.Contains("non-existent-agent", responseJson); + Assert.Contains("not found", responseJson, StringComparison.OrdinalIgnoreCase); + } + + /// + /// Verifies that agent resolution fails gracefully when no agent name is provided. + /// + [Fact] + public async Task CreateResponse_WithoutAgentOrModel_ReturnsBadRequestAsync() + { + // Arrange + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + ("test-agent", "Instructions", "Response")); + + // Act - Use raw HTTP request without agent.name or model + using StringContent requestContent = new(JsonSerializer.Serialize(new + { + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent); + + // Assert + Assert.Equal(System.Net.HttpStatusCode.BadRequest, httpResponse.StatusCode); + + string responseJson = await httpResponse.Content.ReadAsStringAsync(); + Assert.Contains("agent.name", responseJson, StringComparison.OrdinalIgnoreCase); + Assert.Contains("model", responseJson, StringComparison.OrdinalIgnoreCase); + } + + /// + /// Verifies that agent resolution prioritizes agent.name over model when both are provided. + /// + [Fact] + public async Task CreateResponse_WithBothAgentAndModel_UsesAgentNameAsync() + { + // Arrange + const string Agent1Name = "agent-1"; + const string Agent1Response = "Response from agent 1"; + const string Agent2Name = "agent-2"; + const string Agent2Response = "Response from agent 2"; + + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + (Agent1Name, "Agent 1 instructions", Agent1Response), + (Agent2Name, "Agent 2 instructions", Agent2Response)); + + // Act - Use raw HTTP request with both agent.name and model + using StringContent requestContent = new(JsonSerializer.Serialize(new + { + agent = new { name = Agent1Name }, + model = Agent2Name, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent); + + // Assert + Assert.True(httpResponse.IsSuccessStatusCode); + + string responseJson = await httpResponse.Content.ReadAsStringAsync(); + using JsonDocument doc = JsonDocument.Parse(responseJson); + JsonElement root = doc.RootElement; + + JsonElement outputArray = root.GetProperty("output"); + JsonElement firstOutput = outputArray[0]; + JsonElement contentArray = firstOutput.GetProperty("content"); + JsonElement firstContent = contentArray[0]; + string actualResponse = firstContent.GetProperty("text").GetString() ?? string.Empty; + + // Should use agent.name (Agent1Name) and return Agent1Response + Assert.Equal(Agent1Response, actualResponse); + } + + /// + /// Verifies that streaming and non-streaming work correctly with agent resolution. + /// + [Fact] + public async Task CreateResponse_AgentResolution_StreamingAndNonStreamingBothWorkAsync() + { + // Arrange + const string AgentName = "dual-mode-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "This is the response"; + + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + (AgentName, Instructions, ExpectedResponse)); + + // Act - Non-streaming + using StringContent nonStreamingRequest = new(JsonSerializer.Serialize(new + { + agent = new { name = AgentName }, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage nonStreamingHttpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), nonStreamingRequest); + + // Act - Streaming + using StringContent streamingRequest = new(JsonSerializer.Serialize(new + { + agent = new { name = AgentName }, + stream = true, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage streamingHttpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), streamingRequest); + + // Assert non-streaming + string nonStreamingJson = await nonStreamingHttpResponse.Content.ReadAsStringAsync(); + using JsonDocument nonStreamingDoc = JsonDocument.Parse(nonStreamingJson); + string nonStreamingContent = nonStreamingDoc.RootElement.GetProperty("output")[0].GetProperty("content")[0].GetProperty("text").GetString() ?? string.Empty; + + // Assert streaming + string streamingText = await streamingHttpResponse.Content.ReadAsStringAsync(); + + Assert.Equal(ExpectedResponse, nonStreamingContent); + Assert.Contains(ExpectedResponse, streamingText); + } + + /// + /// Verifies that the agent.name field is populated in the response. + /// + [Fact] + public async Task CreateResponse_WithAgentName_ResponseIncludesAgentFieldAsync() + { + // Arrange + const string AgentName = "test-agent"; + const string Instructions = "You are a helpful assistant."; + const string ExpectedResponse = "Hello"; + + this._httpClient = await this.CreateTestServerWithAgentResolutionAsync( + (AgentName, Instructions, ExpectedResponse)); + + // Act + using StringContent requestContent = new(JsonSerializer.Serialize(new + { + agent = new { name = AgentName }, + input = new[] + { + new { type = "message", role = "user", content = "Test message" } + } + }), Encoding.UTF8, "application/json"); + + using HttpResponseMessage httpResponse = await this._httpClient!.PostAsync(new Uri("/v1/responses", UriKind.Relative), requestContent); + + // Assert + Assert.True(httpResponse.IsSuccessStatusCode); + + string responseJson = await httpResponse.Content.ReadAsStringAsync(); + using JsonDocument doc = JsonDocument.Parse(responseJson); + JsonElement root = doc.RootElement; + + // Verify the response includes the agent field + if (root.TryGetProperty("agent", out JsonElement agentElement)) + { + string? agentNameInResponse = agentElement.GetProperty("name").GetString(); + Assert.Equal(AgentName, agentNameInResponse); + } + } + + private async Task CreateTestServerWithAgentResolutionAsync( + params (string Name, string Instructions, string ResponseText)[] agents) + { + WebApplicationBuilder builder = WebApplication.CreateBuilder(); + builder.WebHost.UseTestServer(); + + foreach ((string name, string instructions, string responseText) in agents) + { + IChatClient mockChatClient = new TestHelpers.SimpleMockChatClient(responseText); + builder.Services.AddKeyedSingleton($"chat-client-{name}", mockChatClient); + builder.AddAIAgent(name, instructions, chatClientServiceKey: $"chat-client-{name}"); + } + + builder.AddOpenAIResponses(); + + this._app = builder.Build(); + + // Use the agent resolution variant - MapOpenAIResponses() without agent parameter + this._app.MapOpenAIResponses(); + + await this._app.StartAsync(); + + TestServer testServer = this._app.Services.GetRequiredService() as TestServer + ?? throw new InvalidOperationException("TestServer not found"); + + return testServer.CreateClient(); + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesConformanceTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesConformanceTests.cs index 547920c0fa..cee707fa28 100644 --- a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesConformanceTests.cs +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesConformanceTests.cs @@ -14,7 +14,6 @@ namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; /// Conformance tests for OpenAI Responses API implementation behavior. /// Tests use real API traces to ensure our implementation produces responses /// that match OpenAI's wire format when processing actual requests through the server. -/// For pure serialization/deserialization tests, see OpenAIResponsesSerializationTests. /// public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase { @@ -38,18 +37,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase using var responseDoc = await ParseResponseAsync(httpResponse); var response = responseDoc.RootElement; - // Parse the request to verify it was sent correctly - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Verify request was properly formatted (structure check) - AssertJsonPropertyEquals(request, "model", "gpt-4o-mini"); - AssertJsonPropertyExists(request, "input"); - AssertJsonPropertyEquals(request, "max_output_tokens", 100); - var input = request.GetProperty("input"); - Assert.Equal(JsonValueKind.String, input.ValueKind); - Assert.Equal("Hello, how are you?", input.GetString()); - // Assert - Response metadata (IDs and timestamps are dynamic, just verify structure) AssertJsonPropertyExists(response, "id"); AssertJsonPropertyEquals(response, "object", "response"); @@ -147,11 +134,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase Assert.Equal(JsonValueKind.Null, response.GetProperty("previous_response_id").ValueKind); // Assert - Service tier and store - AssertJsonPropertyExists(response, "service_tier"); - var serviceTier = response.GetProperty("service_tier").GetString(); - Assert.NotNull(serviceTier); - Assert.True(serviceTier == "default" || serviceTier == "auto", - $"service_tier should be 'default' or 'auto', got '{serviceTier}'"); AssertJsonPropertyExists(response, "store"); Assert.Equal(JsonValueKind.True, response.GetProperty("store").ValueKind); } @@ -169,6 +151,15 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase .GetProperty("content")[0] .GetProperty("text").GetString()!; + // Parse the request to verify it has previous_response_id + using var requestDoc = JsonDocument.Parse(requestJson); + var request = requestDoc.RootElement; + var previousResponseId = request.GetProperty("previous_response_id").GetString(); + Assert.NotNull(previousResponseId); + Assert.NotEmpty(previousResponseId); + + // Use stateful mock that tracks conversation state by returning different responses + // First call (initial message) vs second call (conversation continuation) HttpClient client = await this.CreateTestServerAsync("conversation-agent", "You are a helpful assistant.", expectedText); // Act @@ -176,36 +167,20 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase using var responseDoc = await ParseResponseAsync(httpResponse); var response = responseDoc.RootElement; - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has previous_response_id (structure verification) - AssertJsonPropertyExists(request, "previous_response_id"); - var previousResponseId = request.GetProperty("previous_response_id").GetString(); - Assert.NotNull(previousResponseId); - Assert.StartsWith("resp_", previousResponseId); - Assert.NotEmpty(previousResponseId); - - // Assert - Request structure - AssertJsonPropertyEquals(request, "model", "gpt-4o-mini"); - AssertJsonPropertyExists(request, "input"); - AssertJsonPropertyExists(request, "previous_response_id"); - AssertJsonPropertyExists(request, "max_output_tokens"); - var input = request.GetProperty("input"); - Assert.Equal(JsonValueKind.String, input.ValueKind); - // Assert - Response should have previous_response_id field preserved from request AssertJsonPropertyExists(response, "previous_response_id"); var responsePreviousId = response.GetProperty("previous_response_id").GetString(); Assert.Equal(previousResponseId, responsePreviousId); - // Assert - Response has unique ID + // Assert - Response has unique ID (must be different from previous_response_id) var currentId = response.GetProperty("id").GetString(); Assert.NotNull(currentId); Assert.StartsWith("resp_", currentId); + Assert.NotEqual(previousResponseId, currentId); // Assert - Usage includes context from previous response + // The system should pass accumulated conversation history to the chat client, + // resulting in higher input token counts than a single-message request AssertJsonPropertyExists(response, "usage"); var usage = response.GetProperty("usage"); var inputTokens = usage.GetProperty("input_tokens").GetInt32(); @@ -279,112 +254,62 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase string functionName = functionCall.GetProperty("name").GetString()!; string arguments = functionCall.GetProperty("arguments").GetString()!; - HttpClient client = await this.CreateTestServerAsync("tool-agent", "You are a helpful assistant.", functionName); + // Use tool call mock that returns FunctionCallContent from the chat client + // This simulates the chat client (e.g., OpenAI) deciding to call a function + // The test validates that our system correctly processes and serializes + // the function call into the OpenAI Responses API format + HttpClient client = await this.CreateTestServerWithToolCallAsync("tool-agent", "You are a helpful assistant.", functionName, arguments); // Act HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, "tool-agent", requestJson); using var responseDoc = await ParseResponseAsync(httpResponse); var response = responseDoc.RootElement; - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has tools array - AssertJsonPropertyExists(request, "tools"); - var requestTools = request.GetProperty("tools"); - Assert.Equal(JsonValueKind.Array, requestTools.ValueKind); - Assert.True(requestTools.GetArrayLength() > 0, "Tools array should not be empty"); - - // Assert - Tool has correct structure - var requestTool = requestTools[0]; - AssertJsonPropertyEquals(requestTool, "type", "function"); - AssertJsonPropertyExists(requestTool, "name"); - AssertJsonPropertyExists(requestTool, "description"); - AssertJsonPropertyExists(requestTool, "parameters"); - var requestToolName = requestTool.GetProperty("name").GetString(); - Assert.Equal("get_weather", requestToolName); - - // Assert - Parameters have JSON Schema - var requestParameters = requestTool.GetProperty("parameters"); - AssertJsonPropertyEquals(requestParameters, "type", "object"); - AssertJsonPropertyExists(requestParameters, "properties"); - AssertJsonPropertyExists(requestParameters, "required"); - var requestProperties = requestParameters.GetProperty("properties"); - Assert.Equal(JsonValueKind.Object, requestProperties.ValueKind); - AssertJsonPropertyExists(requestProperties, "location"); - AssertJsonPropertyExists(requestProperties, "unit"); - - // Assert - Property has type and description - var locationProperty = requestProperties.GetProperty("location"); - AssertJsonPropertyEquals(locationProperty, "type", "string"); - AssertJsonPropertyExists(locationProperty, "description"); - var description = locationProperty.GetProperty("description").GetString(); - Assert.NotNull(description); - Assert.NotEmpty(description); - - // Assert - Required fields is array - var requestRequired = requestParameters.GetProperty("required"); - Assert.Equal(JsonValueKind.Array, requestRequired.ValueKind); - var requestRequiredFields = requestRequired.EnumerateArray().Select(e => e.GetString()).ToList(); - Assert.Contains("location", requestRequiredFields); - - // Assert - Request has tool choice - AssertJsonPropertyExists(request, "tool_choice"); - var toolChoice = request.GetProperty("tool_choice").GetString(); - Assert.Equal("auto", toolChoice); - - // Assert - Response has function call output (or text output depending on implementation) + // Assert - Response has function call output AssertJsonPropertyExists(response, "output"); var output = response.GetProperty("output"); Assert.Equal(JsonValueKind.Array, output.ValueKind); Assert.True(output.GetArrayLength() > 0); var responseItem = output[0]; - // Our implementation may return either function_call or message type + // Assert - Response item type is function_call (system properly converted FunctionCallContent) var itemType = responseItem.GetProperty("type").GetString(); - if (itemType == "function_call") - { - AssertJsonPropertyEquals(responseItem, "type", "function_call"); + AssertJsonPropertyEquals(responseItem, "type", "function_call"); - // Assert - Function call has name - AssertJsonPropertyExists(responseItem, "name"); - var funcName = responseItem.GetProperty("name").GetString(); - Assert.Equal("get_weather", funcName); + // Assert - Function call has correct name (from chat client) + AssertJsonPropertyExists(responseItem, "name"); + var funcName = responseItem.GetProperty("name").GetString(); + Assert.Equal("get_weather", funcName); - // Assert - Function call has arguments - AssertJsonPropertyExists(responseItem, "arguments"); - var argsString = responseItem.GetProperty("arguments").GetString(); - Assert.NotNull(argsString); - Assert.NotEmpty(argsString); - var argsDoc = JsonDocument.Parse(argsString); - var argsRoot = argsDoc.RootElement; - AssertJsonPropertyExists(argsRoot, "location"); - var location = argsRoot.GetProperty("location").GetString(); - Assert.Contains("San Francisco", location); - } + // Assert - Function call has arguments (properly serialized from chat client response) + AssertJsonPropertyExists(responseItem, "arguments"); + var argsString = responseItem.GetProperty("arguments").GetString(); + Assert.NotNull(argsString); + Assert.NotEmpty(argsString); + var argsDoc = JsonDocument.Parse(argsString); + var argsRoot = argsDoc.RootElement; + AssertJsonPropertyExists(argsRoot, "location"); + var location = argsRoot.GetProperty("location").GetString(); + Assert.Contains("San Francisco", location); - if (itemType == "function_call") - { - // Assert - Function call has call_id and id - AssertJsonPropertyExists(responseItem, "call_id"); - var callId = responseItem.GetProperty("call_id").GetString(); - Assert.NotNull(callId); - Assert.NotEmpty(callId); - Assert.StartsWith("call_", callId); - AssertJsonPropertyExists(responseItem, "id"); - var itemId = responseItem.GetProperty("id").GetString(); - Assert.NotNull(itemId); - Assert.NotEmpty(itemId); - Assert.StartsWith("fc_", itemId); + // Assert - Function call has call_id and id (system generates these) + AssertJsonPropertyExists(responseItem, "call_id"); + var callId = responseItem.GetProperty("call_id").GetString(); + Assert.NotNull(callId); + Assert.NotEmpty(callId); + Assert.StartsWith("call_", callId); + AssertJsonPropertyExists(responseItem, "id"); + var itemId = responseItem.GetProperty("id").GetString(); + Assert.NotNull(itemId); + Assert.NotEmpty(itemId); + Assert.StartsWith("func_", itemId); - // Assert - Function call has status - AssertJsonPropertyExists(responseItem, "status"); - var itemStatus = responseItem.GetProperty("status").GetString(); - Assert.Equal("completed", itemStatus); - } + // Assert - Function call has status + AssertJsonPropertyExists(responseItem, "status"); + var itemStatus = responseItem.GetProperty("status").GetString(); + Assert.Equal("completed", itemStatus); - // Assert - Response preserves tool definitions + // Assert - Response preserves tool definitions from request var responseTools = response.GetProperty("tools"); Assert.Equal(JsonValueKind.Array, responseTools.ValueKind); Assert.True(responseTools.GetArrayLength() > 0); @@ -394,7 +319,7 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase AssertJsonPropertyExists(responseTool, "description"); AssertJsonPropertyExists(responseTool, "parameters"); - // Assert - Response has usage statistics + // Assert - Response has usage statistics (includes tool definition overhead) AssertJsonPropertyExists(response, "usage"); var usage = response.GetProperty("usage"); var inputTokens = usage.GetProperty("input_tokens").GetInt32(); @@ -448,13 +373,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase string responseSse = await httpResponse.Content.ReadAsStringAsync(); var events = ParseSseEventsFromContent(responseSse); - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has stream flag - AssertJsonPropertyEquals(request, "stream", true); - // Assert - Response is valid SSE format var lines = responseSse.Split('\n'); Assert.NotEmpty(lines); @@ -504,7 +422,7 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase Assert.Equal("response.created", eventTypes[0]); Assert.Equal("response.in_progress", eventTypes[1]); var lastEvent = eventTypes[^1]; - Assert.True(lastEvent == "response.completed" || lastEvent == "response.incomplete", + Assert.True(lastEvent is "response.completed" or "response.incomplete", $"Last event should be terminal state, got: {lastEvent}"); // Assert - Created event has response object @@ -577,13 +495,13 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase var finalEvent = events.FirstOrDefault(e => { var type = e.GetProperty("type").GetString(); - return type == "response.completed" || type == "response.incomplete"; + return type is "response.completed" or "response.incomplete"; }); Assert.False(finalEvent.Equals(default(JsonElement)), "Should have a terminal response event"); AssertJsonPropertyExists(finalEvent, "response"); var finalResponse = finalEvent.GetProperty("response"); var finalStatus = finalResponse.GetProperty("status").GetString(); - Assert.True(finalStatus == "completed" || finalStatus == "incomplete", + Assert.True(finalStatus is "completed" or "incomplete", $"Status should be completed or incomplete, got: {finalStatus}"); AssertJsonPropertyExists(finalResponse, "output"); var finalOutput = finalResponse.GetProperty("output"); @@ -650,39 +568,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase using var responseDoc = await ParseResponseAsync(httpResponse); var response = responseDoc.RootElement; - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has metadata object - AssertJsonPropertyExists(request, "metadata"); - var requestMetadata = request.GetProperty("metadata"); - Assert.Equal(JsonValueKind.Object, requestMetadata.ValueKind); - - // Assert - Request has custom metadata fields - AssertJsonPropertyEquals(requestMetadata, "user_id", "test_user_123"); - AssertJsonPropertyEquals(requestMetadata, "session_id", "session_456"); - AssertJsonPropertyEquals(requestMetadata, "purpose", "conformance_test"); - - // Assert - Request has instructions - AssertJsonPropertyExists(request, "instructions"); - var requestInstructions = request.GetProperty("instructions").GetString(); - Assert.NotNull(requestInstructions); - Assert.NotEmpty(requestInstructions); - Assert.Equal("Respond in a friendly, educational tone.", requestInstructions); - - // Assert - Request has temperature parameter - AssertJsonPropertyExists(request, "temperature"); - var requestTemperature = request.GetProperty("temperature").GetDouble(); - Assert.Equal(0.7, requestTemperature); - Assert.InRange(requestTemperature, 0.0, 2.0); - - // Assert - Request has top_p parameter - AssertJsonPropertyExists(request, "top_p"); - var requestTopP = request.GetProperty("top_p").GetDouble(); - Assert.Equal(0.9, requestTopP); - Assert.InRange(requestTopP, 0.0, 1.0); - // Assert - Response preserves metadata var responseMetadata = response.GetProperty("metadata"); AssertJsonPropertyEquals(responseMetadata, "user_id", "test_user_123"); @@ -690,22 +575,21 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase AssertJsonPropertyEquals(responseMetadata, "purpose", "conformance_test"); // Assert - Response preserves instructions - var responseInstructions = response.GetProperty("instructions").GetString(); - Assert.Equal(requestInstructions, responseInstructions); + AssertJsonPropertyEquals(response, "instructions", "Respond in a friendly, educational tone."); // Assert - Response preserves temperature var responseTemperature = response.GetProperty("temperature").GetDouble(); - Assert.Equal(requestTemperature, responseTemperature); + Assert.Equal(0.7, responseTemperature); // Assert - Response preserves top_p var responseTopP = response.GetProperty("top_p").GetDouble(); - Assert.Equal(requestTopP, responseTopP); + Assert.Equal(0.9, responseTopP); // Assert - Response status (may be incomplete if max_output_tokens was respected) AssertJsonPropertyExists(response, "status"); var status = response.GetProperty("status").GetString(); // Our implementation may complete even with max_output_tokens if response fits - Assert.True(status == "completed" || status == "incomplete"); + Assert.True(status is "completed" or "incomplete"); // Assert - Response has incomplete_details field AssertJsonPropertyExists(response, "incomplete_details"); @@ -770,25 +654,28 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase .GetProperty("content")[0] .GetProperty("text").GetString()!; - HttpClient client = await this.CreateTestServerAsync("reasoning-agent", "You are a helpful assistant.", expectedText); + // Get expected reasoning summary text (if any) + var reasoningSummary = expectedResponse.GetProperty("output")[0].GetProperty("summary"); + string reasoningText = reasoningSummary.GetArrayLength() > 0 + ? reasoningSummary[0].GetProperty("text").GetString()! + : "Thinking about the problem..."; + + // Create a custom content provider that returns reasoning content followed by regular text + HttpClient client = await this.CreateTestServerAsync( + "reasoning-agent", + "You are a helpful assistant.", + expectedText, + contentProvider: _ => + [ + new Extensions.AI.TextReasoningContent(reasoningText), + new Extensions.AI.TextContent(expectedText) + ]); // Act HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, "reasoning-agent", requestJson); using var responseDoc = await ParseResponseAsync(httpResponse); var response = responseDoc.RootElement; - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has reasoning configuration - AssertJsonPropertyExists(request, "reasoning"); - var requestReasoning = request.GetProperty("reasoning"); - Assert.Equal(JsonValueKind.Object, requestReasoning.ValueKind); - AssertJsonPropertyExists(requestReasoning, "effort"); - var effort = requestReasoning.GetProperty("effort").GetString(); - Assert.Equal("medium", effort); - // Assert - Response preserves reasoning configuration AssertJsonPropertyExists(response, "reasoning"); var responseReasoning = response.GetProperty("reasoning"); @@ -859,30 +746,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase using var responseDoc = await ParseResponseAsync(httpResponse); var response = responseDoc.RootElement; - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has text format with json_schema - AssertJsonPropertyExists(request, "text"); - var requestText = request.GetProperty("text"); - AssertJsonPropertyExists(requestText, "format"); - var format = requestText.GetProperty("format"); - AssertJsonPropertyEquals(format, "type", "json_schema"); - AssertJsonPropertyEquals(format, "name", "person"); - AssertJsonPropertyEquals(format, "strict", true); - - // Assert - Schema has correct structure - AssertJsonPropertyExists(format, "schema"); - var schema = format.GetProperty("schema"); - AssertJsonPropertyEquals(schema, "type", "object"); - AssertJsonPropertyExists(schema, "properties"); - AssertJsonPropertyExists(schema, "required"); - var properties = schema.GetProperty("properties"); - AssertJsonPropertyExists(properties, "name"); - AssertJsonPropertyExists(properties, "age"); - AssertJsonPropertyExists(properties, "occupation"); - // Assert - Response preserves text format configuration AssertJsonPropertyExists(response, "text"); var responseText = response.GetProperty("text"); @@ -903,6 +766,7 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase Assert.Equal(expectedText, text); // Assert - Output text is valid JSON matching schema + // This validates that the mock/system produced well-formed JSON output using var jsonDoc = JsonDocument.Parse(text); var jsonRoot = jsonDoc.RootElement; AssertJsonPropertyExists(jsonRoot, "name"); @@ -1002,38 +866,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase using var responseDoc = await ParseResponseAsync(httpResponse); var response = responseDoc.RootElement; - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has input array with message - AssertJsonPropertyExists(request, "input"); - var input = request.GetProperty("input"); - Assert.Equal(JsonValueKind.Array, input.ValueKind); - Assert.True(input.GetArrayLength() > 0); - - // Assert - Input message has content with image - var inputMessage = input[0]; - AssertJsonPropertyEquals(inputMessage, "type", "message"); - AssertJsonPropertyEquals(inputMessage, "role", "user"); - AssertJsonPropertyExists(inputMessage, "content"); - var inputContent = inputMessage.GetProperty("content"); - Assert.Equal(JsonValueKind.Array, inputContent.ValueKind); - Assert.True(inputContent.GetArrayLength() >= 2, "Content should have text and image"); - - // Assert - Content has input_text - var textPart = inputContent[0]; - AssertJsonPropertyEquals(textPart, "type", "input_text"); - AssertJsonPropertyExists(textPart, "text"); - - // Assert - Content has input_image - var imagePart = inputContent[1]; - AssertJsonPropertyEquals(imagePart, "type", "input_image"); - AssertJsonPropertyExists(imagePart, "image_url"); - var imageUrl = imagePart.GetProperty("image_url").GetString(); - Assert.NotNull(imageUrl); - Assert.NotEmpty(imageUrl); - // Assert - Response has output AssertJsonPropertyExists(response, "output"); var output = response.GetProperty("output"); @@ -1078,16 +910,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase string responseSse = await httpResponse.Content.ReadAsStringAsync(); var events = ParseSseEventsFromContent(responseSse); - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has stream flag and reasoning configuration - AssertJsonPropertyEquals(request, "stream", true); - AssertJsonPropertyExists(request, "reasoning"); - var reasoning = request.GetProperty("reasoning"); - AssertJsonPropertyExists(reasoning, "effort"); - // Assert - Response has event types for reasoning var eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()!); Assert.Contains("response.created", eventTypes); @@ -1120,7 +942,7 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase var finalEvent = events.FirstOrDefault(e => { var type = e.GetProperty("type").GetString(); - return type == "response.completed" || type == "response.incomplete"; + return type is "response.completed" or "response.incomplete"; }); Assert.False(finalEvent.Equals(default(JsonElement))); var finalResponse = finalEvent.GetProperty("response"); @@ -1156,17 +978,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase string responseSse = await httpResponse.Content.ReadAsStringAsync(); var events = ParseSseEventsFromContent(responseSse); - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has stream flag and json_schema format - AssertJsonPropertyEquals(request, "stream", true); - AssertJsonPropertyExists(request, "text"); - var text = request.GetProperty("text"); - var format = text.GetProperty("format"); - AssertJsonPropertyEquals(format, "type", "json_schema"); - // Assert - Response has standard streaming events var eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()!); Assert.Contains("response.created", eventTypes); @@ -1176,7 +987,7 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase var finalEvent = events.FirstOrDefault(e => { var type = e.GetProperty("type").GetString(); - return type == "response.completed" || type == "response.incomplete"; + return type is "response.completed" or "response.incomplete"; }); Assert.False(finalEvent.Equals(default(JsonElement))); var finalResponse = finalEvent.GetProperty("response"); @@ -1216,13 +1027,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase string responseSse = await httpResponse.Content.ReadAsStringAsync(); var events = ParseSseEventsFromContent(responseSse); - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has stream flag - AssertJsonPropertyEquals(request, "stream", true); - // Assert - Response has standard streaming events var eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()!); Assert.Contains("response.created", eventTypes); @@ -1232,12 +1036,12 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase var finalEvent = events.FirstOrDefault(e => { var type = e.GetProperty("type").GetString(); - return type == "response.completed" || type == "response.incomplete"; + return type is "response.completed" or "response.incomplete"; }); Assert.False(finalEvent.Equals(default(JsonElement))); var finalResponse = finalEvent.GetProperty("response"); var status = finalResponse.GetProperty("status").GetString(); - Assert.True(status == "completed" || status == "incomplete"); + Assert.True(status is "completed" or "incomplete"); // Assert - Text done has refusal content var doneEvent = events.First(e => e.GetProperty("type").GetString() == "response.output_text.done"); @@ -1273,30 +1077,6 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase string responseSse = await httpResponse.Content.ReadAsStringAsync(); var events = ParseSseEventsFromContent(responseSse); - // Parse the request - using var requestDoc = JsonDocument.Parse(requestJson); - var request = requestDoc.RootElement; - - // Assert - Request has stream flag - AssertJsonPropertyEquals(request, "stream", true); - - // Assert - Request has input array with image - AssertJsonPropertyExists(request, "input"); - var input = request.GetProperty("input"); - Assert.Equal(JsonValueKind.Array, input.ValueKind); - var inputMessage = input[0]; - var inputContent = inputMessage.GetProperty("content"); - bool hasImage = false; - foreach (var part in inputContent.EnumerateArray()) - { - if (part.GetProperty("type").GetString() == "input_image") - { - hasImage = true; - break; - } - } - Assert.True(hasImage, "Request should have input_image content"); - // Assert - Response has standard streaming events var eventTypes = events.ConvertAll(e => e.GetProperty("type").GetString()!); Assert.Contains("response.created", eventTypes); @@ -1306,7 +1086,7 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase var finalEvent = events.FirstOrDefault(e => { var type = e.GetProperty("type").GetString(); - return type == "response.completed" || type == "response.incomplete"; + return type is "response.completed" or "response.incomplete"; }); Assert.False(finalEvent.Equals(default(JsonElement))); var finalResponse = finalEvent.GetProperty("response"); @@ -1319,9 +1099,35 @@ public sealed class OpenAIResponsesConformanceTests : ConformanceTestBase Assert.NotEmpty(finalText); } - /// - /// Helper to parse SSE events from a streaming response content string. - /// + [Fact] + public async Task MutualExclusiveErrorAsync() + { + // Arrange + string requestJson = LoadResponsesTraceFile("mutual_exclusive_error/request.json"); + using var expectedResponseDoc = LoadResponsesTraceDocument("mutual_exclusive_error/response.json"); + + HttpClient client = await this.CreateTestServerAsync("mutual-exclusive-agent", "You are a helpful assistant.", "Test response"); + + // Act - Send request with mutually exclusive parameters + HttpResponseMessage httpResponse = await this.SendResponsesRequestAsync(client, "mutual-exclusive-agent", requestJson); + using var responseDoc = await ParseResponseAsync(httpResponse); + var response = responseDoc.RootElement; + + // Assert - Should return 400 + Assert.Equal(System.Net.HttpStatusCode.BadRequest, httpResponse.StatusCode); + + // Assert - Error response structure + AssertJsonPropertyExists(response, "error"); + var error = response.GetProperty("error"); + AssertJsonPropertyExists(error, "message"); + AssertJsonPropertyExists(error, "type"); + AssertJsonPropertyExists(error, "code"); + + var errorMessage = error.GetProperty("message").GetString(); + Assert.NotNull(errorMessage); + Assert.Contains("mutually exclusive", errorMessage, StringComparison.OrdinalIgnoreCase); + } + private static List ParseSseEventsFromContent(string sseContent) { var events = new List(); diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesIntegrationTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesIntegrationTests.cs index 053387b53b..8304bb8a56 100644 --- a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesIntegrationTests.cs +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesIntegrationTests.cs @@ -1110,7 +1110,7 @@ public sealed class OpenAIResponsesIntegrationTests : IAsyncDisposable IChatClient mockChatClient = new TestHelpers.SimpleMockChatClient(responseText); builder.Services.AddKeyedSingleton("chat-client", mockChatClient); - builder.Services.AddOpenAIResponses(); + builder.AddOpenAIResponses(); builder.AddAIAgent(agentName, instructions, chatClientServiceKey: "chat-client"); this._app = builder.Build(); diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesSerializationTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesSerializationTests.cs index 08823e4494..9c0bd023df 100644 --- a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesSerializationTests.cs +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/OpenAIResponsesSerializationTests.cs @@ -25,7 +25,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("basic/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -41,9 +41,9 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string originalJson = LoadResponsesTraceFile("basic/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(originalJson, Responses.ResponsesJsonContext.Default.CreateResponse); - string reserializedJson = JsonSerializer.Serialize(request, Responses.ResponsesJsonContext.Default.CreateResponse); - CreateResponse? roundtripped = JsonSerializer.Deserialize(reserializedJson, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(originalJson, OpenAIHostingJsonContext.Default.CreateResponse); + string reserializedJson = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateResponse); + CreateResponse? roundtripped = JsonSerializer.Deserialize(reserializedJson, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -59,7 +59,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("streaming/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -74,7 +74,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("conversation/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -89,7 +89,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("metadata/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -142,7 +142,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase }; // Act - string json = JsonSerializer.Serialize(request, Responses.ResponsesJsonContext.Default.CreateResponse); + string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateResponse); using var doc = JsonDocument.Parse(json); var root = doc.RootElement; @@ -151,7 +151,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase Assert.True(root.TryGetProperty("input", out var input)); // Input can be string or object - verify one exists - Assert.True(input.ValueKind == JsonValueKind.String || input.ValueKind == JsonValueKind.Object); + Assert.True(input.ValueKind is JsonValueKind.String or JsonValueKind.Object); } [Fact] @@ -175,7 +175,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase }; // Act - string json = JsonSerializer.Serialize(request, Responses.ResponsesJsonContext.Default.CreateResponse); + string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateResponse); using var doc = JsonDocument.Parse(json); var root = doc.RootElement; @@ -203,7 +203,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase }; // Act - string json = JsonSerializer.Serialize(request, Responses.ResponsesJsonContext.Default.CreateResponse); + string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateResponse); using var doc = JsonDocument.Parse(json); var root = doc.RootElement; @@ -223,7 +223,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("image_input/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -237,7 +237,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("image_input_streaming/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -252,7 +252,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("json_output/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -263,7 +263,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase var jsonSchemaFormat = (ResponseTextFormatConfigurationJsonSchema)request.Text.Format; Assert.Equal("json_schema", jsonSchemaFormat.Type); Assert.NotNull(jsonSchemaFormat.Name); - Assert.NotNull(jsonSchemaFormat.Schema); + Assert.NotEqual(default, jsonSchemaFormat.Schema); } [Fact] @@ -273,7 +273,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("json_output_streaming/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -293,7 +293,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("reasoning/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -307,7 +307,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("reasoning_streaming/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -322,7 +322,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("refusal/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -336,7 +336,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("refusal_streaming/request.json"); // Act - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); // Assert Assert.NotNull(request); @@ -370,7 +370,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile(path); // Act & Assert - Should not throw - CreateResponse? request = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.CreateResponse); + CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse); Assert.NotNull(request); Assert.NotNull(request.Input); } @@ -387,7 +387,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("basic/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -406,7 +406,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("basic/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -417,7 +417,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase Assert.NotNull(outputItem); // Verify it's a message type - using var doc = JsonDocument.Parse(JsonSerializer.Serialize(outputItem, Responses.ResponsesJsonContext.Default.ItemResource)); + using var doc = JsonDocument.Parse(JsonSerializer.Serialize(outputItem, OpenAIHostingJsonContext.Default.ItemResource)); var root = doc.RootElement; Assert.Equal("message", root.GetProperty("type").GetString()); } @@ -429,7 +429,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("basic/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -448,7 +448,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("conversation/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -464,7 +464,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("metadata/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -481,7 +481,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("metadata/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -497,7 +497,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("metadata/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -512,7 +512,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("metadata/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -528,7 +528,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("tool_call/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -536,7 +536,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase Assert.Single(response.Output); // Verify the output is a function_call type - using var doc = JsonDocument.Parse(JsonSerializer.Serialize(response.Output[0], Responses.ResponsesJsonContext.Default.ItemResource)); + using var doc = JsonDocument.Parse(JsonSerializer.Serialize(response.Output[0], OpenAIHostingJsonContext.Default.ItemResource)); var root = doc.RootElement; Assert.Equal("function_call", root.GetProperty("type").GetString()); Assert.Equal("get_weather", root.GetProperty("name").GetString()); @@ -552,7 +552,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("tool_call/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -576,7 +576,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("image_input/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -591,7 +591,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("json_output/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -611,7 +611,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("reasoning/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -627,7 +627,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile("refusal/response.json"); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -656,7 +656,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string json = LoadResponsesTraceFile(path); // Act - Response? response = JsonSerializer.Deserialize(json, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -675,9 +675,9 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase string originalJson = LoadResponsesTraceFile("basic/response.json"); // Act - Deserialize and re-serialize - Response? response = JsonSerializer.Deserialize(originalJson, Responses.ResponsesJsonContext.Default.Response); - string reserializedJson = JsonSerializer.Serialize(response, Responses.ResponsesJsonContext.Default.Response); - Response? roundtripped = JsonSerializer.Deserialize(reserializedJson, Responses.ResponsesJsonContext.Default.Response); + Response? response = JsonSerializer.Deserialize(originalJson, OpenAIHostingJsonContext.Default.Response); + string reserializedJson = JsonSerializer.Serialize(response, OpenAIHostingJsonContext.Default.Response); + Response? roundtripped = JsonSerializer.Deserialize(reserializedJson, OpenAIHostingJsonContext.Default.Response); // Assert Assert.NotNull(response); @@ -742,7 +742,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase // Act string jsonString = createdEventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -764,7 +764,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase // Act string jsonString = inProgressEventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -785,7 +785,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase // Act string jsonString = itemAddedJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -805,7 +805,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase // Act string jsonString = partAddedJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -827,7 +827,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase // Act string jsonString = textDeltaJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -853,7 +853,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); if (evt is StreamingOutputTextDelta delta) { @@ -885,7 +885,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); sequenceNumbers.Add(evt.SequenceNumber); } @@ -910,15 +910,15 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase // Act string jsonString = lastEventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); // Should be one of the terminal events - bool isTerminal = evt is StreamingResponseCompleted || - evt is StreamingResponseIncomplete || - evt is StreamingResponseFailed; + bool isTerminal = evt is StreamingResponseCompleted or + StreamingResponseIncomplete or + StreamingResponseFailed; Assert.True(isTerminal, $"Expected terminal event, got: {evt.GetType().Name}"); } @@ -935,7 +935,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase Assert.NotEmpty(events); Assert.All(events, evt => { - StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(parsed); }); } @@ -953,7 +953,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase Assert.NotEmpty(events); Assert.All(events, evt => { - StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(parsed); }); } @@ -974,7 +974,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase Assert.Contains("response.created", eventTypes); Assert.All(events, evt => { - StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(parsed); }); } @@ -994,7 +994,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase // Should have refusal-related events Assert.All(events, evt => { - StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(parsed); }); } @@ -1020,7 +1020,7 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase foreach (var eventJson in ParseSseEventsFromContent(sseContent)) { // Should not throw - StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); } } @@ -1036,24 +1036,24 @@ public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase foreach (var eventJson in ParseSseEventsFromContent(sseContent)) { // Should not throw - StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); // Verify polymorphic deserialization worked Assert.True( - evt is StreamingResponseCreated || - evt is StreamingResponseInProgress || - evt is StreamingResponseCompleted || - evt is StreamingResponseIncomplete || - evt is StreamingResponseFailed || - evt is StreamingOutputItemAdded || - evt is StreamingOutputItemDone || - evt is StreamingContentPartAdded || - evt is StreamingContentPartDone || - evt is StreamingOutputTextDelta || - evt is StreamingOutputTextDone || - evt is StreamingFunctionCallArgumentsDelta || - evt is StreamingFunctionCallArgumentsDone, + evt is StreamingResponseCreated or + StreamingResponseInProgress or + StreamingResponseCompleted or + StreamingResponseIncomplete or + StreamingResponseFailed or + StreamingOutputItemAdded or + StreamingOutputItemDone or + StreamingContentPartAdded or + StreamingContentPartDone or + StreamingOutputTextDelta or + StreamingOutputTextDone or + StreamingFunctionCallArgumentsDelta or + StreamingFunctionCallArgumentsDone, $"Unknown event type: {evt.GetType().Name}"); } } diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/SortOrderExtensionsTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/SortOrderExtensionsTests.cs new file mode 100644 index 0000000000..499d8efdf1 --- /dev/null +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/SortOrderExtensionsTests.cs @@ -0,0 +1,64 @@ +// Copyright (c) Microsoft. All rights reserved. + +using Microsoft.Agents.AI.Hosting.OpenAI.Conversations; +using Microsoft.Agents.AI.Hosting.OpenAI.Models; + +namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests; + +/// +/// Unit tests for SortOrderExtensions. +/// +public sealed class SortOrderExtensionsTests +{ + [Fact] + public void ToOrderString_Ascending_ReturnsAsc() + { + // Arrange + const SortOrder Order = SortOrder.Ascending; + + // Act + string result = Order.ToOrderString(); + + // Assert + Assert.Equal("asc", result); + } + + [Fact] + public void ToOrderString_Descending_ReturnsDesc() + { + // Arrange + const SortOrder Order = SortOrder.Descending; + + // Act + string result = Order.ToOrderString(); + + // Assert + Assert.Equal("desc", result); + } + + [Fact] + public void IsAscending_Ascending_ReturnsTrue() + { + // Arrange + const SortOrder Order = SortOrder.Ascending; + + // Act + bool result = Order.IsAscending(); + + // Assert + Assert.True(result); + } + + [Fact] + public void IsAscending_Descending_ReturnsFalse() + { + // Arrange + const SortOrder Order = SortOrder.Descending; + + // Act + bool result = Order.IsAscending(); + + // Assert + Assert.False(result); + } +} diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/StreamingEventConformanceTests.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/StreamingEventConformanceTests.cs index 573b3ad26a..94073a0e36 100644 --- a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/StreamingEventConformanceTests.cs +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/StreamingEventConformanceTests.cs @@ -108,9 +108,9 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase // Assert - Last event should be a terminal state string lastEventType = eventTypes[^1]; Assert.True( - lastEventType == "response.completed" || - lastEventType == "response.incomplete" || - lastEventType == "response.failed", + lastEventType is "response.completed" or + "response.incomplete" or + "response.failed", $"Last event should be a terminal state, got: {lastEventType}"); } @@ -135,7 +135,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase // Act string jsonString = createdEventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -168,7 +168,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase // Act string jsonString = inProgressEventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -200,7 +200,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase // Act string jsonString = itemAddedJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -231,7 +231,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase // Act string jsonString = partAddedJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -264,7 +264,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase // Act string jsonString = textDeltaJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); @@ -301,7 +301,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); if (evt is StreamingOutputTextDelta delta) { @@ -344,7 +344,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); sequenceNumbers.Add(evt.SequenceNumber); } @@ -380,15 +380,15 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase // Act string jsonString = lastEventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); // Assert Assert.NotNull(evt); // Should be one of the terminal events - bool isTerminal = evt is StreamingResponseCompleted || - evt is StreamingResponseIncomplete || - evt is StreamingResponseFailed; + bool isTerminal = evt is StreamingResponseCompleted or + StreamingResponseIncomplete or + StreamingResponseFailed; Assert.True(isTerminal, $"Expected terminal event, got: {evt.GetType().Name}"); } @@ -413,24 +413,24 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase foreach (var eventJson in ParseSseEvents(sseContent)) { // Should not throw - StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); // Verify polymorphic deserialization worked Assert.True( - evt is StreamingResponseCreated || - evt is StreamingResponseInProgress || - evt is StreamingResponseCompleted || - evt is StreamingResponseIncomplete || - evt is StreamingResponseFailed || - evt is StreamingOutputItemAdded || - evt is StreamingOutputItemDone || - evt is StreamingContentPartAdded || - evt is StreamingContentPartDone || - evt is StreamingOutputTextDelta || - evt is StreamingOutputTextDone || - evt is StreamingFunctionCallArgumentsDelta || - evt is StreamingFunctionCallArgumentsDone, + evt is StreamingResponseCreated or + StreamingResponseInProgress or + StreamingResponseCompleted or + StreamingResponseIncomplete or + StreamingResponseFailed or + StreamingOutputItemAdded or + StreamingOutputItemDone or + StreamingContentPartAdded or + StreamingContentPartDone or + StreamingOutputTextDelta or + StreamingOutputTextDone or + StreamingFunctionCallArgumentsDelta or + StreamingFunctionCallArgumentsDone, $"Unknown event type: {evt.GetType().Name}"); } } @@ -459,7 +459,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); string? responseId = null; @@ -499,7 +499,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); string? itemId = evt switch { @@ -545,7 +545,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase // Assert - All events with output_index should have valid values foreach (var eventJson in ParseSseEvents(await httpResponse.Content.ReadAsStringAsync())) { - StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); if (evt is StreamingOutputItemAdded or StreamingOutputItemDone or StreamingContentPartAdded or StreamingContentPartDone or @@ -607,7 +607,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); if (evt is StreamingResponseCreated created) @@ -722,7 +722,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); switch (evt) @@ -774,7 +774,7 @@ public sealed class StreamingEventConformanceTests : ConformanceTestBase foreach (var eventJson in events) { string jsonString = eventJson.GetRawText(); - StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, Responses.ResponsesJsonContext.Default.StreamingResponseEvent); + StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent); Assert.NotNull(evt); Assert.True(sequenceNumbers.Add(evt.SequenceNumber), diff --git a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/TestHelpers.cs b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/TestHelpers.cs index 53d19574f0..11a0c1940d 100644 --- a/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/TestHelpers.cs +++ b/dotnet/tests/Microsoft.Agents.AI.Hosting.OpenAI.UnitTests/TestHelpers.cs @@ -92,6 +92,102 @@ internal static class TestHelpers } } + /// + /// Stateful mock implementation of IChatClient that returns different responses for each call. + /// + internal sealed class StatefulMockChatClient : IChatClient + { + private readonly string[] _responseTexts; + private int _callIndex; + + public StatefulMockChatClient(string[] responseTexts) + { + this._responseTexts = responseTexts; + this._callIndex = 0; + } + + public ChatClientMetadata Metadata { get; } = new("Test", new Uri("https://test.example.com"), "test-model"); + + public Task GetResponseAsync( + IEnumerable messages, + ChatOptions? options = null, + CancellationToken cancellationToken = default) + { + // Get the response text for this call + string responseText = this._callIndex < this._responseTexts.Length + ? this._responseTexts[this._callIndex] + : this._responseTexts[this._responseTexts.Length - 1]; + + this._callIndex++; + + // Count input messages to simulate context size + int messageCount = messages.Count(); + ChatMessage message = new(ChatRole.Assistant, responseText); + ChatResponse response = new([message]) + { + ModelId = "test-model", + FinishReason = ChatFinishReason.Stop, + Usage = new UsageDetails + { + InputTokenCount = 10 + (messageCount * 5), // More messages = more tokens + OutputTokenCount = 5, + TotalTokenCount = 15 + (messageCount * 5) + } + }; + return Task.FromResult(response); + } + + public async IAsyncEnumerable GetStreamingResponseAsync( + IEnumerable messages, + ChatOptions? options = null, + [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + await Task.Delay(1, cancellationToken); + + // Get the response text for this call + string responseText = this._callIndex < this._responseTexts.Length + ? this._responseTexts[this._callIndex] + : this._responseTexts[this._responseTexts.Length - 1]; + + this._callIndex++; + + // Count input messages to simulate context size + int messageCount = messages.Count(); + + // Split response into words to simulate streaming + string[] words = responseText.Split(' '); + for (int i = 0; i < words.Length; i++) + { + string content = i < words.Length - 1 ? words[i] + " " : words[i]; + ChatResponseUpdate update = new() + { + Contents = [new TextContent(content)], + Role = ChatRole.Assistant + }; + + // Add usage to the last update + if (i == words.Length - 1) + { + update.Contents.Add(new UsageContent(new UsageDetails + { + InputTokenCount = 10 + (messageCount * 5), + OutputTokenCount = 5, + TotalTokenCount = 15 + (messageCount * 5) + })); + } + + yield return update; + } + } + + public object? GetService(Type serviceType, object? serviceKey = null) => + serviceType.IsInstanceOfType(this) ? this : null; + + public void Dispose() + { + } + } + /// /// Mock implementation of IChatClient that returns responses with image content. /// @@ -256,7 +352,7 @@ internal static class TestHelpers public FunctionCallMockChatClient(string functionName = "test_function", string arguments = "{\"param\":\"value\"}") { this._functionName = functionName; - this._arguments = System.Text.Json.JsonSerializer.Deserialize>(arguments) ?? new Dictionary(); + this._arguments = System.Text.Json.JsonSerializer.Deserialize>(arguments) ?? []; } public ChatClientMetadata Metadata { get; } = new("Test", new Uri("https://test.example.com"), "test-model"); @@ -408,7 +504,89 @@ internal static class TestHelpers } /// - /// Mock implementation of IChatClient that returns custom content based on a provider function. + /// Mock implementation of IChatClient that returns function call content for tool testing. + /// + internal sealed class ToolCallMockChatClient : IChatClient + { + private readonly string _functionName; + private readonly Dictionary _arguments; + + public ToolCallMockChatClient(string functionName, string argumentsJson) + { + this._functionName = functionName; + // Parse JSON arguments into dictionary + using var doc = System.Text.Json.JsonDocument.Parse(argumentsJson); + this._arguments = new Dictionary(); + foreach (var prop in doc.RootElement.EnumerateObject()) + { + this._arguments[prop.Name] = prop.Value.ValueKind switch + { + System.Text.Json.JsonValueKind.String => prop.Value.GetString(), + System.Text.Json.JsonValueKind.Number => prop.Value.GetDouble(), + System.Text.Json.JsonValueKind.True => true, + System.Text.Json.JsonValueKind.False => false, + System.Text.Json.JsonValueKind.Null => null, + _ => prop.Value.ToString() + }; + } + } + + public ChatClientMetadata Metadata { get; } = new("Test", new Uri("https://test.example.com"), "test-model"); + + public Task GetResponseAsync( + IEnumerable messages, + ChatOptions? options = null, + CancellationToken cancellationToken = default) + { + int messageCount = messages.Count(); + FunctionCallContent functionCall = new("call_test123", this._functionName, this._arguments); + ChatMessage message = new(ChatRole.Assistant, [functionCall]); + ChatResponse response = new([message]) + { + ModelId = "test-model", + FinishReason = ChatFinishReason.ToolCalls, + Usage = new UsageDetails + { + InputTokenCount = 10 + (messageCount * 5), + OutputTokenCount = 5, + TotalTokenCount = 15 + (messageCount * 5) + } + }; + return Task.FromResult(response); + } + + public async IAsyncEnumerable GetStreamingResponseAsync( + IEnumerable messages, + ChatOptions? options = null, + [EnumeratorCancellation] CancellationToken cancellationToken = default) + { + await Task.Delay(1, cancellationToken); + + int messageCount = messages.Count(); + FunctionCallContent functionCall = new("call_test123", this._functionName, this._arguments); + + yield return new ChatResponseUpdate + { + Contents = [functionCall, new UsageContent(new UsageDetails + { + InputTokenCount = 10 + (messageCount * 5), + OutputTokenCount = 5, + TotalTokenCount = 15 + (messageCount * 5) + })], + Role = ChatRole.Assistant + }; + } + + public object? GetService(Type serviceType, object? serviceKey = null) => + serviceType.IsInstanceOfType(this) ? this : null; + + public void Dispose() + { + } + } + + /// + /// Custom content mock implementation of IChatClient that returns custom content based on a provider function. /// internal sealed class CustomContentMockChatClient : IChatClient { diff --git a/dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/Sample/07_GroupChat_Workflow_HostAsAgent.cs b/dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/Sample/07_GroupChat_Workflow_HostAsAgent.cs index ffc4d0ba35..1739fe7a34 100644 --- a/dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/Sample/07_GroupChat_Workflow_HostAsAgent.cs +++ b/dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/Sample/07_GroupChat_Workflow_HostAsAgent.cs @@ -22,6 +22,11 @@ internal static class Step7EntryPoint AgentThread thread = agent.GetNewThread(); await foreach (AgentRunResponseUpdate update in agent.RunStreamingAsync(thread).ConfigureAwait(false)) { + if (update.RawRepresentation is WorkflowEvent) + { + // Skip workflow status updates + continue; + } string updateText = $"{update.AuthorName ?? update.AgentId ?? update.Role.ToString()