Error Handling (#4)

**Added**
- Response type interface created, all responses now have an Error field.
- Missing fields in Model and OpenAIFile added.
- Error check in DispatchRequest methods.

**Changed**
- Model struct is now OpenAIModel class.

**Fixed**
- Typo in FineTune and Choice fields.

Author: srcnalt

Runtime/DataTypes.cs

@@ -7,7 +7,7 @@ public struct Choice
     {
         public string Text { get; set; }
         public int? Index { get; set; }
-        public int? Logpropbs { get; set; }
+        public int? Logprobs { get; set; }
         public string FinishReason { get; set; }
     }
 
@@ -18,7 +18,7 @@ public struct Usage
         public string TotalTokens { get; set; }
     }
 
-    public struct OpenAIFile
+    public class OpenAIFile
     {
         public string Id { get; set; }
         public string Object { get; set; }
@@ -27,23 +27,46 @@ public struct OpenAIFile
         public string Filename { get; set; }
         public string Purpose { get; set; }
         public object StatusDetails { get; set; }
+        public string Status { get; set; }
+    }
+
+    public class OpenAIFileResponse : OpenAIFile, IResponse
+    {
+        public ApiError Error { get; set; }
+    }
+
+    public class ApiError
+    {
+        public string Message;
+        public string Type;
+        public object Param;
+        public object Code;
     }
     #endregion
 
     #region Models API Data Types
-    public struct ListModelsResponse
+    public struct ListModelsResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Object { get; set; }
-        public Model[] Data { get; set; }
+        public OpenAIModel[] Data { get; set; }
     }
 
-    public struct Model
+    public class OpenAIModel
     {
         public string Id { get; set; }
         public string Object { get; set; }
         public string OwnedBy { get; set; }
+        public long Created { get; set; }
+        public string Root { get; set; }
+        public string Parent { get; set; }
         public Dictionary<string, object>[] Permission { get; set; }
     }
+
+    public class OpenAIModelResponse : OpenAIModel, IResponse
+    {
+        public ApiError Error { get; set; }
+    }
     #endregion
 
     #region Completions API Data Types
@@ -67,8 +90,9 @@ public sealed class CreateCompletionRequest
         public string User { get; set; }
     }
 
-    public struct CreateCompletionResponse
+    public struct CreateCompletionResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Id { get; set; }
         public string Object { get; set; }
         public long Created { get; set; }
@@ -89,8 +113,9 @@ public sealed class CreateEditRequest
         public int? N { get; set; } = 1;
     }
 
-    public struct CreateEditResponse
+    public struct CreateEditResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Object { get; set; }
         public long Created { get; set; }
         public Choice[] Choices { get; set; }
@@ -124,8 +149,9 @@ public sealed class CreateImageVariationRequest: CreateImageRequestBase
         public string Image { get; set; }
     }
 
-    public struct CreateImageResponse
+    public struct CreateImageResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public long Created { get; set; }
         public ImageData[] Data { get; set; }
     }
@@ -145,8 +171,9 @@ public struct CreateEmbeddingsRequest
         public string User { get; set; }
     }
 
-    public struct CreateEmbeddingsResponse
+    public struct CreateEmbeddingsResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Object { get; set; }
         public EmbeddingData[] Data;
         public string Model { get; set; }
@@ -162,14 +189,16 @@ public struct EmbeddingData
     #endregion
 
     #region Files API Data Types
-    public struct ListFilesResponse
+    public struct ListFilesResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Object { get; set; }
         public OpenAIFile[] Data { get; set; }
     }
 
-    public struct DeleteResponse
+    public struct DeleteResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Id { get; set; }
         public string Object { get; set; }
         public bool Deleted { get; set; }
@@ -199,27 +228,29 @@ public class CreateFineTuneRequest
         public string Suffix { get; set; }
     }
 
-    public struct ListFineTunesResponse
+    public struct ListFineTunesResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Object { get; set; }
         public FineTune[] Data { get; set; }
     }
 
-    public struct ListFineTuneEventsResponse
+    public struct ListFineTuneEventsResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Object { get; set; }
         public FineTuneEvent[] Data { get; set; }
     }
 
-    public struct FineTune
+    public class FineTune
     {
         public string Id { get; set; }
         public string Object { get; set; }
         public long CreatedAt { get; set; }
         public long UpdatedAt { get; set; }
         public string Model { get; set; }
         public string FineTunedModel { get; set; }
-        public string OrganizationID { get; set; }
+        public string OrganizationId { get; set; }
         public string Status { get; set; }
         public Dictionary<string, object> Hyperparams { get; set; }
         public OpenAIFile[] TrainingFiles { get; set; }
@@ -228,6 +259,11 @@ public struct FineTune
         public FineTuneEvent[] Events { get; set; }
     }
 
+    public class FineTuneResponse : FineTune, IResponse
+    {
+        public ApiError Error { get; set; }
+    }
+
     public struct FineTuneEvent
     {
         public string Object { get; set; }
@@ -244,8 +280,9 @@ public class CreateModerationRequest
         public string Model { get; set; } = ModerationModel.Latest;
     }
 
-    public struct CreateModerationResponse
+    public struct CreateModerationResponse: IResponse
     {
+        public ApiError Error { get; set; }
         public string Id { get; set; }
         public string Model { get; set; }
         public ModerationResult[] Results { get; set; }

Runtime/Interfaces.meta

@@ -0,0 +1,7 @@
+namespace OpenAI
+{
+    public interface IResponse
+    {
+        public ApiError Error { get; set; }
+    }
+}

Runtime/Interfaces/IResponse.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Text;
 using Newtonsoft.Json;
 using System.Net.Http;
@@ -26,7 +27,8 @@ public class OpenAIApi
             ContractResolver = new DefaultContractResolver()
             {
                 NamingStrategy = new CustomNamingStrategy()
-            }
+            },
+            MissingMemberHandling = MissingMemberHandling.Error
         };
 
         /// <summary>
@@ -37,7 +39,7 @@ public class OpenAIApi
         /// <param name="payload">An optional byte array of json payload to include in the request.</param>
         /// <typeparam name="T">Response type of the request.</typeparam>
         /// <returns>A Task containing the response from the request as the specified type.</returns>
-        private async Task<T> DispatchRequest<T>(string path, HttpMethod method, byte[] payload = null)
+        private async Task<T> DispatchRequest<T>(string path, HttpMethod method, byte[] payload = null) where T: IResponse
         {
             var client = new HttpClient();
             client.SetHeaders(configuration, ContentType.ApplicationJson);
@@ -51,7 +53,16 @@ private async Task<T> DispatchRequest<T>(string path, HttpMethod method, byte[]
 
             var response = await client.SendAsync(request);
             var content = await response.Content.ReadAsStringAsync();
-            return JsonConvert.DeserializeObject<T>(content, jsonSerializerSettings);
+
+            var data = JsonConvert.DeserializeObject<T>(content, jsonSerializerSettings);
+        
+            if (data?.Error != null)
+            {
+                ApiError error = data.Error;
+                throw new Exception($"Error Message: {error.Message}\nError Type: {error.Type}\n");
+            }
+
+            return data;
         }
 
         /// <summary>
@@ -61,14 +72,23 @@ private async Task<T> DispatchRequest<T>(string path, HttpMethod method, byte[]
         /// <param name="form">A multi-part data form to upload with the request.</param>
         /// <typeparam name="T">Response type of the request.</typeparam>
         /// <returns>A Task containing the response from the request as the specified type.</returns>
-        private async Task<T> DispatchRequest<T>(string path, MultipartFormDataContent form)
+        private async Task<T> DispatchRequest<T>(string path, MultipartFormDataContent form) where T: IResponse
         {
             var client = new HttpClient();
             client.SetHeaders(configuration, ContentType.MultipartFormData);
 
             var response = await client.PostAsync(path, form);
             var content = await response.Content.ReadAsStringAsync();
-            return JsonConvert.DeserializeObject<T>(content, jsonSerializerSettings);
+            
+            var data = JsonConvert.DeserializeObject<T>(content, jsonSerializerSettings);
+
+            if (data != null && data.Error != null)
+            {
+                ApiError error = data.Error;
+                throw new Exception($"Error Message: {error.Message}\nError Type: {error.Type}\n");
+            }
+
+            return data;
         }
 
         /// <summary>
@@ -97,10 +117,10 @@ public async Task<ListModelsResponse> ListModels()
         /// </summary>
         /// <param name="id">The ID of the model to use for this request</param>
         /// <returns>See <see cref="Model"/></returns>
-        public async Task<Model> RetrieveModel(string id)
+        public async Task<OpenAIModel> RetrieveModel(string id)
         {
             var path = $"{BASE_PATH}/models/{id}";
-            return await DispatchRequest<Model>(path, HttpMethod.Get);
+            return await DispatchRequest<OpenAIModelResponse>(path, HttpMethod.Get);
         }
 
         /// <summary>
@@ -216,7 +236,7 @@ public async Task<OpenAIFile> CreateFile(CreateFileRequest request)
             form.AddJsonl(request.File, "file");
             form.AddValue(request.Purpose, "purpose");
 
-            return await DispatchRequest<OpenAIFile>(path, form);
+            return await DispatchRequest<OpenAIFileResponse>(path, form);
         }
 
         /// <summary>
@@ -238,7 +258,7 @@ public async Task<DeleteResponse> DeleteFile(string id)
         public async Task<OpenAIFile> RetrieveFile(string id)
         {
             var path = $"{BASE_PATH}/files/{id}";
-            return await DispatchRequest<OpenAIFile>(path, HttpMethod.Get);
+            return await DispatchRequest<OpenAIFileResponse>(path, HttpMethod.Get);
         }
 
         /// <summary>
@@ -249,7 +269,7 @@ public async Task<OpenAIFile> RetrieveFile(string id)
         public async Task<OpenAIFile> DownloadFile(string id)
         {
             var path = $"{BASE_PATH}/files/{id}/content";
-            return await DispatchRequest<OpenAIFile>(path, HttpMethod.Get);
+            return await DispatchRequest<OpenAIFileResponse>(path, HttpMethod.Get);
         }
 
         /// <summary>
@@ -262,7 +282,7 @@ public async Task<FineTune> CreateFineTune(CreateFineTuneRequest request)
         {
             var path = $"{BASE_PATH}/fine-tunes";
             var payload = CreatePayload(request);
-            return await DispatchRequest<FineTune>(path, HttpMethod.Post, payload);
+            return await DispatchRequest<FineTuneResponse>(path, HttpMethod.Post, payload);
         }
 
         /// <summary>
@@ -283,7 +303,7 @@ public async Task<ListFineTunesResponse> ListFineTunes()
         public async Task<FineTune> RetrieveFineTune(string id)
         {
             var path = $"{BASE_PATH}/fine-tunes/{id}";
-            return await DispatchRequest<FineTune>(path, HttpMethod.Get);
+            return await DispatchRequest<FineTuneResponse>(path, HttpMethod.Get);
         }
 
         /// <summary>
@@ -294,7 +314,7 @@ public async Task<FineTune> RetrieveFineTune(string id)
         public async Task<FineTune> CancelFineTune(string id)
         {
             var path = $"{BASE_PATH}/fine-tunes/{id}/cancel";
-            return await DispatchRequest<FineTune>(path, HttpMethod.Post);
+            return await DispatchRequest<FineTuneResponse>(path, HttpMethod.Post);
         }
 
         /// <summary>

Runtime/Interfaces/IResponse.cs.meta

@@ -1,6 +1,6 @@
 {
   "name": "com.srcnalt.openai-unity",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "displayName": "OpenAI Unity",
   "description": "An unofficial OpenAI Unity Package that aims to help you use OpenAI API directly in Unity Game engine.",
   "unity": "2020.3",