🌿 Fern Regeneration -- August 1, 2024

.fernignore

@@ -2,20 +2,28 @@
 
 README.md
 LICENSE.md
+.gitignore
 src/AssemblyAI/AssemblyAI.csproj
+src/AssemblyAI/Core/ClientOptions.cs
+src/AssemblyAI/Core/JsonConfiguration.cs
 src/AssemblyAI/ClientOptions.cs
 src/AssemblyAI/Constants.cs
 src/AssemblyAI/UserAgent.cs
 src/AssemblyAI/Event.cs
 src/AssemblyAI/AssemblyAIClient.cs
 src/AssemblyAI/DependencyInjectionExtensions.cs
-src/AssemblyAI/Files/FilesCustomClient.cs
-src/AssemblyAI/Transcripts/TranscriptsCustomClient.cs
+src/AssemblyAI/Files/ExtendedFilesClient.cs
+src/AssemblyAI/Transcripts/ExtendedTranscriptsClient.cs
+src/AssemblyAI/Lemur/Types/LemurResponse.cs
 src/AssemblyAI/Realtime/RealtimeTranscriber.cs
 src/AssemblyAI/Realtime/WebsocketClient
 src/AssemblyAI/Realtime/Types/RealtimeTranscript.cs
+src/AssemblyAI.Test
 src/AssemblyAI.UnitTests
 src/AssemblyAI.IntegrationTests
 
+# TODO: remove these ignores when AssemblyAI fixes the API
+src/AssemblyAI/Transcripts/Types/ContentSafetyLabelsResult.cs
+src/AssemblyAI/Transcripts/Types/TopicDetectionModelResult.cs
 
 Samples

.github/workflows/ci.yml

@@ -24,6 +24,28 @@ jobs:
       - name: Build Release
         run: dotnet build src -c Release /p:ContinuousIntegrationBuild=true
 
+  unit-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v3
+
+      - uses: actions/checkout@master
+
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: 8.x
+
+      - name: Install tools
+        run: |
+          dotnet tool restore
+
+      - name: Run Tests
+        run: |
+          dotnet test src
+
 
   publish:
     needs: [compile]

src/AssemblyAI.IntegrationTests/LemurTests.cs

@@ -1,3 +1,5 @@
+using AssemblyAI.Lemur;
+
 namespace AssemblyAI.IntegrationTests;
 
 [TestFixture]
@@ -6,8 +8,7 @@ public class LemurTests
     private static string ApiKey => AssemblyAITestParameters.ApiKey;
     private static string[] TranscriptIds => AssemblyAITestParameters.TranscriptIds;
 
-    // TODO: uncomment when Fern fixes params generation
-    /*[Test]
+    [Test]
     public async Task Should_Generate_Summary()
     {
         var client = new AssemblyAIClient(ApiKey);
@@ -105,7 +106,7 @@ public async Task Should_Return_Response()
         }).ConfigureAwait(false);
 
         var taskResponse2OneOf = await client.Lemur.GetResponseAsync(taskResponse.RequestId).ConfigureAwait(false);
-        var taskResponse2 = (LemurStringResponse) taskResponse2OneOf.Value;
+        var taskResponse2 = (LemurStringResponse)taskResponse2OneOf.Value;
         Assert.That(taskResponse2.RequestId, Is.EqualTo(taskResponse.RequestId));
         Assert.That(taskResponse2.Response, Is.EqualTo(taskResponse.Response));
     }
@@ -124,5 +125,5 @@ public async Task Should_Purge_Request_Data()
         var deletionRequest = await client.Lemur.PurgeRequestDataAsync(summaryResponse.RequestId).ConfigureAwait(false);
         Assert.That(deletionRequest.Deleted, Is.True);
         Assert.That(summaryResponse.RequestId, Is.EqualTo(deletionRequest.RequestIdToPurge));
-    }*/
+    }
 }

src/AssemblyAI.IntegrationTests/RealtimeClientTests.cs

@@ -1,3 +1,5 @@
+using AssemblyAI.Realtime;
+
 namespace AssemblyAI.IntegrationTests;
 
 [TestFixture]

src/AssemblyAI.IntegrationTests/TranscriptsClientTests.cs

@@ -1,3 +1,5 @@
+using AssemblyAI.Transcripts;
+
 namespace AssemblyAI.IntegrationTests;
 
 [TestFixture]
@@ -20,6 +22,7 @@ public async Task Should_Submit_Using_Uri()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
+        Assert.That(transcript.Text, Is.Null);
         Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Queued));
     }
 
@@ -36,6 +39,7 @@ public async Task Should_Submit_Using_Stream()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
+        Assert.That(transcript.Text, Is.Null);
         Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Queued));
     }
 
@@ -52,6 +56,7 @@ public async Task Should_Submit_Using_FileInfo()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
+        Assert.That(transcript.Text, Is.Null);
         Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Queued));
     }
 
@@ -66,7 +71,8 @@ public async Task Should_Transcribe_Using_Uri()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
-        Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Queued));
+        Assert.That(transcript.Text, Is.Not.Empty);
+        Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Completed));
     }
 
     [Test]
@@ -82,6 +88,7 @@ public async Task Should_Transcribe_From_FileInfo()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
+        Assert.That(transcript.Text, Is.Not.Empty);
         Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Completed));
     }
 
@@ -98,6 +105,7 @@ public async Task Should_Transcribe_Using_Stream()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
+        Assert.That(transcript.Text, Is.Not.Empty);
         Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Completed));
     }
 
@@ -111,7 +119,7 @@ public async Task Should_Fail_To_Transcribe()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
-        Assert.That(transcript.Text, Is.Empty);
+        Assert.That(transcript.Text, Is.Null);
         Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Error));
         Assert.That(transcript.Error, Is.Not.Empty);
     }
@@ -130,6 +138,7 @@ public async Task Should_Wait_Until_Ready()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
+        Assert.That(transcript.Text, Is.Not.Empty);
         Assert.That(transcript.Status, Is.EqualTo(TranscriptStatus.Completed));
     }
 
@@ -157,7 +166,7 @@ public async Task Should_Delete_Transcript()
 
         Assert.That(transcript, Is.Not.Null);
         Assert.That(transcript.Id, Is.Not.Null);
-        Assert.That(transcript.Text, Is.Empty);
+        Assert.That(transcript.Text, Is.EqualTo("Deleted by user."));
         Assert.That(transcript.AudioUrl, Is.EqualTo("http://deleted_by_user"));
     }
 

src/AssemblyAI.UnitTests/DiClientOptionsTests.cs

@@ -14,7 +14,7 @@ public class DependencyInjectionClientOptionsTests
         ApiKey = "MyAssemblyAIApiKey",
         BaseUrl = "https://api.assemblyai.com",
         MaxRetries = 2,
-        TimeoutInSeconds = 30
+        Timeout = TimeSpan.FromSeconds(30)
     };
 
     [Test]
@@ -27,7 +27,7 @@ public void AddAssemblyAIClient_With_Callback_Should_Match_Configuration()
             options.ApiKey = ValidAssemblyAIOptions.ApiKey;
             options.BaseUrl = ValidAssemblyAIOptions.BaseUrl;
             options.MaxRetries = ValidAssemblyAIOptions.MaxRetries;
-            options.TimeoutInSeconds = ValidAssemblyAIOptions.TimeoutInSeconds;
+            options.Timeout = ValidAssemblyAIOptions.Timeout;
         });
 
         var serviceProvider = serviceCollection.BuildServiceProvider();
@@ -62,7 +62,7 @@ public async Task AddAssemblyAIClient_From_Configuration_Should_Reload_On_Change
             ApiKey = "UpdatedApiKey",
             BaseUrl = "https://api.updated.assemblyai.com",
             MaxRetries = 3,
-            TimeoutInSeconds = 45
+            Timeout = TimeSpan.FromSeconds(45)
         };
 
         jsonText = JsonSerializer.Serialize(new { AssemblyAI = updatedOptions });

src/AssemblyAI/AssemblyAIClient.cs

@@ -3,6 +3,10 @@
 using System.Net.Http;
 using AssemblyAI;
 using AssemblyAI.Core;
+using AssemblyAI.Files;
+using AssemblyAI.Lemur;
+using AssemblyAI.Realtime;
+using AssemblyAI.Transcripts;
 
 
 namespace AssemblyAI;
@@ -26,6 +30,7 @@ public AssemblyAIClient(ClientOptions clientOptions)
         clientOptions.HttpClient ??= new HttpClient();
         var client = new RawClient(
             new Dictionary<string, string>(),
+            new Dictionary<string, Func<string>>(),
             clientOptions
         );
         clientOptions.HttpClient.DefaultRequestHeaders.TryAddWithoutValidation("Authorization", clientOptions.ApiKey);

src/AssemblyAI/ClientOptions.cs

@@ -15,7 +15,7 @@ public class ClientOptions
     /// <summary>
     /// The Base URL for the API.
     /// </summary>
-    public string BaseUrl { get; set; } = Environments.DEFAULT;
+    public string BaseUrl { get; set; } = AssemblyAIClientEnvironment.DEFAULT;
 
     private UserAgent? _userAgent = UserAgent.Default;
 
@@ -49,5 +49,5 @@ public UserAgent? UserAgent
     /// <summary>
     /// The timeout for the request in seconds.
     /// </summary>
-    public int TimeoutInSeconds { get; set; } = 30;
+    public TimeSpan Timeout { get; set; } = TimeSpan.FromSeconds(30);
 }

src/AssemblyAI/Core/AssemblyAIClientApiException.cs

@@ -0,0 +1,27 @@
+using AssemblyAI.Core;
+
+#nullable enable
+
+namespace AssemblyAI.Core;
+
+/// <summary>
+/// This exception type will be thrown for any non-2XX API responses.
+/// </summary>
+public class AssemblyAIClientApiException(string message, int statusCode, object body)
+    : AssemblyAIClientException(message)
+{
+    /// <summary>
+    /// The error code of the response that triggered the exception.
+    /// </summary>
+    public int StatusCode { get; } = statusCode;
+
+    /// <summary>
+    /// The body of the response that triggered the exception.
+    /// </summary>
+    public object Body { get; } = body;
+
+    public override string ToString()
+    {
+        return $"AssemblyAIClientApiException {{ message: {Message}, statusCode: {StatusCode}, body: {Body} }}";
+    }
+}

src/AssemblyAI/Core/Environments.cs → src/AssemblyAI/Core/AssemblyAIClientEnvironment.cs

@@ -1,6 +1,6 @@
 namespace AssemblyAI.Core;
 
-public class Environments
+public class AssemblyAIClientEnvironment
 {
     public static string DEFAULT = "https://api.assemblyai.com";
 }

src/AssemblyAI/Core/AssemblyAIClientException.cs

@@ -0,0 +1,11 @@
+using System;
+
+#nullable enable
+
+namespace AssemblyAI.Core;
+
+/// <summary>
+/// Base exception class for all exceptions thrown by the SDK.
+/// </summary>
+public class AssemblyAIClientException(string message, Exception? innerException = null)
+    : Exception(message, innerException) { }

src/AssemblyAI/Core/Constants.cs

@@ -2,5 +2,6 @@ namespace AssemblyAI.Core;
 
 internal static class Constants
 {
-    internal const string Version = "0.0.2-alpha";
+    internal const string Version = "1.0.0-beta";
+    public const string DateTimeFormat = "yyyy'-'MM'-'dd'T'HH':'mm':'ss.fffK";
 }

src/AssemblyAI/Core/DateTimeSerializer.cs

@@ -0,0 +1,22 @@
+using System.Globalization;
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace AssemblyAI.Core;
+
+public class DateTimeSerializer : JsonConverter<DateTime>
+{
+    public override DateTime Read(
+        ref Utf8JsonReader reader,
+        System.Type typeToConvert,
+        JsonSerializerOptions options
+    )
+    {
+        return DateTime.Parse(reader.GetString()!, null, DateTimeStyles.RoundtripKind);
+    }
+
+    public override void Write(Utf8JsonWriter writer, DateTime value, JsonSerializerOptions options)
+    {
+        writer.WriteStringValue(value.ToString(Constants.DateTimeFormat));
+    }
+}

src/AssemblyAI/Core/JsonConfiguration.cs

@@ -0,0 +1,32 @@
+using System.Text.Json;
+using System.Text.Json.Serialization;
+
+namespace AssemblyAI.Core;
+
+public static class JsonOptions
+{
+    public static readonly JsonSerializerOptions JsonSerializerOptions;
+
+    static JsonOptions()
+    {
+        JsonSerializerOptions = new JsonSerializerOptions
+        {
+            Converters = { new DateTimeSerializer() },
+            WriteIndented = true,
+            DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,
+        };
+    }
+}
+
+public static class JsonUtils
+{
+    public static string Serialize<T>(T obj)
+    {
+        return JsonSerializer.Serialize(obj, JsonOptions.JsonSerializerOptions);
+    }
+
+    public static T Deserialize<T>(string json)
+    {
+        return JsonSerializer.Deserialize<T>(json, JsonOptions.JsonSerializerOptions)!;
+    }
+}

src/AssemblyAI/Core/LemurResponseConverter.cs

@@ -0,0 +1,33 @@
+using System.Text.Json;
+using System.Text.Json.Serialization;
+using AssemblyAI.Lemur;
+
+namespace AssemblyAI.Core;
+
+public class LemurResponseConverter : JsonConverter<LemurResponse>
+{
+    public override LemurResponse? Read(
+        ref Utf8JsonReader reader,
+        Type typeToConvert,
+        JsonSerializerOptions options
+    )
+    {
+        if (reader.TokenType is JsonTokenType.Null)
+            return default;
+
+        var jsonElement = JsonSerializer.Deserialize<JsonElement>(ref reader, options);
+        if (jsonElement.GetProperty("response").ValueKind == JsonValueKind.Array)
+        {
+            return jsonElement.Deserialize<LemurQuestionAnswerResponse>() ?? 
+                   throw new Exception("Failed to deserialize LemurQuestionAnswerResponse");
+        }
+
+        return jsonElement.Deserialize<LemurStringResponse>() ?? 
+               throw new Exception("Failed to deserialize LemurStringResponse");
+    }
+
+    public override void Write(Utf8JsonWriter writer, LemurResponse value, JsonSerializerOptions options)
+    {
+        JsonSerializer.Serialize(writer, value.Value, options);
+    }
+}