@elevenlabs/client 0.9.2 → 0.11.0

package/dist/scribe/connection.d.ts

@@ -1,6 +1,6 @@
-import type { SessionStartedMessage, PartialTranscriptMessage, FinalTranscriptMessage, FinalTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage } from "@elevenlabs/types";
-export type { SessionStartedMessage, PartialTranscriptMessage, FinalTranscriptMessage, FinalTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, };
-export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | FinalTranscriptMessage | FinalTranscriptWithTimestampsMessage | ScribeErrorMessage | ScribeAuthErrorMessage;
+import type { SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage } from "@elevenlabs/types";
+export type { SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage, };
+export type WebSocketMessage = SessionStartedMessage | PartialTranscriptMessage | CommittedTranscriptMessage | CommittedTranscriptWithTimestampsMessage | ScribeErrorMessage | ScribeAuthErrorMessage | ScribeQuotaExceededErrorMessage;
 /**
  * Events emitted by the RealtimeConnection.
  */
@@ -10,9 +10,9 @@ export declare enum RealtimeEvents {
     /** Emitted when a partial (interim) transcript is available */
     PARTIAL_TRANSCRIPT = "partial_transcript",
     /** Emitted when a final transcript is available */
-    FINAL_TRANSCRIPT = "final_transcript",
+    COMMITTED_TRANSCRIPT = "committed_transcript",
     /** Emitted when a final transcript with timestamps is available */
-    FINAL_TRANSCRIPT_WITH_TIMESTAMPS = "final_transcript_with_timestamps",
+    COMMITTED_TRANSCRIPT_WITH_TIMESTAMPS = "committed_transcript_with_timestamps",
     /** Emitted when an authentication error occurs */
     AUTH_ERROR = "auth_error",
     /** Emitted when an error occurs */
@@ -20,7 +20,9 @@ export declare enum RealtimeEvents {
     /** Emitted when the WebSocket connection is opened */
     OPEN = "open",
     /** Emitted when the WebSocket connection is closed */
-    CLOSE = "close"
+    CLOSE = "close",
+    /** Emitted when a quota exceeded error occurs */
+    QUOTA_EXCEEDED = "quota_exceeded"
 }
 /**
  * Manages a real-time transcription WebSocket connection.
@@ -29,7 +31,7 @@ export declare enum RealtimeEvents {
  * ```typescript
  * const connection = await Scribe.connect({
  *     token: "...",
- *     modelId: "scribe_realtime_v2",
+ *     modelId: "scribe_v2_realtime",
  *     audioFormat: AudioFormat.PCM_16000,
  *     sampleRate: 16000,
  * });
@@ -42,7 +44,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();
  * });
@@ -81,7 +83,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);
      * });
      * ```
@@ -133,8 +135,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 transcription, signaling that a segment of audio has been sent. This clears the buffer and triggers a COMMITTED_TRANSCRIPT event. Context from previous segments is kept.
+     * Committing a segment triggers a COMMITTED_TRANSCRIPT event.
      *
      * @throws {Error} If the WebSocket connection is not open
      *
@@ -164,8 +166,8 @@ export declare class RealtimeConnection {
      *
      * @example
      * ```typescript
-     * connection.on(RealtimeEvents.FINAL_TRANSCRIPT, (data) => {
-     *     console.log("Final:", data.transcript);
+     * connection.on(RealtimeEvents.COMMITTED_TRANSCRIPT, (data) => {
+     *     console.log("Segment committed:", data.transcript);
      *     connection.close();
      * });
      * ```

package/dist/scribe/index.d.ts

@@ -3,4 +3,4 @@ export { RealtimeConnection } from "./connection";
 export { AudioFormat, CommitStrategy } from "./scribe";
 export { RealtimeEvents } from "./connection";
 export type { AudioOptions, MicrophoneOptions } from "./scribe";
-export type { WebSocketMessage, SessionStartedMessage, PartialTranscriptMessage, FinalTranscriptMessage, FinalTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, } from "./connection";
+export type { WebSocketMessage, SessionStartedMessage, PartialTranscriptMessage, CommittedTranscriptMessage, CommittedTranscriptWithTimestampsMessage, ScribeErrorMessage, ScribeAuthErrorMessage, ScribeQuotaExceededErrorMessage, } from "./connection";

package/dist/scribe/scribe.d.ts

@@ -57,6 +57,11 @@ interface BaseOptions {
      * If not provided, the default URI will be used.
      */
     baseUri?: string;
+    /**
+     * Whether to receive a committed_transcript_with_timestamps event which includes word-level timestamps.
+     * @default false
+     */
+    includeTimestamps?: boolean;
 }
 export interface AudioOptions extends BaseOptions {
     audioFormat: AudioFormat;
@@ -96,7 +101,7 @@ export declare class ScribeRealtime {
      * // Manual audio streaming
      * const connection = Scribe.connect({
      *     token: "...",
-     *     modelId: "scribe_realtime_v2",
+     *     modelId: "scribe_v2_realtime",
      *     audioFormat: AudioFormat.PCM_16000,
      *     sampleRate: 16000,
      * });
@@ -104,7 +109,7 @@ export declare class ScribeRealtime {
      * // Automatic microphone streaming
      * const connection = Scribe.connect({
      *     token: "...",
-     *     modelId: "scribe_realtime_v2",
+     *     modelId: "scribe_v2_realtime",
      *     microphone: {
      *         echoCancellation: true,
      *         noiseSuppression: true

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "0.9.2";
+export declare const PACKAGE_VERSION = "0.11.0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elevenlabs/client",
-  "version": "0.9.2",
+  "version": "0.11.0",
   "description": "ElevenLabs JavaScript Client Library",
   "main": "./dist/lib.umd.js",
   "module": "./dist/lib.module.js",
@@ -39,7 +39,7 @@
   },
   "dependencies": {
     "livekit-client": "^2.11.4",
-    "@elevenlabs/types": "0.1.1"
+    "@elevenlabs/types": "0.3.0"
   },
   "scripts": {
     "generate-version": "printf \"// This file is auto-generated during build\\nexport const PACKAGE_VERSION = \\\"%s\\\";\\n\" \"$npm_package_version\" > src/version.ts",