AssemblyAI 0.0.2-alpha

WIP! AssemblyAI C# SDK

[!WARNING]
We are actively working on the .NET SDK for AssemblyAI. Watch the C# SDK repo, specifically the releases, so you get notified when we have our first release. <img width="441" alt="Screenshot 2024-01-25 at 2 27 59 PM" src="https://github.com/AssemblyAI/assemblyai-semantic-kernel/assets/3382717/5e3af901-26f6-4910-bd86-31e4f07deab1">

The official AssemblyAI C# library, supporting .NET Standard 3.0+, .NET Core 3.0+, and .NET Framework 4.6.1+.

Documentation

API reference documentation is available here.

Installation

Using the .NET Core command-line interface (CLI) tools:

dotnet add package AssemblyAI.Client

Using the NuGet Command Line Interface (CLI):

nuget install AssemblyAI.Client

Using the Package Manager Console:

Install-Package AssemblyAI.Client

Usage

Instantiate the SDK using the AssemblyAI class. Note that all of the SDK methods are awaitable!

  using AssemblyaAI;

  AssemblyAI aai = new AssemblyAI("YOUR_API_KEY")
  TranscriptResponse transcript = 
      await aai.Transcript.get("transcript_id");
  System.Console.WriteLine("Received transcript!", transcript);

HTTP Client

You can override the HttpClient by passing in ClientOptions.

aai = new AssemblyAI("YOUR_API_KEY", new ClientOptions{
    HttpClient = ... // Override the Http Client
    BaseURL = ... // Override the Base URL
})

Exception Handling

When the API returns a non-zero status code, (4xx or 5xx response), a subclass of AssemblyAIException will be thrown:

try {
  aai.transcript.create(...);    
} catch (AssemblyAIException e) {
  System.Console.WriteLine(e.Message) 
  System.Console.WriteLine(e.StatusCode) 
}

Retries

409 Conflict, 429 Rate Limit, and >=500 Internal errors will all be retried twice with exponential backoff. You can override this behavior globally or per-request.

var aai = new AssemblyAI("...", new ClientOptions{
    MaxRetries = 1 // Only retry once
});
aai.transcript.create(new TranscriptCreateParams{ ... }, new RequestOptions {
    MaxRetries = 0 // Disable retries
});

Timeouts

The SDK defaults to a 60s timeout. You can override this behaviour globally or per-request.

var aai = new AssemblyAI("...", new ClientOptions{
    TimeoutInSeconds = 20 // Lower timeout
});
aai.transcript.create(new TranscriptCreateParams{ ... }, new RequestOptions {
    TimeoutInSeconds = 90 // Raise timeout
});

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!