Refactor ChatResponseFormat -> TextResponseFormat

first pass responses unit test

Author: StephenHodgson

OpenAI/Packages/com.openai.unity/Runtime/Assistants/AssistantResponse.cs

@@ -163,7 +163,7 @@ internal AssistantResponse(
 
         /// <summary>
         /// Specifies the format that the model must output.
-        /// Setting to <see cref="ChatResponseFormat.Json"/> or <see cref="ChatResponseFormat.JsonSchema"/> enables JSON mode,
+        /// Setting to <see cref="TextResponseFormat.Json"/> or <see cref="TextResponseFormat.JsonSchema"/> enables JSON mode,
         /// which guarantees the message the model generates is valid JSON.
         /// </summary>
         /// <remarks>
@@ -180,7 +180,7 @@ internal AssistantResponse(
 
         [Preserve]
         [JsonIgnore]
-        public ChatResponseFormat ResponseFormat => ResponseFormatObject ?? ChatResponseFormat.Auto;
+        public TextResponseFormat ResponseFormat => ResponseFormatObject ?? TextResponseFormat.Auto;
 
         [Preserve]
         public static implicit operator string(AssistantResponse assistant) => assistant?.Id;

OpenAI/Packages/com.openai.unity/Runtime/Assistants/CreateAssistantRequest.cs

@@ -25,7 +25,7 @@ public CreateAssistantRequest(
             double? temperature,
             double? topP,
             JsonSchema jsonSchema,
-            ChatResponseFormat? responseFormat = null)
+            TextResponseFormat? responseFormat = null)
             : this(
                 string.IsNullOrWhiteSpace(model) ? assistant.Model : model,
                 string.IsNullOrWhiteSpace(name) ? assistant.Name : name,
@@ -100,7 +100,7 @@ public CreateAssistantRequest(
         /// </param>
         /// <param name="responseFormat">
         /// Specifies the format that the model must output.
-        /// Setting to <see cref="ChatResponseFormat.Json"/> enables JSON mode,
+        /// Setting to <see cref="TextResponseFormat.Json"/> enables JSON mode,
         /// which guarantees the message the model generates is valid JSON.<br/>
         /// Important: When using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message.
         /// Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit,
@@ -121,7 +121,7 @@ public CreateAssistantRequest(
             double? topP = null,
             ReasoningEffort reasoningEffort = 0,
             JsonSchema jsonSchema = null,
-            ChatResponseFormat? responseFormat = null)
+            TextResponseFormat? responseFormat = null)
         : this(
             string.IsNullOrWhiteSpace(model) ? assistant.Model : model,
             string.IsNullOrWhiteSpace(name) ? assistant.Name : name,
@@ -195,7 +195,7 @@ public CreateAssistantRequest(
         /// </param>
         /// <param name="responseFormat">
         /// Specifies the format that the model must output.
-        /// Setting to <see cref="ChatResponseFormat.Json"/> or <see cref="ChatResponseFormat.JsonSchema"/> enables JSON mode,
+        /// Setting to <see cref="TextResponseFormat.Json"/> or <see cref="TextResponseFormat.JsonSchema"/> enables JSON mode,
         /// which guarantees the message the model generates is valid JSON.<br/>
         /// Important: When using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message.
         /// Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit,
@@ -215,7 +215,7 @@ public CreateAssistantRequest(
             double? topP = null,
             ReasoningEffort reasoningEffort = 0,
             JsonSchema jsonSchema = null,
-            ChatResponseFormat responseFormat = ChatResponseFormat.Text)
+            TextResponseFormat responseFormat = TextResponseFormat.Text)
         {
             Model = string.IsNullOrWhiteSpace(model) ? Models.Model.GPT4o : model;
             Name = name;
@@ -318,7 +318,7 @@ public CreateAssistantRequest(
 
         /// <summary>
         /// Specifies the format that the model must output.
-        /// Setting to <see cref="ChatResponseFormat.Json"/> or <see cref="ChatResponseFormat.JsonSchema"/> enables JSON mode,
+        /// Setting to <see cref="TextResponseFormat.Json"/> or <see cref="TextResponseFormat.JsonSchema"/> enables JSON mode,
         /// which guarantees the message the model generates is valid JSON.
         /// </summary>
         /// <remarks>
@@ -335,7 +335,7 @@ public CreateAssistantRequest(
 
         [Preserve]
         [JsonIgnore]
-        public ChatResponseFormat ResponseFormat => ResponseFormatObject ?? ChatResponseFormat.Auto;
+        public TextResponseFormat ResponseFormat => ResponseFormatObject ?? TextResponseFormat.Auto;
 
         /// <summary>
         /// Set of 16 key-value pairs that can be attached to an object.

OpenAI/Packages/com.openai.unity/Runtime/Chat/ChatRequest.cs

@@ -24,7 +24,7 @@ public ChatRequest(
             int? maxTokens = null,
             int? number = null,
             double? presencePenalty = null,
-            ChatResponseFormat responseFormat = ChatResponseFormat.Auto,
+            TextResponseFormat responseFormat = TextResponseFormat.Auto,
             int? seed = null,
             string[] stops = null,
             double? temperature = null,
@@ -38,28 +38,26 @@ public ChatRequest(
             : this(messages, model, frequencyPenalty, logitBias, maxTokens, number, presencePenalty,
                 responseFormat, seed, stops, temperature, topP, topLogProbs, parallelToolCalls, jsonSchema, audioConfig, reasoningEffort, user)
         {
+            if (string.IsNullOrWhiteSpace(toolChoice))
+            {
+                ToolChoice = "auto";
+            }
+
             var toolList = tools?.ToList();
 
             if (toolList is { Count: > 0 })
             {
-                if (string.IsNullOrWhiteSpace(toolChoice))
+                if (!toolChoice.Equals("none") &&
+                    !toolChoice.Equals("required") &&
+                    !toolChoice.Equals("auto"))
                 {
-                    ToolChoice = "auto";
+                    var tool = toolList.FirstOrDefault(t => t.Function.Name.Contains(toolChoice)) ??
+                        throw new ArgumentException($"The specified tool choice '{toolChoice}' was not found in the list of tools");
+                    ToolChoice = new { type = "function", function = new { name = tool.Function.Name } };
                 }
                 else
                 {
-                    if (!toolChoice.Equals("none") &&
-                        !toolChoice.Equals("required") &&
-                        !toolChoice.Equals("auto"))
-                    {
-                        var tool = toolList.FirstOrDefault(t => t.Function.Name.Contains(toolChoice)) ??
-                            throw new ArgumentException($"The specified tool choice '{toolChoice}' was not found in the list of tools");
-                        ToolChoice = new { type = "function", function = new { name = tool.Function.Name } };
-                    }
-                    else
-                    {
-                        ToolChoice = toolChoice;
-                    }
+                    ToolChoice = toolChoice;
                 }
 
                 foreach (var tool in toolList)
@@ -117,7 +115,7 @@ public ChatRequest(
         /// </param>
         /// <param name="responseFormat">
         /// An object specifying the format that the model must output.
-        /// Setting to <see cref="ChatResponseFormat.Json"/> or <see cref="ChatResponseFormat.JsonSchema"/> enables JSON mode,
+        /// Setting to <see cref="TextResponseFormat.Json"/> or <see cref="TextResponseFormat.JsonSchema"/> enables JSON mode,
         /// which guarantees the message the model generates is valid JSON.
         /// </param>
         /// <param name="frequencyPenalty">
@@ -167,7 +165,7 @@ public ChatRequest(
             int? maxTokens = null,
             int? number = null,
             double? presencePenalty = null,
-            ChatResponseFormat responseFormat = ChatResponseFormat.Auto,
+            TextResponseFormat responseFormat = TextResponseFormat.Auto,
             int? seed = null,
             string[] stops = null,
             double? temperature = null,
@@ -222,8 +220,8 @@ public ChatRequest(
             {
                 ResponseFormatObject = responseFormat switch
                 {
-                    ChatResponseFormat.Text or ChatResponseFormat.Json or ChatResponseFormat.JsonSchema => responseFormat,
-                    _ => null
+                    TextResponseFormat.Auto => null,
+                    _ => responseFormat
                 };
             }
 
@@ -380,7 +378,7 @@ public ChatRequest(
 
         /// <summary>
         /// An object specifying the format that the model must output.
-        /// Setting to <see cref="ChatResponseFormat.Json"/> or <see cref="ChatResponseFormat.JsonSchema"/> enables JSON mode,
+        /// Setting to <see cref="TextResponseFormat.Json"/> or <see cref="TextResponseFormat.JsonSchema"/> enables JSON mode,
         /// which guarantees the message the model generates is valid JSON.
         /// </summary>
         /// <remarks>
@@ -396,7 +394,7 @@ public ChatRequest(
 
         /// <summary>
         /// An object specifying the format that the model must output.
-        /// Setting to <see cref="ChatResponseFormat.Json"/> or <see cref="ChatResponseFormat.JsonSchema"/> enables JSON mode,
+        /// Setting to <see cref="TextResponseFormat.Json"/> or <see cref="TextResponseFormat.JsonSchema"/> enables JSON mode,
         /// which guarantees the message the model generates is valid JSON.
         /// </summary>
         /// <remarks>
@@ -407,7 +405,7 @@ public ChatRequest(
         /// </remarks>
         [Preserve]
         [JsonIgnore]
-        public ChatResponseFormat ResponseFormat => ResponseFormatObject ?? ChatResponseFormat.Auto;
+        public TextResponseFormat ResponseFormat => ResponseFormatObject ?? TextResponseFormat.Auto;
 
         /// <summary>
         /// This feature is in Beta. If specified, our system will make a best effort to sample deterministically,

OpenAI/Packages/com.openai.unity/Runtime/Common/ChatResponseFormat.cs

@@ -1,19 +1,34 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
+using System;
 using System.Runtime.Serialization;
 
 namespace OpenAI
 {
-    /// <summary>
-    /// TODO rename to TextResponseFormat
-    /// </summary>
+    [Obsolete("use TextResponseFormat instead")]
     public enum ChatResponseFormat
     {
         Auto = 0,
+        /// <summary>
+        /// Default response format. Used to generate text responses.
+        /// </summary>
         [EnumMember(Value = "text")]
         Text,
+        /// <summary>
+        /// JSON object response format.
+        /// An older method of generating JSON responses.
+        /// Using `json_schema` is recommended for models that support it.
+        /// Note that the model will not generate JSON without a system or user message
+        /// instructing it to do so.
+        /// </summary>
+        /// <remarks>
+        /// Not recommended for gpt-4o and newer models!
+        /// </remarks>
         [EnumMember(Value = "json_object")]
         Json,
+        /// <summary>
+        /// JSON Schema response format. Used to generate structured JSON responses.
+        /// </summary>
         [EnumMember(Value = "json_schema")]
         JsonSchema
     }

OpenAI/Packages/com.openai.unity/Runtime/Common/TextResponseFormat.cs

@@ -0,0 +1,35 @@
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using System;
+using System.Runtime.Serialization;
+
+namespace OpenAI
+{
+    public enum TextResponseFormat
+    {
+        Auto = 0,
+        /// <summary>
+        /// Default response format. Used to generate text responses.
+        /// </summary>
+        [EnumMember(Value = "text")]
+        Text,
+        /// <summary>
+        /// JSON object response format.
+        /// An older method of generating JSON responses.
+        /// Using `json_schema` is recommended for models that support it.
+        /// Note that the model will not generate JSON without a system or user message
+        /// instructing it to do so.
+        /// </summary>
+        /// <remarks>
+        /// Not recommended for gpt-4o and newer models!
+        /// </remarks>
+        [Obsolete("use JsonSchema instead")]
+        [EnumMember(Value = "json_object")]
+        Json,
+        /// <summary>
+        /// JSON Schema response format. Used to generate structured JSON responses.
+        /// </summary>
+        [EnumMember(Value = "json_schema")]
+        JsonSchema
+    }
+}

OpenAI/Packages/com.openai.unity/Runtime/Common/TextResponseFormat.cs.meta

@@ -13,26 +13,44 @@ public sealed class TextResponseFormatConfiguration
         public TextResponseFormatConfiguration() { }
 
         [Preserve]
+        [Obsolete("Use new overload with TextResponseFormat instead")]
         public TextResponseFormatConfiguration(ChatResponseFormat type)
         {
             if (type == ChatResponseFormat.JsonSchema)
             {
                 throw new ArgumentException("Use the constructor overload that accepts a JsonSchema object for ChatResponseFormat.JsonSchema.", nameof(type));
             }
+
+            Type = type switch
+            {
+                ChatResponseFormat.Text => TextResponseFormat.Text,
+                ChatResponseFormat.Json => TextResponseFormat.Json,
+                _ => throw new ArgumentOutOfRangeException(nameof(type), $"Unsupported response format: {type}")
+            };
+        }
+
+        [Preserve]
+        public TextResponseFormatConfiguration(TextResponseFormat type)
+        {
+            if (type == TextResponseFormat.JsonSchema)
+            {
+                throw new ArgumentException("Use the constructor overload that accepts a JsonSchema object for ChatResponseFormat.JsonSchema.", nameof(type));
+            }
+
             Type = type;
         }
 
         [Preserve]
         public TextResponseFormatConfiguration(JsonSchema schema)
         {
-            Type = ChatResponseFormat.JsonSchema;
+            Type = TextResponseFormat.JsonSchema;
             JsonSchema = schema;
         }
 
         [Preserve]
         [JsonConstructor]
         internal TextResponseFormatConfiguration(
-            [JsonProperty("type")] ChatResponseFormat type,
+            [JsonProperty("type")] TextResponseFormat type,
             [JsonProperty("json_schema")] JsonSchema schema)
         {
             Type = type;
@@ -41,15 +59,35 @@ internal TextResponseFormatConfiguration(
 
         [Preserve]
         [JsonProperty("type", DefaultValueHandling = DefaultValueHandling.Include)]
-        public ChatResponseFormat Type { get; private set; }
+        public TextResponseFormat Type { get; private set; }
 
         [Preserve]
         [JsonProperty("json_schema", DefaultValueHandling = DefaultValueHandling.Ignore)]
         public JsonSchema JsonSchema { get; private set; }
 
+#pragma warning disable CS0618 // Type or member is obsolete
+        [Preserve]
+        [Obsolete("Use new overload with TextResponseFormat instead")]
         public static implicit operator TextResponseFormatConfiguration(ChatResponseFormat type) => new(type);
 
         [Preserve]
-        public static implicit operator ChatResponseFormat(TextResponseFormatConfiguration format) => format.Type;
+        [Obsolete("Use new overload with TextResponseFormat instead")]
+        public static implicit operator ChatResponseFormat(TextResponseFormatConfiguration format)
+        {
+            return format.Type switch
+            {
+                TextResponseFormat.Text => ChatResponseFormat.Text,
+                TextResponseFormat.Json => ChatResponseFormat.Json,
+                TextResponseFormat.JsonSchema => ChatResponseFormat.JsonSchema,
+                _ => throw new ArgumentOutOfRangeException(nameof(format), $"Unsupported response format: {format.Type}")
+            };
+        }
+#pragma warning restore CS0618 // Type or member is obsolete
+
+        [Preserve]
+        public static implicit operator TextResponseFormatConfiguration(TextResponseFormat type) => new(type);
+
+        [Preserve]
+        public static implicit operator TextResponseFormat(TextResponseFormatConfiguration format) => format.Type;
     }
 }

OpenAI/Packages/com.openai.unity/Runtime/Common/TextResponseFormatConfiguration.cs

@@ -24,6 +24,7 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist
             {
                 "input_text" => jObject.ToObject<TextContent>(serializer),
                 "output_text" => jObject.ToObject<TextContent>(serializer),
+                "input_audio" => jObject.ToObject<AudioContent>(serializer),
                 "input_image" => jObject.ToObject<ImageContent>(serializer),
                 "input_file" => jObject.ToObject<FileContent>(serializer),
                 "refusal" => jObject.ToObject<RefusalContent>(serializer),

OpenAI/Packages/com.openai.unity/Runtime/Extensions/ResponseContentConverter.cs

@@ -16,21 +16,19 @@ public override TextResponseFormatConfiguration ReadJson(JsonReader reader, Type
             {
                 if (reader.TokenType is JsonToken.Null or JsonToken.String)
                 {
-                    return ChatResponseFormat.Auto;
+                    return TextResponseFormat.Auto;
                 }
 
                 return serializer.Deserialize<TextResponseFormatConfiguration>(reader);
             }
             catch (Exception e)
             {
-                throw new JsonSerializationException($"Error reading {nameof(ChatResponseFormat)} from JSON", e);
+                throw new JsonSerializationException($"Error reading {nameof(TextResponseFormat)} from JSON", e);
             }
         }
 
         [Preserve]
         public override void WriteJson(JsonWriter writer, TextResponseFormatConfiguration value, JsonSerializer serializer)
-        {
-            serializer.Serialize(writer, value);
-        }
+            => serializer.Serialize(writer, value);
     }
 }