assemblyai 4.3.3 → 4.4.0

package/dist/services/realtime/service.d.ts

@@ -1,4 +1,4 @@
-import { RealtimeTranscriberParams, RealtimeTranscript, PartialTranscript, FinalTranscript, SessionBeginsEventData, AudioData } from "../..";
+import { RealtimeTranscriberParams, RealtimeTranscript, PartialTranscript, FinalTranscript, SessionBeginsEventData, AudioData, SessionInformation } from "../..";
 export declare class RealtimeTranscriber {
     private realtimeUrl;
     private sampleRate;
@@ -7,6 +7,8 @@ export declare class RealtimeTranscriber {
     private apiKey?;
     private token?;
     private endUtteranceSilenceThreshold?;
+    private enableExtraSessionInformation?;
+    private disablePartialTranscripts?;
     private socket?;
     private listeners;
     private sessionTerminatedResolve?;
@@ -16,6 +18,7 @@ export declare class RealtimeTranscriber {
     on(event: "transcript", listener: (transcript: RealtimeTranscript) => void): void;
     on(event: "transcript.partial", listener: (transcript: PartialTranscript) => void): void;
     on(event: "transcript.final", listener: (transcript: FinalTranscript) => void): void;
+    on(event: "session_information", listener: (info: SessionInformation) => void): void;
     on(event: "error", listener: (error: Error) => void): void;
     on(event: "close", listener: (code: number, reason: string) => void): void;
     connect(): Promise<SessionBeginsEventData>;

package/dist/types/asyncapi.generated.d.ts

@@ -16,6 +16,9 @@ export type ConfigureEndUtteranceSilenceThreshold = {
      */
     end_utterance_silence_threshold: number;
 };
+/**
+ * Transcript text at the end of an utterance with punctuation and casing.
+ */
 export type FinalTranscript = RealtimeBaseTranscript & {
     /**
      * Describes the type of message
@@ -39,7 +42,10 @@ export type ForceEndUtterance = {
      */
     force_end_utterance: boolean;
 };
-export type MessageType = "SessionBegins" | "PartialTranscript" | "FinalTranscript" | "SessionTerminated";
+export type MessageType = "SessionBegins" | "PartialTranscript" | "FinalTranscript" | "SessionInformation" | "SessionTerminated";
+/**
+ * As you send audio data to the API, the API immediately starts responding with Partial Transcript results.
+ */
 export type PartialTranscript = RealtimeBaseTranscript & {
     /**
      * Describes the type of message
@@ -79,12 +85,18 @@ export type RealtimeBaseTranscript = {
      */
     words: Word[];
 };
+/**
+ * Error message
+ */
 export type RealtimeError = {
     error: string;
 };
-export type RealtimeMessage = SessionBegins | PartialTranscript | FinalTranscript | SessionTerminated | RealtimeError;
+export type RealtimeMessage = SessionBegins | PartialTranscript | FinalTranscript | SessionInformation | SessionTerminated | RealtimeError;
 export type RealtimeTranscript = PartialTranscript | FinalTranscript;
 export type RealtimeTranscriptType = "PartialTranscript" | "FinalTranscript";
+/**
+ * Session start
+ */
 export type SessionBegins = RealtimeBaseMessage & {
     /**
      * Timestamp when this session will expire
@@ -99,15 +111,36 @@ export type SessionBegins = RealtimeBaseMessage & {
      */
     session_id: string;
 };
+/**
+ * Information about the session
+ * Information about the session that is concluding.
+ * This message is sent at the end of the session, before the SessionTerminated message.
+ */
+export type SessionInformation = RealtimeBaseMessage & {
+    /**
+     * The total duration of the audio in seconds
+     */
+    audio_duration_seconds: number;
+    /**
+     * Describes the type of the message
+     */
+    message_type: "SessionInformation";
+};
+/**
+ * Session terminated
+ */
 export type SessionTerminated = RealtimeBaseMessage & {
     /**
      * Describes the type of the message
      */
     message_type: "SessionTerminated";
 };
+/**
+ * Terminate session
+ */
 export type TerminateSession = {
     /**
-     * Set to true to end your real-time session forever
+     * Set to true to end your streaming session forever
      */
     terminate_session: boolean;
 };

package/dist/types/openapi.generated.d.ts

@@ -258,6 +258,10 @@ export type AutoHighlightsResult = {
      * A temporally-sequential array of Key Phrases
      */
     results: AutoHighlightResult[];
+    /**
+     * The status of the Key Phrases model. Either success, or unavailable in the rare case that the model failed.
+     */
+    status: AudioIntelligenceModelStatus;
 };
 /**
  * Chapter of the audio file
@@ -532,7 +536,8 @@ export type LemurActionItemsResponse = LemurBaseResponse & {
  * ```js
  * {
  *   "transcript_ids": [
- *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
+ *     "85f9b381-e90c-46ed-beca-7d76245d375e",
+ *     "7c3acd18-df4d-4432-88f5-1e89f8827eea"
  *   ],
  *   "context": "This is an interview about wildfires.",
  *   "final_model": "default",
@@ -761,12 +766,12 @@ export type LemurSummaryResponse = LemurBaseResponse & {
  * }
  * ```
  */
-export type LemurTaskParams = LemurBaseParams & {
+export type LemurTaskParams = {
     /**
      * Your text to prompt the model to produce a desired output, including any context you want to pass into the model.
      */
     prompt: string;
-};
+} & LemurBaseParams;
 /**
  * @example
  * ```js
@@ -776,12 +781,12 @@ export type LemurTaskParams = LemurBaseParams & {
  * }
  * ```
  */
-export type LemurTaskResponse = LemurBaseResponse & {
+export type LemurTaskResponse = {
     /**
      * The response generated by LeMUR.
      */
     response: string;
-};
+} & LemurBaseResponse;
 /**
  * @example
  * ```js
@@ -823,6 +828,8 @@ export type ListTranscriptParams = {
     throttled_only?: boolean;
 };
 /**
+ * Details of the transcript page.
+ * Details of the transcript page. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
  * @example
  * ```js
  * {
@@ -835,10 +842,27 @@ export type ListTranscriptParams = {
  * ```
  */
 export type PageDetails = {
+    /**
+     * The URL used to retrieve the current page of transcripts
+     */
     current_url: string;
+    /**
+     * The number of results this page is limited to
+     */
     limit: number;
-    next_url?: string | null;
-    prev_url: string;
+    /**
+     * The URL to the next page of transcripts
+     * The URL to the next page of transcripts. The next URL always points to a page with newer transcripts.
+     */
+    next_url: string | null;
+    /**
+     * The URL to the previous page of transcripts
+     * The URL to the next page of transcripts. The previous URL always points to a page with older transcripts.
+     */
+    prev_url: string | null;
+    /**
+     * The actual number of results in the page
+     */
     result_count: number;
 };
 /**
@@ -959,7 +983,7 @@ export type PurgeLemurRequestDataResponse = {
  */
 export type RealtimeTemporaryTokenResponse = {
     /**
-     * The temporary authentication token for real-time transcription
+     * The temporary authentication token for Streaming Speech-to-Text
      */
     token: string;
 };
@@ -1157,11 +1181,11 @@ export type SeverityScoreSummary = {
 /**
  * The speech model to use for the transcription.
  */
-export type SpeechModel = "nano" | "conformer-2";
+export type SpeechModel = "best" | "nano" | "conformer-2";
 /**
- * The replacement logic for detected PII, can be "entity_type" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
+ * The replacement logic for detected PII, can be "entity_name" or "hash". See {@link https://www.assemblyai.com/docs/models/pii-redaction | PII redaction } for more details.
  */
-export type SubstitutionPolicy = "entity_type" | "hash";
+export type SubstitutionPolicy = "entity_name" | "hash";
 /**
  * Format of the subtitles
  */
@@ -1609,7 +1633,7 @@ export type TopicDetectionResult = {
  *   "punctuate": true,
  *   "format_text": true,
  *   "dual_channel": false,
- *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_url": "https://your-webhook-url.tld/path",
  *   "webhook_status_code": 200,
  *   "webhook_auth": true,
  *   "webhook_auth_header_name": "webhook-secret",
@@ -2336,32 +2360,45 @@ export type TranscriptCustomSpelling = {
  */
 export type TranscriptLanguageCode = "en" | "en_au" | "en_uk" | "en_us" | "es" | "fr" | "de" | "it" | "pt" | "nl" | "hi" | "ja" | "zh" | "fi" | "ko" | "pl" | "ru" | "tr" | "uk" | "vi";
 /**
+ * A list of transcripts
+ * A list of transcripts. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
  * @example
  * ```js
  * {
  *   "page_details": {
- *     "limit": 2",
- *     "result_count": 2,
- *     "current_url": "https://api.assemblyai.com/v2/transcript?limit=2",
- *     "prev_url": "https://api.assemblyai.com/v2/transcript?limit=2&before_id=62npeahu2b-a8ea-4112-854c-69542c20d90c",
- *     "next_url": "https://api.assemblyai.com/v2/transcript?limit=2&after_id=62nfw3mlar-01ad-4631-92f6-629929496eed"
+ *     "limit": 3",
+ *     "result_count": 3,
+ *     "current_url": "https://api.assemblyai.com/v2/transcript?limit=3",
+ *     "prev_url": "https://api.assemblyai.com/v2/transcript?limit=3&before_id=28a73d01-98db-41dd-9e98-2533ba0af117",
+ *     "next_url": "https://api.assemblyai.com/v2/transcript?limit=3&after_id=b33f4691-85b7-4f31-be12-a87cef1c1229"
  *   },
  *   "transcripts": [
  *     {
- *       "id": "9ea68fd3-f953-42c1-9742-976c447fb463",
- *       "resource_url": "https://api.assemblyai.com/v2/transcript/9ea68fd3-f953-42c1-9742-976c447fb463",
+ *       "id": "b33f4691-85b7-4f31-be12-a87cef1c1229",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/b33f4691-85b7-4f31-be12-a87cef1c1229",
  *       "status": "completed",
- *       "created": "2023-11-02T21:49:25.586965",
- *       "completed": "2023-11-02T21:49:25.586965",
- *       "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3"
+ *       "created": "2024-03-11T21:29:59.936851",
+ *       "completed": "2024-03-11T21:30:07.314223",
+ *       "audio_url": "http://deleted_by_user",
+ *       "error": null
+ *     },
+ *     {
+ *       "id": "ce522f10-d204-42e8-a838-6b95098145cc",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/ce522f10-d204-42e8-a838-6b95098145cc",
+ *       "status": "error",
+ *       "created": "2024-03-11T21:23:59.979420",
+ *       "completed": null,
+ *       "audio_url": "https://storage.googleapis.com/client-docs-samples/nbc.mp3",
+ *       "error": "Download error, unable to download https://storage.googleapis.com/client-docs-samples/nbc.mp3. Please make sure the file exists and is accessible from the internet."
  *     },
  *     {
- *       "id": "d5a3d302-066e-43fb-b63b-8f57baf185db",
- *       "resource_url": "https://api.assemblyai.com/v2/transcript/d5a3d302-066e-43fb-b63b-8f57baf185db",
+ *       "id": "28a73d01-98db-41dd-9e98-2533ba0af117",
+ *       "resource_url": "https://api.assemblyai.com/v2/transcript/28a73d01-98db-41dd-9e98-2533ba0af117",
  *       "status": "completed",
- *       "created": "2023-11-02T21:49:25.586965",
- *       "completed": "2023-11-02T21:49:25.586965",
- *       "audio_url": "http://deleted_by_user"
+ *       "created": "2024-03-11T21:12:57.372215",
+ *       "completed": "2024-03-11T21:13:03.267020",
+ *       "audio_url": "https://storage.googleapis.com/aai-docs-samples/nbc.mp3",
+ *       "error": null
  *     }
  *   ]
  * }
@@ -2380,7 +2417,8 @@ export type TranscriptList = {
  *   "status": "completed",
  *   "created": "2023-11-02T21:49:25.586965",
  *   "completed": "2023-11-02T21:49:25.586965",
- *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3"
+ *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3",
+ *   "error": null
  * }
  * ```
  */
@@ -2388,6 +2426,10 @@ export type TranscriptListItem = {
     audio_url: string;
     completed: Date | null;
     created: Date;
+    /**
+     * Error message of why the transcript failed
+     */
+    error: string | null;
     id: string;
     resource_url: string;
     status: TranscriptStatus;
@@ -2402,7 +2444,7 @@ export type TranscriptListItem = {
  *   "punctuate": true,
  *   "format_text": true,
  *   "dual_channel": true,
- *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_url": "https://your-webhook-url.tld/path",
  *   "webhook_auth_header_name": "webhook-secret",
  *   "webhook_auth_header_value": "webhook-secret-value",
  *   "auto_highlights": true,
@@ -2653,13 +2695,61 @@ export type TranscriptParagraph = {
 };
 /**
  * The parameters for creating a transcript
+ * @example
+ * ```js
+ * {
+ *   "speech_model": null,
+ *   "language_code": "en_us",
+ *   "audio_url": "https://github.com/AssemblyAI-Examples/audio-examples/raw/main/20230607_me_canadian_wildfires.mp3",
+ *   "punctuate": true,
+ *   "format_text": true,
+ *   "dual_channel": true,
+ *   "webhook_url": "https://your-webhook-url/path",
+ *   "webhook_auth_header_name": "webhook-secret",
+ *   "webhook_auth_header_value": "webhook-secret-value",
+ *   "auto_highlights": true,
+ *   "audio_start_from": 10,
+ *   "audio_end_at": 280,
+ *   "word_boost": [
+ *     "aws",
+ *     "azure",
+ *     "google cloud"
+ *   ],
+ *   "boost_param": "high",
+ *   "filter_profanity": true,
+ *   "redact_pii": true,
+ *   "redact_pii_audio": true,
+ *   "redact_pii_audio_quality": "mp3",
+ *   "redact_pii_policies": [
+ *     "us_social_security_number",
+ *     "credit_card_number"
+ *   ],
+ *   "redact_pii_sub": "hash",
+ *   "speaker_labels": true,
+ *   "speakers_expected": 2,
+ *   "content_safety": true,
+ *   "iab_categories": true,
+ *   "language_detection": false,
+ *   "custom_spelling": [],
+ *   "disfluencies": false,
+ *   "sentiment_analysis": true,
+ *   "auto_chapters": true,
+ *   "entity_detection": true,
+ *   "speech_threshold": 0.5,
+ *   "summarization": true,
+ *   "summary_model": "informative",
+ *   "summary_type": "bullets",
+ *   "custom_topics": true,
+ *   "topics": []
+ * }
+ * ```
  */
-export type TranscriptParams = TranscriptOptionalParams & {
+export type TranscriptParams = {
     /**
      * The URL of the audio or video file to transcribe.
      */
     audio_url: string;
-};
+} & TranscriptOptionalParams;
 /**
  * The notification when the transcript status is completed or error.
  * @example

package/dist/types/realtime/index.d.ts

@@ -1,4 +1,4 @@
-import { AudioEncoding, FinalTranscript, PartialTranscript, RealtimeTranscript, RealtimeTranscriptType } from "../asyncapi.generated";
+import { AudioEncoding, FinalTranscript, PartialTranscript, RealtimeTranscript, RealtimeTranscriptType, SessionInformation } from "../asyncapi.generated";
 type CreateRealtimeTranscriberParams = {
     /**
      * The WebSocket URL that the RealtimeTranscriber connects to
@@ -20,6 +20,18 @@ type CreateRealtimeTranscriberParams = {
      * The duration of the end utterance silence threshold in milliseconds
      */
     endUtteranceSilenceThreshold?: number;
+    /**
+     * Disable partial transcripts.
+     * Set to `true` to not receive partial transcripts. Defaults to `false`.
+     * @defaultValue false
+     */
+    disablePartialTranscripts?: boolean;
+    /**
+     * Enable extra session information.
+     * Set to `true` to receive the `session_information` message before the session ends. Defaults to `false`.
+     * @defaultValue false
+     */
+    enableExtraSessionInformation?: boolean;
 } & ({
     /**
      * The API key used to authenticate the RealtimeTranscriber
@@ -57,6 +69,18 @@ type RealtimeTranscriberParams = {
      * The duration of the end utterance silence threshold in milliseconds
      */
     endUtteranceSilenceThreshold?: number;
+    /**
+     * Disable partial transcripts.
+     * Set to `true` to not receive partial transcripts. Defaults to `false`.
+     * @defaultValue false
+     */
+    disablePartialTranscripts?: boolean;
+    /**
+     * Enable extra session information.
+     * Set to `true` to receive the `session_information` message before the session ends. Defaults to `false`.
+     * @defaultValue false
+     */
+    enableExtraSessionInformation?: boolean;
 } & ({
     /**
      * The API key used to authenticate the RealtimeTranscriber.
@@ -73,7 +97,7 @@ type RealtimeTranscriberParams = {
  * @deprecated Use RealtimeTranscriberParams instead
  */
 type RealtimeServiceParams = RealtimeTranscriberParams;
-type RealtimeEvents = "open" | "close" | "transcript" | "transcript.partial" | "transcript.final" | "error";
+type RealtimeEvents = "open" | "close" | "transcript" | "transcript.partial" | "transcript.final" | "session_information" | "error";
 type SessionBeginsEventData = {
     sessionId: string;
     expiresAt: Date;
@@ -84,6 +108,7 @@ type RealtimeListeners = {
     transcript?: (transcript: RealtimeTranscript) => void;
     "transcript.partial"?: (transcript: PartialTranscript) => void;
     "transcript.final"?: (transcript: FinalTranscript) => void;
+    session_information?: (info: SessionInformation) => void;
     error?: (error: Error) => void;
 };
 type RealtimeTokenParams = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "assemblyai",
-  "version": "4.3.3",
+  "version": "4.4.0",
   "description": "The AssemblyAI JavaScript SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async and real-time transcription, as well as the latest LeMUR models.",
   "engines": {
     "node": ">=18"
@@ -69,9 +69,12 @@
     "build": "pnpm clean && pnpm rollup -c",
     "clean": "rimraf dist/* && rimraf temp/* && rimraf temp-docs/*",
     "lint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}' && publint && tsc --noEmit -p tsconfig.json",
-    "test": "jest --config jest.config.js",
+    "test": "pnpm run test:unit && pnpm run test:integration",
+    "test:unit": "jest --config jest.unit.config.js",
+    "test:integration": "jest --config jest.integration.config.js --testTimeout 360000",
     "format": "prettier '**/*' --write",
-    "generate-types": "tsx ./scripts/generate-types.ts && pnpm format",
+    "generate:types": "tsx ./scripts/generate-types.ts && prettier 'src/types/*.generated.ts' --write",
+    "generate:reference": "typedoc",
     "copybara:dry-run": "./copybara.sh dry_run --init-history",
     "copybara:pr": "./copybara.sh sync_out --init-history"
   },
@@ -125,7 +128,8 @@
     "ts-jest": "^29.1.2",
     "tslib": "^2.5.3",
     "typescript": "^5.4.2",
-    "typedoc": "^0.25.12"
+    "typedoc": "^0.25.12",
+    "typedoc-plugin-extras": "^3.0.0"
   },
   "dependencies": {
     "ws": "^8.16.0"

package/src/services/realtime/service.ts

@@ -12,6 +12,7 @@ import {
   SessionBeginsEventData,
   AudioEncoding,
   AudioData,
+  SessionInformation,
 } from "../..";
 import {
   RealtimeError,
@@ -49,6 +50,9 @@ export class RealtimeTranscriber {
   private apiKey?: string;
   private token?: string;
   private endUtteranceSilenceThreshold?: number;
+  private enableExtraSessionInformation?: boolean;
+  private disablePartialTranscripts?: boolean;
+
   private socket?: WebSocket;
   private listeners: RealtimeListeners = {};
   private sessionTerminatedResolve?: () => void;
@@ -59,6 +63,8 @@ export class RealtimeTranscriber {
     this.wordBoost = params.wordBoost;
     this.encoding = params.encoding;
     this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
+    this.enableExtraSessionInformation = params.enableExtraSessionInformation;
+    this.disablePartialTranscripts = params.disablePartialTranscripts;
     if ("token" in params && params.token) this.token = params.token;
     if ("apiKey" in params && params.apiKey) this.apiKey = params.apiKey;
 
@@ -85,6 +91,18 @@ export class RealtimeTranscriber {
     if (this.encoding) {
       searchParams.set("encoding", this.encoding);
     }
+    if (this.enableExtraSessionInformation) {
+      searchParams.set(
+        "enable_extra_session_information",
+        this.enableExtraSessionInformation.toString(),
+      );
+    }
+    if (this.disablePartialTranscripts) {
+      searchParams.set(
+        "disable_partial_transcripts",
+        this.disablePartialTranscripts.toString(),
+      );
+    }
     url.search = searchParams.toString();
 
     return url;
@@ -103,6 +121,10 @@ export class RealtimeTranscriber {
     event: "transcript.final",
     listener: (transcript: FinalTranscript) => void,
   ): void;
+  on(
+    event: "session_information",
+    listener: (info: SessionInformation) => void,
+  ): void;
   on(event: "error", listener: (error: Error) => void): void;
   on(event: "close", listener: (code: number, reason: string) => void): void;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -183,6 +205,10 @@ export class RealtimeTranscriber {
             this.listeners["transcript.final"]?.(message);
             break;
           }
+          case "SessionInformation": {
+            this.listeners.session_information?.(message);
+            break;
+          }
           case "SessionTerminated": {
             this.sessionTerminatedResolve?.();
             break;

package/src/services/transcripts/index.ts

@@ -15,6 +15,7 @@ import {
   TranscribeParams,
   TranscribeOptions,
   SubmitParams,
+  SpeechModel,
 } from "../..";
 import { FileService } from "../files";
 import { getPath } from "../../utils/path";
@@ -37,6 +38,7 @@ export class TranscriptService extends BaseService {
     params: TranscribeParams,
     options?: TranscribeOptions,
   ): Promise<Transcript> {
+    deprecateConformer2(params);
     const transcript = await this.submit(params);
     return await this.waitUntilReady(transcript.id, options);
   }
@@ -47,6 +49,7 @@ export class TranscriptService extends BaseService {
    * @returns A promise that resolves to the queued transcript.
    */
   async submit(params: SubmitParams): Promise<Transcript> {
+    deprecateConformer2(params);
     let audioUrl;
     let transcriptParams: TranscriptParams | undefined = undefined;
     if ("audio" in params) {
@@ -87,6 +90,7 @@ export class TranscriptService extends BaseService {
     params: TranscriptParams,
     options?: CreateTranscriptOptions,
   ): Promise<Transcript> {
+    deprecateConformer2(params);
     const path = getPath(params.audio_url);
     if (path !== null) {
       const uploadUrl = await this.files.upload(path);
@@ -246,3 +250,12 @@ export class TranscriptService extends BaseService {
     );
   }
 }
+
+function deprecateConformer2(params: { speech_model?: SpeechModel | null }) {
+  if (!params) return;
+  if (params.speech_model === "conformer-2") {
+    console.warn(
+      "The speech_model conformer-2 option is deprecated and will stop working in the near future. Use best or nano instead.",
+    );
+  }
+}

package/src/types/asyncapi.generated.ts

@@ -37,6 +37,9 @@ export type ConfigureEndUtteranceSilenceThreshold = {
   end_utterance_silence_threshold: number;
 };
 
+/**
+ * Transcript text at the end of an utterance with punctuation and casing.
+ */
 export type FinalTranscript = RealtimeBaseTranscript & {
   /**
    * Describes the type of message
@@ -66,8 +69,12 @@ export type MessageType =
   | "SessionBegins"
   | "PartialTranscript"
   | "FinalTranscript"
+  | "SessionInformation"
   | "SessionTerminated";
 
+/**
+ * As you send audio data to the API, the API immediately starts responding with Partial Transcript results.
+ */
 export type PartialTranscript = RealtimeBaseTranscript & {
   /**
    * Describes the type of message
@@ -110,6 +117,9 @@ export type RealtimeBaseTranscript = {
   words: Word[];
 };
 
+/**
+ * Error message
+ */
 export type RealtimeError = {
   error: string;
 };
@@ -118,6 +128,7 @@ export type RealtimeMessage =
   | SessionBegins
   | PartialTranscript
   | FinalTranscript
+  | SessionInformation
   | SessionTerminated
   | RealtimeError;
 
@@ -125,6 +136,9 @@ export type RealtimeTranscript = PartialTranscript | FinalTranscript;
 
 export type RealtimeTranscriptType = "PartialTranscript" | "FinalTranscript";
 
+/**
+ * Session start
+ */
 export type SessionBegins = RealtimeBaseMessage & {
   /**
    * Timestamp when this session will expire
@@ -140,6 +154,25 @@ export type SessionBegins = RealtimeBaseMessage & {
   session_id: string;
 };
 
+/**
+ * Information about the session
+ * Information about the session that is concluding.
+ * This message is sent at the end of the session, before the SessionTerminated message.
+ */
+export type SessionInformation = RealtimeBaseMessage & {
+  /**
+   * The total duration of the audio in seconds
+   */
+  audio_duration_seconds: number;
+  /**
+   * Describes the type of the message
+   */
+  message_type: "SessionInformation";
+};
+
+/**
+ * Session terminated
+ */
 export type SessionTerminated = RealtimeBaseMessage & {
   /**
    * Describes the type of the message
@@ -147,9 +180,12 @@ export type SessionTerminated = RealtimeBaseMessage & {
   message_type: "SessionTerminated";
 };
 
+/**
+ * Terminate session
+ */
 export type TerminateSession = {
   /**
-   * Set to true to end your real-time session forever
+   * Set to true to end your streaming session forever
    */
   terminate_session: boolean;
 };