Skip to content

docs: replace placeholder example.com audio URLs with real samples #184

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.

Sign up for GitHub

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
brit9612 merged 1 commit into from
Sep 14, 2026
Merged

docs: replace placeholder example.com audio URLs with real samples #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const client = new AssemblyAI({
});

const transcript = await client.transcripts.transcribe({
audio: "https://example.com/audio.mp3",
audio: "https://assembly.ai/wildfires.mp3",
speech_models: ["universal-3-5-pro", "universal-2"],
speaker_labels: true,
});
Expand Down
10 changes: 5 additions & 5 deletions samples/speaker-diarization.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ async function transcribeWithSpeakerDiarization() {
// Example 1: Basic speaker diarization (uses smart defaults)
// The model automatically detects the optimal number of speakers
let transcript = await client.transcripts.transcribe({
audio: "https://example.com/audio.mp3",
audio: "https://assemblyaiassets.com/audios/medical.mp3",
speaker_labels: true,
})

Expand All @@ -25,7 +25,7 @@ async function transcribeWithSpeakerDiarization() {
// Example 2: Provide a hint with speakers_expected (smart default with guidance)
// Still uses smart defaults but gives the model a hint about expected speakers
transcript = await client.transcripts.transcribe({
audio: "https://example.com/audio.mp3",
audio: "https://assemblyaiassets.com/audios/medical.mp3",
speaker_labels: true,
speakers_expected: 3,
})
Expand All @@ -40,7 +40,7 @@ async function transcribeWithSpeakerDiarization() {
}

transcript = await client.transcripts.transcribe({
audio: "https://example.com/audio.mp3",
audio: "https://assemblyaiassets.com/audios/medical.mp3",
speaker_labels: true,
speaker_options: speakerOptions,
})
Expand All @@ -49,7 +49,7 @@ async function transcribeWithSpeakerDiarization() {

// Note: The following would be INVALID since speakers_expected and speaker_options are mutually exclusive:
// transcript = await client.transcripts.transcribe({
// audio: "https://example.com/audio.mp3",
// audio: "https://assemblyaiassets.com/audios/medical.mp3",
// speaker_labels: true,
// speakers_expected: 3, // ❌ Cannot use both
// speaker_options: { min_speakers_expected: 2 }, // ❌ Cannot use both
Expand All @@ -58,7 +58,7 @@ async function transcribeWithSpeakerDiarization() {
// Example 4: Edge case handling for challenging audio
// Use speaker_options when you need precise control over speaker detection
transcript = await client.transcripts.transcribe({
audio: "https://example.com/audio.mp3",
audio: "https://assemblyaiassets.com/audios/medical.mp3",
speaker_labels: true,
speaker_options: {
min_speakers_expected: 1, // Handle solo speakers or presentations
Expand Down
Loading