Skip to content

Fix duplication between OpenAI Assistants pre-configured tools #6896

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 1 commit into from
Oct 7, 2025
+29 −7
Merged

Fix duplication between OpenAI Assistants pre-configured tools #6896

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 29 additions & 7 deletions src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIAssistantsChatClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,8 @@ internal static FunctionToolDefinition ToOpenAIAssistantsFunctionToolDefinition(

if (options.Tools is { Count: > 0 } tools)
{
HashSet<ToolDefinition> toolsOverride = new(ToolDefinitionNameEqualityComparer.Instance);

// If the caller has provided any tool overrides, we'll assume they don't want to use the assistant's tools.
// But if they haven't, the only way we can provide our tools is via an override, whereas we'd really like to
// just add them. To handle that, we'll get all of the assistant's tools and add them to the override list
Expand All @@ -318,10 +320,7 @@ internal static FunctionToolDefinition ToOpenAIAssistantsFunctionToolDefinition(
_assistantTools = assistant.Value.Tools;
}

foreach (var tool in _assistantTools)
{
runOptions.ToolsOverride.Add(tool);
}
toolsOverride.UnionWith(_assistantTools);
}

// The caller can provide tools in the supplied ThreadAndRunOptions. Augment it with any supplied via ChatOptions.Tools.
Expand All @@ -330,12 +329,12 @@ internal static FunctionToolDefinition ToOpenAIAssistantsFunctionToolDefinition(
switch (tool)
{
case AIFunctionDeclaration aiFunction:
runOptions.ToolsOverride.Add(ToOpenAIAssistantsFunctionToolDefinition(aiFunction, options));
_ = toolsOverride.Add(ToOpenAIAssistantsFunctionToolDefinition(aiFunction, options));
break;

case HostedCodeInterpreterTool codeInterpreterTool:
var interpreterToolDef = ToolDefinition.CreateCodeInterpreter();
runOptions.ToolsOverride.Add(interpreterToolDef);
_ = toolsOverride.Add(interpreterToolDef);

if (codeInterpreterTool.Inputs?.Count is > 0)
{
Expand All @@ -358,7 +357,7 @@ internal static FunctionToolDefinition ToOpenAIAssistantsFunctionToolDefinition(
break;

case HostedFileSearchTool fileSearchTool:
runOptions.ToolsOverride.Add(ToolDefinition.CreateFileSearch(fileSearchTool.MaximumResultCount));
_ = toolsOverride.Add(ToolDefinition.CreateFileSearch(fileSearchTool.MaximumResultCount));
if (fileSearchTool.Inputs is { Count: > 0 } fileSearchInputs)
{
foreach (var input in fileSearchInputs)
Expand All @@ -374,6 +373,11 @@ internal static FunctionToolDefinition ToOpenAIAssistantsFunctionToolDefinition(
break;
}
}

foreach (var tool in toolsOverride)
{
runOptions.ToolsOverride.Add(tool);
}
}

// Store the tool mode, if relevant.
Expand Down Expand Up @@ -543,4 +547,22 @@ void AppendSystemInstructions(string? toAppend)

return runId;
}

/// <summary>
/// Provides the same behavior as <see cref="EqualityComparer{ToolDefinition}.Default"/>, except
/// for <see cref="FunctionToolDefinition"/> it compares names so that two function tool definitions with the
/// same name compare equally.
/// </summary>
private sealed class ToolDefinitionNameEqualityComparer : IEqualityComparer<ToolDefinition>
{
public static ToolDefinitionNameEqualityComparer Instance { get; } = new();

public bool Equals(ToolDefinition? x, ToolDefinition? y) =>
x is FunctionToolDefinition xFtd && y is FunctionToolDefinition yFtd ? xFtd.FunctionName.Equals(yFtd.FunctionName, StringComparison.Ordinal) :
EqualityComparer<ToolDefinition?>.Default.Equals(x, y);

public int GetHashCode(ToolDefinition obj) =>
obj is FunctionToolDefinition ftd ? ftd.FunctionName.GetHashCode(StringComparison.Ordinal) :
EqualityComparer<ToolDefinition>.Default.GetHashCode(obj);
}
}
Loading