com.openai.unity 8.1.1

- Added overloads to Assistant streaming event callbacks to include event name: Func<String, IServerSentEvent, Task>

Author: StephenHodgson

Runtime/Threads/ThreadsEndpoint.cs

@@ -7,7 +7,6 @@
 using System.Collections.Generic;
 using System.Threading;
 using System.Threading.Tasks;
-using UnityEngine;
 using Utilities.WebRequestRest;
 using Utilities.WebRequestRest.Interfaces;
 
@@ -211,6 +210,20 @@ public async Task<RunResponse> CreateRunAsync(string threadId, CreateRunRequest
         /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
         /// <returns><see cref="RunResponse"/>.</returns>
         public async Task<RunResponse> CreateRunAsync(string threadId, CreateRunRequest request = null, Func<IServerSentEvent, Task> streamEventHandler = null, CancellationToken cancellationToken = default)
+            => await CreateRunAsync(threadId, request, streamEventHandler == null ? null : async (_, serverSentEvent) =>
+            {
+                await streamEventHandler.Invoke(serverSentEvent);
+            }, cancellationToken);
+
+        /// <summary>
+        /// Create a run.
+        /// </summary>
+        /// <param name="threadId">The id of the thread to run.</param>
+        /// <param name="request"><see cref="CreateRunRequest"/>.</param>
+        /// <param name="streamEventHandler">Optional, <see cref="Func{String, IServerSentEvent, Task}"/> stream callback handler.</param>
+        /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
+        /// <returns><see cref="RunResponse"/>.</returns>
+        public async Task<RunResponse> CreateRunAsync(string threadId, CreateRunRequest request = null, Func<string, IServerSentEvent, Task> streamEventHandler = null, CancellationToken cancellationToken = default)
         {
             if (request == null || string.IsNullOrWhiteSpace(request.AssistantId))
             {
@@ -248,6 +261,19 @@ public async Task<RunResponse> CreateThreadAndRunAsync(CreateThreadAndRunRequest
         /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
         /// <returns><see cref="RunResponse"/>.</returns>
         public async Task<RunResponse> CreateThreadAndRunAsync(CreateThreadAndRunRequest request = null, Func<IServerSentEvent, Task> streamEventHandler = null, CancellationToken cancellationToken = default)
+            => await CreateThreadAndRunAsync(request, streamEventHandler == null ? null : async (_, serverSentEvent) =>
+            {
+                await streamEventHandler.Invoke(serverSentEvent);
+            }, cancellationToken);
+
+        /// <summary>
+        /// Create a thread and run it in one request.
+        /// </summary>
+        /// <param name="request"><see cref="CreateThreadAndRunRequest"/>.</param>
+        /// <param name="streamEventHandler">Optional, <see cref="Func{String, IServerSentEvent, Task}"/> stream callback handler.</param>
+        /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
+        /// <returns><see cref="RunResponse"/>.</returns>
+        public async Task<RunResponse> CreateThreadAndRunAsync(CreateThreadAndRunRequest request = null, Func<string, IServerSentEvent, Task> streamEventHandler = null, CancellationToken cancellationToken = default)
         {
             if (request == null || string.IsNullOrWhiteSpace(request.AssistantId))
             {
@@ -324,6 +350,23 @@ public async Task<RunResponse> SubmitToolOutputsAsync(string threadId, string ru
         /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
         /// <returns><see cref="RunResponse"/>.</returns>
         public async Task<RunResponse> SubmitToolOutputsAsync(string threadId, string runId, SubmitToolOutputsRequest request, Func<IServerSentEvent, Task> streamEventHandler = null, CancellationToken cancellationToken = default)
+            => await SubmitToolOutputsAsync(threadId, runId, request, streamEventHandler == null ? null : async (_, serverSentEvent) =>
+            {
+                await streamEventHandler.Invoke(serverSentEvent);
+            }, cancellationToken);
+
+        /// <summary>
+        /// When a run has the status: "requires_action" and required_action.type is submit_tool_outputs,
+        /// this endpoint can be used to submit the outputs from the tool calls once they're all completed.
+        /// All outputs must be submitted in a single request.
+        /// </summary>
+        /// <param name="threadId">The id of the thread to which this run belongs.</param>
+        /// <param name="runId">The id of the run that requires the tool output submission.</param>
+        /// <param name="request"><see cref="SubmitToolOutputsRequest"/>.</param>
+        /// <param name="streamEventHandler">Optional, <see cref="Func{String, IServerSentEvent, Task}"/> stream callback handler.</param>
+        /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
+        /// <returns><see cref="RunResponse"/>.</returns>
+        public async Task<RunResponse> SubmitToolOutputsAsync(string threadId, string runId, SubmitToolOutputsRequest request, Func<string, IServerSentEvent, Task> streamEventHandler = null, CancellationToken cancellationToken = default)
         {
             request.Stream = streamEventHandler != null;
             var payload = JsonConvert.SerializeObject(request, OpenAIClient.JsonSerializationOptions);
@@ -435,21 +478,25 @@ public async Task<MessageFileResponse> RetrieveFileAsync(string threadId, string
 
         #endregion Files (Obsolete)
 
-        private async Task<RunResponse> StreamRunAsync(string endpoint, string payload, Func<IServerSentEvent, Task> streamEventHandler, CancellationToken cancellationToken = default)
+        private async Task<RunResponse> StreamRunAsync(string endpoint, string payload, Func<string, IServerSentEvent, Task> streamEventHandler, CancellationToken cancellationToken = default)
         {
             RunResponse run = null;
             RunStepResponse runStep = null;
             MessageResponse message = null;
 
             var response = await Rest.PostAsync(endpoint, payload, async (sseResponse, ssEvent) =>
             {
+                IServerSentEvent serverSentEvent = default;
+                var @event = ssEvent.Value.Value<string>();
+
                 try
                 {
                     switch (ssEvent.Value.Value<string>())
                     {
                         case "thread.created":
-                            await streamEventHandler.Invoke(sseResponse.Deserialize<ThreadResponse>(client));
-                            return;
+                            serverSentEvent = sseResponse.Deserialize<ThreadResponse>(client);
+
+                            break;
                         case "thread.run.created":
                         case "thread.run.queued":
                         case "thread.run.in_progress":
@@ -471,8 +518,9 @@ private async Task<RunResponse> StreamRunAsync(string endpoint, string payload,
                                 run.AppendFrom(partialRun);
                             }
 
-                            await streamEventHandler.Invoke(run);
-                            return;
+                            serverSentEvent = run;
+
+                            break;
                         case "thread.run.step.created":
                         case "thread.run.step.in_progress":
                         case "thread.run.step.delta":
@@ -492,8 +540,9 @@ private async Task<RunResponse> StreamRunAsync(string endpoint, string payload,
                                 runStep.AppendFrom(partialRunStep);
                             }
 
-                            await streamEventHandler.Invoke(runStep);
-                            return;
+                            serverSentEvent = runStep;
+
+                            break;
                         case "thread.message.created":
                         case "thread.message.in_progress":
                         case "thread.message.delta":
@@ -511,20 +560,28 @@ private async Task<RunResponse> StreamRunAsync(string endpoint, string payload,
                                 message.AppendFrom(partialMessage);
                             }
 
-                            await streamEventHandler.Invoke(message);
-                            return;
+                            serverSentEvent = message;
+
+                            break;
                         case "error":
-                            await streamEventHandler.Invoke(sseResponse.Deserialize<Error>(client));
-                            return;
+                            serverSentEvent = sseResponse.Deserialize<Error>(client);
+
+                            break;
                         default:
                             // if not properly handled raise it up to caller to deal with it themselves.
-                            await streamEventHandler.Invoke(ssEvent);
-                            return;
+                            serverSentEvent = ssEvent;
+                            break;
                     }
+
                 }
                 catch (Exception e)
                 {
-                    Debug.LogError($"{ssEvent}\n{e}");
+                    @event = "error";
+                    serverSentEvent = new Error(e);
+                }
+                finally
+                {
+                    await streamEventHandler.Invoke(@event, serverSentEvent);
                 }
             }, new RestParameters(client.DefaultRequestHeaders), cancellationToken);
             response.Validate(EnableDebug);

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.1.0",
+  "version": "8.1.1",
   "unity": "2021.3",
   "documentationUrl": "https://github.com/RageAgainstThePixel/com.openai.unity#documentation",
   "changelogUrl": "https://github.com/RageAgainstThePixel/com.openai.unity/releases",