com.openai.unity 5.0.8 (#104)

- Fixed AudioTranscriptionRequest.Temperature type. int? -> float?
- Updated Moderations Categories and Scores with new metrics

Author: StephenHodgson

OpenAI/Packages/com.openai.unity/Runtime/Audio/AudioTranscriptionRequest.cs

@@ -46,7 +46,7 @@ public AudioTranscriptionRequest(
             string model = null,
             string prompt = null,
             AudioResponseFormat responseFormat = AudioResponseFormat.Json,
-            int? temperature = null,
+            float? temperature = null,
             string language = null)
             : this(File.OpenRead(audioPath), Path.GetFileName(audioPath), model, prompt, responseFormat, temperature, language)
         {
@@ -89,7 +89,7 @@ public AudioTranscriptionRequest(
             string model = null,
             string prompt = null,
             AudioResponseFormat responseFormat = AudioResponseFormat.Json,
-            int? temperature = null,
+            float? temperature = null,
             string language = null)
             : this(new MemoryStream(audio.EncodeToWav()), $"{audio.name}.wav", model, prompt, responseFormat, temperature, language)
         {
@@ -136,7 +136,7 @@ public AudioTranscriptionRequest(
             string model = null,
             string prompt = null,
             AudioResponseFormat responseFormat = AudioResponseFormat.Json,
-            int? temperature = null,
+            float? temperature = null,
             string language = null)
         {
             Audio = audio;
@@ -196,7 +196,7 @@ public AudioTranscriptionRequest(
         /// the model will use log probability to automatically increase the temperature until certain thresholds are hit.<br/>
         /// Defaults to 0
         /// </summary>
-        public int? Temperature { get; }
+        public float? Temperature { get; }
 
         /// <summary>
         /// Optional, The language of the input audio.

OpenAI/Packages/com.openai.unity/Runtime/Moderations/Categories.cs

@@ -7,11 +7,26 @@ namespace OpenAI.Moderations
     public sealed class Categories
     {
         [JsonConstructor]
-        public Categories(bool hate, bool hateThreatening, bool selfHarm, bool sexual, bool sexualMinors, bool violence, bool violenceGraphic)
+        public Categories(
+            [JsonProperty("hate")] bool hate,
+            [JsonProperty("hate/threatening")] bool hateThreatening,
+            [JsonProperty("harassment")] bool harassment,
+            [JsonProperty("harassment/threatening")] bool harassmentThreatening,
+            [JsonProperty("self-harm")] bool selfHarm,
+            [JsonProperty("self-harm/intent")] bool selfHarmIntent,
+            [JsonProperty("self-harm/instructions")] bool selfHarmInstructions,
+            [JsonProperty("sexual")] bool sexual,
+            [JsonProperty("sexual/minors")] bool sexualMinors,
+            [JsonProperty("violence")] bool violence,
+            [JsonProperty("violence/graphic")] bool violenceGraphic)
         {
             Hate = hate;
             HateThreatening = hateThreatening;
+            Harassment = harassment;
+            HarassmentThreatening = harassmentThreatening;
             SelfHarm = selfHarm;
+            SelfHarmIntent = selfHarmIntent;
+            SelfHarmInstructions = selfHarmInstructions;
             Sexual = sexual;
             SexualMinors = sexualMinors;
             Violence = violence;
@@ -24,9 +39,21 @@ public Categories(bool hate, bool hateThreatening, bool selfHarm, bool sexual, b
         [JsonProperty("hate/threatening")]
         public bool HateThreatening { get; }
 
+        [JsonProperty("harassment")]
+        public bool Harassment { get; }
+
+        [JsonProperty("harassment/threatening")]
+        public bool HarassmentThreatening { get; }
+
         [JsonProperty("self-harm")]
         public bool SelfHarm { get; }
 
+        [JsonProperty("self-harm/intent")]
+        public bool SelfHarmIntent { get; }
+
+        [JsonProperty("self-harm/instructions")]
+        public bool SelfHarmInstructions { get; }
+
         [JsonProperty("sexual")]
         public bool Sexual { get; }
 

OpenAI/Packages/com.openai.unity/Runtime/Moderations/ModerationResult.cs

@@ -7,7 +7,10 @@ namespace OpenAI.Moderations
     public sealed class ModerationResult
     {
         [JsonConstructor]
-        public ModerationResult(Categories categories, Scores scores, bool flagged)
+        public ModerationResult(
+            [JsonProperty("categories")] Categories categories,
+            [JsonProperty("category_scores")] Scores scores,
+            [JsonProperty("flagged")] bool flagged)
         {
             Categories = categories;
             Scores = scores;

OpenAI/Packages/com.openai.unity/Runtime/Moderations/Scores.cs

@@ -1,7 +1,6 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Newtonsoft.Json;
-using System;
 
 namespace OpenAI.Moderations
 {
@@ -11,15 +10,23 @@ public sealed class Scores
         public Scores(
             [JsonProperty("hate")] double hate,
             [JsonProperty("hate/threatening")] double hateThreatening,
+            [JsonProperty("harassment")] double harassment,
+            [JsonProperty("harassment/threatening")] double harassmentThreatening,
             [JsonProperty("self-harm")] double selfHarm,
+            [JsonProperty("self-harm/intent")] double selfHarmIntent,
+            [JsonProperty("self-harm/instructions")] double selfHarmInstructions,
             [JsonProperty("sexual")] double sexual,
             [JsonProperty("sexual/minors")] double sexualMinors,
             [JsonProperty("violence")] double violence,
             [JsonProperty("violence/graphic")] double violenceGraphic)
         {
             Hate = hate;
             HateThreatening = hateThreatening;
+            Harassment = harassment;
+            HarassmentThreatening = harassmentThreatening;
             SelfHarm = selfHarm;
+            SelfHarmIntent = selfHarmIntent;
+            SelfHarmInstructions = selfHarmInstructions;
             Sexual = sexual;
             SexualMinors = sexualMinors;
             Violence = violence;
@@ -32,9 +39,21 @@ public Scores(
         [JsonProperty("hate/threatening")]
         public double HateThreatening { get; }
 
+        [JsonProperty("harassment")]
+        public double Harassment { get; }
+
+        [JsonProperty("harassment/threatening")]
+        public double HarassmentThreatening { get; }
+
         [JsonProperty("self-harm")]
         public double SelfHarm { get; }
 
+        [JsonProperty("self-harm/intent")]
+        public double SelfHarmIntent { get; }
+
+        [JsonProperty("self-harm/instructions")]
+        public double SelfHarmInstructions { get; }
+
         [JsonProperty("sexual")]
         public double Sexual { get; }
 
@@ -48,13 +67,17 @@ public Scores(
         public double ViolenceGraphic { get; }
 
         public override string ToString() =>
-            $"{"Hate:",-10}{Hate:0.00 E+00}{Environment.NewLine}" +
-            $"{"Threat:",-10}{HateThreatening:0.00 E+00}{Environment.NewLine}" +
-            $"{"Violence:",-10}{Violence:0.00 E+00}{Environment.NewLine}" +
-            $"{"Graphic:",-10}{ViolenceGraphic:0.00 E+00}{Environment.NewLine}" +
-            $"{"SelfHarm:",-10}{SelfHarm:0.00 E+00}{Environment.NewLine}" +
-            $"{"Sexual:",-10}{Sexual:0.00 E+00}{Environment.NewLine}" +
-            $"{"Minors:",-10}{SexualMinors:0.00 E+00}{Environment.NewLine}";
+            $"Hate: {Hate:0.00 e+00}\n" +
+            $"Hate/Threatening: {HateThreatening:0.00 e+00}\n" +
+            $"Harassment: {Harassment:0.00 e+00}\n" +
+            $"Harassment/Threatening: {HarassmentThreatening:0.00 e+00}\n" +
+            $"Self-Harm: {SelfHarm:0.00 e+00}\n" +
+            $"Self-Harm/Intent: {SelfHarmIntent:0.00 e+00}\n" +
+            $"Self-Harm/Instructions: {SelfHarmInstructions:0.00 e+00}\n" +
+            $"Sexual: {Sexual:0.00 e+00}\n" +
+            $"Sexual/Minors: {SexualMinors:0.00 e+00}\n" +
+            $"Violence: {Violence:0.00 e+00}\n" +
+            $"Violence/Graphic: {ViolenceGraphic:0.00 e+00}\n";
 
         public static implicit operator string(Scores scores) => scores.ToString();
     }

OpenAI/Packages/com.openai.unity/Tests/TestFixture_07_Audio.cs

@@ -18,7 +18,7 @@ public async Task Test_1_Transcription_AudioClip()
             Assert.IsNotNull(api.AudioEndpoint);
             var audioPath = AssetDatabase.GUIDToAssetPath("259eaa73cab84284eac307d3134c3ade");
             var audioClip = AssetDatabase.LoadAssetAtPath<AudioClip>(audioPath);
-            using var request = new AudioTranscriptionRequest(audioClip, language: "en");
+            using var request = new AudioTranscriptionRequest(audioClip, temperature: 0.1f, language: "en");
             var result = await api.AudioEndpoint.CreateTranscriptionAsync(request);
             Assert.IsNotNull(result);
             Debug.Log(result);
@@ -30,7 +30,7 @@ public async Task Test_1_Transcription_Path()
             var api = new OpenAIClient(OpenAIAuthentication.Default.LoadFromEnvironment());
             Assert.IsNotNull(api.AudioEndpoint);
             var audioPath = AssetDatabase.GUIDToAssetPath("259eaa73cab84284eac307d3134c3ade");
-            using var request = new AudioTranscriptionRequest(Path.GetFullPath(audioPath), language: "en");
+            using var request = new AudioTranscriptionRequest(Path.GetFullPath(audioPath), temperature: 0.1f, language: "en");
             var result = await api.AudioEndpoint.CreateTranscriptionAsync(request);
             Assert.IsNotNull(result);
             Debug.Log(result);

OpenAI/Packages/com.openai.unity/Tests/TestFixture_10_Moderations.cs

@@ -2,8 +2,8 @@
 
 using NUnit.Framework;
 using OpenAI.Moderations;
-using System;
 using System.Threading.Tasks;
+using UnityEngine;
 
 namespace OpenAI.Tests
 {
@@ -18,7 +18,7 @@ public async Task Test_1_Moderate()
 
             var response = await api.ModerationsEndpoint.CreateModerationAsync(new ModerationsRequest("I love you"));
             Assert.IsNotNull(response);
-            Console.WriteLine(response.Results?[0]?.Scores?.ToString());
+            Debug.Log(response.Results?[0]?.Scores?.ToString());
         }
     }
 }

OpenAI/Packages/com.openai.unity/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": "5.0.7",
+  "version": "5.0.8",
   "unity": "2021.3",
   "documentationUrl": "https://github.com/RageAgainstThePixel/com.openai.unity#documentation",
   "changelogUrl": "https://github.com/RageAgainstThePixel/com.openai.unity/releases",
@@ -17,7 +17,7 @@
     "url": "https://github.com/StephenHodgson"
   },
   "dependencies": {
-    "com.utilities.rest": "2.1.4",
+    "com.utilities.rest": "2.1.6",
     "com.utilities.encoder.wav": "1.0.4"
   },
   "samples": [

OpenAI/Packages/manifest.json

@@ -1,7 +1,7 @@
 {
   "dependencies": {
     "com.unity.ide.rider": "3.0.24",
-    "com.unity.ide.visualstudio": "2.0.18",
+    "com.unity.ide.visualstudio": "2.0.20",
     "com.unity.textmeshpro": "3.0.6",
     "com.utilities.buildpipeline": "1.1.7"
   },