🌿 Fern Regeneration -- August 1, 2024 #37

fern-api · 2024-08-01T11:11:35Z

This PR regenerates code to match the latest API Definition.

src/AssemblyAI/Exceptions/BadRequestError.cs

Swimburger · 2024-08-01T11:23:04Z

src/AssemblyAI/Lemur/Requests/LemurActionItemsParams.cs

+ /// </summary>
+ [JsonPropertyName("context")]
+ [JsonConverter(typeof(OneOfSerializer<OneOf<string, Dictionary<string, object?>>>))]
+ public OneOf<string, Dictionary<string, object?>>? Context { get; set; }


This should be a string or an object

We do the same thing in java for you

Happy to talk through possible workarounds, but we consider map<string, object> to be a helpful type for object, since a json object is of course a map of strings to values

I'm not sure what the most natural way is in Java, but in C# the most natural way would be to create an anonymous object:

new { foo = "bar", outer = new { inner = "value" } }

A dictionary is helpful, but the DX is better for C# devs to use an object here

I see, that does seems ideal for object creation

Is this Context type used as a request type? What do you think of this type as a response type, as it's shown here?

This is only used as a parameter, it isn't returned anywhere.
Hypothetically, if it were returned, it'd be best returned as a string, or have a method overload to specify a type to convert it to using our JSON serializer.

Oh my mistake 😅 going to look into making these changes

Right now, since we don't differentiate between requests or responses when generating types, so they will all be given the same typings (given the same type definition).

So, if we made this change, how would you feel if OpenAPI object type responses came through as object rather than Dictionary<string, object?>? That seems possibly harder to work with?

For the request, we can do object which you can assign a string to or anything else.
OneOf<string, object> is fine too.

Swimburger · 2024-08-01T11:26:15Z

src/AssemblyAI/Realtime/Types/Realtime.cs

+namespace AssemblyAI.Realtime;
+
+[JsonConverter(typeof(StringEnumSerializer<Realtime>))]
+public enum Realtime


Not sure why this is still being generated across the SDKs

Swimburger · 2024-08-01T11:29:04Z

src/AssemblyAI/Transcripts/Requests/ListTranscriptParams.cs


 public record ListTranscriptParams
 {
 /// <summary>
 /// Maximum amount of transcripts to retrieve
 /// </summary>
- public int? Limit { get; set; }
+ public long? Limit { get; set; }


Was this change intentional? I expected it to default toint

we did make a change to represent int64 format OpenAPI integers as long, as this is actually how longs are represented in OpenAPI:

from here

here's your type in openapi for reference:

ListTranscriptParams: x-label: List transcript parameters type: object x-fern-sdk-group-name: transcripts # Don't use this type in Fern SDKs as it is already generated from the endpoint parameters x-fern-ignore: true additionalProperties: false properties: limit: x-label: Limit description: Maximum amount of transcripts to retrieve type: integer format: int64 minimum: 1 maximum: 200 default: 10

Strange, I didn't think we specified that for this param. The maximum is 200 so it doesn't make sense to say its int64.
I'll update this in the spec. Thanks!

Sounds good!

Swimburger · 2024-08-01T11:32:48Z

src/AssemblyAI/Transcripts/Requests/WordSearchParams.cs


 public record WordSearchParams
 {
 /// <summary>
 /// Keywords to search for
 /// </summary>
- public string? Words { get; init; }
+ public IEnumerable<string> Words { get; set; } = new List<string>();


We should use Enumerable.Empty<string> as default values

Thanks for the suggestion. If do that, Rider suggests I use a collection expression, ie = [];. Thoughts on that?

The reason I suggest using Enumerable.Empty is that it'll cache and reuse the object, reducing memory usage.
I didn't realize this, but .NET will automatic translate the collection expression to Enumerable.Empty, so yes, let's do that!

Awesome, thanks for this suggestion! I'll make the change 👍

Swimburger · 2024-08-01T12:31:12Z

src/AssemblyAI/Core/AssemblyAIClientApiException.cs

+
+#nullable enable
+
+namespace AssemblyAI.Core;


We don't want to expose a Core namespace, so let's put this at the root namespace.

Swimburger · 2024-08-01T12:32:11Z

src/AssemblyAI/Core/Constants.cs

@@ -1,6 +1,6 @@
 namespace AssemblyAI.Core;

-internal static class Constants
+public static class Constants


Let's make anything that the user doesn't need internal, or we'll need to make a lot of breaking changes version changes.

Swimburger · 2024-08-01T14:27:32Z

src/AssemblyAI/ClientOptions.cs

I need to keep using this custom client options which has set instead of init, and includes the API key.
These custom client options are used for the DI extensions.

Swimburger · 2024-08-01T14:28:53Z

src/AssemblyAI/Files/FilesClient.cs


 #nullable enable

-namespace AssemblyAI;
+namespace AssemblyAI.Files;

 public partial class FilesClient


All clients should be partial so we can extend them. I manually changed it to partial here.

Swimburger · 2024-08-01T14:51:08Z

src/AssemblyAI/Files/FilesClient.cs

+ switch (response.StatusCode)
+ {
+ case 400:
+ throw new BadRequestError(JsonUtils.Deserialize<Error>(responseBody));
+ case 401:
+ throw new UnauthorizedError(JsonUtils.Deserialize<Error>(responseBody));
+ case 404:
+ throw new NotFoundError(JsonUtils.Deserialize<Error>(responseBody));
+ case 429:
+ throw new TooManyRequestsError(JsonUtils.Deserialize<Error>(responseBody));
+ case 500:
+ throw new InternalServerError(JsonUtils.Deserialize<Error>(responseBody));
+ case 503:
+ throw new ServiceUnavailableError(JsonUtils.Deserialize<object>(responseBody));
+ case 504:
+ throw new GatewayTimeoutError(JsonUtils.Deserialize<object>(responseBody));
+ }


For exceptions that have a JSON error response, we want the exception message to be set to the .error message.
Having the error code is helpful too (as a property) but shouldn't be included in the message.

we want the exception message to be set to the .error message.

We are doing this today, no? I may be misunderstanding 😄

Do you mean that you want the .error message to be the Exception message?

If I catch the exception, this should be true:

Assert.That(ex.Message, Is.EqualTo("each transcript source id must be valid"));

Currently, the ex.Message is "BadRequestError".

Hey @Swimburger , this ask makes a lot of sense, but it's a heavy lift on our end, as it would be a new end to end feature

Would it be possible to remove this from the GA blockers, and we'll follow up with it after GA?

As I suggested in a past conversation, we don't need this to be something that Fern generates, but we do need an extension point where we can add our own code without disabling too much code generation.

You can provide a partial method for us to implement like I show here:
https://github.com/AssemblyAI/assemblyai-csharp-sdk/pull/39/files#diff-cadbe42714ba9be588f87ec2595828c853eed16be025736993d2c370bb9e6e1aR10

Swimburger · 2024-08-01T14:52:25Z

src/AssemblyAI/Files/FilesClient.cs

+ switch (response.StatusCode)
+ {
+ case 400:
+ throw new BadRequestError(JsonUtils.Deserialize<Error>(responseBody));


These exception classes should be suffixed by Exception.
However, we could just have a single exception for all of these.
We don't need a separate exception class for each error.

Swimburger · 2024-08-01T14:53:29Z

src/AssemblyAI/Lemur/Types/LemurResponse.cs

It would be great if Fern generated dedicated classes for our unions like this.

Swimburger · 2024-08-01T15:20:28Z

src/AssemblyAI/Core/JsonConfiguration.cs

+ new OneOfSerializer<OneOf<LemurStringResponse, LemurQuestionAnswerResponse>>()
+ },
+ WriteIndented = true,
+ DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull,


I had to configure this, so that null properties are omitted from the JSON.
Otherwise there's an error in the API.

The API should be able to handle null values, but it doesn't properly for some properties, which has been reported.

Swimburger · 2024-08-01T16:58:36Z

src/AssemblyAI/Core/AssemblyAIClientApiException.cs

+ /// </summary>
+ public object Body { get; } = body;
+
+ public override string ToString()


Exceptions shouldn't override the ToString method.
To communicate the exception details, use Message and additional properties only.

Swimburger · 2024-08-01T23:09:52Z

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";


DEFAULT should be Default according to .NET naming conventions

Swimburger · 2024-08-02T10:18:28Z

src/AssemblyAI/Lemur/LemurClient.cs

+ $"Error with status code {response.StatusCode}",
+ response.StatusCode,
+ JsonUtils.Deserialize<object>(responseBody)
+ );
 }

 /// <summary>
 /// Question & Answer allows you to ask free-form questions about a single transcript or a group of transcripts.


& is not legal in XML docs. The contents of the XML docs should be XML escaped.

SDK regeneration

93db068

fern-api bot requested a review from fern-bot August 1, 2024 11:11

Swimburger reviewed Aug 1, 2024

View reviewed changes

Swimburger added 2 commits August 1, 2024 14:24

Remove test project

af49570

Remove generated ClientOptions.cs, update handwritten ClientOptions.cs

a85df3a

Swimburger reviewed Aug 1, 2024

View reviewed changes

Swimburger added 5 commits August 1, 2024 14:33

Merge Constants.cs, keep internal

45e74bd

Fix ClientOptions.cs

0731aa4

Fix customizations and tests

3667121

Fix JSON serialization, fix transcript tests

321b017

Serialize LemurResponse

634b686

Swimburger reviewed Aug 1, 2024

View reviewed changes

Use built-in converter

b596a4c

Swimburger reviewed Aug 1, 2024

View reviewed changes

Swimburger added 2 commits August 1, 2024 17:26

Fix tests

fea248b

Rename step from unit-tests to tests

6713ddd

Swimburger merged commit 9db4524 into main Aug 1, 2024
2 of 3 checks passed

Swimburger deleted the fern-bot/08-01-2024-1111AM branch August 1, 2024 15:45

Swimburger reviewed Aug 1, 2024

View reviewed changes

Swimburger reviewed Aug 2, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🌿 Fern Regeneration -- August 1, 2024 #37

🌿 Fern Regeneration -- August 1, 2024 #37

fern-api bot commented Aug 1, 2024

Swimburger Aug 1, 2024

dcb6 Aug 1, 2024

Swimburger Aug 1, 2024 •

edited

Loading

dcb6 Aug 1, 2024

Swimburger Aug 1, 2024

dcb6 Aug 1, 2024

dcb6 Aug 1, 2024

Swimburger Aug 2, 2024

Swimburger Aug 1, 2024

Swimburger Aug 1, 2024

dcb6 Aug 1, 2024 •

edited

Loading

Swimburger Aug 1, 2024

dcb6 Aug 1, 2024

Swimburger Aug 1, 2024

dcb6 Aug 1, 2024 •

edited

Loading

Swimburger Aug 1, 2024

dcb6 Aug 1, 2024

Swimburger Aug 1, 2024

Swimburger Aug 1, 2024

Swimburger Aug 1, 2024

Swimburger Aug 1, 2024 •

edited

Loading

Swimburger Aug 1, 2024

dcb6 Aug 1, 2024 •

edited

Loading

Swimburger Aug 1, 2024

dcb6 Aug 6, 2024

Swimburger Aug 7, 2024

Swimburger Aug 7, 2024

Swimburger Aug 1, 2024

Swimburger Aug 1, 2024

Swimburger Aug 1, 2024

Swimburger Aug 1, 2024

Swimburger Aug 1, 2024

Swimburger Aug 2, 2024

🌿 Fern Regeneration -- August 1, 2024 #37

🌿 Fern Regeneration -- August 1, 2024 #37

Conversation

fern-api bot commented Aug 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Swimburger Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcb6 Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcb6 Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Swimburger Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dcb6 Aug 1, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Swimburger Aug 1, 2024 •

edited

Loading

dcb6 Aug 1, 2024 •

edited

Loading

dcb6 Aug 1, 2024 •

edited

Loading

Swimburger Aug 1, 2024 •

edited

Loading

dcb6 Aug 1, 2024 •

edited

Loading