diff --git a/fern/pages/05-guides/sdks/csharp/csharp-async.mdx b/fern/pages/05-guides/sdks/csharp/csharp-async.mdx index bd464a7..7fc798e 100644 --- a/fern/pages/05-guides/sdks/csharp/csharp-async.mdx +++ b/fern/pages/05-guides/sdks/csharp/csharp-async.mdx @@ -1,12 +1,15 @@ --- title: "C# SDK Reference" --- + - As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [C# Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/csharp) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [C# Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/csharp) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Pre-recorded audio @@ -16,9 +19,9 @@ Our Speech-to-Text model enables you to transcribe pre-recorded audio into writt On top of the transcription, you can enable other features and models, such as [Speaker Diarization](/docs/speech-to-text/speaker-diarization), by adding additional parameters to the same transcription request. - Choose between [_Best_ and - _Nano_](#select-the-speech-model-with-best-and-nano) based on the cost and - performance tradeoffs best suited for your application. + +Choose between [_Best_ and _Nano_](#select-the-speech-model-with-best-and-nano) based on the cost and performance tradeoffs best suited for your application. + The following example transcribes an audio file from a URL. @@ -113,6 +116,7 @@ if (transcript.Status == TranscriptStatus.Error) ``` + A transcription may fail for various reasons: - Unsupported file format @@ -152,7 +156,9 @@ For a list of the supported languages for each model, see [Supported languages]( The default region is US, with base URL `api.assemblyai.com`. For EU data residency requirements, you can use our base URL for EU at `api.eu.assemblyai.com`. - The base URL for EU is currently only available for Async transcription. + +The base URL for EU is currently only available for Async transcription. + | Region | Base URL | @@ -280,6 +286,7 @@ var transcript = await client.Transcripts.TranscribeAsync(new TranscriptParams ``` + Follow formatting guidelines for custom vocabulary to ensure the best results: - Remove all punctuation except apostrophes. @@ -497,10 +504,9 @@ The Speaker Diarization model lets you detect multiple speakers in an audio file If you enable Speaker Diarization, the resulting transcript will return a list of _utterances_, where each utterance corresponds to an uninterrupted segment of speech from a single speaker. - Speaker Diarization doesn't support multichannel transcription. Enabling both - Speaker Diarization and - [multichannel](/docs/speech-to-text/pre-recorded-audio/multichannel-transcription) - will result in an error. + +Speaker Diarization doesn't support multichannel transcription. Enabling both Speaker Diarization and [multichannel](/docs/speech-to-text/pre-recorded-audio/multichannel-transcription) will result in an error. + **Quickstart** @@ -564,6 +570,7 @@ var transcript = await client.Transcripts.TranscribeAsync(new TranscriptParams ``` - The `SpeakersExpected` parameter is ignored for audio files with a duration - less than 2 minutes. + +The `SpeakersExpected` parameter is ignored for audio files with a duration less than 2 minutes. + diff --git a/fern/pages/05-guides/sdks/csharp/csharp-audio-intelligence.mdx b/fern/pages/05-guides/sdks/csharp/csharp-audio-intelligence.mdx index 20db240..6bde6a4 100644 --- a/fern/pages/05-guides/sdks/csharp/csharp-audio-intelligence.mdx +++ b/fern/pages/05-guides/sdks/csharp/csharp-audio-intelligence.mdx @@ -1,12 +1,15 @@ --- title: "C# SDK Reference" --- + - As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [C# Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/csharp) or any of our Audio Intelligence pages for information on how to integrate with our API directly. +As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [C# Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/csharp) or any of our Audio Intelligence pages for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Audio Intelligence diff --git a/fern/pages/05-guides/sdks/csharp/csharp-lemur.mdx b/fern/pages/05-guides/sdks/csharp/csharp-lemur.mdx index 26dc26e..e1e89c5 100644 --- a/fern/pages/05-guides/sdks/csharp/csharp-lemur.mdx +++ b/fern/pages/05-guides/sdks/csharp/csharp-lemur.mdx @@ -1,12 +1,15 @@ --- title: "C# SDK Reference" --- + - As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [LeMUR page](/docs/lemur/apply-llms-to-audio-files) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [LeMUR page](/docs/lemur/apply-llms-to-audio-files) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # LeMUR diff --git a/fern/pages/05-guides/sdks/csharp/csharp-streaming.mdx b/fern/pages/05-guides/sdks/csharp/csharp-streaming.mdx index b79c0cd..d7a3f83 100644 --- a/fern/pages/05-guides/sdks/csharp/csharp-streaming.mdx +++ b/fern/pages/05-guides/sdks/csharp/csharp-streaming.mdx @@ -1,12 +1,15 @@ --- title: "C# SDK Reference" --- + - As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [C# Streaming page](/docs/getting-started/transcribe-streaming-audio-from-a-microphone/csharp) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [C# Streaming page](/docs/getting-started/transcribe-streaming-audio-from-a-microphone/csharp) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Streaming Speech-to-Text @@ -27,8 +30,9 @@ The audio format must conform to the following requirements: - 100 to 2000 milliseconds of audio per message - Audio segments with a duration between 100 ms and 450 ms produce the best - results in transcription accuracy. + +Audio segments with a duration between 100 ms and 450 ms produce the best results in transcription accuracy. + ## Specify the encoding @@ -63,9 +67,9 @@ await using var transcriber = new RealtimeTranscriber(new RealtimeTranscriberOpt ``` - If you're not using one of the SDKs, you must ensure that the `word_boost` - parameter is a JSON array that is URL encoded. See this [code - example](/docs/guides/real-time-streaming-transcription#adding-custom-vocabulary). + +If you're not using one of the SDKs, you must ensure that the `word_boost` parameter is a JSON array that is URL encoded. See this [code example](/docs/guides/real-time-streaming-transcription#adding-custom-vocabulary). + ## Authenticate with a temporary token @@ -92,8 +96,9 @@ var tokenResponse = await client.Realtime.CreateTemporaryTokenAsync(expiresIn: 6 The client should retrieve the token from the server and use the token to authenticate the transcriber. - Each token has a one-time use restriction and can only be used for a single - session. + +Each token has a one-time use restriction and can only be used for a single session. + ```csharp {3} @@ -131,10 +136,9 @@ await transcriber.ConfigureEndUtteranceThresholdAsync(500); ``` - By default, Streaming Speech-to-Text ends an utterance after 700 milliseconds - of silence. You can configure the duration threshold any number of times - during a session after the session has started. The valid range is between 0 - and 20000. + +By default, Streaming Speech-to-Text ends an utterance after 700 milliseconds of silence. You can configure the duration threshold any number of times during a session after the session has started. The valid range is between 0 and 20000. + ## Disable partial transcripts diff --git a/fern/pages/05-guides/sdks/csharp/csharp.mdx b/fern/pages/05-guides/sdks/csharp/csharp.mdx index b1d6615..e4688d3 100644 --- a/fern/pages/05-guides/sdks/csharp/csharp.mdx +++ b/fern/pages/05-guides/sdks/csharp/csharp.mdx @@ -1,12 +1,15 @@ --- title: "C# SDK Reference" --- + - As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [C# Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/csharp) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI C# SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [C# Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/csharp) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. ## Installation diff --git a/fern/pages/05-guides/sdks/go/go-async.mdx b/fern/pages/05-guides/sdks/go/go-async.mdx index 5b72233..d8ba6af 100644 --- a/fern/pages/05-guides/sdks/go/go-async.mdx +++ b/fern/pages/05-guides/sdks/go/go-async.mdx @@ -1,12 +1,14 @@ --- title: "Go SDK Reference" --- + As of April 2025, AssemblyAI Go SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Pre-recorded audio diff --git a/fern/pages/05-guides/sdks/go/go-audio-intelligence.mdx b/fern/pages/05-guides/sdks/go/go-audio-intelligence.mdx index 6136ae9..bec30f2 100644 --- a/fern/pages/05-guides/sdks/go/go-audio-intelligence.mdx +++ b/fern/pages/05-guides/sdks/go/go-audio-intelligence.mdx @@ -1,12 +1,15 @@ --- title: "Go SDK Reference" --- + - As of April 2025, AssemblyAI Go SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Go SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Audio Intelligence @@ -23,9 +26,9 @@ Each chapter contains the following: - Start and end timestamps - You can only enable one of the Auto Chapters and - [Summarization](/docs/audio-intelligence/summarization) models in the same - transcription. + +You can only enable one of the Auto Chapters and [Summarization](/docs/audio-intelligence/summarization) models in the same transcription. + **Quickstart** @@ -72,9 +75,9 @@ func main() { ``` - Check out this cookbook [Creating Chapter - Summaries](/docs/guides/input-text-chapters) for an example of how to leverage - LeMUR's custom text input parameter for chapter summaries. + +Check out this cookbook [Creating Chapter Summaries](/docs/guides/input-text-chapters) for an example of how to leverage LeMUR's custom text input parameter for chapter summaries. + For the full API reference, see the [API reference section on the Auto Chapters page](/docs/audio-intelligence/auto-chapters#api-reference). @@ -206,8 +209,9 @@ Here are a few examples of what you can detect: For the full list of entities that you can detect, see [Supported entities](/docs/audio-intelligence/entity-detection#supported-entities). - Entity Detection is available in multiple languages. See [Supported - languages](/docs/speech-to-text/pre-recorded-audio/supported-languages). + +Entity Detection is available in multiple languages. See [Supported languages](/docs/speech-to-text/pre-recorded-audio/supported-languages). + **Quickstart** @@ -329,15 +333,15 @@ When you enable the PII Redaction model, your transcript will look like this: You can also [Create redacted audio files](/docs/audio-intelligence/pii-redaction#create-redacted-audio-files) to replace sensitive information with a beeping sound. - PII Redaction is available in multiple languages. See [Supported - languages](/docs/speech-to-text/pre-recorded-audio/supported-languages). + +PII Redaction is available in multiple languages. See [Supported languages](/docs/speech-to-text/pre-recorded-audio/supported-languages). + - PII only redacts words in the `text` property. Properties from other features - may still include PII, such as `entities` from [Entity - Detection](/docs/audio-intelligence/entity-detection) or `summary` from - [Summarization](/docs/audio-intelligence/summarization). + +PII only redacts words in the `text` property. Properties from other features may still include PII, such as `entities` from [Entity Detection](/docs/audio-intelligence/entity-detection) or `summary` from [Summarization](/docs/audio-intelligence/summarization). + **Quickstart** @@ -420,8 +424,9 @@ You can only create redacted audio files for transcriptions in English and Spani - You can only create redacted versions of audio files if the original file is - smaller than 1 GB. + +You can only create redacted versions of audio files if the original file is smaller than 1 GB. + **Example output** @@ -487,9 +492,9 @@ Timestamp: 250 - 6350 ``` - Check out this cookbook [LeMUR for Customer Call Sentiment - Analysis](/docs/guides/call-sentiment-analysis) for an example of how to - leverage LeMUR's QA feature for sentiment analysis. + +Check out this cookbook [LeMUR for Customer Call Sentiment Analysis](/docs/guides/call-sentiment-analysis) for an example of how to leverage LeMUR's QA feature for sentiment analysis. + **Add speaker labels to sentiments** @@ -567,8 +572,9 @@ func main() { ``` - If you want more control of the output format, see how to generate a [Custom - summary using LeMUR](/docs/lemur/summarize-audio). + +If you want more control of the output format, see how to generate a [Custom summary using LeMUR](/docs/lemur/summarize-audio). + For the full API reference, as well as the supported summary models/types and FAQs, refer to the [full Summarization page](/docs/audio-intelligence/summarization). @@ -636,8 +642,9 @@ Audio is 93.78% relevant to Home&Garden>IndoorEnvironmentalQuality ``` - Check out this cookbook [Custom Topic Tags](/docs/guides/custom-topic-tags) - for an example of how to leverage LeMUR for custom topic detection. + +Check out this cookbook [Custom Topic Tags](/docs/guides/custom-topic-tags) for an example of how to leverage LeMUR for custom topic detection. + For the full API reference, as well as the full list of supported topics and FAQs, refer to the [full Topic Detection page](/docs/audio-intelligence/topic-detection). diff --git a/fern/pages/05-guides/sdks/go/go-lemur.mdx b/fern/pages/05-guides/sdks/go/go-lemur.mdx index beeaa1b..5c10ee0 100644 --- a/fern/pages/05-guides/sdks/go/go-lemur.mdx +++ b/fern/pages/05-guides/sdks/go/go-lemur.mdx @@ -1,12 +1,14 @@ --- title: "Go SDK Reference" --- + As of April 2025, AssemblyAI Go SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # LeMUR diff --git a/fern/pages/05-guides/sdks/go/go-streaming.mdx b/fern/pages/05-guides/sdks/go/go-streaming.mdx index 4f80685..992ed0c 100644 --- a/fern/pages/05-guides/sdks/go/go-streaming.mdx +++ b/fern/pages/05-guides/sdks/go/go-streaming.mdx @@ -1,12 +1,15 @@ --- title: "Go SDK Reference" --- + - As of April 2025, AssemblyAI Go SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Go SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Streaming Speech-to-Text @@ -14,7 +17,9 @@ title: "Go SDK Reference" AssemblyAI's Streaming Speech-to-Text (STT) allows you to transcribe live audio streams with high accuracy and low latency. By streaming your audio data to our secure WebSocket API, you can receive transcripts back within a few hundred milliseconds. - Streaming Speech-to-Text is only available for English. + +Streaming Speech-to-Text is only available for English. + ## Audio requirements @@ -27,8 +32,9 @@ The audio format must conform to the following requirements: - 100 to 2000 milliseconds of audio per message - Audio segments with a duration between 100 ms and 450 ms produce the best - results in transcription accuracy. + +Audio segments with a duration between 100 ms and 450 ms produce the best results in transcription accuracy. + ## Specify the encoding @@ -63,9 +69,9 @@ client := aai.NewRealTimeClientWithOptions( ``` - If you're not using one of the SDKs, you must ensure that the `word_boost` - parameter is a JSON array that is URL encoded. See this [code - example](/docs/guides/real-time-streaming-transcription#adding-custom-vocabulary). + +If you're not using one of the SDKs, you must ensure that the `word_boost` parameter is a JSON array that is URL encoded. See this [code example](/docs/guides/real-time-streaming-transcription#adding-custom-vocabulary). + ## Authenticate with a temporary token @@ -94,8 +100,9 @@ resp, _ := client.RealTime.CreateTemporaryToken(ctx, 60) The client should retrieve the token from the server and use the token to authenticate the transcriber. - Each token has a one-time use restriction and can only be used for a single - session. + +Each token has a one-time use restriction and can only be used for a single session. + To use it, specify the [`WithRealTimeAuthToken`](https://pkg.go.dev/github.com/AssemblyAI/assemblyai-go-sdk#WithRealTimeAuthToken) parameter when creating the real-time client. @@ -131,10 +138,9 @@ client.SetEndUtteranceSilenceThreshold(ctx, 500) ``` - By default, Streaming Speech-to-Text ends an utterance after 700 milliseconds - of silence. You can configure the duration threshold any number of times - during a session after the session has started. The valid range is between 0 - and 20000. + +By default, Streaming Speech-to-Text ends an utterance after 700 milliseconds of silence. You can configure the duration threshold any number of times during a session after the session has started. The valid range is between 0 and 20000. + ## Disable partial transcripts diff --git a/fern/pages/05-guides/sdks/go/go.mdx b/fern/pages/05-guides/sdks/go/go.mdx index 3f028cb..2c430ba 100644 --- a/fern/pages/05-guides/sdks/go/go.mdx +++ b/fern/pages/05-guides/sdks/go/go.mdx @@ -1,12 +1,14 @@ --- title: "Go SDK Reference" --- + As of April 2025, AssemblyAI Go SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # AssemblyAI Go SDK diff --git a/fern/pages/05-guides/sdks/java/java-async.mdx b/fern/pages/05-guides/sdks/java/java-async.mdx index eef470a..6f1e2bb 100644 --- a/fern/pages/05-guides/sdks/java/java-async.mdx +++ b/fern/pages/05-guides/sdks/java/java-async.mdx @@ -1,12 +1,14 @@ --- title: "Java SDK Reference" --- + As of April 2025, AssemblyAI Java SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Pre-recorded audio diff --git a/fern/pages/05-guides/sdks/java/java-audio-intelligence.mdx b/fern/pages/05-guides/sdks/java/java-audio-intelligence.mdx index 2854db0..cb61b74 100644 --- a/fern/pages/05-guides/sdks/java/java-audio-intelligence.mdx +++ b/fern/pages/05-guides/sdks/java/java-audio-intelligence.mdx @@ -1,12 +1,14 @@ --- title: "Java SDK Reference" --- + As of April 2025, AssemblyAI Java SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Audio Intelligence diff --git a/fern/pages/05-guides/sdks/java/java-lemur.mdx b/fern/pages/05-guides/sdks/java/java-lemur.mdx index b527644..a52cad6 100644 --- a/fern/pages/05-guides/sdks/java/java-lemur.mdx +++ b/fern/pages/05-guides/sdks/java/java-lemur.mdx @@ -1,12 +1,15 @@ --- title: "Java SDK Reference" --- + - As of April 2025, AssemblyAI Java SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Java SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # LeMUR diff --git a/fern/pages/05-guides/sdks/java/java-streaming.mdx b/fern/pages/05-guides/sdks/java/java-streaming.mdx index 74aedff..c57a466 100644 --- a/fern/pages/05-guides/sdks/java/java-streaming.mdx +++ b/fern/pages/05-guides/sdks/java/java-streaming.mdx @@ -1,12 +1,15 @@ --- title: "Java SDK Reference" --- + - As of April 2025, AssemblyAI Java SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Java SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Streaming Speech-to-Text @@ -14,7 +17,9 @@ title: "Java SDK Reference" AssemblyAI's Streaming Speech-to-Text (STT) allows you to transcribe live audio streams with high accuracy and low latency. By streaming your audio data to our secure WebSocket API, you can receive transcripts back within a few hundred milliseconds. - Streaming Speech-to-Text is only available for English. + +Streaming Speech-to-Text is only available for English. + ## Audio requirements @@ -27,8 +32,9 @@ The audio format must conform to the following requirements: - 100 to 2000 milliseconds of audio per message - Audio segments with a duration between 100 ms and 450 ms produce the best - results in transcription accuracy. + +Audio segments with a duration between 100 ms and 450 ms produce the best results in transcription accuracy. + ## Specify the encoding @@ -138,10 +144,9 @@ realtimeTranscriber.configureEndUtteranceSilenceThreshold(300) ``` - By default, Streaming Speech-to-Text ends an utterance after 700 milliseconds - of silence. You can configure the duration threshold any number of times - during a session after the session has started. The valid range is between 0 - and 20000. + +By default, Streaming Speech-to-Text ends an utterance after 700 milliseconds of silence. You can configure the duration threshold any number of times during a session after the session has started. The valid range is between 0 and 20000. + ## Disable partial transcripts diff --git a/fern/pages/05-guides/sdks/java/java.mdx b/fern/pages/05-guides/sdks/java/java.mdx index c0a283b..fbb61cd 100644 --- a/fern/pages/05-guides/sdks/java/java.mdx +++ b/fern/pages/05-guides/sdks/java/java.mdx @@ -1,12 +1,15 @@ --- title: "Java SDK Reference" --- + - As of April 2025, AssemblyAI Java SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Java SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [API Reference Guide](/docs/api-reference/overview) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. ## Installation diff --git a/fern/pages/05-guides/sdks/ruby/ruby-async.mdx b/fern/pages/05-guides/sdks/ruby/ruby-async.mdx index ef4c50d..f7eb729 100644 --- a/fern/pages/05-guides/sdks/ruby/ruby-async.mdx +++ b/fern/pages/05-guides/sdks/ruby/ruby-async.mdx @@ -3,11 +3,13 @@ title: "Ruby SDK Reference" --- - As of April 2025, AssemblyAI Ruby SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [Ruby Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/ruby) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Ruby SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [Ruby Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/ruby) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Pre-recorded audio @@ -17,9 +19,9 @@ Our Speech-to-Text model enables you to transcribe pre-recorded audio into writt On top of the transcription, you can enable other features and models, such as [Speaker Diarization](/docs/speech-to-text/speaker-diarization), by adding additional parameters to the same transcription request. - Choose between [_Best_ and - _Nano_](#select-the-speech-model-with-best-and-nano) based on the cost and - performance tradeoffs best suited for your application. + +Choose between [_Best_ and _Nano_](#select-the-speech-model-with-best-and-nano) based on the cost and performance tradeoffs best suited for your application. + The following example transcribes an audio file from a URL. @@ -87,6 +89,7 @@ puts transcript.error if transcript.status == AssemblyAI::Transcripts::Transcrip ``` + A transcription may fail for various reasons: - Unsupported file format @@ -195,9 +198,9 @@ transcript = client.transcripts.transcribe( ``` - For a workflow that resubmits a transcription request using a default language - if the threshold is not reached, see [this - cookbook](/docs/guides/automatic-language-detection-route-default-language). + +For a workflow that resubmits a transcription request using a default language if the threshold is not reached, see [this cookbook](/docs/guides/automatic-language-detection-route-default-language). + ## Set language manually @@ -258,6 +261,7 @@ transcript = client.transcripts.transcribe( ``` + Follow formatting guidelines for custom vocabulary to ensure the best results: - Remove all punctuation except apostrophes. @@ -299,7 +303,11 @@ Additionally, each word in the `words` array contains the channel identifier. ## Dual-channel transcription -Use [Multichannel](#multichannel-transcription) instead. + + +Use [Multichannel](#multichannel-transcription) instead. + + ## Export SRT or VTT caption files @@ -473,10 +481,9 @@ The Speaker Diarization model lets you detect multiple speakers in an audio file If you enable Speaker Diarization, the resulting transcript will return a list of _utterances_, where each utterance corresponds to an uninterrupted segment of speech from a single speaker. - Speaker Diarization doesn't support multichannel transcription. Enabling both - Speaker Diarization and - [multichannel](/docs/speech-to-text/pre-recorded-audio/multichannel-transcription) - will result in an error. + +Speaker Diarization doesn't support multichannel transcription. Enabling both Speaker Diarization and [multichannel](/docs/speech-to-text/pre-recorded-audio/multichannel-transcription) will result in an error. + **Quickstart** @@ -529,6 +536,7 @@ transcript = client.transcripts.transcribe( ``` - The `speakers_expected` parameter is ignored for audio files with a duration - less than 2 minutes. + +The `speakers_expected` parameter is ignored for audio files with a duration less than 2 minutes. + diff --git a/fern/pages/05-guides/sdks/ruby/ruby-audio-intelligence.mdx b/fern/pages/05-guides/sdks/ruby/ruby-audio-intelligence.mdx index af22844..258438f 100644 --- a/fern/pages/05-guides/sdks/ruby/ruby-audio-intelligence.mdx +++ b/fern/pages/05-guides/sdks/ruby/ruby-audio-intelligence.mdx @@ -1,12 +1,15 @@ --- title: "Ruby SDK Reference" --- + - As of April 2025, AssemblyAI Ruby SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [Ruby Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/ruby) and any of our Audio Intelligence pages for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Ruby SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [Ruby Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/ruby) and any of our Audio Intelligence pages for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # Ruby Audio Intelligence @@ -568,8 +571,9 @@ Audio is 93.78% relevant to Home&Garden>IndoorEnvironmentalQuality ``` - Check out this cookbook [Custom Topic Tags](/docs/guides/custom-topic-tags) - for an example of how to leverage LeMUR for custom topic detection. + +Check out this cookbook [Custom Topic Tags](/docs/guides/custom-topic-tags) for an example of how to leverage LeMUR for custom topic detection. + For the full API reference, as well as the full list of supported topics and FAQs, refer to the [full Topic Detection page](/docs/audio-intelligence/topic-detection). diff --git a/fern/pages/05-guides/sdks/ruby/ruby-lemur.mdx b/fern/pages/05-guides/sdks/ruby/ruby-lemur.mdx index d8c146d..a34aa6d 100644 --- a/fern/pages/05-guides/sdks/ruby/ruby-lemur.mdx +++ b/fern/pages/05-guides/sdks/ruby/ruby-lemur.mdx @@ -1,12 +1,15 @@ --- title: "Ruby SDK Reference" --- + - As of April 2025, AssemblyAI Ruby SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [LeMUR page](/docs/lemur/apply-llms-to-audio-files) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Ruby SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [LeMUR page](/docs/lemur/apply-llms-to-audio-files) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. # LeMUR diff --git a/fern/pages/05-guides/sdks/ruby/ruby.mdx b/fern/pages/05-guides/sdks/ruby/ruby.mdx index a67710b..5479643 100644 --- a/fern/pages/05-guides/sdks/ruby/ruby.mdx +++ b/fern/pages/05-guides/sdks/ruby/ruby.mdx @@ -3,11 +3,13 @@ title: "Ruby SDK Reference" --- - As of April 2025, AssemblyAI Ruby SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. - Going forward, see the [Ruby Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/ruby) for information on how to integrate with our API directly. +As of April 2025, AssemblyAI Ruby SDK has been discontinued and will no longer be maintained. While the SDK will no longer be updated, any previously published releases will remain available. + +Going forward, see the [Ruby Pre-Recorded Audio page](/docs/getting-started/transcribe-an-audio-file/ruby) for information on how to integrate with our API directly. + +We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. - We know this is a disruptive change. If you need help with this transition, reach out to our Support team at support@assemblyai.com and we'll help you in any way we can. The AssemblyAI Ruby SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async, diff --git a/fern/pages/08-concepts/account_management.mdx b/fern/pages/08-concepts/account_management.mdx index 912028e..269319f 100644 --- a/fern/pages/08-concepts/account_management.mdx +++ b/fern/pages/08-concepts/account_management.mdx @@ -60,9 +60,11 @@ Get insights into your usage and spend to track and manage costs effectively wit ## Usage Limits - With the current version of multi-project support, rate limiting is applied at the account level, not at the project level. This means that the rate limits for each API key mirror the rate limits for the account. - Example: If an account has an Async concurrency of 200, each API key for that account will be able to process up to 200 requests concurrently. +With the current version of multi-project support, rate limiting is applied at the account level, not at the project level. This means that the rate limits for each API key mirror the rate limits for the account. + +Example: If an account has an Async concurrency of 200, each API key for that account will be able to process up to 200 requests concurrently. + To ensure a smooth experience for all users, certain operations have per-account usage limits. @@ -71,7 +73,9 @@ To ensure a smooth experience for all users, certain operations have per-account - **Rate limits** for synchronous operations - Our services are infinitely scalable and we offer custom concurrency limits that scale to support any workload at no additional cost. If you need a higher concurrency limit please either contact our Sales team or send an email to our [Support team](https://www.assemblyai.com/contact/support). + +Our services are infinitely scalable and we offer custom concurrency limits that scale to support any workload at no additional cost. If you need a higher concurrency limit please either contact our{" "} Sales team {" "} or send an email to our [Support team](https://www.assemblyai.com/contact/support). + ### Speech-to-Text usage limits