Skip to content

Commit 4bd3521

Browse files
stephentoubstephentoub
committed
Remove duplication of tool handling across OpenAI impls
1 parent f6f0a86 commit 4bd3521

File tree

7 files changed

+171
-260
lines changed

7 files changed

+171
-260
lines changed

‎src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIAssistantChatClient.cs‎

Lines changed: 19 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
using System.Runtime.CompilerServices;
1010
using System.Text;
1111
using System.Text.Json;
12-
using System.Text.Json.Serialization;
1312
using System.Threading;
1413
using System.Threading.Tasks;
1514
using Microsoft.Shared.Diagnostics;
@@ -30,7 +29,7 @@ namespace Microsoft.Extensions.AI;
3029

3130
/// <summary>Represents an <see cref="IChatClient"/> for an Azure.AI.Agents.Persistent <see cref="AssistantClient"/>.</summary>
3231
[Experimental("OPENAI001")]
33-
internal sealed partial class OpenAIAssistantChatClient : IChatClient
32+
internal sealed class OpenAIAssistantChatClient : IChatClient
3433
{
3534
/// <summary>The underlying <see cref="AssistantClient" />.</summary>
3635
private readonly AssistantClient _client;
@@ -197,9 +196,9 @@ public async IAsyncEnumerable<ChatResponseUpdate> GetStreamingResponseAsync(
197196
{
198197
ruUpdate.Contents.Add(
199198
new FunctionCallContent(
200-
JsonSerializer.Serialize([ru.Value.Id, toolCallId], AssistantJsonContext.Default.StringArray),
199+
JsonSerializer.Serialize([ru.Value.Id, toolCallId], OpenAIJsonContext.Default.StringArray),
201200
functionName,
202-
JsonSerializer.Deserialize(rau.FunctionArguments, AssistantJsonContext.Default.IDictionaryStringObject)!));
201+
JsonSerializer.Deserialize(rau.FunctionArguments, OpenAIJsonContext.Default.IDictionaryStringObject)!));
203202
}
204203

205204
yield return ruUpdate;
@@ -237,6 +236,19 @@ void IDisposable.Dispose()
237236
// nop
238237
}
239238

239+
/// <summary>Converts an Extensions function to an OpenAI assistants function tool.</summary>
240+
internal static FunctionToolDefinition ToOpenAIAssistantsFunctionToolDefinition(AIFunction aiFunction)
241+
{
242+
(BinaryData parameters, bool? strict) = OpenAIClientExtensions.ToOpenAIFunctionParameters(aiFunction);
243+
244+
return new FunctionToolDefinition(aiFunction.Name)
245+
{
246+
Description = aiFunction.Description,
247+
Parameters = parameters,
248+
StrictParameterSchemaEnabled = strict,
249+
};
250+
}
251+
240252
/// <summary>
241253
/// Creates the <see cref="RunCreationOptions"/> to use for the request and extracts any function result contents
242254
/// that need to be submitted as tool results.
@@ -284,18 +296,7 @@ void IDisposable.Dispose()
284296
switch (tool)
285297
{
286298
case AIFunction aiFunction:
287-
bool? strict = aiFunction.AdditionalProperties.TryGetValue(OpenAIClientExtensions.StrictKey, out var strictValue) && strictValue is bool strictBool ?
288-
strictBool :
289-
null;
290-
291-
JsonElement jsonSchema = OpenAIClientExtensions.GetSchema(aiFunction, strict);
292-
293-
runOptions.ToolsOverride.Add(new FunctionToolDefinition(aiFunction.Name)
294-
{
295-
Description = aiFunction.Description,
296-
Parameters = BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(jsonSchema, AssistantJsonContext.Default.JsonElement)),
297-
StrictParameterSchemaEnabled = strict,
298-
});
299+
runOptions.ToolsOverride.Add(ToOpenAIAssistantsFunctionToolDefinition(aiFunction));
299300
break;
300301

301302
case HostedCodeInterpreterTool:
@@ -340,7 +341,7 @@ void IDisposable.Dispose()
340341
case ChatResponseFormatJson jsonFormat when OpenAIClientExtensions.StrictSchemaTransformCache.GetOrCreateTransformedSchema(jsonFormat) is { } jsonSchema:
341342
runOptions.ResponseFormat = AssistantResponseFormat.CreateJsonSchemaFormat(
342343
jsonFormat.SchemaName,
343-
BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(jsonSchema, AssistantJsonContext.Default.JsonElement)),
344+
BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(jsonSchema, OpenAIJsonContext.Default.JsonElement)),
344345
jsonFormat.SchemaDescription);
345346
break;
346347

@@ -453,7 +454,7 @@ void AppendSystemInstructions(string? toAppend)
453454
string[]? runAndCallIDs;
454455
try
455456
{
456-
runAndCallIDs = JsonSerializer.Deserialize(frc.CallId, AssistantJsonContext.Default.StringArray);
457+
runAndCallIDs = JsonSerializer.Deserialize(frc.CallId, OpenAIJsonContext.Default.StringArray);
457458
}
458459
catch
459460
{
@@ -476,9 +477,4 @@ void AppendSystemInstructions(string? toAppend)
476477

477478
return runId;
478479
}
479-
480-
[JsonSerializable(typeof(JsonElement))]
481-
[JsonSerializable(typeof(string[]))]
482-
[JsonSerializable(typeof(IDictionary<string, object>))]
483-
private sealed partial class AssistantJsonContext : JsonSerializerContext;
484480
}

‎src/Libraries/Microsoft.Extensions.AI.OpenAI/OpenAIChatClient.cs‎

Lines changed: 7 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
using System.Runtime.CompilerServices;
88
using System.Text;
99
using System.Text.Json;
10-
using System.Text.Json.Serialization;
1110
using System.Threading;
1211
using System.Threading.Tasks;
1312
using Microsoft.Shared.Diagnostics;
@@ -23,7 +22,7 @@
2322
namespace Microsoft.Extensions.AI;
2423

2524
/// <summary>Represents an <see cref="IChatClient"/> for an OpenAI <see cref="OpenAIClient"/> or <see cref="ChatClient"/>.</summary>
26-
internal sealed partial class OpenAIChatClient : IChatClient
25+
internal sealed class OpenAIChatClient : IChatClient
2726
{
2827
/// <summary>Metadata about the client.</summary>
2928
private readonly ChatClientMetadata _metadata;
@@ -104,18 +103,9 @@ void IDisposable.Dispose()
104103
/// <summary>Converts an Extensions function to an OpenAI chat tool.</summary>
105104
internal static ChatTool ToOpenAIChatTool(AIFunction aiFunction)
106105
{
107-
bool? strict =
108-
aiFunction.AdditionalProperties.TryGetValue(OpenAIClientExtensions.StrictKey, out object? strictObj) &&
109-
strictObj is bool strictValue ?
110-
strictValue : null;
111-
112-
// Perform transformations making the schema legal per OpenAI restrictions
113-
JsonElement jsonSchema = OpenAIClientExtensions.GetSchema(aiFunction, strict);
114-
115-
// Map to an intermediate model so that redundant properties are skipped.
116-
var tool = JsonSerializer.Deserialize(jsonSchema, ChatClientJsonContext.Default.ChatToolJson)!;
117-
var functionParameters = BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(tool, ChatClientJsonContext.Default.ChatToolJson));
118-
return ChatTool.CreateFunctionTool(aiFunction.Name, aiFunction.Description, functionParameters, strict);
106+
(BinaryData parameters, bool? strict) = OpenAIClientExtensions.ToOpenAIFunctionParameters(aiFunction);
107+
108+
return ChatTool.CreateFunctionTool(aiFunction.Name, aiFunction.Description, parameters, strict);
119109
}
120110

121111
/// <summary>Converts an Extensions chat message enumerable to an OpenAI chat message enumerable.</summary>
@@ -564,8 +554,7 @@ private ChatCompletionOptions ToOpenAIOptions(ChatOptions? options)
564554
result.ResponseFormat = OpenAIClientExtensions.StrictSchemaTransformCache.GetOrCreateTransformedSchema(jsonFormat) is { } jsonSchema ?
565555
OpenAI.Chat.ChatResponseFormat.CreateJsonSchemaFormat(
566556
jsonFormat.SchemaName ?? "json_schema",
567-
BinaryData.FromBytes(
568-
JsonSerializer.SerializeToUtf8Bytes(jsonSchema, ChatClientJsonContext.Default.JsonElement)),
557+
BinaryData.FromBytes(JsonSerializer.SerializeToUtf8Bytes(jsonSchema, OpenAIJsonContext.Default.JsonElement)),
569558
jsonFormat.SchemaDescription) :
570559
OpenAI.Chat.ChatResponseFormat.CreateJsonObjectFormat();
571560
}
@@ -668,27 +657,11 @@ private static ChatRole FromOpenAIChatRole(ChatMessageRole role) =>
668657

669658
private static FunctionCallContent ParseCallContentFromJsonString(string json, string callId, string name) =>
670659
FunctionCallContent.CreateFromParsedArguments(json, callId, name,
671-
argumentParser: static json => JsonSerializer.Deserialize(json, ChatClientJsonContext.Default.IDictionaryStringObject)!);
660+
argumentParser: static json => JsonSerializer.Deserialize(json, OpenAIJsonContext.Default.IDictionaryStringObject)!);
672661

673662
private static FunctionCallContent ParseCallContentFromBinaryData(BinaryData ut8Json, string callId, string name) =>
674663
FunctionCallContent.CreateFromParsedArguments(ut8Json, callId, name,
675-
argumentParser: static json => JsonSerializer.Deserialize(json, ChatClientJsonContext.Default.IDictionaryStringObject)!);
676-
677-
/// <summary>Used to create the JSON payload for an OpenAI chat tool description.</summary>
678-
private sealed class ChatToolJson
679-
{
680-
[JsonPropertyName("type")]
681-
public string Type { get; set; } = "object";
682-
683-
[JsonPropertyName("required")]
684-
public HashSet<string> Required { get; set; } = [];
685-
686-
[JsonPropertyName("properties")]
687-
public Dictionary<string, JsonElement> Properties { get; set; } = [];
688-
689-
[JsonPropertyName("additionalProperties")]
690-
public bool AdditionalProperties { get; set; }
691-
}
664+
argumentParser: static json => JsonSerializer.Deserialize(json, OpenAIJsonContext.Default.IDictionaryStringObject)!);
692665

693666
/// <summary>POCO representing function calling info. Used to concatenation information for a single function call from across multiple streaming updates.</summary>
694667
private sealed class FunctionCallInfo
@@ -697,14 +670,4 @@ private sealed class FunctionCallInfo
697670
public string? Name;
698671
public StringBuilder? Arguments;
699672
}
700-
701-
/// <summary>Source-generated JSON type information.</summary>
702-
[JsonSourceGenerationOptions(JsonSerializerDefaults.Web,
703-
UseStringEnumConverter = true,
704-
DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
705-
WriteIndented = true)]
706-
[JsonSerializable(typeof(ChatToolJson))]
707-
[JsonSerializable(typeof(IDictionary<string, object?>))]
708-
[JsonSerializable(typeof(string[]))]
709-
private sealed partial class ChatClientJsonContext : JsonSerializerContext;
710673
}

0 commit comments

Comments
 (0)