Skip to content

Consolidate MDX block format #228

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 14, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 20 additions & 13 deletions fern/pages/05-guides/sdks/csharp/csharp-async.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
---
title: "C# SDK Reference"
---

<Warning title="Deprecation Notice">
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 [email protected] 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 [email protected] and we'll help you in any way we can.
</Warning>

# Pre-recorded audio
Expand All @@ -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.

<Tip title="Choose model class">
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.

</Tip>

The following example transcribes an audio file from a URL.
Expand Down Expand Up @@ -113,6 +116,7 @@ if (transcript.Status == TranscriptStatus.Error)
```

<Note>

A transcription may fail for various reasons:

- Unsupported file format
Expand Down Expand Up @@ -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`.

<Note>
The base URL for EU is currently only available for Async transcription.

The base URL for EU is currently only available for Async transcription.

</Note>

| Region | Base URL |
Expand Down Expand Up @@ -280,6 +286,7 @@ var transcript = await client.Transcripts.TranscribeAsync(new TranscriptParams
```

<Note>

Follow formatting guidelines for custom vocabulary to ensure the best results:

- Remove all punctuation except apostrophes.
Expand Down Expand Up @@ -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.

<Warning title="Speaker Diarization and multichannel">
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.

</Warning>

**Quickstart**
Expand Down Expand Up @@ -564,6 +570,7 @@ var transcript = await client.Transcripts.TranscribeAsync(new TranscriptParams
```

<Note>
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.

</Note>
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
---
title: "C# SDK Reference"
---

<Warning title="Deprecation Notice">
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 [email protected] 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 [email protected] and we'll help you in any way we can.
</Warning>

# Audio Intelligence
Expand Down
9 changes: 6 additions & 3 deletions fern/pages/05-guides/sdks/csharp/csharp-lemur.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
---
title: "C# SDK Reference"
---

<Warning title="Deprecation Notice">
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 [email protected] 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 [email protected] and we'll help you in any way we can.
</Warning>

# LeMUR
Expand Down
32 changes: 18 additions & 14 deletions fern/pages/05-guides/sdks/csharp/csharp-streaming.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
---
title: "C# SDK Reference"
---

<Warning title="Deprecation Notice">
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 [email protected] 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 [email protected] and we'll help you in any way we can.
</Warning>

# Streaming Speech-to-Text
Expand All @@ -27,8 +30,9 @@ The audio format must conform to the following requirements:
- 100 to 2000 milliseconds of audio per message

<Tip>
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.

</Tip>

## Specify the encoding
Expand Down Expand Up @@ -63,9 +67,9 @@ await using var transcriber = new RealtimeTranscriber(new RealtimeTranscriberOpt
```

<Note>
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).

</Note>

## Authenticate with a temporary token
Expand All @@ -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.

<Note>
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.

</Note>

```csharp {3}
Expand Down Expand Up @@ -131,10 +136,9 @@ await transcriber.ConfigureEndUtteranceThresholdAsync(500);
```

<Note>
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.

</Note>

## Disable partial transcripts
Expand Down
9 changes: 6 additions & 3 deletions fern/pages/05-guides/sdks/csharp/csharp.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
---
title: "C# SDK Reference"
---

<Warning title="Deprecation Notice">
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 [email protected] 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 [email protected] and we'll help you in any way we can.
</Warning>

## Installation
Expand Down
6 changes: 4 additions & 2 deletions fern/pages/05-guides/sdks/go/go-async.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: "Go SDK Reference"
---

<Warning title="Deprecation Notice">
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 [email protected] 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 [email protected] and we'll help you in any way we can.
</Warning>

# Pre-recorded audio
Expand Down
59 changes: 33 additions & 26 deletions fern/pages/05-guides/sdks/go/go-audio-intelligence.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
---
title: "Go SDK Reference"
---

<Warning title="Deprecation Notice">
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 [email protected] 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 [email protected] and we'll help you in any way we can.
</Warning>

# Audio Intelligence
Expand All @@ -23,9 +26,9 @@ Each chapter contains the following:
- Start and end timestamps

<Warning title="Auto Chapters and Summarization">
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.

</Warning>

**Quickstart**
Expand Down Expand Up @@ -72,9 +75,9 @@ func main() {
```

<Tip title="Auto Chapters Using LeMUR">
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.

</Tip>

For the full API reference, see the [API reference section on the Auto Chapters page](/docs/audio-intelligence/auto-chapters#api-reference).
Expand Down Expand Up @@ -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).

<Tip title="Supported languages">
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).

</Tip>

**Quickstart**
Expand Down Expand Up @@ -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.

<Tip title="Supported languages">
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).

</Tip>

<Warning title="Redacted properties">
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).

</Warning>

**Quickstart**
Expand Down Expand Up @@ -420,8 +424,9 @@ You can only create redacted audio files for transcriptions in English and Spani
</Note>

<Warning title="Maximum audio file size">
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.

</Warning>

**Example output**
Expand Down Expand Up @@ -487,9 +492,9 @@ Timestamp: 250 - 6350
```

<Tip title="Sentiment Analysis Using LeMUR">
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.

</Tip>

**Add speaker labels to sentiments**
Expand Down Expand Up @@ -567,8 +572,9 @@ func main() {
```

<Tip title="Custom Summaries Using LeMUR">
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).

</Tip>

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).
Expand Down Expand Up @@ -636,8 +642,9 @@ Audio is 93.78% relevant to Home&Garden>IndoorEnvironmentalQuality
```

<Tip title="Topic Detection Using LeMUR">
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.

</Tip>

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).
6 changes: 4 additions & 2 deletions fern/pages/05-guides/sdks/go/go-lemur.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
---
title: "Go SDK Reference"
---

<Warning title="Deprecation Notice">
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 [email protected] 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 [email protected] and we'll help you in any way we can.
</Warning>

# LeMUR
Expand Down
Loading