Skip to content

.Net: OpenAI: throw clear error when tool result call ID is missing #13945

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

Open
Utricularor wants to merge 4 commits into
base: main
Choose a base branch
from
+35 −0
Open

.Net: OpenAI: throw clear error when tool result call ID is missing #13945

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d9ac961
Add clear error and test for missing tool call id in tool results
Utricularor May 2, 2026
f8abc47
Re-trigger CI for merge gatekeeper
Utricularor May 3, 2026
758e41f
Address Copilot review: use nameof and rename test method
Utricularor May 6, 2026
8dbb2db
Address Copilot review: use nameof(message) as paramName and capitali…
Utricularor May 6, 2026
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
28 changes: 28 additions & 0 deletions ...t/src/Connectors/Connectors.OpenAI.UnitTests/Services/OpenAIChatCompletionServiceTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -916,6 +916,34 @@ public async Task FunctionResultsCanBeProvidedToLLMAsOneResultPerChatMessageAsyn
Assert.Equal("2", assistantMessage2.GetProperty("tool_call_id").GetString());
}

[Fact]
public async Task FunctionResultsWithoutCallIdThrowsClearExceptionAsync()
{
// Arrange
this._messageHandlerStub.ResponseToReturn = new HttpResponseMessage(System.Net.HttpStatusCode.OK)
{
Content = new StringContent(ChatCompletionResponse)
};

var sut = new OpenAIChatCompletionService(modelId: "gpt-3.5-turbo", apiKey: "NOKEY", httpClient: this._httpClient);

var chatHistory = new ChatHistory
{
new ChatMessageContent(AuthorRole.Tool,
[
new FunctionResultContent(functionName: "GetCurrentWeather", pluginName: "MyPlugin", callId: null, result: "rainy")
])
};

var settings = new OpenAIPromptExecutionSettings() { ToolCallBehavior = ToolCallBehavior.EnableKernelFunctions };

// Act
var exception = await Assert.ThrowsAsync<ArgumentException>(() => sut.GetChatMessageContentAsync(chatHistory, settings));

// Assert
Assert.Contains("missing a tool call id", exception.Message, StringComparison.OrdinalIgnoreCase);
}

[Fact]
public async Task FunctionResultsCanBeProvidedToLLMAsManyResultsInOneChatMessageAsync()
{
Expand Down
7 changes: 7 additions & 0 deletions dotnet/src/Connectors/Connectors.OpenAI/Core/ClientCore.ChatCompletion.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -759,6 +759,13 @@ private static List<ChatMessage> CreateRequestMessages(ChatMessageContent messag
continue;
}

if (string.IsNullOrWhiteSpace(resultContent.CallId))
{
throw new ArgumentException(
$"Function result message is missing a tool call ID. Provide {nameof(FunctionResultContent.CallId)} when sending tool results to OpenAI.",
nameof(message));
}

toolMessages ??= [];

if (resultContent.Result is Exception ex)
Expand Down
Loading