com.openai.unity 7.7.1 (#196)

- More Function utilities and invoking methods
  - Added FunctionPropertyAttribute to help better inform the feature how to format the Function json
  - Added FromFunc<,> overloads for convenance
  - Fixed invoke args sometimes being casting to wrong type
  - Added additional protections for static and instanced function calls
  - Added additional tool utilities:
    - Tool.ClearRegisteredTools
    - Tool.IsToolRegistered(Tool) - Tool.TryRegisterTool(Tool)
- Updated Sample Chat Behaviour with updated tool implementations
- com.utilities.rest -> 2.5.3

Author: StephenHodgson

Runtime/Assistants/AssistantExtensions.cs

@@ -121,7 +121,7 @@ public static async Task<AssistantFileResponse> RetrieveFileAsync(this Assistant
         //    => await assistantFile.Client.FilesEndpoint.DownloadFileAsync(assistantFile.Id, directory, deleteCachedFile, cancellationToken);
 
         /// <summary>
-        /// Remove AssistantFile.
+        /// Remove the file from the assistant it is attached to.
         /// </summary>
         /// <remarks>
         /// Note that removing an AssistantFile does not delete the original File object,
@@ -135,7 +135,7 @@ public static async Task<bool> RemoveFileAsync(this AssistantFileResponse file,
             => await file.Client.AssistantsEndpoint.RemoveFileAsync(file.AssistantId, file.Id, cancellationToken);
 
         /// <summary>
-        /// Remove AssistantFile.
+        /// Remove the file from the assistant it is attached to.
         /// </summary>
         /// <remarks>
         /// Note that removing an AssistantFile does not delete the original File object,

Runtime/Assistants/AssistantsEndpoint.cs

@@ -10,7 +10,7 @@
 
 namespace OpenAI.Assistants
 {
-    public class AssistantsEndpoint : OpenAIBaseEndpoint
+    public sealed class AssistantsEndpoint : OpenAIBaseEndpoint
     {
         internal AssistantsEndpoint(OpenAIClient client) : base(client) { }
 

Runtime/Audio/AudioEndpoint.cs

@@ -46,6 +46,7 @@ internal AudioEndpoint(OpenAIClient client) : base(client) { }
         /// <param name="request"><see cref="SpeechRequest"/>.</param>
         /// <param name="cancellationToken">Optional, <see cref="CancellationToken"/>.</param>
         /// <returns><see cref="AudioClip"/> and the cached path.</returns>
+        [Function("Generates audio from the input text.")]
         public async Task<Tuple<string, AudioClip>> CreateSpeechAsync(SpeechRequest request, CancellationToken cancellationToken = default)
         {
             var audioFormat = request.ResponseFormat switch

Runtime/Audio/AudioTranscriptionRequest.cs

@@ -105,7 +105,7 @@ public AudioTranscriptionRequest(
         /// The name of the audio file to transcribe.
         /// </param>
         /// <param name="model">
-        /// ID of the model to use.
+        /// ID of the model to use. Only whisper-1 is currently available.
         /// </param>
         /// <param name="prompt">
         /// Optional, An optional text to guide the model's style or continue a previous audio segment.<br/>
@@ -167,7 +167,7 @@ public AudioTranscriptionRequest(
         public string AudioName { get; }
 
         /// <summary>
-        /// ID of the model to use.
+        /// ID of the model to use. Only whisper-1 is currently available.
         /// </summary>
         public string Model { get; }
 

Runtime/Audio/AudioTranslationRequest.cs

@@ -16,7 +16,7 @@ public sealed class AudioTranslationRequest : IDisposable
         /// The audio file to translate, in one of these formats: flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
         /// </param>
         /// <param name="model">
-        /// ID of the model to use.
+        /// ID of the model to use. Only whisper-1 is currently available.
         /// </param>
         /// <param name="prompt">
         /// Optional, An optional text to guide the model's style or continue a previous audio segment.<br/>
@@ -37,7 +37,7 @@ public AudioTranslationRequest(
             string model = null,
             string prompt = null,
             AudioResponseFormat responseFormat = AudioResponseFormat.Json,
-            int? temperature = null)
+            float? temperature = null)
             : this(File.OpenRead(audioPath), Path.GetFileName(audioPath), model, prompt, responseFormat, temperature)
         {
         }
@@ -136,7 +136,7 @@ public AudioTranslationRequest(
         public string AudioName { get; }
 
         /// <summary>
-        /// ID of the model to use.
+        /// ID of the model to use. Only whisper-1 is currently available.
         /// </summary>
         public string Model { get; }
 

Runtime/Audio/SpeechRequest.cs

@@ -2,6 +2,7 @@
 
 using Newtonsoft.Json;
 using OpenAI.Models;
+using System;
 using UnityEngine.Scripting;
 
 namespace OpenAI.Audio
@@ -20,31 +21,51 @@ public sealed class SpeechRequest
         [Preserve]
         public SpeechRequest(string input, Model model = null, SpeechVoice voice = SpeechVoice.Alloy, SpeechResponseFormat responseFormat = SpeechResponseFormat.MP3, float? speed = null)
         {
-            Input = input;
+            Input = !string.IsNullOrWhiteSpace(input) ? input : throw new ArgumentException("Input cannot be null or empty.", nameof(input));
             Model = string.IsNullOrWhiteSpace(model?.Id) ? Models.Model.TTS_1 : model;
             Voice = voice;
             ResponseFormat = responseFormat;
             Speed = speed;
         }
 
+        /// <summary>
+        /// One of the available TTS models. Defaults to tts-1.
+        /// </summary>
         [Preserve]
         [JsonProperty("model")]
+        [FunctionProperty("One of the available TTS models. Defaults to tts-1.", true, "tts-1", "tts-1-hd")]
         public string Model { get; }
 
+        /// <summary>
+        /// The text to generate audio for. The maximum length is 4096 characters.
+        /// </summary>
         [Preserve]
         [JsonProperty("input")]
+        [FunctionProperty("The text to generate audio for. The maximum length is 4096 characters.", true)]
         public string Input { get; }
 
+        /// <summary>
+        /// The voice to use when generating the audio.
+        /// </summary>
         [Preserve]
         [JsonProperty("voice", DefaultValueHandling = DefaultValueHandling.Include)]
+        [FunctionProperty("The voice to use when generating the audio.", true)]
         public SpeechVoice Voice { get; }
 
+        /// <summary>
+        /// The format to audio in. Supported formats are mp3, opus, aac, and flac.
+        /// </summary>
         [Preserve]
         [JsonProperty("response_format", DefaultValueHandling = DefaultValueHandling.Include)]
+        [FunctionProperty("The format to audio in. Supported formats are mp3, opus, aac, and flac.", false, SpeechResponseFormat.MP3)]
         public SpeechResponseFormat ResponseFormat { get; }
 
+        /// <summary>
+        /// The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.
+        /// </summary>
         [Preserve]
         [JsonProperty("speed")]
+        [FunctionProperty("The speed of the generated audio. Select a value from 0.25 to 4.0. 1.0 is the default.", false, 1.0f)]
         public float? Speed { get; }
     }
 }

Runtime/Chat/ChatEndpoint.cs

@@ -30,12 +30,6 @@ internal ChatEndpoint(OpenAIClient client) : base(client) { }
         public async Task<ChatResponse> GetCompletionAsync(ChatRequest chatRequest, CancellationToken cancellationToken = default)
         {
             var payload = JsonConvert.SerializeObject(chatRequest, OpenAIClient.JsonSerializationOptions);
-
-            if (EnableDebug)
-            {
-                Debug.Log(payload);
-            }
-
             var response = await Rest.PostAsync(GetUrl("/completions"), payload, new RestParameters(client.DefaultRequestHeaders), cancellationToken);
             response.Validate(EnableDebug);
             return response.Deserialize<ChatResponse>(client);

Runtime/Chat/ChatRequest.cs

@@ -1,7 +1,6 @@
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
 using System;
 using System.Collections.Generic;
 using System.Linq;

Runtime/Chat/ChatResponse.cs

@@ -35,6 +35,9 @@ public ChatResponse(
             this.choices = choices.ToList();
         }
 
+        /// <summary>
+        /// A unique identifier for the chat completion.
+        /// </summary>
         [Preserve]
         [JsonProperty("id")]
         public string Id { get; private set; }
@@ -77,6 +80,9 @@ public ChatResponse(
         [JsonIgnore]
         private List<Choice> choices;
 
+        /// <summary>
+        /// A list of chat completion choices. Can be more than one if n is greater than 1.
+        /// </summary>
         [Preserve]
         [JsonProperty("choices")]
         public IReadOnlyList<Choice> Choices

Runtime/Chat/Conversation.cs

@@ -2,7 +2,9 @@
 
 using Newtonsoft.Json;
 using System;
+using System.Collections.Concurrent;
 using System.Collections.Generic;
+using System.Linq;
 using UnityEngine.Scripting;
 
 namespace OpenAI.Chat
@@ -15,21 +17,30 @@ public sealed class Conversation
         [JsonConstructor]
         public Conversation([JsonProperty("messages")] List<Message> messages = null)
         {
-            this.messages = messages ?? new List<Message>();
+
+            this.messages = new ConcurrentQueue<Message>();
+
+            if (messages != null)
+            {
+                foreach (var message in messages)
+                {
+                    this.messages.Enqueue(message);
+                }
+            }
         }
 
-        private readonly List<Message> messages;
+        private readonly ConcurrentQueue<Message> messages;
 
         [Preserve]
         [JsonProperty("messages")]
-        public IReadOnlyList<Message> Messages => messages;
+        public IReadOnlyList<Message> Messages => messages.ToList();
 
         /// <summary>
         /// Appends <see cref="Message"/> to the end of <see cref="Messages"/>.
         /// </summary>
         /// <param name="message">The message to add to the <see cref="Conversation"/>.</param>
         [Preserve]
-        public void AppendMessage(Message message) => messages.Add(message);
+        public void AppendMessage(Message message) => messages.Enqueue(message);
 
         [Preserve]
         public override string ToString() => JsonConvert.SerializeObject(this, OpenAIClient.JsonSerializationOptions);