com.openai.unity 8.5.0 (#327)

- Added Role.Developer for reasoning model messages
- Added reasoning effort parameter for o1 series models in ChatRequest
- Fix possible misinterpretation of function parameter types in function calls

Runtime/Chat/ChatRequest.cs

@@ -33,9 +33,10 @@ public ChatRequest(
             bool? parallelToolCalls = null,
             JsonSchema jsonSchema = null,
             AudioConfig audioConfig = null,
+            ReasoningEffort? reasoningEffort = null,
             string user = null)
             : this(messages, model, frequencyPenalty, logitBias, maxTokens, number, presencePenalty,
-                responseFormat, seed, stops, temperature, topP, topLogProbs, parallelToolCalls, jsonSchema, audioConfig, user)
+                responseFormat, seed, stops, temperature, topP, topLogProbs, parallelToolCalls, jsonSchema, audioConfig, reasoningEffort, user)
         {
             var toolList = tools?.ToList();
 
@@ -149,6 +150,11 @@ public ChatRequest(
         /// <param name="audioConfig">
         /// Parameters for audio output. <see cref="Chat.AudioConfig"/>.
         /// </param>
+        /// <param name="reasoningEffort">
+        /// Constrains the effort of reasoning for <see href="https://platform.openai.com/docs/guides/reasoning">Reasoning Models</see>.<br/>
+        /// Currently supported values are: Low, Medium, High. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning response.<br/>
+        /// <b>o1 models only!</b>
+        /// </param>
         /// <param name="user">
         /// A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
         /// </param>
@@ -170,6 +176,7 @@ public ChatRequest(
             bool? parallelToolCalls = null,
             JsonSchema jsonSchema = null,
             AudioConfig audioConfig = null,
+            ReasoningEffort? reasoningEffort = null,
             string user = null)
         {
             Messages = messages?.ToList();
@@ -181,6 +188,16 @@ public ChatRequest(
 
             Model = string.IsNullOrWhiteSpace(model) ? Models.Model.GPT4o : model;
 
+            if (reasoningEffort.HasValue)
+            {
+                if (!Model.Contains("o1"))
+                {
+                    throw new ArgumentException("Only o1 series models support reasoning effort", nameof(reasoningEffort));
+                }
+
+                ReasoningEffort = reasoningEffort.Value;
+            }
+
             if (audioConfig != null && !Model.Contains("audio"))
             {
                 throw new ArgumentException("Audio settings are only valid for models that support audio output", nameof(audioConfig));
@@ -246,6 +263,10 @@ public ChatRequest(
         [JsonProperty("store")]
         public bool? Store { get; set; }
 
+        [Preserve]
+        [JsonProperty("reasoning_effort", DefaultValueHandling = DefaultValueHandling.Ignore)]
+        public ReasoningEffort ReasoningEffort { get; }
+
         /// <summary>
         /// Developer-defined tags and values used for filtering completions in the dashboard.
         /// </summary>
@@ -304,7 +325,7 @@ public ChatRequest(
         /// </summary>
         [JsonIgnore]
         [Obsolete("Use MaxCompletionTokens instead")]
-        public int? MaxTokens { get; }
+        public int? MaxTokens => MaxCompletionTokens;
 
         /// <summary>
         /// An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.

Runtime/Common/Function.cs

@@ -502,6 +502,12 @@ private static async Task<T> InvokeInternalAsync<T>(Function function, object[]
                     }
                     else
                     {
+                        // check that the value assigned type matches the parameter type. If not then attempt to change it.
+                        if (value.GetType() != parameter.ParameterType)
+                        {
+                            value = Convert.ChangeType(value, parameter.ParameterType);
+                        }
+
                         invokeArgs[i] = value;
                     }
                 }

Runtime/Common/ReasoningEffort.cs

@@ -0,0 +1,18 @@
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace OpenAI
+{
+    /// <summary>
+    /// Constrains the effort of reasoning for <see href="https://platform.openai.com/docs/guides/reasoning">Reasoning Models</see>.<br/>
+    /// Currently supported values are: Low, Medium, High. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning response.
+    /// </summary>
+    /// <remarks>
+    /// <b>o1 models only!</b>
+    /// </remarks>
+    public enum ReasoningEffort
+    {
+        Low = 1,
+        Medium,
+        High
+    }
+}

Runtime/Common/Role.cs

@@ -7,10 +7,11 @@ namespace OpenAI
     public enum Role
     {
         System = 1,
-        Assistant,
-        User,
+        Developer = 1,
+        Assistant = 2,
+        User = 3,
         [Obsolete("Use Tool")]
-        Function,
-        Tool
+        Function = 4,
+        Tool = 4
     }
 }

Tests/TestFixture_00_02_Extensions.cs

@@ -3,6 +3,7 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using NUnit.Framework;
+using OpenAI.Audio;
 using OpenAI.Images;
 using OpenAI.Tests.StructuredOutput;
 using OpenAI.Tests.Weather;
@@ -23,7 +24,15 @@ public void Test_01_01_GetTools()
             Assert.IsNotNull(tools);
             Assert.IsNotEmpty(tools);
             tools.Add(Tool.GetOrCreateTool(OpenAIClient.ImagesEndPoint, nameof(ImagesEndpoint.GenerateImageAsync)));
+            tools.Add(Tool.GetOrCreateTool(OpenAIClient.AudioEndpoint, nameof(AudioEndpoint.GetSpeechAsync)));
             tools.Add(Tool.FromFunc<GameObject, Vector2, Vector3, Quaternion, string>("complex_objects", (gameObject, vector2, vector3, quaternion) => "success"));
+
+
+            foreach (var tool in tools)
+            {
+                Debug.Log(tool.Function?.Name ?? tool.Type);
+            }
+
             var json = JsonConvert.SerializeObject(tools, Formatting.Indented, OpenAIClient.JsonSerializationOptions);
             Debug.Log(json);
         }

package.json

@@ -3,7 +3,7 @@
   "displayName": "OpenAI",
   "description": "A OpenAI package for the Unity Game Engine to use GPT-4, GPT-3.5, GPT-3 and Dall-E though their RESTful API (currently in beta).\n\nIndependently developed, this is not an official library and I am not affiliated with OpenAI.\n\nAn OpenAI API account is required.",
   "keywords": [],
-  "version": "8.4.5",
+  "version": "8.5.0",
   "unity": "2021.3",
   "documentationUrl": "https://github.com/RageAgainstThePixel/com.openai.unity#documentation",
   "changelogUrl": "https://github.com/RageAgainstThePixel/com.openai.unity/releases",