OpenAI-DotNet 8.8.3 (#495)

- Fix regression ObjectDisposedException from OpenAIBaseEndpoint refactoring
- Add Azure Blob Batch API compatible fields for CreateBatchRequest
- Added DurationUsage
- Updated ConversationItemInputAudioTranscriptionResponse to include logprobs and usage

---------

Co-authored-by: Alec Chan <34929371+aechan@users.noreply.github.com>

Author: StephenHodgson

OpenAI-DotNet-Tests/TestFixture_14_Responses.cs

@@ -193,7 +193,12 @@ async Task StreamCallback(string @event, IServerSentEvent sseEvent)
                         Assert.IsNotEmpty(functionToolCall.Name);
                         Assert.IsTrue(functionToolCall.Name.Contains(nameof(DateTimeUtility.GetDateTime)));
                         Assert.NotNull(functionToolCall.Arguments);
-                        conversation.Add(functionToolCall);
+
+                        if (conversation.All(i => i.Id != functionToolCall.Id))
+                        {
+                            conversation.Add(functionToolCall);
+                        }
+
                         var output = await functionToolCall.InvokeFunctionAsync();
                         conversation.Add(output);
                         break;

OpenAI-DotNet/Batch/BatchOutputFolder.cs

@@ -0,0 +1,20 @@
+using System.Text.Json.Serialization;
+
+namespace OpenAI.Batch
+{
+    public sealed class BatchOutputFolder
+    {
+        public BatchOutputFolder(string url)
+        {
+            Url = url;
+        }
+
+        /// <summary>
+        /// The URL of the blob storage folder where the batch output will be written.
+        /// </summary>
+        [JsonPropertyName("url")]
+        public string Url { get; }
+
+        public static implicit operator BatchOutputFolder(string url) => new(url);
+    }
+}

OpenAI-DotNet/Batch/BatchResponse.cs

@@ -186,6 +186,27 @@ public DateTime? CancelledAt
         [JsonPropertyName("metadata")]
         public IReadOnlyDictionary<string, object> Metadata { get; private set; }
 
+        /// <summary>
+        /// The URL of the blob storage location where any errors encountered during processing will be written.
+        /// </summary>
+        [JsonInclude]
+        [JsonPropertyName("error_blob")]
+        public string ErrorBlob { get; private set; }
+
+        /// <summary>
+        /// The URL of the blob storage location where the batch output will be written.
+        /// </summary>
+        [JsonInclude]
+        [JsonPropertyName("output_blob")]
+        public string OutputBlob { get; private set; }
+
+        /// <summary>
+        /// The URL of the blob storage location where the batch input was read from.
+        /// </summary>
+        [JsonInclude]
+        [JsonPropertyName("input_blob")]
+        public string InputBlob { get; private set; }
+
         public override string ToString() => Id;
 
         public static implicit operator string(BatchResponse response) => response?.ToString();

OpenAI-DotNet/Batch/CreateBatchRequest.cs

@@ -25,12 +25,21 @@ public sealed class CreateBatchRequest
         /// <param name="metadata">
         /// Optional custom metadata for the batch.
         /// </param>
-        public CreateBatchRequest(string inputFileId, string endpoint, IReadOnlyDictionary<string, object> metadata = null)
+        /// <param name="inputBlob">Azure blob</param>
+        /// <param name="outputFolder"><see cref="BatchOutputFolder"/>.</param>
+        public CreateBatchRequest(
+            string inputFileId,
+            string endpoint,
+            IReadOnlyDictionary<string, object> metadata = null,
+            string inputBlob = null,
+            BatchOutputFolder outputFolder = null)
         {
             InputFileId = inputFileId;
             Endpoint = endpoint;
             CompletionWindow = DefaultCompletionWindow;
             Metadata = metadata;
+            InputBlob = inputBlob;
+            OutputFolder = outputFolder;
         }
 
         [JsonPropertyName("input_file_id")]
@@ -43,6 +52,15 @@ public CreateBatchRequest(string inputFileId, string endpoint, IReadOnlyDictiona
         public string CompletionWindow { get; }
 
         [JsonPropertyName("metadata")]
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
         public IReadOnlyDictionary<string, object> Metadata { get; }
+
+        [JsonPropertyName("input_blob")]
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
+        public string InputBlob { get; }
+
+        [JsonPropertyName("output_folder")]
+        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
+        public BatchOutputFolder OutputFolder { get; }
     }
 }

OpenAI-DotNet/Common/DurationUsage.cs

@@ -0,0 +1,22 @@
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+using OpenAI.Extensions;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace OpenAI
+{
+    public sealed class DurationUsage
+    {
+        [JsonInclude]
+        [JsonPropertyName("seconds")]
+        public float Seconds { get; }
+
+        [JsonInclude]
+        [JsonPropertyName("type")]
+        public string Type { get; }
+
+        public override string ToString()
+            => JsonSerializer.Serialize(this, ResponseExtensions.DebugJsonOptions);
+    }
+}

OpenAI-DotNet/Common/OpenAIBaseEndpoint.cs

@@ -52,30 +52,24 @@ public bool EnableDebug
         internal virtual IReadOnlyDictionary<string, IEnumerable<string>> Headers => null;
 
         protected Task<HttpResponseMessage> GetAsync(string uri, CancellationToken cancellationToken)
-        {
-            using var message = new HttpRequestMessage(HttpMethod.Get, uri);
-            return SendAsync(message, cancellationToken);
-        }
+            => SendAsync(new(HttpMethod.Get, uri), cancellationToken);
 
         protected Task<HttpResponseMessage> PostAsync(string uri, HttpContent content, CancellationToken cancellationToken)
         {
-            using var message = new HttpRequestMessage(HttpMethod.Post, uri);
+            var message = new HttpRequestMessage(HttpMethod.Post, uri);
             message.Content = content;
             return SendAsync(message, cancellationToken);
         }
 
         protected Task<HttpResponseMessage> PatchAsync(string uri, HttpContent content, CancellationToken cancellationToken)
         {
-            using var message = new HttpRequestMessage(HttpMethod.Patch, uri);
+            var message = new HttpRequestMessage(HttpMethod.Patch, uri);
             message.Content = content;
             return SendAsync(message, cancellationToken);
         }
 
         protected Task<HttpResponseMessage> DeleteAsync(string uri, CancellationToken cancellationToken)
-        {
-            using var message = new HttpRequestMessage(HttpMethod.Delete, uri);
-            return SendAsync(message, cancellationToken);
-        }
+            => SendAsync(new(HttpMethod.Delete, uri), cancellationToken);
 
         protected Task<Stream> GetStreamAsync(string uri, CancellationToken cancellationToken)
             => HttpClient.GetStreamAsync(uri, cancellationToken);

OpenAI-DotNet/Responses/Prompt.cs OpenAI-DotNet/Common/Prompt.csOpenAI-DotNet/Responses/Prompt.cs renamed to OpenAI-DotNet/Common/Prompt.cs

@@ -4,7 +4,7 @@
 using System.Collections.Generic;
 using System.Text.Json.Serialization;
 
-namespace OpenAI.Responses
+namespace OpenAI
 {
     public sealed class Prompt
     {

OpenAI-DotNet/OpenAI-DotNet.csproj

@@ -29,8 +29,15 @@ More context [on Roger Pincombe's blog](https://rogerpincombe.com/openai-dotnet-
     <AssemblyOriginatorKeyFile>OpenAI-DotNet.pfx</AssemblyOriginatorKeyFile>
     <IncludeSymbols>true</IncludeSymbols>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
-    <Version>8.8.2</Version>
+    <Version>8.8.3</Version>
     <PackageReleaseNotes>
+Version 8.8.3
+- Fix regression ObjectDisposedException from OpenAIBaseEndpoint refactoring
+- Add Azure Blob Batch API compatible fields for CreateBatchRequest
+- Added DurationUsage
+- Updated ConversationItemInputAudioTranscriptionResponse to include logprobs and usage
+- Update Realtime.SessionConfiguration with Prompt and Speed parameters
+- Move Realtime.Prompt to common namespace
 Version 8.8.2
 - Add file_url for responses api
 - Added NoiseReductionSettings for RealtimeConfiguration

OpenAI-DotNet/Realtime/ConversationItemInputAudioTranscriptionResponse.cs

@@ -1,5 +1,6 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
+using System.Collections.Generic;
 using System.Text.Json.Serialization;
 
 namespace OpenAI.Realtime
@@ -23,6 +24,13 @@ public sealed class ConversationItemInputAudioTranscriptionResponse : BaseRealti
         [JsonPropertyName("item_id")]
         public string ItemId { get; private set; }
 
+        /// <summary>
+        /// The log probabilities of the transcription.
+        /// </summary>
+        [JsonInclude]
+        [JsonPropertyName("logprobs")]
+        public IReadOnlyList<LogProbInfo> LogProbs { get; }
+
         /// <summary>
         /// The index of the content part containing the audio.
         /// </summary>
@@ -37,6 +45,10 @@ public sealed class ConversationItemInputAudioTranscriptionResponse : BaseRealti
         [JsonPropertyName("transcript")]
         public string Transcript { get; private set; }
 
+        [JsonInclude]
+        [JsonPropertyName("usage")]
+        public object Usage { get; }
+
         /// <summary>
         /// Details of the transcription error.
         /// </summary>
@@ -49,5 +61,8 @@ public sealed class ConversationItemInputAudioTranscriptionResponse : BaseRealti
 
         [JsonIgnore]
         public bool IsFailed => Type.Contains("failed");
+
+        public string PrintUsage()
+            => Usage?.ToString() ?? "";
     }
 }