assemblyai 4.5.0 → 4.6.0

package/src/services/realtime/service.ts

@@ -45,6 +45,9 @@ type BufferLike =
   | { valueOf(): string }
   | { [Symbol.toPrimitive](hint: string): string };
 
+/**
+ * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
+ */
 export class RealtimeTranscriber {
   private realtimeUrl: string;
   private sampleRate: number;
@@ -59,6 +62,10 @@ export class RealtimeTranscriber {
   private listeners: RealtimeListeners = {};
   private sessionTerminatedResolve?: () => void;
 
+  /**
+   * Create a new RealtimeTranscriber.
+   * @param params - Parameters to configure the RealtimeTranscriber
+   */
   constructor(params: RealtimeTranscriberParams) {
     this.realtimeUrl = params.realtimeUrl ?? defaultRealtimeUrl;
     this.sampleRate = params.sampleRate ?? 16_000;
@@ -106,30 +113,75 @@ export class RealtimeTranscriber {
     return url;
   }
 
+  /**
+   * Listen for the open event which is emitted when the connection is established and the session begins.
+   * @param event - The open event.
+   * @param listener - The function to call when the event is emitted.
+   */
   on(event: "open", listener: (event: SessionBeginsEventData) => void): void;
+  /**
+   * Listen for the transcript event which is emitted when a partian or final transcript is received.
+   * @param event - The transcript event.
+   * @param listener - The function to call when the event is emitted.
+   */
   on(
     event: "transcript",
     listener: (transcript: RealtimeTranscript) => void,
   ): void;
+  /**
+   * Listen for the partial transcript event which is emitted when a partial transcript is received.
+   * @param event - The partial transcript event.
+   * @param listener - The function to call when the event is emitted.
+   */
   on(
     event: "transcript.partial",
     listener: (transcript: PartialTranscript) => void,
   ): void;
+  /**
+   * Listen for the final transcript event which is emitted when a final transcript is received.
+   * @param event - The final transcript event.
+   * @param listener - The function to call when the event is emitted.
+   */
   on(
     event: "transcript.final",
     listener: (transcript: FinalTranscript) => void,
   ): void;
+  /**
+   * Listen for the session information event which is emitted when session information is received.
+   * The session information is sent right before the session is terminated.
+   * @param event - The session information event.
+   * @param listener - The function to call when the event is emitted.
+   */
   on(
     event: "session_information",
     listener: (info: SessionInformation) => void,
   ): void;
+  /**
+   * Listen for the error event which is emitted when an error occurs.
+   * @param event - The error event.
+   * @param listener - The function to call when the event is emitted.
+   */
   on(event: "error", listener: (error: Error) => void): void;
+  /**
+   * Listen for the close event which is emitted when the connection is closed.
+   * @param event - The close event.
+   * @param listener - The function to call when the event is emitted.
+   */
   on(event: "close", listener: (code: number, reason: string) => void): void;
+  /**
+   * Add a listener for an event.
+   * @param event - The event to listen for.
+   * @param listener - The function to call when the event is emitted.
+   */
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   on(event: RealtimeEvents, listener: (...args: any[]) => void) {
     this.listeners[event] = listener;
   }
 
+  /**
+   * Connect to the server and begin a new session.
+   * @returns A promise that resolves when the connection is established and the session begins.
+   */
   connect() {
     return new Promise<SessionBeginsEventData>((resolve) => {
       if (this.socket) {
@@ -216,10 +268,18 @@ export class RealtimeTranscriber {
     });
   }
 
+  /**
+   * Send audio data to the server.
+   * @param audio - The audio data to send to the server.
+   */
   sendAudio(audio: AudioData) {
     this.send(audio);
   }
 
+  /**
+   * Create a writable stream that can be used to send audio data to the server.
+   * @returns A writable stream that can be used to send audio data to the server.
+   */
   stream(): WritableStream<AudioData> {
     return new WritableStream<AudioData>({
       write: (chunk: AudioData) => {
@@ -251,6 +311,11 @@ export class RealtimeTranscriber {
     this.socket.send(data);
   }
 
+  /**
+   * Close the connection to the server.
+   * @param waitForSessionTermination - If true, the method will wait for the session to be terminated before closing the connection.
+   * While waiting for the session to be terminated, you will receive the final transcript and session information.
+   */
   async close(waitForSessionTermination = true) {
     if (this.socket) {
       if (this.socket.readyState === this.socket.OPEN) {

package/src/types/openapi.generated.ts

@@ -632,7 +632,6 @@ export type LemurBaseParams = {
   >;
   /**
    * The model that is used for the final prompt after compression is performed.
-   * Defaults to "default".
    *
    * @defaultValue "default
    */
@@ -687,10 +686,16 @@ export type LemurBaseResponse = {
  *
  */
 export type LemurModel =
+  | "anthropic/claude-3-5-sonnet"
+  | "anthropic/claude-3-opus"
+  | "anthropic/claude-3-haiku"
+  | "anthropic/claude-3-sonnet"
+  | "anthropic/claude-2-1"
+  | "anthropic/claude-2"
   | "default"
+  | "anthropic/claude-instant-1-2"
   | "basic"
-  | "assemblyai/mistral-7b"
-  | "anthropic/claude-2-1";
+  | "assemblyai/mistral-7b";
 
 /**
  * @example
@@ -1168,6 +1173,11 @@ export type RealtimeTemporaryTokenResponse = {
   token: string;
 };
 
+/**
+ * The notification when the redacted audio is ready.
+ */
+export type RedactedAudioNotification = RedactedAudioResponse;
+
 /**
  * @example
  * ```js
@@ -2506,15 +2516,17 @@ export type Transcript = {
    */
   webhook_auth: boolean;
   /**
-   * The header name which should be sent back with webhook calls
+   * The header name to be sent with the transcript completed or failed webhook requests
    */
   webhook_auth_header_name?: string | null;
   /**
-   * The status code we received from your server when delivering your webhook, if a webhook URL was provided
+   * The status code we received from your server when delivering the transcript completed or failed webhook request, if a webhook URL was provided
    */
   webhook_status_code?: number | null;
   /**
-   * The URL to which we send webhooks upon transcription completion
+   * The URL to which we send webhook requests.
+   * We sends two different types of webhook requests.
+   * One request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.
    */
   webhook_url?: string | null;
   /**
@@ -2931,17 +2943,17 @@ export type TranscriptOptionalParams = {
    */
   topics?: string[];
   /**
-   * The header name which should be sent back with webhook calls
+   * The header name to be sent with the transcript completed or failed webhook requests
    * @defaultValue null
    */
   webhook_auth_header_name?: string | null;
   /**
-   * Specify a header name and value to send back with a webhook call for added security
+   * The header value to send back with the transcript completed or failed webhook requests for added security
    * @defaultValue null
    */
   webhook_auth_header_value?: string | null;
   /**
-   * The URL to which AssemblyAI send webhooks upon transcription completion
+   * The URL to which we send webhook requests. We sends two different types of webhook requests. One request when a transcript is completed or failed, and one request when the redacted audio is ready if redact_pii_audio is enabled.
    */
   webhook_url?: string;
   /**
@@ -3292,6 +3304,13 @@ export type TranscriptUtterance = {
   words: TranscriptWord[];
 };
 
+/**
+ * The notifications sent to the webhook URL.
+ */
+export type TranscriptWebhookNotification =
+  | TranscriptReadyNotification
+  | RedactedAudioNotification;
+
 /**
  * @example
  * ```js