OpenAI-DotNet 8.3.0 (#369)

- Updated library to .net 8 - Refactored TypeExtensions and JsonSchema generation - Improved JsonSchema generation for enums and dictionaries - Ensured JsonSchema properly handles nullable types - Ensure that function args are not re-serialized and passed back into tool function for future calls
RageAgainstThePixel · Sep 19, 2024 · 09ddbdc · 09ddbdc
1 parent b2c0aa7
commit 09ddbdc
Show file tree

Hide file tree

Showing 29 changed files with 348 additions and 152 deletions.
diff --git a/.gitattributes b/.gitattributes
diff --git a/OpenAI-DotNet-Proxy/OpenAI-DotNet-Proxy.csproj b/OpenAI-DotNet-Proxy/OpenAI-DotNet-Proxy.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
- <TargetFramework>net6.0</TargetFramework>
+ <TargetFramework>net8.0</TargetFramework>
  <LangVersion>latest</LangVersion>
  <Nullable>disable</Nullable>
  <Title>OpenAI API Proxy</Title>

diff --git a/OpenAI-DotNet-Tests-Proxy/OpenAI-DotNet-Tests-Proxy.csproj b/OpenAI-DotNet-Tests-Proxy/OpenAI-DotNet-Tests-Proxy.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
  <PropertyGroup>
- <TargetFramework>net6.0</TargetFramework>
+ <TargetFramework>net8.0</TargetFramework>
  <Nullable>enable</Nullable>
  <ImplicitUsings>false</ImplicitUsings>
  <IsPackable>false</IsPackable>

diff --git a/OpenAI-DotNet-Tests/OpenAI-DotNet-Tests.csproj b/OpenAI-DotNet-Tests/OpenAI-DotNet-Tests.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
- <TargetFramework>net6.0</TargetFramework>
+ <TargetFramework>net8.0</TargetFramework>
  <IsPackable>false</IsPackable>
  <SignAssembly>false</SignAssembly>
  <LangVersion>latest</LangVersion>

diff --git a/OpenAI-DotNet-Tests/TestFixture_00_02_Extensions.cs b/OpenAI-DotNet-Tests/TestFixture_00_02_Extensions.cs
@@ -146,5 +146,51 @@ public void Test_02_01_GenerateJsonSchema()
  JsonSchema mathSchema = typeof(MathResponse);
  Console.WriteLine(mathSchema.ToString());
  }
+
+ [Test]
+ public void Test_02_02_GenerateJsonSchema_PrimitiveTypes()
+ {
+ JsonSchema schema = typeof(TestSchema);
+ Console.WriteLine(schema.ToString());
+ }
+
+ private class TestSchema
+ {
+ // test all primitive types can be serialized
+ public bool Bool { get; set; }
+ public byte Byte { get; set; }
+ public sbyte SByte { get; set; }
+ public short Short { get; set; }
+ public ushort UShort { get; set; }
+ public int Integer { get; set; }
+ public uint UInteger { get; set; }
+ public long Long { get; set; }
+ public ulong ULong { get; set; }
+ public float Float { get; set; }
+ public double Double { get; set; }
+ public decimal Decimal { get; set; }
+ public char Char { get; set; }
+ public string String { get; set; }
+ public DateTime DateTime { get; set; }
+ public DateTimeOffset DateTimeOffset { get; set; }
+ public Guid Guid { get; set; }
+ // test nullables
+ public int? NullInt { get; set; }
+ public DateTime? NullDateTime { get; set; }
+ public TestEnum TestEnum { get; set; }
+ public TestEnum? NullEnum { get; set; }
+ public Dictionary<string, object> Dictionary { get; set; }
+ public IDictionary<string, int> IntDictionary { get; set; }
+ public IReadOnlyDictionary<string, string> StringDictionary { get; set; }
+ public Dictionary<string, MathResponse> CustomDictionary { get; set; }
+ }
+
+ private enum TestEnum
+ {
+ Enum1,
+ Enum2,
+ Enum3,
+ Enum4
+ }
  }
 }
diff --git a/OpenAI-DotNet/Audio/SpeechRequest.cs b/OpenAI-DotNet/Audio/SpeechRequest.cs
@@ -1,6 +1,5 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using OpenAI.Extensions;
 using OpenAI.Models;
 using System;
 using System.Text.Json.Serialization;
@@ -49,7 +48,7 @@ public SpeechRequest(string input, Model model = null, SpeechVoice voice = Speec
  /// </summary>
  [JsonPropertyName("response_format")]
  [JsonIgnore(Condition = JsonIgnoreCondition.Never)]
- [JsonConverter(typeof(JsonStringEnumConverter<SpeechResponseFormat>))]
+ [JsonConverter(typeof(Extensions.JsonStringEnumConverter<SpeechResponseFormat>))]
  public SpeechResponseFormat ResponseFormat { get; }
 
  /// <summary>

diff --git a/OpenAI-DotNet/Batch/BatchResponse.cs b/OpenAI-DotNet/Batch/BatchResponse.cs
@@ -1,6 +1,5 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using OpenAI.Extensions;
 using System;
 using System.Collections.Generic;
 using System.Text.Json.Serialization;
@@ -53,7 +52,7 @@ public sealed class BatchResponse : BaseResponse
  /// </summary>
  [JsonInclude]
  [JsonPropertyName("status")]
- [JsonConverter(typeof(JsonStringEnumConverter<BatchStatus>))]
+ [JsonConverter(typeof(Extensions.JsonStringEnumConverter<BatchStatus>))]
  public BatchStatus Status { get; private set; }
 
  /// <summary>

diff --git a/OpenAI-DotNet/Chat/ChatRequest.cs b/OpenAI-DotNet/Chat/ChatRequest.cs
@@ -36,7 +36,7 @@ public ChatRequest(
  {
  var toolList = tools?.ToList();
 
- if (toolList != null && toolList.Any())
+ if (toolList is { Count: > 0 })
  {
  if (string.IsNullOrWhiteSpace(toolChoice))
  {
@@ -57,6 +57,15 @@ public ChatRequest(
  ToolChoice = toolChoice;
  }
  }
+
+ foreach (var tool in toolList)
+ {
+ if (tool?.Function?.Arguments != null)
+ {
+ // just in case clear any lingering func args.
+ tool.Function.Arguments = null;
+ }
+ }
  }
 
  Tools = toolList?.ToList();

diff --git a/OpenAI-DotNet/Common/Annotation.cs b/OpenAI-DotNet/Common/Annotation.cs
@@ -14,7 +14,7 @@ public sealed class Annotation : IAppendable<Annotation>
 
  [JsonInclude]
  [JsonPropertyName("type")]
- [JsonConverter(typeof(JsonStringEnumConverter<AnnotationType>))]
+ [JsonConverter(typeof(Extensions.JsonStringEnumConverter<AnnotationType>))]
  public AnnotationType Type { get; private set; }
 
  /// <summary>

diff --git a/OpenAI-DotNet/Common/Content.cs b/OpenAI-DotNet/Common/Content.cs
@@ -59,7 +59,7 @@ public Content(ContentType type, string input)
 
  [JsonInclude]
  [JsonPropertyName("type")]
- [JsonConverter(typeof(JsonStringEnumConverter<ContentType>))]
+ [JsonConverter(typeof(Extensions.JsonStringEnumConverter<ContentType>))]
  [JsonIgnore(Condition = JsonIgnoreCondition.Never)]
  public ContentType Type { get; private set; }
 

diff --git a/OpenAI-DotNet/Common/Function.cs b/OpenAI-DotNet/Common/Function.cs
@@ -92,6 +92,7 @@ internal Function(string name, JsonNode arguments, bool? strict = null)
  {
  Name = name;
  Arguments = arguments;
+ Strict = strict;
  }
 
  private Function(string name, string description, MethodInfo method, object instance = null, bool? strict = null)

diff --git a/OpenAI-DotNet/Common/ResponseFormatObject.cs b/OpenAI-DotNet/Common/ResponseFormatObject.cs
@@ -1,6 +1,5 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
-using OpenAI.Extensions;
 using System.Text.Json.Serialization;
 
 namespace OpenAI
@@ -26,7 +25,7 @@ public ResponseFormatObject(JsonSchema schema)
 
  [JsonInclude]
  [JsonPropertyName("type")]
- [JsonConverter(typeof(JsonStringEnumConverter<ChatResponseFormat>))]
+ [JsonConverter(typeof(Extensions.JsonStringEnumConverter<ChatResponseFormat>))]
  public ChatResponseFormat Type { get; private set; }
 
  [JsonInclude]

diff --git a/OpenAI-DotNet/Common/Tool.cs b/OpenAI-DotNet/Common/Tool.cs
@@ -175,11 +175,11 @@ public async Task<T> InvokeFunctionAsync<T>(CancellationToken cancellationToken
 
  #region Tool Cache
 
- private static readonly List<Tool> toolCache = new()
- {
+ private static readonly List<Tool> toolCache =
+ [
  FileSearch,
  CodeInterpreter
- };
+ ];
 
  /// <summary>
  /// Gets a list of all available tools.