@elevenlabs/elevenlabs-js 2.22.0 → 2.24.0

package/wrapper/music.d.ts

@@ -25,6 +25,8 @@ export interface MultipartResponse {
 }
 export declare class Music {
     private _client;
+    private readonly _options;
+    private _compositionPlan;
     constructor(options?: Music.Options);
     /**
      * Get the composition plan client
@@ -35,6 +37,7 @@ export declare class Music {
      * @throws {@link ElevenLabs.UnprocessableEntityError}
      */
     compose(request?: ElevenLabs.BodyComposeMusicV1MusicPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
+    private __compose;
     /**
      * Compose a song from a prompt or a composition plan with detailed response parsing.
      *
@@ -96,11 +99,19 @@ export declare class Music {
      */
     composeDetailed(request?: ElevenLabs.BodyComposeMusicWithADetailedResponseV1MusicDetailedPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<MultipartResponse>;
     private _composeDetailed;
+    private __composeDetailed;
     /**
      * Stream a composed song from a prompt or a composition plan.
      * @throws {@link ElevenLabs.UnprocessableEntityError}
      */
     stream(request?: ElevenLabs.BodyStreamComposedMusicV1MusicStreamPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
+    private __stream;
+    /**
+     * Separate a music file into individual stems
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     */
+    separateStems(request: ElevenLabs.BodyStemSeparationV1MusicStemSeparationPost, requestOptions?: Music.RequestOptions): core.HttpResponsePromise<ReadableStream<Uint8Array>>;
+    private __separateStems;
     /**
      * Reads a ReadableStream containing multipart data and parses it into JSON and audio parts
      * @param stream - ReadableStream from ElevenLabs music API response

package/wrapper/music.js

@@ -47,6 +47,7 @@ const Client_1 = require("../api/resources/music/client/Client");
 const core = __importStar(require("../core"));
 class Music {
     constructor(options = {}) {
+        this._options = options;
         this._client = new Client_1.Music(options);
     }
     /**
@@ -62,6 +63,12 @@ class Music {
     compose(request = {}, requestOptions) {
         return this._client.compose(request, requestOptions);
     }
+    // Private method for structural compatibility with generated Music class
+    __compose(request = {}, requestOptions) {
+        // This method exists for type compatibility only
+        // The actual implementation is delegated through compose()
+        throw new Error("Internal method - should not be called directly");
+    }
     /**
      * Compose a song from a prompt or a composition plan with detailed response parsing.
      *
@@ -139,6 +146,12 @@ class Music {
             }
         });
     }
+    // Private method for structural compatibility with generated Music class
+    __composeDetailed(request = {}, requestOptions) {
+        // This method exists for type compatibility only
+        // The actual implementation is delegated through composeDetailed()
+        throw new Error("Internal method - should not be called directly");
+    }
     /**
      * Stream a composed song from a prompt or a composition plan.
      * @throws {@link ElevenLabs.UnprocessableEntityError}
@@ -146,6 +159,25 @@ class Music {
     stream(request = {}, requestOptions) {
         return this._client.stream(request, requestOptions);
     }
+    // Private method for structural compatibility with generated Music class
+    __stream(request = {}, requestOptions) {
+        // This method exists for type compatibility only
+        // The actual implementation is delegated through stream()
+        throw new Error("Internal method - should not be called directly");
+    }
+    /**
+     * Separate a music file into individual stems
+     * @throws {@link ElevenLabs.UnprocessableEntityError}
+     */
+    separateStems(request, requestOptions) {
+        return this._client.separateStems(request, requestOptions);
+    }
+    // Private method for structural compatibility with generated Music class
+    __separateStems(request, requestOptions) {
+        // This method exists for type compatibility only
+        // The actual implementation is delegated through separateStems()
+        throw new Error("Internal method - should not be called directly");
+    }
     /**
      * Reads a ReadableStream containing multipart data and parses it into JSON and audio parts
      * @param stream - ReadableStream from ElevenLabs music API response

package/wrapper/realtime/connection.d.ts

@@ -1,5 +1,54 @@
 import WebSocket from "ws";
 import type { ChildProcess } from "node:child_process";
+import type { AudioFormat, CommitStrategy } from "./scribe";
+export interface InputAudioChunk {
+    message_type: "input_audio_chunk";
+    audio_base_64: string;
+    commit: boolean;
+    sample_rate: number;
+}
+export type WordsItemType = "word" | "spacing";
+export interface WordsItem {
+    text?: string;
+    start?: number;
+    end?: number;
+    type?: WordsItemType;
+    speaker_id?: string;
+    logprob?: number;
+    characters?: string[];
+}
+export interface Config {
+    sample_rate?: number;
+    audio_format?: AudioFormat;
+    language_code?: string;
+    vad_commit_strategy?: CommitStrategy;
+    vad_silence_threshold_secs?: number;
+    vad_threshold?: number;
+    min_speech_duration_ms?: number;
+    min_silence_duration_ms?: number;
+    model_id?: string;
+    disable_logging?: boolean;
+}
+export interface SessionStartedMessage {
+    message_type: "session_started";
+    session_id: string;
+    config: Config;
+}
+export interface PartialTranscriptMessage {
+    message_type: "partial_transcript";
+    text: string;
+}
+export interface CommittedTranscriptMessage {
+    message_type: "committed_transcript";
+    text: string;
+}
+export interface CommittedTranscriptWithTimestampsMessage {
+    message_type: "committed_transcript_with_timestamps";
+    text: string;
+    language_code?: string;
+    words?: WordsItem[];
+}
+export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage;
 /**
  * Events emitted by the RealtimeConnection.
  */
@@ -8,10 +57,10 @@ export declare enum RealtimeEvents {
     SESSION_STARTED = "session_started",
     /** Emitted when a partial (interim) transcript is available */
     PARTIAL_TRANSCRIPT = "partial_transcript",
-    /** Emitted when a final transcript is available */
-    FINAL_TRANSCRIPT = "final_transcript",
-    /** Emitted when a final transcript with timestamps is available */
-    FINAL_TRANSCRIPT_WITH_TIMESTAMPS = "final_transcript_with_timestamps",
+    /** Emitted when a committed transcript is available */
+    COMMITTED_TRANSCRIPT = "committed_transcript",
+    /** Emitted when a committed transcript with timestamps is available */
+    COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS = "committed_transcript_with_timestamps",
     /** Emitted when an error occurs */
     ERROR = "error",
     /** Emitted when the WebSocket connection is opened */
@@ -28,7 +77,7 @@ export declare enum RealtimeEvents {
  * @example
  * ```typescript
  * const connection = await client.speechToText.realtime.connect({
- *     modelId: "scribe_realtime_v2",
+ *     modelId: "scribe_v2_realtime",
  *     audioFormat: AudioFormat.PCM_16000,
  *     sampleRate: 16000,
  * });
@@ -41,7 +90,7 @@ export declare enum RealtimeEvents {
  *     console.log("Partial:", data.transcript);
  * });
  *
- * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+ * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
  *     console.log("Final:", data.transcript);
  *     connection.close();
  * });
@@ -85,7 +134,7 @@ export declare class RealtimeConnection {
      *     console.log("Partial:", data.transcript);
      * });
      *
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
      *     console.log("Final:", data.transcript);
      * });
      * ```
@@ -137,8 +186,8 @@ export declare class RealtimeConnection {
         sampleRate?: number;
     }): void;
     /**
-     * Commits the transcription, signaling that all audio has been sent.
-     * This finalizes the transcription and triggers a FINAL_TRANSCRIPT event.
+     * Commits the segment, triggering a COMMITTED_TRANSCRIPT event and clearing the buffer.
+     * It's recommend to commit often when using CommitStrategy.MANUAL to keep latency low.
      *
      * @throws {Error} If the WebSocket connection is not open
      *
@@ -168,7 +217,7 @@ export declare class RealtimeConnection {
      *
      * @example
      * ```typescript
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
      *     console.log("Final:", data.transcript);
      *     connection.close();
      * });

package/wrapper/realtime/connection.js

@@ -15,10 +15,10 @@ var RealtimeEvents;
     RealtimeEvents["SESSION_STARTED"] = "session_started";
     /** Emitted when a partial (interim) transcript is available */
     RealtimeEvents["PARTIAL_TRANSCRIPT"] = "partial_transcript";
-    /** Emitted when a final transcript is available */
-    RealtimeEvents["FINAL_TRANSCRIPT"] = "final_transcript";
-    /** Emitted when a final transcript with timestamps is available */
-    RealtimeEvents["FINAL_TRANSCRIPT_WITH_TIMESTAMPS"] = "final_transcript_with_timestamps";
+    /** Emitted when a committed transcript is available */
+    RealtimeEvents["COMMITTED_TRANSCRIPT"] = "committed_transcript";
+    /** Emitted when a committed transcript with timestamps is available */
+    RealtimeEvents["COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS"] = "committed_transcript_with_timestamps";
     /** Emitted when an error occurs */
     RealtimeEvents["ERROR"] = "error";
     /** Emitted when the WebSocket connection is opened */
@@ -35,7 +35,7 @@ var RealtimeEvents;
  * @example
  * ```typescript
  * const connection = await client.speechToText.realtime.connect({
- *     modelId: "scribe_realtime_v2",
+ *     modelId: "scribe_v2_realtime",
  *     audioFormat: AudioFormat.PCM_16000,
  *     sampleRate: 16000,
  * });
@@ -48,7 +48,7 @@ var RealtimeEvents;
  *     console.log("Partial:", data.transcript);
  * });
  *
- * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+ * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
  *     console.log("Final:", data.transcript);
  *     connection.close();
  * });
@@ -93,11 +93,11 @@ class RealtimeConnection {
                 case "partial_transcript":
                     this.eventEmitter.emit(RealtimeEvents.PARTIAL_TRANSCRIPT, data);
                     break;
-                case "final_transcript":
-                    this.eventEmitter.emit(RealtimeEvents.FINAL_TRANSCRIPT, data);
+                case "committed_transcript":
+                    this.eventEmitter.emit(RealtimeEvents.COMMITTED_TRANSCRIPT, data);
                     break;
-                case "final_transcript_with_timestamps":
-                    this.eventEmitter.emit(RealtimeEvents.FINAL_TRANSCRIPT_WITH_TIMESTAMPS, data);
+                case "committed_transcript_with_timestamps":
+                    this.eventEmitter.emit(RealtimeEvents.COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS, data);
                     break;
             }
         });
@@ -132,7 +132,7 @@ class RealtimeConnection {
      *     console.log("Partial:", data.transcript);
      * });
      *
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
      *     console.log("Final:", data.transcript);
      * });
      * ```
@@ -196,8 +196,8 @@ class RealtimeConnection {
         this.websocket.send(JSON.stringify(message));
     }
     /**
-     * Commits the transcription, signaling that all audio has been sent.
-     * This finalizes the transcription and triggers a FINAL_TRANSCRIPT event.
+     * Commits the segment, triggering a COMMITTED_TRANSCRIPT event and clearing the buffer.
+     * It's recommend to commit often when using CommitStrategy.MANUAL to keep latency low.
      *
      * @throws {Error} If the WebSocket connection is not open
      *
@@ -238,7 +238,7 @@ class RealtimeConnection {
      *
      * @example
      * ```typescript
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
      *     console.log("Final:", data.transcript);
      *     connection.close();
      * });

package/wrapper/realtime/index.d.ts

@@ -1,2 +1,2 @@
-export { RealtimeConnection, RealtimeEvents } from "./connection";
+export { RealtimeConnection, RealtimeEvents, type Config, type InputAudioChunk, type WordsItem, type WordsItemType, type CommittedTranscriptMessage, type CommittedTranscriptWithTimestampsMessage, type PartialTranscriptMessage, type SessionStartedMessage } from "./connection";
 export { ScribeRealtime, AudioFormat, CommitStrategy, type AudioOptions, type UrlOptions } from "./scribe";

package/wrapper/realtime/scribe.d.ts

@@ -94,14 +94,14 @@ export declare class ScribeRealtime {
      * ```typescript
      * // Manual audio streaming
      * const connection = await client.speechToText.realtime.connect({
-     *     modelId: "scribe_realtime_v2",
+     *     modelId: "scribe_v2_realtime",
      *     audioFormat: AudioFormat.PCM_16000,
      *     sampleRate: 16000,
      * });
      *
      * // Automatic URL streaming (requires ffmpeg)
      * const connection = await client.speechToText.realtime.connect({
-     *     modelId: "scribe_realtime_v2",
+     *     modelId: "scribe_v2_realtime",
      *     url: "https://example.com/stream.mp3",
      * });
      * ```

package/wrapper/realtime/scribe.js

@@ -82,7 +82,7 @@ class ScribeRealtime {
             const baseUrl = (_b = (_a = (yield core.Supplier.get(this.options.baseUrl))) !== null && _a !== void 0 ? _a : (yield core.Supplier.get(this.options.environment))) !== null && _b !== void 0 ? _b : environments.ElevenLabsEnvironment.Production;
             // Convert HTTP(S) to WS(S)
             const wsUrl = baseUrl.replace(/^https?:\/\//i, (match) => match.toLowerCase() === "https://" ? "wss://" : "ws://");
-            return `${wsUrl}/v1/speech-to-text/realtime-beta`;
+            return `${wsUrl}/v1/speech-to-text/realtime`;
         });
     }
     checkFfmpegInstalled() {
@@ -156,14 +156,14 @@ class ScribeRealtime {
      * ```typescript
      * // Manual audio streaming
      * const connection = await client.speechToText.realtime.connect({
-     *     modelId: "scribe_realtime_v2",
+     *     modelId: "scribe_v2_realtime",
      *     audioFormat: AudioFormat.PCM_16000,
      *     sampleRate: 16000,
      * });
      *
      * // Automatic URL streaming (requires ffmpeg)
      * const connection = await client.speechToText.realtime.connect({
-     *     modelId: "scribe_realtime_v2",
+     *     modelId: "scribe_v2_realtime",
      *     url: "https://example.com/stream.mp3",
      * });
      * ```
@@ -239,8 +239,8 @@ class ScribeRealtime {
             });
             (_b = ffmpegProcess.stdout) === null || _b === void 0 ? void 0 : _b.on("end", () => {
                 if (commitStrategy === CommitStrategy.MANUAL) {
-                    // Manual strategy: commit to finalize transcription, then close
-                    console.log("Stream ended, sending final commit");
+                    // Manual strategy: commit to process segment transcription, then close
+                    console.log("Stream ended, committing segment");
                     connection.commit();
                 }
                 // Close connection since no more audio will be sent

package/dist/serialization/resources/conversationalAi/resources/conversations/resources/feedback/client/requests/BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost.d.ts

@@ -1,10 +0,0 @@
-import * as serializers from "../../../../../../../../index";
-import * as ElevenLabs from "../../../../../../../../../api/index";
-import * as core from "../../../../../../../../../core";
-import { UserFeedbackScore } from "../../../../../../../../types/UserFeedbackScore";
-export declare const BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost: core.serialization.Schema<serializers.conversationalAi.conversations.BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost.Raw, ElevenLabs.conversationalAi.conversations.BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost>;
-export declare namespace BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost {
-    interface Raw {
-        feedback: UserFeedbackScore.Raw;
-    }
-}

package/serialization/resources/conversationalAi/resources/conversations/resources/feedback/client/requests/BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost.d.ts

@@ -1,10 +0,0 @@
-import * as serializers from "../../../../../../../../index";
-import * as ElevenLabs from "../../../../../../../../../api/index";
-import * as core from "../../../../../../../../../core";
-import { UserFeedbackScore } from "../../../../../../../../types/UserFeedbackScore";
-export declare const BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost: core.serialization.Schema<serializers.conversationalAi.conversations.BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost.Raw, ElevenLabs.conversationalAi.conversations.BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost>;
-export declare namespace BodySendConversationFeedbackV1ConvaiConversationsConversationIdFeedbackPost {
-    interface Raw {
-        feedback: UserFeedbackScore.Raw;
-    }
-}