ReferenzBibliotheken & SDKsScribe (STT)

JavaScript SDK

Scribe: Echtzeit-Spracherkennung in JavaScript

Einen Überblick über Scribe und seine Funktionen finden Sie in der Speech-to-Text- Übersicht. Schritt-für-Schritt-Anleitungen finden Sie unter Clientseitiges Streaming.

Installation

npm install @elevenlabs/client
# or
yarn add @elevenlabs/client
# or
pnpm install @elevenlabs/client

Verwenden Sie den ElevenLabs-Speech-to-Text-Skill, um Audio mit Ihrem KI-Coding-Assistenten zu transkribieren:

npx skills add elevenlabs/skills --skill speech-to-text

Diese Bibliothek kann in jedem JavaScript-basierten Projekt verwendet werden. Wenn Sie React verwenden, nutzen Sie den useScribe-Hook, der integrierte Statusverwaltung und Lifecycle-Handling bietet.

Verwendung

Hier ist ein minimales funktionierendes Beispiel, das eine Verbindung zu Scribe herstellt und Transkriptionsergebnisse protokolliert:

import { Scribe, RealtimeEvents } from "@elevenlabs/client";
const token = await fetchTokenFromServer();
const connection = Scribe.connect({
  token,
  modelId: "scribe_v2_realtime",
  microphone: {
    echoCancellation: true,
    noiseSuppression: true,
  },
});
connection.on(RealtimeEvents.PARTIAL_TRANSCRIPT, (data) => {
  console.log("Partial:", data.text);
});
connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
  console.log("Committed:", data.text);
});
// Later, close the connection
connection.close();

Token abrufen

Scribe benötigt zur Authentifizierung ein Einmal-Token. Erstellen Sie einen API-Endpunkt auf Ihrem Server:

// Node.js server
app.get("/scribe-token", yourAuthMiddleware, async (req, res) => {
  const response = await fetch("https://api.elevenlabs.io/v1/single-use-token/realtime_scribe", {
    method: "POST",
    headers: {
      "xi-api-key": process.env.ELEVENLABS_API_KEY,
    },
  });
  const data = await response.json();
  res.json({ token: data.token });
});

Ihr ElevenLabs API-Key ist vertraulich. Geben Sie ihn niemals an den Client weiter. Generieren Sie das Token immer auf dem Server.

// Client
const fetchToken = async () => {
  const response = await fetch("/scribe-token");
  const { token } = await response.json();
  return token;
};

Verbindungsoptionen

Scribe.connect() akzeptiert entweder Mikrofonoptionen oder manuelle Audiooptionen. Beide verwenden gemeinsame Basisoptionen.

Basisoptionen

EigenschaftTypStandardBeschreibung
tokenstringEinmal-Token für die WebSocket-Authentifizierung.
modelIdstringModell-ID (z. B. "scribe_v2_realtime").
baseUristring"wss://api.elevenlabs.io"Benutzerdefinierte WebSocket-Basis-URI.
commitStrategyCommitStrategy"manual""manual" oder "vad".
vadSilenceThresholdSecsnumber1.5Sekunden Stille, bevor VAD übernimmt (0.3-3.0).
vadThresholdnumber0.4VAD-Empfindlichkeit (0.1-0.9, niedrigere Werte sind empfindlicher).
minSpeechDurationMsnumber100Minimale Sprechdauer in ms (50-2000).
minSilenceDurationMsnumber100Minimale Stilledauer in ms (50-2000).
languageCodestringISO-639-1- oder ISO-639-3-Sprachcode. Für automatische Erkennung leer lassen.
includeTimestampsbooleanfalseZeitstempel auf Wortebene über das Event COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS empfangen.

Mikrofonoptionen

Übergeben Sie ein microphone-Objekt, um Audio direkt vom Mikrofon des Nutzers zu streamen. Die Verbindung verarbeitet getUserMedia und die Audiokodierung automatisch.

const connection = Scribe.connect({
  token,
  modelId: "scribe_v2_realtime",
  microphone: {
    deviceId: "optional-device-id",
    echoCancellation: true,
    noiseSuppression: true,
    autoGainControl: true,
  },
});
EigenschaftTypBeschreibung
deviceIdstringID eines bestimmten Mikrofongeräts.
echoCancellationbooleanEchounterdrückung aktivieren.
noiseSuppressionbooleanRauschunterdrückung aktivieren.
autoGainControlbooleanAutomatische Verstärkungsregelung aktivieren.

Manuelle Audiooptionen

Übergeben Sie audioFormat und sampleRate, um Audiodaten manuell über connection.send() zu senden.

import { AudioFormat } from "@elevenlabs/client";
const connection = Scribe.connect({
  token,
  modelId: "scribe_v2_realtime",
  audioFormat: AudioFormat.PCM_16000,
  sampleRate: 16000,
});
EigenschaftTypBeschreibung
audioFormatAudioFormatAudiokodierungsformat (z. B. AudioFormat.PCM_16000).
sampleRatenumberAbtastrate in Hz. Muss mit audioFormat übereinstimmen.

AudioFormat-Enum

enum AudioFormat {
  PCM_8000 = "pcm_8000",
  PCM_16000 = "pcm_16000",
  PCM_22050 = "pcm_22050",
  PCM_24000 = "pcm_24000",
  PCM_44100 = "pcm_44100",
  PCM_48000 = "pcm_48000",
  ULAW_8000 = "ulaw_8000",
}

Mikrofonmodus

Streamen Sie Audio direkt vom Mikrofon des Nutzers:

import { Scribe, RealtimeEvents } from "@elevenlabs/client";
async function transcribeFromMicrophone() {
  const token = await fetchToken();
  const connection = Scribe.connect({
    token,
    modelId: "scribe_v2_realtime",
    microphone: {
      echoCancellation: true,
      noiseSuppression: true,
      autoGainControl: true,
    },
  });
  connection.on(RealtimeEvents.PARTIAL_TRANSCRIPT, (data) => {
    document.getElementById("live").textContent = data.text;
  });
  connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
    const el = document.createElement("p");
    el.textContent = data.text;
    document.getElementById("transcripts").appendChild(el);
    document.getElementById("live").textContent = "";
  });
  document.getElementById("stop").addEventListener("click", () => {
    connection.close();
  });
}

Manueller Audiomodus (Dateitranskription)

Transkribieren Sie vorab aufgezeichnete Audiodateien, indem Sie die Audiodaten manuell senden:

import { Scribe, RealtimeEvents, AudioFormat } from "@elevenlabs/client";
async function transcribeFile(file) {
  const token = await fetchToken();
  const connection = Scribe.connect({
    token,
    modelId: "scribe_v2_realtime",
    audioFormat: AudioFormat.PCM_16000,
    sampleRate: 16000,
  });
  connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
    console.log("Transcript:", data.text);
  });
  // Decode audio file
  const arrayBuffer = await file.arrayBuffer();
  const audioContext = new AudioContext({ sampleRate: 16000 });
  const audioBuffer = await audioContext.decodeAudioData(arrayBuffer);
  // Convert to PCM16
  const channelData = audioBuffer.getChannelData(0);
  const pcmData = new Int16Array(channelData.length);
  for (let i = 0; i < channelData.length; i++) {
    const sample = Math.max(-1, Math.min(1, channelData[i]));
    pcmData[i] = sample < 0 ? sample * 32768 : sample * 32767;
  }
  // Send in chunks
  const chunkSize = 4096;
  for (let offset = 0; offset < pcmData.length; offset += chunkSize) {
    const chunk = pcmData.slice(offset, offset + chunkSize);
    const bytes = new Uint8Array(chunk.buffer);
    const base64 = btoa(String.fromCharCode(...bytes));
    connection.send({ audioBase64: base64 });
    await new Promise((resolve) => setTimeout(resolve, 50));
  }
  // Commit and close
  connection.commit();
}

RealtimeConnection

Scribe.connect() gibt eine RealtimeConnection-Instanz mit den folgenden Methoden zurück.

on(event, listener)

Registriert einen Event-Listener. Verfügbare Event-Typen finden Sie unter Events.

connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
  console.log("Committed:", data.text);
});

off(event, listener)

Entfernt einen zuvor registrierten Event-Listener.

const handler = (data) => console.log(data.text);
connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, handler);
// Later
connection.off(RealtimeEvents.COMMITTED_TRANSCRIPT, handler);

send(data)

Sendet Audiodaten an Scribe (nur im manuellen Audiomodus).

connection.send({
  audioBase64: base64AudioChunk,
  commit: false, // Optional: commit immediately
  sampleRate: 16000, // Optional: override sample rate
  previousText: "Previous transcription text", // Optional: context from a previous transcription
});

Das Feld previousText kann nur im ersten Audio-Chunk einer Sitzung gesendet werden. Das Senden in nachfolgenden Chunks führt zu einem Fehler.

commit()

Übernimmt die aktuelle Transkription manuell. Nur erforderlich bei Verwendung von CommitStrategy.MANUAL.

connection.commit();

close()

Schließt die WebSocket-Verbindung und bereinigt Ressourcen (Mikrofonstream, Audiokontext).

connection.close();

Events

Registrieren Sie Event-Listener mit connection.on(event, listener). Alle Events sind als Konstanten im Enum RealtimeEvents verfügbar.

Transkriptions-Events

EventDatenBeschreibung
SESSION_STARTED{ session_id: string }Scribe-Sitzung gestartet.
PARTIAL_TRANSCRIPT{ text: string }Vorläufiges Transkriptionsergebnis.
COMMITTED_TRANSCRIPT{ text: string }Finalisiertes Transkriptionsergebnis.
COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS{ text: string; language_code?: string; words?: WordsItem[] }Finalisiertes Ergebnis mit Zeitangaben auf Wortebene.

Der Typ WordsItem enthält Zeitinformationen auf Wortebene:

interface WordsItem {
  text?: string; // Word text
  start?: number; // Start time in seconds
  end?: number; // End time in seconds
  type?: "word" | "spacing"; // Token type
  speaker_id?: string; // Speaker identifier
}

Verbindungs-Events

EventDatenBeschreibung
OPENEventWebSocket-Verbindung geöffnet.
CLOSEEventWebSocket-Verbindung geschlossen.
ERRORError | EventAllgemeiner Fehler.

Fehler-Events

Alle Fehler-Events empfangen { error: string }.

EventBeschreibung
AUTH_ERRORAuthentifizierungsfehler.
QUOTA_EXCEEDEDNutzungskontingent überschritten.
COMMIT_THROTTLEDCommit-Anfrage gedrosselt.
TRANSCRIBER_ERRORFehler der Transkriptions-Engine.
UNACCEPTED_TERMSNutzungsbedingungen nicht akzeptiert.
RATE_LIMITEDRate-Limit erreicht.
INPUT_ERRORUngültiges Eingabeformat.
QUEUE_OVERFLOWVerarbeitungswarteschlange voll.
RESOURCE_EXHAUSTEDServerressourcen ausgelastet.
SESSION_TIME_LIMIT_EXCEEDEDMaximale Sitzungsdauer erreicht.
CHUNK_SIZE_EXCEEDEDAudio-Chunk zu groß.
INSUFFICIENT_AUDIO_ACTIVITYNicht genügend Audioaktivität, um die Verbindung aufrechtzuerhalten.

Commit-Strategien

Steuern Sie, wann Transkriptionen übernommen werden:

import { Scribe, CommitStrategy } from '@elevenlabs/client';
// Manual (default): you control when to commit
const connection = Scribe.connect({
  token,
  modelId: 'scribe_v2_realtime',
  audioFormat: AudioFormat.PCM_16000,
  sampleRate: 16000,
  commitStrategy: CommitStrategy.MANUAL,
});
// Send audio, then commit when ready
connection.send({ audioBase64: chunk });
connection.commit();
// Voice Activity Detection: Scribe detects silences and commits automatically
const connection = Scribe.connect({
  token,
  modelId: 'scribe_v2_realtime',
  microphone: { echoCancellation: true },
  commitStrategy: CommitStrategy.VAD,
});

Weitere Details finden Sie unter Transkripte und Commit-Strategien.

Vollständiges Beispiel

Hier ist ein vollständiges Beispiel, das Mikrofonaudio mit einer VAD-basierten Commit-Strategie transkribiert:

import { Scribe, RealtimeEvents, CommitStrategy } from "@elevenlabs/client";
async function startTranscription() {
  const token = await fetchToken();
  const connection = Scribe.connect({
    token,
    modelId: "scribe_v2_realtime",
    commitStrategy: CommitStrategy.VAD,
    microphone: {
      echoCancellation: true,
      noiseSuppression: true,
    },
  });
  connection.on(RealtimeEvents.SESSION_STARTED, (data) => {
    console.log("Session started:", data.session_id);
  });
  connection.on(RealtimeEvents.PARTIAL_TRANSCRIPT, (data) => {
    document.getElementById("live").textContent = data.text;
  });
  connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
    const el = document.createElement("p");
    el.textContent = data.text;
    document.getElementById("transcripts").appendChild(el);
    document.getElementById("live").textContent = "";
  });
  connection.on(RealtimeEvents.ERROR, (error) => {
    console.error("Scribe error:", error);
  });
  // Stop button
  document.getElementById("stop").addEventListener("click", () => {
    connection.close();
  });
}
document.getElementById("start").addEventListener("click", startTranscription);