Skip to content

Update AsOpenAIResponseItems to roundtrip User AIContent ResponseItems #6931

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 18, 2025
Merged

Update AsOpenAIResponseItems to roundtrip User AIContent ResponseItems #6931

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
476e48f
Update AsOpenAIResponseItems to roundtrip User AIContent ResponseItems
stephentoub Oct 18, 2025
2badeed
Ensure ordering of AIContent-to-ResponseItem mapping
stephentoub Oct 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 48 additions & 17 deletions src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIResponsesChatClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ internal static IEnumerable<ChatMessage> ToChatMessages(IEnumerable<ResponseItem
break;

case McpToolCallApprovalResponseItem mtcari:
message.Contents.Add(new McpServerToolApprovalResponseContent(mtcari.ApprovalRequestId, mtcari.Approved));
message.Contents.Add(new McpServerToolApprovalResponseContent(mtcari.ApprovalRequestId, mtcari.Approved) { RawRepresentation = mtcari });
break;

case FunctionCallOutputResponseItem functionCallOutputItem:
Expand Down Expand Up @@ -663,55 +663,86 @@ internal static IEnumerable<ResponseItem> ToOpenAIResponseItems(IEnumerable<Chat

if (input.Role == ChatRole.User)
{
bool handleEmptyMessage = true; // MCP approval responses (and future cases) yield an item rather than adding a part and we don't want to return an empty user message in that case.
List<ResponseContentPart> parts = [];
// Some AIContent items may map to ResponseItems directly. Others map to ResponseContentParts that need to be grouped together.
// In order to preserve ordering, we yield ResponseItems as we find them, grouping ResponseContentParts between those yielded
// items together into their own yielded item.

List<ResponseContentPart>? parts = null;
bool responseItemYielded = false;

foreach (AIContent item in input.Contents)
{
// Items that directly map to a ResponseItem.
ResponseItem? directItem = item switch
{
{ RawRepresentation: ResponseItem rawRep } => rawRep,
McpServerToolApprovalResponseContent mcpResp => ResponseItem.CreateMcpApprovalResponseItem(mcpResp.Id, mcpResp.Approved),
_ => null
};

if (directItem is not null)
{
// Yield any parts already accumulated.
if (parts is not null)
{
yield return ResponseItem.CreateUserMessageItem(parts);
parts = null;
}

// Now yield the directly mapped item.
yield return directItem;

responseItemYielded = true;
continue;
}

// Items that map into ResponseContentParts and are grouped.
switch (item)
{
case AIContent when item.RawRepresentation is ResponseContentPart rawRep:
parts.Add(rawRep);
(parts ??= []).Add(rawRep);
break;

case TextContent textContent:
parts.Add(ResponseContentPart.CreateInputTextPart(textContent.Text));
(parts ??= []).Add(ResponseContentPart.CreateInputTextPart(textContent.Text));
break;

case UriContent uriContent when uriContent.HasTopLevelMediaType("image"):
parts.Add(ResponseContentPart.CreateInputImagePart(uriContent.Uri));
(parts ??= []).Add(ResponseContentPart.CreateInputImagePart(uriContent.Uri));
break;

case DataContent dataContent when dataContent.HasTopLevelMediaType("image"):
parts.Add(ResponseContentPart.CreateInputImagePart(BinaryData.FromBytes(dataContent.Data), dataContent.MediaType));
(parts ??= []).Add(ResponseContentPart.CreateInputImagePart(BinaryData.FromBytes(dataContent.Data), dataContent.MediaType));
break;

case DataContent dataContent when dataContent.MediaType.StartsWith("application/pdf", StringComparison.OrdinalIgnoreCase):
parts.Add(ResponseContentPart.CreateInputFilePart(BinaryData.FromBytes(dataContent.Data), dataContent.MediaType, dataContent.Name ?? $"{Guid.NewGuid():N}.pdf"));
(parts ??= []).Add(ResponseContentPart.CreateInputFilePart(BinaryData.FromBytes(dataContent.Data), dataContent.MediaType, dataContent.Name ?? $"{Guid.NewGuid():N}.pdf"));
break;

case HostedFileContent fileContent:
parts.Add(ResponseContentPart.CreateInputFilePart(fileContent.FileId));
(parts ??= []).Add(ResponseContentPart.CreateInputFilePart(fileContent.FileId));
break;

case ErrorContent errorContent when errorContent.ErrorCode == nameof(ResponseContentPartKind.Refusal):
parts.Add(ResponseContentPart.CreateRefusalPart(errorContent.Message));
break;

case McpServerToolApprovalResponseContent mcpApprovalResponseContent:
handleEmptyMessage = false;
yield return ResponseItem.CreateMcpApprovalResponseItem(mcpApprovalResponseContent.Id, mcpApprovalResponseContent.Approved);
(parts ??= []).Add(ResponseContentPart.CreateRefusalPart(errorContent.Message));
break;
}
}

if (parts.Count == 0 && handleEmptyMessage)
// If we haven't accumulated any parts nor have we yielded any items, manufacture an empty input text part
// to guarantee that every user message results in at least one ResponseItem.
if (parts is null && !responseItemYielded)
{
parts = [];
parts.Add(ResponseContentPart.CreateInputTextPart(string.Empty));
responseItemYielded = true;
}

if (parts.Count > 0)
// Final yield of any accumulated parts.
if (parts is not null)
{
yield return ResponseItem.CreateUserMessageItem(parts);
parts = null;
}

continue;
Expand Down
37 changes: 37 additions & 0 deletions test/Libraries/Microsoft.Extensions.AI.OpenAI.Tests/OpenAIConversionTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,43 @@ public void AsOpenAIResponseItems_ProducesExpectedOutput()
Assert.Equal("The answer is 42.", Assert.Single(m5.Content).Text);
}

[Fact]
public void AsOpenAIResponseItems_RoundtripsRawRepresentation()
{
List<ChatMessage> messages =
[
new(ChatRole.User,
[
new TextContent("Hello, "),
new AIContent { RawRepresentation = ResponseItem.CreateWebSearchCallItem() },
new AIContent { RawRepresentation = ResponseItem.CreateReferenceItem("123") },
new TextContent("World"),
new TextContent("!"),
]),
new(ChatRole.Assistant,
[
new TextContent("Hi!"),
new AIContent { RawRepresentation = ResponseItem.CreateReasoningItem("text") },
]),
new(ChatRole.User,
[
new AIContent { RawRepresentation = ResponseItem.CreateSystemMessageItem("test") },
]),
];

var items = messages.AsOpenAIResponseItems().ToArray();

Assert.Equal(7, items.Length);
Assert.Equal("Hello, ", ((MessageResponseItem)items[0]).Content[0].Text);
Assert.Same(messages[0].Contents[1].RawRepresentation, items[1]);
Assert.Same(messages[0].Contents[2].RawRepresentation, items[2]);
Assert.Equal("World", ((MessageResponseItem)items[3]).Content[0].Text);
Assert.Equal("!", ((MessageResponseItem)items[3]).Content[1].Text);
Assert.Equal("Hi!", ((MessageResponseItem)items[4]).Content[0].Text);
Assert.Same(messages[1].Contents[1].RawRepresentation, items[5]);
Assert.Same(messages[2].Contents[0].RawRepresentation, items[6]);
}

[Fact]
public void AsChatResponse_ConvertsOpenAIChatCompletion()
{
Expand Down
Loading