mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
361c47f30f
* Do not build DevUI assets during .NET project build (#2010) * .NET: Add unit tests for declarative executor SetMultipleVariables (#2016) * Add unit tests for create conversation executor * Update indentation and comment typo. * Added unit tests for declarative executor SetMultipleVariablesExecutor * Updated comments and syntactic sugar * Python: DevUI: Use metadata.entity_id instead of model field (#1984) * DevUI: Use metadata.entity_id for agent/workflow name instead of model field * OpenAI Responses: add explicit request validation * Review feedback * .NET: DevUI - Do not automatically add/map OpenAI services/endpoints (#2014) * Don't add OpenAIResponses as part of Dev UI You should be able to add and remove Dev UI without impacting your other production endpoints. * Remove `AddDevUI()` and do not map OpenAI endpoints from `MapDevUI()` * Fix comment wording * Revise documentation --------- Co-authored-by: Daniel Roth <daroth@microsoft.com> * Python: DevUI: Add OpenAI Responses API proxy support + HIL for Workflows (#1737) * DevUI: Add OpenAI Responses API proxy support with enhanced UI features This commit adds support for proxying requests to OpenAI's Responses API, allowing DevUI to route conversations to OpenAI models when configured to enable testing. Backend changes: - Add OpenAI proxy executor with conversation routing logic - Enhance event mapper to support OpenAI Responses API format - Extend server endpoints to handle OpenAI proxy mode - Update models with OpenAI-specific response types - Remove emojis from logging and CLI output for cleaner text Frontend changes: - Add settings modal with OpenAI proxy configuration UI - Enhance agent and workflow views with improved state management - Add new UI components (separator, switch) for settings - Update debug panel with better event filtering - Improve message renderers for OpenAI content types - Update types and API client for OpenAI integration * update ui, settings modal and workflow input form, add register cleanup hooks. * add workflow HIL support, user mode, other fixes * feat(devui): add human-in-the-loop (HIL) support with dynamic response schemas Implement HIL workflow support allowing workflows to pause for user input with dynamically generated JSON schemas based on response handler type hints. Key Features: - Automatic response schema extraction from @response_handler decorators - Dynamic form generation in UI based on Pydantic/dataclass response types - Checkpoint-based conversation storage for HIL requests/responses - Resume workflow execution after user provides HIL response Backend Changes: - Add extract_response_type_from_executor() to introspect response handlers - Enrich RequestInfoEvent with response_schema via _enrich_request_info_event_with_response_schema() - Map RequestInfoEvent to response.input.requested OpenAI event format - Store HIL responses in conversation history and restore checkpoints Frontend Changes: - Add HILInputModal component with SchemaFormRenderer for dynamic forms - Support Pydantic BaseModel and dataclass response types - Render enum fields as dropdowns, strings as text/textarea, numbers, booleans, arrays, objects - Display original request context alongside response form Testing: - Add tests for checkpoint storage (test_checkpoints.py) - Add schema generation tests for all input types (test_schema_generation.py) - Validate end-to-end HIL flow with spam workflow sample This enables workflows to seamlessly pause execution and request structured user input with type-safe, validated forms generated automatically from response type annotations. * improve HIL support, improve workflow execution view * ui updates * ui updates * improve HIL for workflows, add auth and view modes * update workflow * security improvements , ui fixes * fix mypy error * update loading spinner in ui --------- Co-authored-by: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com> * .NET: Remove launchSettings.json from .gitignore in dotnet/samples (#2006) * Remove launchSettings.json from .gitignore in dotnet/samples * Update dotnet/samples/GettingStarted/DevUI/DevUI_Step01_BasicUsage/Properties/launchSettings.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update dotnet/samples/AGUIClientServer/AGUIServer/Properties/launchSettings.json Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * DevUI: Serialize workflow input as string to maintain conformance with OpenAI Responses format (#2021) Co-authored-by: Victor Dibia <chuvidi2003@gmail.com> * Add Microsoft Agent Framework logo to assets (#2007) * Updated package versions (#2027) * DevUI: Prevent line breaks within words in the agent view (#2024) Co-authored-by: Victor Dibia <chuvidi2003@gmail.com> * .NET [AG-UI]: Adds support for shared state. (#1996) * Product changes * Tests * Dojo project * Cleanups * Python: Fix underlying tool choice bug and all for return to previous Handoff subagent (#2037) * Fix tool_choice override bug and add enable_return_to_previous support * Add unit test for handoff checkpointing * Handle tools when we have them * added missing chatAgent params (#2044) * .NET: fix ChatCompletions Tools serialization (#2043) * fix serialization in chat completions on tools * nit * .NET: assign AgentCard's URL to mapped-endpoint if not defined explicitly (#2047) * fix serialization in chat completions on tools * nit * write e2e test for agent card resolve + adjust behavior * nit * Version 1.0.0-preview.251110.1 (#2048) * .NET: Remove moved OpenAPI sample and point to SK one. (#1997) * Remove moved OpenAPI sample and point to SK one. * Update dotnet/samples/GettingStarted/Agents/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Bump AWSSDK.Extensions.Bedrock.MEAI from 4.0.4.2 to 4.0.4.6 (#2031) --- updated-dependencies: - dependency-name: AWSSDK.Extensions.Bedrock.MEAI dependency-version: 4.0.4.6 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * .NET: Separate all memory and rag samples into their own folders (#2000) * Separate all memory and rag samples into their own folders * Fix broken link. * Python: .Net: Dotnet devui compatibility fixes (#2026) * DevUI: Add OpenAI Responses API proxy support with enhanced UI features This commit adds support for proxying requests to OpenAI's Responses API, allowing DevUI to route conversations to OpenAI models when configured to enable testing. Backend changes: - Add OpenAI proxy executor with conversation routing logic - Enhance event mapper to support OpenAI Responses API format - Extend server endpoints to handle OpenAI proxy mode - Update models with OpenAI-specific response types - Remove emojis from logging and CLI output for cleaner text Frontend changes: - Add settings modal with OpenAI proxy configuration UI - Enhance agent and workflow views with improved state management - Add new UI components (separator, switch) for settings - Update debug panel with better event filtering - Improve message renderers for OpenAI content types - Update types and API client for OpenAI integration * update ui, settings modal and workflow input form, add register cleanup hooks. * add workflow HIL support, user mode, other fixes * feat(devui): add human-in-the-loop (HIL) support with dynamic response schemas Implement HIL workflow support allowing workflows to pause for user input with dynamically generated JSON schemas based on response handler type hints. Key Features: - Automatic response schema extraction from @response_handler decorators - Dynamic form generation in UI based on Pydantic/dataclass response types - Checkpoint-based conversation storage for HIL requests/responses - Resume workflow execution after user provides HIL response Backend Changes: - Add extract_response_type_from_executor() to introspect response handlers - Enrich RequestInfoEvent with response_schema via _enrich_request_info_event_with_response_schema() - Map RequestInfoEvent to response.input.requested OpenAI event format - Store HIL responses in conversation history and restore checkpoints Frontend Changes: - Add HILInputModal component with SchemaFormRenderer for dynamic forms - Support Pydantic BaseModel and dataclass response types - Render enum fields as dropdowns, strings as text/textarea, numbers, booleans, arrays, objects - Display original request context alongside response form Testing: - Add tests for checkpoint storage (test_checkpoints.py) - Add schema generation tests for all input types (test_schema_generation.py) - Validate end-to-end HIL flow with spam workflow sample This enables workflows to seamlessly pause execution and request structured user input with type-safe, validated forms generated automatically from response type annotations. * improve HIL support, improve workflow execution view * ui updates * ui updates * improve HIL for workflows, add auth and view modes * update workflow * security improvements , ui fixes * fix mypy error * update loading spinner in ui * DevUI: Serialize workflow input as string to maintain conformance with OpenAI Responses format * Phase 1: Add /meta endpoint and fix workflow event naming for .NET DevUI compatibility * additional fixes for .NET DevUI workflow visualization item ID tracking **Problem:** .NET DevUI was generating different item IDs for ExecutorInvokedEvent and ExecutorCompletedEvent, causing only the first executor to highlight in the workflow graph. Long executor names and error messages also broke UI layout. **Changes:** - Add ExecutorActionItemResource to match Python DevUI implementation - Track item IDs per executor using dictionary in AgentRunResponseUpdateExtensions - Reuse same item ID across invoked/completed/failed events for proper pairing - Add truncateText() utility to workflow-utils.ts - Truncate executor names to 35 chars in execution timeline - Truncate error messages to 150 chars in workflow graph nodes ** Details:** - ExecutorActionItemResource registered with JSON source generation context - Dictionary cleaned up after executor completion/failure to prevent memory leaks - Frontend item tracking by unique item.id supports multiple executor runs - All changes follow existing codebase patterns and conventions Tested with review-workflow showing correct executor highlighting and state transitions for sequential and concurrent executors. * format fixes, remove cors tests * remove unecessary attributes --------- Co-authored-by: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com> Co-authored-by: Reuben Bond <reuben.bond@gmail.com> * DevUI: support having both an agent and a workflow with the same id in discovery (#2023) * Python: Fix Model ID attribute not showing up in `invoke_agent` span (#2061) * Best effort to surface the model id to invoke agent span * Fix tests * Fix tests * Version 1.0.0-preview.251107.2 (#2065) * Version 1.0.0-preview.251110.2 (#2067) * Update README.md to change Grafana links to Azure portal links for dashboard access (#1983) * .NET - Enable build & test on branch `feature-foundry-agents` (#2068) * Tests good, mkay * Update .github/workflows/dotnet-build-and-test.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Enable feature build pipelines --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com> * Python: Add concrete AGUIChatClient (#2072) * Add concrete AGUIChatClient * Update logging docstrings and conventions * PR feedback * Updates to support client-side tool calls * .NET: Move catalog samples to the HostedAgents folder (#2090) * move catalog samples to the HostedAgents folder * move the catalog samples' projects to the HostedAgents folder * Bump OpenTelemetry.Instrumentation.Runtime from 1.12.0 to 1.13.0 (#1856) --- updated-dependencies: - dependency-name: OpenTelemetry.Instrumentation.Runtime dependency-version: 1.13.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * .NET: Bump Microsoft.SemanticKernel.Agents.Abstractions from 1.66.0 to 1.67.0 (#1962) * Bump Microsoft.SemanticKernel.Agents.Abstractions from 1.66.0 to 1.67.0 --- updated-dependencies: - dependency-name: Microsoft.SemanticKernel.Agents.Abstractions dependency-version: 1.67.0 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * .NET: Bump all Microsoft.SemanticKernel packages from 1.66.* to 1.67.* (#1969) * Initial plan * Update all Microsoft.SemanticKernel packages to 1.67.* Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com> * Remove unrelated changes to package-lock.json and yarn.lock Co-authored-by: markwallace-microsoft <127216156+markwallace-microsoft@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com> Co-authored-by: markwallace-microsoft <127216156+markwallace-microsoft@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: rogerbarreto <19890735+rogerbarreto@users.noreply.github.com> Co-authored-by: markwallace-microsoft <127216156+markwallace-microsoft@users.noreply.github.com> * .NET: fix: WorkflowAsAgent Sample (#1787) * fix: WorkflowAsAgent Sample * Also makes ChatForwardingExecutor public * feat: Expand ChatForwardingExecutor handled types Make ChatForwardingExecutor match the input types of ChatProtocolExecutor. * fix: Update for the new AgentRunResponseUpdate merge logic AIAgent always sends out List<ChatMessage> now. * Updated (#2076) * Bump vite in /python/samples/demos/chatkit-integration/frontend (#1918) Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 7.1.9 to 7.1.12. - [Release notes](https://github.com/vitejs/vite/releases) - [Changelog](https://github.com/vitejs/vite/blob/v7.1.12/packages/vite/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite/commits/v7.1.12/packages/vite) --- updated-dependencies: - dependency-name: vite dependency-version: 7.1.12 dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump Roslynator.Analyzers from 4.14.0 to 4.14.1 (#1857) --- updated-dependencies: - dependency-name: Roslynator.Analyzers dependency-version: 4.14.1 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Bump MishaKav/pytest-coverage-comment from 1.1.57 to 1.1.59 (#2034) Bumps [MishaKav/pytest-coverage-comment](https://github.com/mishakav/pytest-coverage-comment) from 1.1.57 to 1.1.59. - [Release notes](https://github.com/mishakav/pytest-coverage-comment/releases) - [Changelog](https://github.com/MishaKav/pytest-coverage-comment/blob/main/CHANGELOG.md) - [Commits](https://github.com/mishakav/pytest-coverage-comment/compare/v1.1.57...v1.1.59) --- updated-dependencies: - dependency-name: MishaKav/pytest-coverage-comment dependency-version: 1.1.59 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Chris <66376200+crickman@users.noreply.github.com> * Python: Handle agent user input request in AgentExecutor (#2022) * Handle agent user input request in AgentExecutor * fix test * Address comments * Fix tests * Fix tests * Address comments * Address comments * Python: OpenAI Responses Image Generation Stream Support, Sample and Unit Tests (#1853) * support for image gen streaming * small fixes * fixes * added comment * Python: Fix MCP Tool Parameter Descriptions Not Propagated to LLMs (#1978) * mcp tool description fix * small fix * .NET: Allow extending agent run options via additional properties (#1872) * Allow extending agent run options via additional properties This mirrors the M.E.AI model in ChatOptions.AdditionalProperties which is very useful when building functionality pipelines. Fixes https://github.com/microsoft/agent-framework/issues/1815 * Expand XML documentation Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Add AdditionalProperties tests to AgentRunOptions Co-authored-by: kzu <169707+kzu@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: kzu <169707+kzu@users.noreply.github.com> * Python: Use the last entry in the task history to avoid empty responses (#2101) * Use the last entry in the task history to avoid empty responses * History only contains Messages * Updated package versions (#2104) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Reuben Bond <203839+ReubenBond@users.noreply.github.com> Co-authored-by: Peter Ibekwe <109177538+peibekwe@users.noreply.github.com> Co-authored-by: Jeff Handley <jeffhandley@users.noreply.github.com> Co-authored-by: Daniel Roth <daroth@microsoft.com> Co-authored-by: Victor Dibia <chuvidi2003@gmail.com> Co-authored-by: Mark Wallace <127216156+markwallace-microsoft@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Shawn Henry <sphenry@gmail.com> Co-authored-by: Javier Calvarro Nelson <jacalvar@microsoft.com> Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com> Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com> Co-authored-by: Korolev Dmitry <deagle.gross@gmail.com> Co-authored-by: westey <164392973+westey-m@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Reuben Bond <reuben.bond@gmail.com> Co-authored-by: Tao Chen <taochen@microsoft.com> Co-authored-by: wuweng <wuweng@microsoft.com> Co-authored-by: Chris <66376200+crickman@users.noreply.github.com> Co-authored-by: Roger Barreto <19890735+rogerbarreto@users.noreply.github.com> Co-authored-by: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: Jacob Alber <jaalber@microsoft.com> Co-authored-by: Giles Odigwe <79032838+giles17@users.noreply.github.com> Co-authored-by: Daniel Cazzulino <daniel@cazzulino.com> Co-authored-by: kzu <169707+kzu@users.noreply.github.com>
1108 lines
39 KiB
C#
1108 lines
39 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Text.Json;
|
|
using Microsoft.Agents.AI.Hosting.OpenAI.Responses.Models;
|
|
using Microsoft.Agents.AI.Hosting.OpenAI.Tests;
|
|
|
|
namespace Microsoft.Agents.AI.Hosting.OpenAI.UnitTests;
|
|
|
|
/// <summary>
|
|
/// Tests for OpenAI Responses 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.
|
|
/// </summary>
|
|
public sealed class OpenAIResponsesSerializationTests : ConformanceTestBase
|
|
{
|
|
#region Request Serialization Tests
|
|
|
|
[Fact]
|
|
public void Deserialize_BasicRequest_Success()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("basic/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.Equal("gpt-4o-mini", request.Model);
|
|
Assert.NotNull(request.Input);
|
|
Assert.Equal(100, request.MaxOutputTokens);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_BasicRequest_RoundTrip()
|
|
{
|
|
// Arrange
|
|
string originalJson = LoadResponsesTraceFile("basic/request.json");
|
|
|
|
// Act
|
|
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);
|
|
Assert.NotNull(roundtripped);
|
|
Assert.Equal(request.Model, roundtripped.Model);
|
|
Assert.Equal(request.MaxOutputTokens, roundtripped.MaxOutputTokens);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_StreamingRequest_HasStreamFlag()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("streaming/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.True(request.Stream);
|
|
Assert.Equal(200, request.MaxOutputTokens);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ConversationRequest_HasPreviousResponseId()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("conversation/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.NotNull(request.PreviousResponseId);
|
|
Assert.StartsWith("resp_", request.PreviousResponseId);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_MetadataRequest_HasAllParameters()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("metadata/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.NotNull(request.Metadata);
|
|
Assert.Equal(3, request.Metadata.Count);
|
|
Assert.Equal("test_user_123", request.Metadata["user_id"]);
|
|
Assert.Equal("session_456", request.Metadata["session_id"]);
|
|
Assert.Equal("conformance_test", request.Metadata["purpose"]);
|
|
|
|
Assert.NotNull(request.Instructions);
|
|
Assert.Equal("Respond in a friendly, educational tone.", request.Instructions);
|
|
|
|
Assert.Equal(0.7, request.Temperature);
|
|
Assert.Equal(0.9, request.TopP);
|
|
Assert.Equal(150, request.MaxOutputTokens);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ToolCallRequest_HasToolDefinitions()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("tool_call/request.json");
|
|
|
|
// Act
|
|
// CreateResponse doesn't have Tools property - it uses dynamic JSON
|
|
using var doc = JsonDocument.Parse(json);
|
|
var root = doc.RootElement;
|
|
|
|
// Assert
|
|
Assert.True(root.TryGetProperty("tools", out var tools));
|
|
Assert.Equal(JsonValueKind.Array, tools.ValueKind);
|
|
Assert.Equal(1, tools.GetArrayLength());
|
|
|
|
var tool = tools[0];
|
|
Assert.Equal("function", tool.GetProperty("type").GetString());
|
|
Assert.Equal("get_weather", tool.GetProperty("name").GetString());
|
|
Assert.True(tool.TryGetProperty("description", out _));
|
|
Assert.True(tool.TryGetProperty("parameters", out var parameters));
|
|
Assert.Equal("object", parameters.GetProperty("type").GetString());
|
|
}
|
|
|
|
[Fact]
|
|
public void Serialize_CreateMinimalRequest_MatchesFormat()
|
|
{
|
|
// Arrange
|
|
var request = new CreateResponse
|
|
{
|
|
Model = "gpt-4o-mini",
|
|
Input = ResponseInput.FromText("Hello")
|
|
};
|
|
|
|
// Act
|
|
string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
using var doc = JsonDocument.Parse(json);
|
|
var root = doc.RootElement;
|
|
|
|
// Assert
|
|
Assert.Equal("gpt-4o-mini", root.GetProperty("model").GetString());
|
|
Assert.True(root.TryGetProperty("input", out var input));
|
|
|
|
// Input can be string or object - verify one exists
|
|
Assert.True(input.ValueKind is JsonValueKind.String or JsonValueKind.Object);
|
|
}
|
|
|
|
[Fact]
|
|
public void Serialize_CreateRequestWithOptions_IncludesAllFields()
|
|
{
|
|
// Arrange
|
|
var request = new CreateResponse
|
|
{
|
|
Model = "gpt-4o-mini",
|
|
Input = ResponseInput.FromText("Test input"),
|
|
MaxOutputTokens = 100,
|
|
Temperature = 0.7,
|
|
TopP = 0.9,
|
|
Stream = false,
|
|
Instructions = "Test instructions",
|
|
Metadata = new Dictionary<string, string>
|
|
{
|
|
["key1"] = "value1",
|
|
["key2"] = "value2"
|
|
}
|
|
};
|
|
|
|
// Act
|
|
string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
using var doc = JsonDocument.Parse(json);
|
|
var root = doc.RootElement;
|
|
|
|
// Assert
|
|
Assert.Equal("gpt-4o-mini", root.GetProperty("model").GetString());
|
|
Assert.Equal(100, root.GetProperty("max_output_tokens").GetInt32());
|
|
Assert.Equal(0.7, root.GetProperty("temperature").GetDouble());
|
|
Assert.Equal(0.9, root.GetProperty("top_p").GetDouble());
|
|
Assert.False(root.GetProperty("stream").GetBoolean());
|
|
Assert.Equal("Test instructions", root.GetProperty("instructions").GetString());
|
|
|
|
var metadata = root.GetProperty("metadata");
|
|
Assert.Equal("value1", metadata.GetProperty("key1").GetString());
|
|
Assert.Equal("value2", metadata.GetProperty("key2").GetString());
|
|
}
|
|
|
|
[Fact]
|
|
public void Serialize_NullableFields_AreOmittedWhenNull()
|
|
{
|
|
// Arrange
|
|
var request = new CreateResponse
|
|
{
|
|
Model = "gpt-4o-mini",
|
|
Input = ResponseInput.FromText("Test")
|
|
};
|
|
|
|
// Act
|
|
string json = JsonSerializer.Serialize(request, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
using var doc = JsonDocument.Parse(json);
|
|
var root = doc.RootElement;
|
|
|
|
// Assert - Optional fields should not be present when null
|
|
Assert.False(root.TryGetProperty("previous_response_id", out _) &&
|
|
root.GetProperty("previous_response_id").ValueKind != JsonValueKind.Null,
|
|
"previous_response_id should be omitted or null");
|
|
Assert.False(root.TryGetProperty("instructions", out _) &&
|
|
root.GetProperty("instructions").ValueKind != JsonValueKind.Null,
|
|
"instructions should be omitted or null");
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ImageInputRequest_HasImageData()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("image_input/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.NotNull(request.Input);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ImageInputStreamingRequest_HasStreamAndImage()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("image_input_streaming/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.True(request.Stream);
|
|
Assert.NotNull(request.Input);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_JsonOutputRequest_HasJsonSchema()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("json_output/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.NotNull(request.Input);
|
|
Assert.NotNull(request.Text);
|
|
Assert.NotNull(request.Text.Format);
|
|
Assert.IsType<ResponseTextFormatConfigurationJsonSchema>(request.Text.Format);
|
|
var jsonSchemaFormat = (ResponseTextFormatConfigurationJsonSchema)request.Text.Format;
|
|
Assert.Equal("json_schema", jsonSchemaFormat.Type);
|
|
Assert.NotNull(jsonSchemaFormat.Name);
|
|
Assert.NotEqual(default, jsonSchemaFormat.Schema);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_JsonOutputStreamingRequest_HasJsonSchemaAndStream()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("json_output_streaming/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.True(request.Stream);
|
|
Assert.NotNull(request.Input);
|
|
Assert.NotNull(request.Text);
|
|
Assert.NotNull(request.Text.Format);
|
|
Assert.IsType<ResponseTextFormatConfigurationJsonSchema>(request.Text.Format);
|
|
var jsonSchemaFormat = (ResponseTextFormatConfigurationJsonSchema)request.Text.Format;
|
|
Assert.Equal("json_schema", jsonSchemaFormat.Type);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ReasoningRequest_HasReasoningConfiguration()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("reasoning/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.NotNull(request.Reasoning);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ReasoningStreamingRequest_HasReasoningAndStream()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("reasoning_streaming/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.True(request.Stream);
|
|
Assert.NotNull(request.Reasoning);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_RefusalRequest_CanBeDeserialized()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("refusal/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.NotNull(request.Input);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_RefusalStreamingRequest_HasStream()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("refusal_streaming/request.json");
|
|
|
|
// Act
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
|
|
// Assert
|
|
Assert.NotNull(request);
|
|
Assert.True(request.Stream);
|
|
Assert.NotNull(request.Input);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_InvalidInputObject_ThrowsHelpfulException()
|
|
{
|
|
// Arrange
|
|
const string Json = "{\"model\":\"gpt-4o-mini\",\"input\":{\"input\":\"testing!\"},\"stream\":true}";
|
|
|
|
// Act & Assert
|
|
var exception = Assert.Throws<JsonException>(() =>
|
|
JsonSerializer.Deserialize(Json, OpenAIHostingJsonContext.Default.CreateResponse));
|
|
|
|
Assert.Contains("ResponseInput must be either a string or an array of messages", exception.Message);
|
|
Assert.Contains("Objects are not supported", exception.Message);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_AllRequests_CanBeDeserialized()
|
|
{
|
|
// Arrange
|
|
string[] requestPaths =
|
|
[
|
|
"basic/request.json",
|
|
"streaming/request.json",
|
|
"conversation/request.json",
|
|
"metadata/request.json",
|
|
"tool_call/request.json",
|
|
"image_input/request.json",
|
|
"image_input_streaming/request.json",
|
|
"json_output/request.json",
|
|
"json_output_streaming/request.json",
|
|
"reasoning/request.json",
|
|
"reasoning_streaming/request.json",
|
|
"refusal/request.json",
|
|
"refusal_streaming/request.json"
|
|
];
|
|
|
|
foreach (var path in requestPaths)
|
|
{
|
|
string json = LoadResponsesTraceFile(path);
|
|
|
|
// Act & Assert - Should not throw
|
|
CreateResponse? request = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.CreateResponse);
|
|
Assert.NotNull(request);
|
|
Assert.NotNull(request.Input);
|
|
}
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Response Deserialization Tests
|
|
|
|
[Fact]
|
|
public void Deserialize_BasicResponse_Success()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("basic/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.StartsWith("resp_", response.Id);
|
|
Assert.Equal("response", response.Object);
|
|
Assert.True(response.CreatedAt > 0);
|
|
Assert.Equal(ResponseStatus.Completed, response.Status);
|
|
Assert.NotNull(response.Model);
|
|
Assert.StartsWith("gpt-4o-mini", response.Model);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_BasicResponse_HasCorrectOutput()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("basic/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.NotNull(response.Output);
|
|
Assert.Single(response.Output);
|
|
|
|
var outputItem = response.Output[0];
|
|
Assert.NotNull(outputItem);
|
|
|
|
// Verify it's a message type
|
|
using var doc = JsonDocument.Parse(JsonSerializer.Serialize(outputItem, OpenAIHostingJsonContext.Default.ItemResource));
|
|
var root = doc.RootElement;
|
|
Assert.Equal("message", root.GetProperty("type").GetString());
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_BasicResponse_HasCorrectUsage()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("basic/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.NotNull(response.Usage);
|
|
Assert.True(response.Usage.InputTokens > 0);
|
|
Assert.True(response.Usage.OutputTokens > 0);
|
|
Assert.Equal(response.Usage.InputTokens + response.Usage.OutputTokens, response.Usage.TotalTokens);
|
|
Assert.NotNull(response.Usage.InputTokensDetails);
|
|
Assert.NotNull(response.Usage.OutputTokensDetails);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ConversationResponse_HasPreviousResponseId()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("conversation/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.NotNull(response.PreviousResponseId);
|
|
Assert.StartsWith("resp_", response.PreviousResponseId);
|
|
Assert.NotEqual(response.Id, response.PreviousResponseId);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_MetadataResponse_PreservesMetadata()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("metadata/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.NotNull(response.Metadata);
|
|
Assert.Equal("test_user_123", response.Metadata["user_id"]);
|
|
Assert.Equal("session_456", response.Metadata["session_id"]);
|
|
Assert.Equal("conformance_test", response.Metadata["purpose"]);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_MetadataResponse_HasIncompleteStatus()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("metadata/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.Equal(ResponseStatus.Incomplete, response.Status);
|
|
Assert.NotNull(response.IncompleteDetails);
|
|
Assert.Equal("max_output_tokens", response.IncompleteDetails.Reason);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_MetadataResponse_HasInstructions()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("metadata/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.NotNull(response.Instructions);
|
|
Assert.Equal("Respond in a friendly, educational tone.", response.Instructions);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_MetadataResponse_HasModelParameters()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("metadata/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.Equal(0.7, response.Temperature);
|
|
Assert.Equal(0.9, response.TopP);
|
|
Assert.Equal(150, response.MaxOutputTokens);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ToolCallResponse_HasFunctionCall()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("tool_call/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.NotNull(response.Output);
|
|
Assert.Single(response.Output);
|
|
|
|
// Verify the output is a function_call type
|
|
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());
|
|
Assert.True(root.TryGetProperty("arguments", out var args));
|
|
Assert.True(root.TryGetProperty("call_id", out var callId));
|
|
Assert.StartsWith("call_", callId.GetString());
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ToolCallResponse_HasToolDefinitions()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("tool_call/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.NotNull(response.Tools);
|
|
Assert.Single(response.Tools);
|
|
|
|
var tool = response.Tools[0];
|
|
Assert.Equal(JsonValueKind.Object, tool.ValueKind);
|
|
|
|
var toolObj = tool;
|
|
Assert.Equal("function", toolObj.GetProperty("type").GetString());
|
|
Assert.Equal("get_weather", toolObj.GetProperty("name").GetString());
|
|
Assert.True(toolObj.TryGetProperty("parameters", out var parameters));
|
|
Assert.Equal("object", parameters.GetProperty("type").GetString());
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ImageInputResponse_HasImageInInput()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("image_input/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.Equal(ResponseStatus.Completed, response.Status);
|
|
Assert.NotNull(response.Output);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_JsonOutputResponse_HasStructuredOutput()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("json_output/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.Equal(ResponseStatus.Completed, response.Status);
|
|
Assert.NotNull(response.Output);
|
|
Assert.NotNull(response.Text);
|
|
Assert.NotNull(response.Text.Format);
|
|
Assert.IsType<ResponseTextFormatConfigurationJsonSchema>(response.Text.Format);
|
|
var jsonSchemaFormat = (ResponseTextFormatConfigurationJsonSchema)response.Text.Format;
|
|
Assert.Equal("json_schema", jsonSchemaFormat.Type);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ReasoningResponse_HasReasoningItems()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("reasoning/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.Equal(ResponseStatus.Completed, response.Status);
|
|
Assert.NotNull(response.Output);
|
|
Assert.NotNull(response.Reasoning);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_RefusalResponse_HasRefusalContent()
|
|
{
|
|
// Arrange
|
|
string json = LoadResponsesTraceFile("refusal/response.json");
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.Equal(ResponseStatus.Completed, response.Status);
|
|
Assert.NotNull(response.Output);
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_AllResponses_HaveRequiredFields()
|
|
{
|
|
// Arrange
|
|
string[] responsePaths =
|
|
[
|
|
"basic/response.json",
|
|
"conversation/response.json",
|
|
"metadata/response.json",
|
|
"tool_call/response.json",
|
|
"image_input/response.json",
|
|
"json_output/response.json",
|
|
"reasoning/response.json",
|
|
"refusal/response.json"
|
|
];
|
|
|
|
foreach (var path in responsePaths)
|
|
{
|
|
string json = LoadResponsesTraceFile(path);
|
|
|
|
// Act
|
|
Response? response = JsonSerializer.Deserialize(json, OpenAIHostingJsonContext.Default.Response);
|
|
|
|
// Assert
|
|
Assert.NotNull(response);
|
|
Assert.NotNull(response.Id);
|
|
Assert.Equal("response", response.Object);
|
|
Assert.True(response.CreatedAt > 0, $"Response from {path} should have created_at");
|
|
Assert.NotNull(response.Model);
|
|
Assert.NotNull(response.Output);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void Deserialize_ResponseRoundTrip_PreservesData()
|
|
{
|
|
// Arrange
|
|
string originalJson = LoadResponsesTraceFile("basic/response.json");
|
|
|
|
// Act - Deserialize and re-serialize
|
|
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);
|
|
Assert.NotNull(roundtripped);
|
|
Assert.Equal(response.Id, roundtripped.Id);
|
|
Assert.Equal(response.CreatedAt, roundtripped.CreatedAt);
|
|
Assert.Equal(response.Status, roundtripped.Status);
|
|
Assert.Equal(response.Model, roundtripped.Model);
|
|
}
|
|
|
|
#endregion
|
|
|
|
#region Streaming Event Deserialization Tests
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_BasicFormat_Success()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
|
|
// Act
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
|
|
// Assert
|
|
Assert.NotEmpty(events);
|
|
Assert.All(events, evt =>
|
|
{
|
|
Assert.True(evt.TryGetProperty("type", out var type));
|
|
Assert.True(evt.TryGetProperty("sequence_number", out var seqNum));
|
|
Assert.Equal(JsonValueKind.Number, seqNum.ValueKind);
|
|
});
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_HasCorrectEventTypes()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
|
|
// Act
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var eventTypes = events.Select(e => e.GetProperty("type").GetString()).ToHashSet();
|
|
|
|
// Assert
|
|
Assert.Contains("response.created", eventTypes);
|
|
Assert.Contains("response.in_progress", eventTypes);
|
|
Assert.Contains("response.output_item.added", eventTypes);
|
|
Assert.Contains("response.content_part.added", eventTypes);
|
|
Assert.Contains("response.output_text.delta", eventTypes);
|
|
Assert.Contains("response.output_text.done", eventTypes);
|
|
Assert.Contains("response.content_part.done", eventTypes);
|
|
Assert.Contains("response.output_item.done", eventTypes);
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_DeserializeCreatedEvent_Success()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var createdEventJson = events.First(e => e.GetProperty("type").GetString() == "response.created");
|
|
|
|
// Act
|
|
string jsonString = createdEventJson.GetRawText();
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
|
|
// Assert
|
|
Assert.NotNull(evt);
|
|
Assert.IsType<StreamingResponseCreated>(evt);
|
|
var created = (StreamingResponseCreated)evt;
|
|
Assert.Equal(0, created.SequenceNumber);
|
|
Assert.NotNull(created.Response);
|
|
Assert.NotNull(created.Response.Id);
|
|
Assert.StartsWith("resp_", created.Response.Id);
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_DeserializeInProgressEvent_Success()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var inProgressEventJson = events.First(e => e.GetProperty("type").GetString() == "response.in_progress");
|
|
|
|
// Act
|
|
string jsonString = inProgressEventJson.GetRawText();
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
|
|
// Assert
|
|
Assert.NotNull(evt);
|
|
Assert.IsType<StreamingResponseInProgress>(evt);
|
|
var inProgress = (StreamingResponseInProgress)evt;
|
|
Assert.Equal(1, inProgress.SequenceNumber);
|
|
Assert.NotNull(inProgress.Response);
|
|
Assert.Equal(ResponseStatus.InProgress, inProgress.Response.Status);
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_DeserializeOutputItemAdded_Success()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var itemAddedJson = events.First(e => e.GetProperty("type").GetString() == "response.output_item.added");
|
|
|
|
// Act
|
|
string jsonString = itemAddedJson.GetRawText();
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
|
|
// Assert
|
|
Assert.NotNull(evt);
|
|
Assert.IsType<StreamingOutputItemAdded>(evt);
|
|
var itemAdded = (StreamingOutputItemAdded)evt;
|
|
Assert.Equal(0, itemAdded.OutputIndex);
|
|
Assert.NotNull(itemAdded.Item);
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_DeserializeContentPartAdded_Success()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var partAddedJson = events.First(e => e.GetProperty("type").GetString() == "response.content_part.added");
|
|
|
|
// Act
|
|
string jsonString = partAddedJson.GetRawText();
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
|
|
// Assert
|
|
Assert.NotNull(evt);
|
|
Assert.IsType<StreamingContentPartAdded>(evt);
|
|
var partAdded = (StreamingContentPartAdded)evt;
|
|
Assert.NotNull(partAdded.ItemId);
|
|
Assert.Equal(0, partAdded.OutputIndex);
|
|
Assert.Equal(0, partAdded.ContentIndex);
|
|
Assert.NotNull(partAdded.Part);
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_DeserializeTextDelta_Success()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var textDeltaJson = events.First(e => e.GetProperty("type").GetString() == "response.output_text.delta");
|
|
|
|
// Act
|
|
string jsonString = textDeltaJson.GetRawText();
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
|
|
// Assert
|
|
Assert.NotNull(evt);
|
|
Assert.IsType<StreamingOutputTextDelta>(evt);
|
|
var textDelta = (StreamingOutputTextDelta)evt;
|
|
Assert.NotNull(textDelta.ItemId);
|
|
Assert.Equal(0, textDelta.OutputIndex);
|
|
Assert.Equal(0, textDelta.ContentIndex);
|
|
Assert.NotNull(textDelta.Delta);
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_AccumulateTextDeltas_MatchesFinalText()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
|
|
// Act
|
|
var deltas = new List<string>();
|
|
string? finalText = null;
|
|
|
|
foreach (var eventJson in events)
|
|
{
|
|
string jsonString = eventJson.GetRawText();
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
|
|
if (evt is StreamingOutputTextDelta delta)
|
|
{
|
|
deltas.Add(delta.Delta);
|
|
}
|
|
else if (evt is StreamingOutputTextDone done)
|
|
{
|
|
finalText = done.Text;
|
|
}
|
|
}
|
|
|
|
// Assert
|
|
Assert.NotEmpty(deltas);
|
|
Assert.NotNull(finalText);
|
|
|
|
string accumulated = string.Concat(deltas);
|
|
Assert.Equal(accumulated, finalText);
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_SequenceNumbersAreSequential()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
|
|
// Act
|
|
var sequenceNumbers = new List<int>();
|
|
foreach (var eventJson in events)
|
|
{
|
|
string jsonString = eventJson.GetRawText();
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
Assert.NotNull(evt);
|
|
sequenceNumbers.Add(evt.SequenceNumber);
|
|
}
|
|
|
|
// Assert
|
|
Assert.NotEmpty(sequenceNumbers);
|
|
Assert.Equal(0, sequenceNumbers.First());
|
|
|
|
for (int i = 0; i < sequenceNumbers.Count; i++)
|
|
{
|
|
Assert.Equal(i, sequenceNumbers[i]);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_FinalEvent_IsTerminalState()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var lastEventJson = events.Last();
|
|
|
|
// Act
|
|
string jsonString = lastEventJson.GetRawText();
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(jsonString, OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
|
|
// Assert
|
|
Assert.NotNull(evt);
|
|
|
|
// Should be one of the terminal events
|
|
bool isTerminal = evt is StreamingResponseCompleted or
|
|
StreamingResponseIncomplete or
|
|
StreamingResponseFailed;
|
|
Assert.True(isTerminal, $"Expected terminal event, got: {evt.GetType().Name}");
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_ImageInputStreaming_HasImageEvents()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("image_input_streaming/response.txt");
|
|
|
|
// Act
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
|
|
// Assert
|
|
Assert.NotEmpty(events);
|
|
Assert.All(events, evt =>
|
|
{
|
|
StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
Assert.NotNull(parsed);
|
|
});
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_JsonOutputStreaming_HasJsonSchemaEvents()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("json_output_streaming/response.txt");
|
|
|
|
// Act
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
|
|
// Assert
|
|
Assert.NotEmpty(events);
|
|
Assert.All(events, evt =>
|
|
{
|
|
StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
Assert.NotNull(parsed);
|
|
});
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_ReasoningStreaming_HasReasoningEvents()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("reasoning_streaming/response.txt");
|
|
|
|
// Act
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var eventTypes = events.Select(e => e.GetProperty("type").GetString()).ToHashSet();
|
|
|
|
// Assert
|
|
Assert.NotEmpty(events);
|
|
// Should have reasoning-related events
|
|
Assert.Contains("response.created", eventTypes);
|
|
Assert.All(events, evt =>
|
|
{
|
|
StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
Assert.NotNull(parsed);
|
|
});
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_RefusalStreaming_HasRefusalEvents()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("refusal_streaming/response.txt");
|
|
|
|
// Act
|
|
var events = ParseSseEventsFromContent(sseContent);
|
|
var eventTypes = events.Select(e => e.GetProperty("type").GetString()).ToHashSet();
|
|
|
|
// Assert
|
|
Assert.NotEmpty(events);
|
|
// Should have refusal-related events
|
|
Assert.All(events, evt =>
|
|
{
|
|
StreamingResponseEvent? parsed = JsonSerializer.Deserialize(evt.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
Assert.NotNull(parsed);
|
|
});
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_AllStreamingTraces_CanBeDeserialized()
|
|
{
|
|
// Arrange
|
|
string[] streamingPaths =
|
|
[
|
|
"streaming/response.txt",
|
|
"image_input_streaming/response.txt",
|
|
"json_output_streaming/response.txt",
|
|
"reasoning_streaming/response.txt",
|
|
"refusal_streaming/response.txt"
|
|
];
|
|
|
|
foreach (var path in streamingPaths)
|
|
{
|
|
string sseContent = LoadResponsesTraceFile(path);
|
|
|
|
// Act & Assert
|
|
foreach (var eventJson in ParseSseEventsFromContent(sseContent))
|
|
{
|
|
// Should not throw
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
Assert.NotNull(evt);
|
|
}
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void ParseStreamingEvents_AllEvents_CanBeDeserialized()
|
|
{
|
|
// Arrange
|
|
string sseContent = LoadResponsesTraceFile("streaming/response.txt");
|
|
|
|
// Act & Assert
|
|
foreach (var eventJson in ParseSseEventsFromContent(sseContent))
|
|
{
|
|
// Should not throw
|
|
StreamingResponseEvent? evt = JsonSerializer.Deserialize(eventJson.GetRawText(), OpenAIHostingJsonContext.Default.StreamingResponseEvent);
|
|
Assert.NotNull(evt);
|
|
|
|
// Verify polymorphic deserialization worked
|
|
Assert.True(
|
|
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}");
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Helper to parse SSE events from a streaming response content string.
|
|
/// </summary>
|
|
private static List<JsonElement> ParseSseEventsFromContent(string sseContent)
|
|
{
|
|
var events = new List<JsonElement>();
|
|
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))
|
|
{
|
|
// Next line should have the data
|
|
if (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
|
|
}
|