assemblyai 4.5.0-beta.0 → 4.6.0

package/dist/streaming.mjs

@@ -0,0 +1,303 @@
+import ws from 'ws';
+
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol */
+
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
+const { WritableStream } = typeof window !== "undefined"
+    ? window
+    : typeof global !== "undefined"
+        ? global
+        : globalThis;
+
+const factory = (url, params) => new ws(url, params);
+
+var RealtimeErrorType;
+(function (RealtimeErrorType) {
+    RealtimeErrorType[RealtimeErrorType["BadSampleRate"] = 4000] = "BadSampleRate";
+    RealtimeErrorType[RealtimeErrorType["AuthFailed"] = 4001] = "AuthFailed";
+    // Both InsufficientFunds and FreeAccount error use 4002
+    RealtimeErrorType[RealtimeErrorType["InsufficientFundsOrFreeAccount"] = 4002] = "InsufficientFundsOrFreeAccount";
+    RealtimeErrorType[RealtimeErrorType["NonexistentSessionId"] = 4004] = "NonexistentSessionId";
+    RealtimeErrorType[RealtimeErrorType["SessionExpired"] = 4008] = "SessionExpired";
+    RealtimeErrorType[RealtimeErrorType["ClosedSession"] = 4010] = "ClosedSession";
+    RealtimeErrorType[RealtimeErrorType["RateLimited"] = 4029] = "RateLimited";
+    RealtimeErrorType[RealtimeErrorType["UniqueSessionViolation"] = 4030] = "UniqueSessionViolation";
+    RealtimeErrorType[RealtimeErrorType["SessionTimeout"] = 4031] = "SessionTimeout";
+    RealtimeErrorType[RealtimeErrorType["AudioTooShort"] = 4032] = "AudioTooShort";
+    RealtimeErrorType[RealtimeErrorType["AudioTooLong"] = 4033] = "AudioTooLong";
+    RealtimeErrorType[RealtimeErrorType["BadJson"] = 4100] = "BadJson";
+    RealtimeErrorType[RealtimeErrorType["BadSchema"] = 4101] = "BadSchema";
+    RealtimeErrorType[RealtimeErrorType["TooManyStreams"] = 4102] = "TooManyStreams";
+    RealtimeErrorType[RealtimeErrorType["Reconnected"] = 4103] = "Reconnected";
+    RealtimeErrorType[RealtimeErrorType["ReconnectAttemptsExhausted"] = 1013] = "ReconnectAttemptsExhausted";
+})(RealtimeErrorType || (RealtimeErrorType = {}));
+const RealtimeErrorMessages = {
+    [RealtimeErrorType.BadSampleRate]: "Sample rate must be a positive integer",
+    [RealtimeErrorType.AuthFailed]: "Not Authorized",
+    [RealtimeErrorType.InsufficientFundsOrFreeAccount]: "Insufficient funds or you are using a free account. This feature is paid-only and requires you to add a credit card. Please visit https://assemblyai.com/dashboard/ to add a credit card to your account.",
+    [RealtimeErrorType.NonexistentSessionId]: "Session ID does not exist",
+    [RealtimeErrorType.SessionExpired]: "Session has expired",
+    [RealtimeErrorType.ClosedSession]: "Session is closed",
+    [RealtimeErrorType.RateLimited]: "Rate limited",
+    [RealtimeErrorType.UniqueSessionViolation]: "Unique session violation",
+    [RealtimeErrorType.SessionTimeout]: "Session Timeout",
+    [RealtimeErrorType.AudioTooShort]: "Audio too short",
+    [RealtimeErrorType.AudioTooLong]: "Audio too long",
+    [RealtimeErrorType.BadJson]: "Bad JSON",
+    [RealtimeErrorType.BadSchema]: "Bad schema",
+    [RealtimeErrorType.TooManyStreams]: "Too many streams",
+    [RealtimeErrorType.Reconnected]: "Reconnected",
+    [RealtimeErrorType.ReconnectAttemptsExhausted]: "Reconnect attempts exhausted",
+};
+class RealtimeError extends Error {
+}
+
+const defaultRealtimeUrl = "wss://api.assemblyai.com/v2/realtime/ws";
+const forceEndOfUtteranceMessage = `{"force_end_utterance":true}`;
+const terminateSessionMessage = `{"terminate_session":true}`;
+/**
+ * RealtimeTranscriber connects to the Streaming Speech-to-Text API and lets you transcribe audio in real-time.
+ */
+class RealtimeTranscriber {
+    /**
+     * Create a new RealtimeTranscriber.
+     * @param params - Parameters to configure the RealtimeTranscriber
+     */
+    constructor(params) {
+        var _a, _b;
+        this.listeners = {};
+        this.realtimeUrl = (_a = params.realtimeUrl) !== null && _a !== void 0 ? _a : defaultRealtimeUrl;
+        this.sampleRate = (_b = params.sampleRate) !== null && _b !== void 0 ? _b : 16000;
+        this.wordBoost = params.wordBoost;
+        this.encoding = params.encoding;
+        this.endUtteranceSilenceThreshold = params.endUtteranceSilenceThreshold;
+        this.disablePartialTranscripts = params.disablePartialTranscripts;
+        if ("token" in params && params.token)
+            this.token = params.token;
+        if ("apiKey" in params && params.apiKey)
+            this.apiKey = params.apiKey;
+        if (!(this.token || this.apiKey)) {
+            throw new Error("API key or temporary token is required.");
+        }
+    }
+    connectionUrl() {
+        const url = new URL(this.realtimeUrl);
+        if (url.protocol !== "wss:") {
+            throw new Error("Invalid protocol, must be wss");
+        }
+        const searchParams = new URLSearchParams();
+        if (this.token) {
+            searchParams.set("token", this.token);
+        }
+        searchParams.set("sample_rate", this.sampleRate.toString());
+        if (this.wordBoost && this.wordBoost.length > 0) {
+            searchParams.set("word_boost", JSON.stringify(this.wordBoost));
+        }
+        if (this.encoding) {
+            searchParams.set("encoding", this.encoding);
+        }
+        searchParams.set("enable_extra_session_information", "true");
+        if (this.disablePartialTranscripts) {
+            searchParams.set("disable_partial_transcripts", this.disablePartialTranscripts.toString());
+        }
+        url.search = searchParams.toString();
+        return url;
+    }
+    /**
+     * 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, listener) {
+        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((resolve) => {
+            if (this.socket) {
+                throw new Error("Already connected");
+            }
+            const url = this.connectionUrl();
+            if (this.token) {
+                this.socket = factory(url.toString());
+            }
+            else {
+                this.socket = factory(url.toString(), {
+                    headers: { Authorization: this.apiKey },
+                });
+            }
+            this.socket.binaryType = "arraybuffer";
+            this.socket.onopen = () => {
+                if (this.endUtteranceSilenceThreshold === undefined ||
+                    this.endUtteranceSilenceThreshold === null) {
+                    return;
+                }
+                this.configureEndUtteranceSilenceThreshold(this.endUtteranceSilenceThreshold);
+            };
+            this.socket.onclose = ({ code, reason }) => {
+                var _a, _b;
+                if (!reason) {
+                    if (code in RealtimeErrorType) {
+                        reason = RealtimeErrorMessages[code];
+                    }
+                }
+                (_b = (_a = this.listeners).close) === null || _b === void 0 ? void 0 : _b.call(_a, code, reason);
+            };
+            this.socket.onerror = (event) => {
+                var _a, _b, _c, _d;
+                if (event.error)
+                    (_b = (_a = this.listeners).error) === null || _b === void 0 ? void 0 : _b.call(_a, event.error);
+                else
+                    (_d = (_c = this.listeners).error) === null || _d === void 0 ? void 0 : _d.call(_c, new Error(event.message));
+            };
+            this.socket.onmessage = ({ data }) => {
+                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+                const message = JSON.parse(data.toString());
+                if ("error" in message) {
+                    (_b = (_a = this.listeners).error) === null || _b === void 0 ? void 0 : _b.call(_a, new RealtimeError(message.error));
+                    return;
+                }
+                switch (message.message_type) {
+                    case "SessionBegins": {
+                        const openObject = {
+                            sessionId: message.session_id,
+                            expiresAt: new Date(message.expires_at),
+                        };
+                        resolve(openObject);
+                        (_d = (_c = this.listeners).open) === null || _d === void 0 ? void 0 : _d.call(_c, openObject);
+                        break;
+                    }
+                    case "PartialTranscript": {
+                        // message.created is actually a string when coming from the socket
+                        message.created = new Date(message.created);
+                        (_f = (_e = this.listeners).transcript) === null || _f === void 0 ? void 0 : _f.call(_e, message);
+                        (_h = (_g = this.listeners)["transcript.partial"]) === null || _h === void 0 ? void 0 : _h.call(_g, message);
+                        break;
+                    }
+                    case "FinalTranscript": {
+                        // message.created is actually a string when coming from the socket
+                        message.created = new Date(message.created);
+                        (_k = (_j = this.listeners).transcript) === null || _k === void 0 ? void 0 : _k.call(_j, message);
+                        (_m = (_l = this.listeners)["transcript.final"]) === null || _m === void 0 ? void 0 : _m.call(_l, message);
+                        break;
+                    }
+                    case "SessionInformation": {
+                        (_p = (_o = this.listeners).session_information) === null || _p === void 0 ? void 0 : _p.call(_o, message);
+                        break;
+                    }
+                    case "SessionTerminated": {
+                        (_q = this.sessionTerminatedResolve) === null || _q === void 0 ? void 0 : _q.call(this);
+                        break;
+                    }
+                }
+            };
+        });
+    }
+    /**
+     * Send audio data to the server.
+     * @param audio - The audio data to send to the server.
+     */
+    sendAudio(audio) {
+        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() {
+        return new WritableStream({
+            write: (chunk) => {
+                this.sendAudio(chunk);
+            },
+        });
+    }
+    /**
+     * Manually end an utterance
+     */
+    forceEndUtterance() {
+        this.send(forceEndOfUtteranceMessage);
+    }
+    /**
+     * Configure the threshold for how long to wait before ending an utterance. Default is 700ms.
+     * @param threshold - The duration of the end utterance silence threshold in milliseconds.
+     * This value must be an integer between 0 and 20_000.
+     */
+    configureEndUtteranceSilenceThreshold(threshold) {
+        this.send(`{"end_utterance_silence_threshold":${threshold}}`);
+    }
+    send(data) {
+        if (!this.socket || this.socket.readyState !== this.socket.OPEN) {
+            throw new Error("Socket is not open for communication");
+        }
+        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.
+     */
+    close() {
+        return __awaiter(this, arguments, void 0, function* (waitForSessionTermination = true) {
+            var _a;
+            if (this.socket) {
+                if (this.socket.readyState === this.socket.OPEN) {
+                    if (waitForSessionTermination) {
+                        const sessionTerminatedPromise = new Promise((resolve) => {
+                            this.sessionTerminatedResolve = resolve;
+                        });
+                        this.socket.send(terminateSessionMessage);
+                        yield sessionTerminatedPromise;
+                    }
+                    else {
+                        this.socket.send(terminateSessionMessage);
+                    }
+                }
+                if ((_a = this.socket) === null || _a === void 0 ? void 0 : _a.removeAllListeners)
+                    this.socket.removeAllListeners();
+                this.socket.close();
+            }
+            this.listeners = {};
+            this.socket = undefined;
+        });
+    }
+}
+/**
+ * @deprecated Use RealtimeTranscriber instead
+ */
+class RealtimeService extends RealtimeTranscriber {
+}
+
+export { RealtimeService, RealtimeTranscriber };

package/dist/types/index.d.ts

@@ -5,3 +5,10 @@ export * from "./services";
 export * from "./asyncapi.generated";
 export * from "./openapi.generated";
 export * from "./deprecated";
+export type UserAgentItem = {
+    name: string;
+    version: string;
+};
+export type UserAgent = {
+    [component: string]: UserAgentItem | undefined | null | false;
+};

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

@@ -476,7 +476,7 @@ export type Entity = {
 /**
  * The type of entity for the detected entity
  */
-export type EntityType = "banking_information" | "blood_type" | "credit_card_cvv" | "credit_card_expiration" | "credit_card_number" | "date" | "date_of_birth" | "drivers_license" | "drug" | "email_address" | "event" | "injury" | "language" | "location" | "medical_condition" | "medical_process" | "money_amount" | "nationality" | "occupation" | "organization" | "password" | "person_age" | "person_name" | "phone_number" | "political_affiliation" | "religion" | "time" | "url" | "us_social_security_number";
+export type EntityType = "account_number" | "banking_information" | "blood_type" | "credit_card_cvv" | "credit_card_expiration" | "credit_card_number" | "date" | "date_interval" | "date_of_birth" | "drivers_license" | "drug" | "duration" | "email_address" | "event" | "filename" | "gender_sexuality" | "healthcare_number" | "injury" | "ip_address" | "language" | "location" | "marital_status" | "medical_condition" | "medical_process" | "money_amount" | "nationality" | "number_sequence" | "occupation" | "organization" | "passport_number" | "password" | "person_age" | "person_name" | "phone_number" | "physical_attribute" | "political_affiliation" | "religion" | "statistics" | "time" | "url" | "us_social_security_number" | "username" | "vehicle_id" | "zodiac_sign";
 /**
  * @example
  * ```js
@@ -521,7 +521,11 @@ export type LemurActionItemsParams = LemurBaseParams & {
  * ```js
  * {
  *   "request_id": "5"e1b27c2-691f-4414-8bc5-f14678442f9e",
- *   "response": "Here are some potential action items based on the transcript:\n\n- Monitor air quality levels in affected areas and issue warnings as needed.\n\n- Advise vulnerable populations like children, the elderly, and those with respiratory conditions to limit time outdoors.\n\n- Have schools cancel outdoor activities when air quality is poor.\n\n- Educate the public on health impacts of smoke inhalation and precautions to take.\n\n- Track progression of smoke plumes using weather and air quality monitoring systems.\n\n- Coordinate cross-regionally to manage smoke exposure as air masses shift.\n\n- Plan for likely increase in such events due to climate change. Expand monitoring and forecasting capabilities.\n\n- Conduct research to better understand health impacts of wildfire smoke and mitigation strategies.\n\n- Develop strategies to prevent and manage wildfires to limit air quality impacts.\n"
+ *   "response": "Here are some potential action items based on the transcript:\n\n- Monitor air quality levels in affected areas and issue warnings as needed.\n\n- Advise vulnerable populations like children, the elderly, and those with respiratory conditions to limit time outdoors.\n\n- Have schools cancel outdoor activities when air quality is poor.\n\n- Educate the public on health impacts of smoke inhalation and precautions to take.\n\n- Track progression of smoke plumes using weather and air quality monitoring systems.\n\n- Coordinate cross-regionally to manage smoke exposure as air masses shift.\n\n- Plan for likely increase in such events due to climate change. Expand monitoring and forecasting capabilities.\n\n- Conduct research to better understand health impacts of wildfire smoke and mitigation strategies.\n\n- Develop strategies to prevent and manage wildfires to limit air quality impacts.\n",
+ *   "usage": {
+ *     "input_tokens": 27,
+ *     "output_tokens": 3
+ *   }
  * }
  * ```
  */
@@ -558,7 +562,6 @@ export type LemurBaseParams = {
     ]>;
     /**
      * The model that is used for the final prompt after compression is performed.
-     * Defaults to "default".
      *
      * @defaultValue "default
      */
@@ -588,7 +591,11 @@ export type LemurBaseParams = {
  * @example
  * ```js
  * {
- *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e"
+ *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
+ *   "usage": {
+ *     "input_tokens": 27,
+ *     "output_tokens": 3
+ *   }
  * }
  * ```
  */
@@ -597,12 +604,16 @@ export type LemurBaseResponse = {
      * The ID of the LeMUR request
      */
     request_id: string;
+    /**
+     * The usage numbers for the LeMUR request
+     */
+    usage: LemurUsage;
 };
 /**
  * The model that is used for the final prompt after compression is performed.
  *
  */
-export type LemurModel = "default" | "basic" | "assemblyai/mistral-7b" | "anthropic/claude-2-1";
+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";
 /**
  * @example
  * ```js
@@ -706,7 +717,11 @@ export type LemurQuestionAnswerParams = LemurBaseParams & {
  *       "answer": "yes",
  *       "question": "Is global warming affecting wildfires?"
  *     }
- *   ]
+ *   ],
+ *   "usage": {
+ *     "input_tokens": 27,
+ *     "output_tokens": 3
+ *   }
  * }
  * ```
  */
@@ -716,12 +731,13 @@ export type LemurQuestionAnswerResponse = LemurBaseResponse & {
      */
     response: LemurQuestionAnswer[];
 };
+export type LemurResponse = LemurTaskResponse | LemurSummaryResponse | LemurQuestionAnswerResponse | LemurActionItemsResponse;
 /**
  * @example
  * ```js
  * {
  *   "transcript_ids": [
- *     "64nygnr62k-405c-4ae8-8a6b-d90b40ff3cce"
+ *     "47b95ba5-8889-44d8-bc80-5de38306e582"
  *   ],
  *   "context": "This is an interview about wildfires.",
  *   "final_model": "default",
@@ -741,7 +757,11 @@ export type LemurSummaryParams = LemurBaseParams & {
  * ```js
  * {
  *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
- *   "response": "- Wildfires in Canada are sending smoke and air pollution across parts of the US, triggering air quality alerts from Maine to Minnesota. Concentrations of particulate matter have exceeded safety levels.\n\n- Weather systems are channeling the smoke through Pennsylvania into the Mid-Atlantic and Northeast regions. New York City has canceled outdoor activities to keep children and vulnerable groups indoors.\n\n- Very small particulate matter can enter the lungs and impact respiratory, cardiovascular and neurological health. Young children, the elderly and those with preexisting conditions are most at risk.\n\n- The conditions causing the poor air quality could get worse or shift to different areas in coming days depending on weather patterns. More wildfires may also contribute to higher concentrations.\n\n- Climate change is leading to longer and more severe fire seasons. Events of smoke traveling long distances and affecting air quality over wide areas will likely become more common in the future.\"\n"
+ *   "response": "- Wildfires in Canada are sending smoke and air pollution across parts of the US, triggering air quality alerts from Maine to Minnesota. Concentrations of particulate matter have exceeded safety levels.\n\n- Weather systems are channeling the smoke through Pennsylvania into the Mid-Atlantic and Northeast regions. New York City has canceled outdoor activities to keep children and vulnerable groups indoors.\n\n- Very small particulate matter can enter the lungs and impact respiratory, cardiovascular and neurological health. Young children, the elderly and those with preexisting conditions are most at risk.\n\n- The conditions causing the poor air quality could get worse or shift to different areas in coming days depending on weather patterns. More wildfires may also contribute to higher concentrations.\n\n- Climate change is leading to longer and more severe fire seasons. Events of smoke traveling long distances and affecting air quality over wide areas will likely become more common in the future.\"\n",
+ *   "usage": {
+ *     "input_tokens": 27,
+ *     "output_tokens": 3
+ *   }
  * }
  * ```
  */
@@ -777,7 +797,11 @@ export type LemurTaskParams = {
  * ```js
  * {
  *   "request_id": "5e1b27c2-691f-4414-8bc5-f14678442f9e",
- *   "response": "Based on the transcript, the following locations were mentioned as being affected by wildfire smoke from Canada:\n\n- Maine\n- Maryland\n- Minnesota\n- Mid Atlantic region\n- Northeast region\n- New York City\n- Baltimore\n"
+ *   "response": "Based on the transcript, the following locations were mentioned as being affected by wildfire smoke from Canada:\n\n- Maine\n- Maryland\n- Minnesota\n- Mid Atlantic region\n- Northeast region\n- New York City\n- Baltimore\n",
+ *   "usage": {
+ *     "input_tokens": 27,
+ *     "output_tokens": 3
+ *   }
  * }
  * ```
  */
@@ -787,6 +811,19 @@ export type LemurTaskResponse = {
      */
     response: string;
 } & LemurBaseResponse;
+/**
+ * The usage numbers for the LeMUR request
+ */
+export type LemurUsage = {
+    /**
+     * The number of input tokens used by the model
+     */
+    input_tokens: number;
+    /**
+     * The number of output tokens generated by the model
+     */
+    output_tokens: number;
+};
 /**
  * @example
  * ```js
@@ -828,7 +865,6 @@ 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
@@ -851,12 +887,10 @@ export type PageDetails = {
      */
     limit: number;
     /**
-     * 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;
@@ -948,7 +982,10 @@ export type ParagraphsResponse = {
     id: string;
     paragraphs: TranscriptParagraph[];
 };
-export type PiiPolicy = "medical_process" | "medical_condition" | "blood_type" | "drug" | "injury" | "number_sequence" | "email_address" | "date_of_birth" | "phone_number" | "us_social_security_number" | "credit_card_number" | "credit_card_expiration" | "credit_card_cvv" | "date" | "nationality" | "event" | "language" | "location" | "money_amount" | "person_name" | "person_age" | "organization" | "political_affiliation" | "occupation" | "religion" | "drivers_license" | "banking_information";
+/**
+ * The type of PII to redact
+ */
+export type PiiPolicy = "account_number" | "banking_information" | "blood_type" | "credit_card_cvv" | "credit_card_expiration" | "credit_card_number" | "date" | "date_interval" | "date_of_birth" | "drivers_license" | "drug" | "duration" | "email_address" | "event" | "filename" | "gender_sexuality" | "healthcare_number" | "injury" | "ip_address" | "language" | "location" | "marital_status" | "medical_condition" | "medical_process" | "money_amount" | "nationality" | "number_sequence" | "occupation" | "organization" | "passport_number" | "password" | "person_age" | "person_name" | "phone_number" | "physical_attribute" | "political_affiliation" | "religion" | "statistics" | "time" | "url" | "us_social_security_number" | "username" | "vehicle_id" | "zodiac_sign";
 /**
  * @example
  * ```js
@@ -987,6 +1024,10 @@ export type RealtimeTemporaryTokenResponse = {
      */
     token: string;
 };
+/**
+ * The notification when the redacted audio is ready.
+ */
+export type RedactedAudioNotification = RedactedAudioResponse;
 /**
  * @example
  * ```js
@@ -1124,7 +1165,7 @@ export type SentencesResponse = {
 };
 export type Sentiment = "POSITIVE" | "NEUTRAL" | "NEGATIVE";
 /**
- * The result of the sentiment analysis model
+ * The result of the Sentiment Analysis model
  * @example
  * ```js
  * {
@@ -2114,7 +2155,7 @@ export type Transcript = {
     auto_highlights: boolean;
     /**
      * An array of results for the Key Phrases model, if it is enabled.
-     * See {@link https://www.assemblyai.com/docs/models/key-phrases | Key phrases } for more information.
+     * See {@link https://www.assemblyai.com/docs/models/key-phrases | Key Phrases } for more information.
      */
     auto_highlights_result?: AutoHighlightsResult | null;
     /**
@@ -2236,7 +2277,7 @@ export type Transcript = {
     sentiment_analysis?: boolean | null;
     /**
      * An array of results for the Sentiment Analysis model, if it is enabled.
-     * See {@link https://www.assemblyai.com/docs/models/sentiment-analysis | Sentiment analysis } for more information.
+     * See {@link https://www.assemblyai.com/docs/models/sentiment-analysis | Sentiment Analysis } for more information.
      */
     sentiment_analysis_results?: SentimentAnalysisResult[] | null;
     /**
@@ -2305,15 +2346,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 trancription 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;
     /**
@@ -2358,9 +2401,8 @@ export type TranscriptCustomSpelling = {
  *
  * @defaultValue "en_us
  */
-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";
+export type TranscriptLanguageCode = "en" | "en_au" | "en_uk" | "en_us" | "es" | "fr" | "de" | "it" | "pt" | "nl" | "af" | "sq" | "am" | "ar" | "hy" | "as" | "az" | "ba" | "eu" | "be" | "bn" | "bs" | "br" | "bg" | "my" | "ca" | "zh" | "hr" | "cs" | "da" | "et" | "fo" | "fi" | "gl" | "ka" | "el" | "gu" | "ht" | "ha" | "haw" | "he" | "hi" | "hu" | "is" | "id" | "ja" | "jw" | "kn" | "kk" | "km" | "ko" | "lo" | "la" | "lv" | "ln" | "lt" | "lb" | "mk" | "mg" | "ms" | "ml" | "mt" | "mi" | "mr" | "mn" | "ne" | "no" | "nn" | "oc" | "pa" | "ps" | "fa" | "pl" | "ro" | "ru" | "sa" | "sr" | "sn" | "sd" | "si" | "sk" | "sl" | "so" | "su" | "sw" | "sv" | "tl" | "tg" | "ta" | "tt" | "te" | "th" | "bo" | "tr" | "tk" | "uk" | "ur" | "uz" | "vi" | "cy" | "yi" | "yo";
 /**
- * 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
@@ -2498,7 +2540,7 @@ export type TranscriptOptionalParams = {
      */
     auto_chapters?: boolean;
     /**
-     * Whether Key Phrases is enabled, either true or false
+     * Enable Key Phrases, either true or false
      */
     auto_highlights?: boolean;
     /**
@@ -2510,7 +2552,7 @@ export type TranscriptOptionalParams = {
      */
     content_safety?: boolean;
     /**
-     * The confidence threshold for content moderation. Values must be between 25 and 100.
+     * The confidence threshold for the Content Moderation model. Values must be between 25 and 100.
      */
     content_safety_confidence?: number;
     /**
@@ -2518,7 +2560,7 @@ export type TranscriptOptionalParams = {
      */
     custom_spelling?: TranscriptCustomSpelling[];
     /**
-     * Whether custom topics is enabled, either true or false
+     * Enable custom topics, either true or false
      */
     custom_topics?: boolean;
     /**
@@ -2551,7 +2593,7 @@ export type TranscriptOptionalParams = {
      */
     language_code?: LiteralUnion<TranscriptLanguageCode, string> | null;
     /**
-     * Whether {@link https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection | Automatic language detection } was enabled in the transcription request, either true or false.
+     * Enable {@link https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection | Automatic language detection }, either true or false.
      */
     language_detection?: boolean;
     /**
@@ -2619,21 +2661,21 @@ export type TranscriptOptionalParams = {
      */
     summary_type?: SummaryType;
     /**
-     * The list of custom topics provided, if custom topics is enabled
+     * The list of custom topics
      */
     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 trancription 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;
     /**
@@ -2976,6 +3018,10 @@ export type TranscriptUtterance = {
      */
     words: TranscriptWord[];
 };
+/**
+ * The notifications sent to the webhook URL.
+ */
+export type TranscriptWebhookNotification = TranscriptReadyNotification | RedactedAudioNotification;
 /**
  * @example
  * ```js

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

@@ -1,5 +1,12 @@
+import { UserAgent } from "..";
 type BaseServiceParams = {
     apiKey: string;
     baseUrl?: string;
+    /**
+     * The AssemblyAI user agent to use for requests.
+     * The provided components will be merged into the default AssemblyAI user agent.
+     * If `false`, the AssemblyAI user agent will be removed.
+     */
+    userAgent?: UserAgent | false;
 };
 export type { BaseServiceParams };

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

@@ -46,3 +46,12 @@ export type SubmitParams = TranscribeParams;
  * The options to transcribe an audio file, including polling options.
  */
 export type TranscribeOptions = PollingOptions;
+/**
+ * The PII redacted audio file, transmitted over the network.
+ */
+export type RedactedAudioFile = {
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    blob: () => Promise<Blob>;
+    body: ReadableStream<Uint8Array> | null;
+    bodyUsed: boolean;
+};

package/dist/utils/userAgent.d.ts

@@ -0,0 +1,2 @@
+import { UserAgent } from "../types";
+export declare const buildUserAgent: (userAgent: UserAgent | false) => string;