assemblyai 4.4.2 → 4.4.4

package/dist/streaming.mjs

@@ -0,0 +1,274 @@
+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}`;
+class 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;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    on(event, listener) {
+        this.listeners[event] = listener;
+    }
+    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;
+                    }
+                }
+            };
+        });
+    }
+    sendAudio(audio) {
+        this.send(audio);
+    }
+    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() {
+        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

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/utils/userAgent.d.ts

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

package/docs/reference-types-from-js.md

@@ -0,0 +1,27 @@
+# Reference types from JavaScript
+
+Types are automatically configured in most IDEs when you import the `assemblyai` module using `require` or `import`.
+However, if you're using the _assemblyai.umd.js_ or _assemblyai.umd.min.js_ script,
+you need to manually reference the types.
+
+1. Install the `assemblyai` module locally.
+2. Create an _assemblyai.d.ts_ file with the following content.
+   ```typescript
+   import AssemblyAIModule from "assemblyai";
+   declare global {
+     const assemblyai: typeof AssemblyAIModule;
+   }
+   ```
+   This will import the TypeScript types from the `assemblyai` module,
+   and configure them as the global `assemblyai` variable.
+3. Reference the _assemblyai.d.ts_ file at the top of your script file.
+
+   ```js
+   /// <reference path="assemblyai.d.ts" />
+   const { RealtimeTranscriber } = assemblyai;
+   ...
+   ```
+
+   Your IDE will load the types specified in the `<reference />` tag.
+
+   > [!INFO] > `/// <reference />` tags only work in script files, not script-blocks, and should be at the top of the file.

package/package.json

@@ -1,25 +1,26 @@
 {
   "name": "assemblyai",
-  "version": "4.4.2",
+  "version": "4.4.4",
   "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"
   },
   "exports": {
     ".": {
-      "types": "./dist/index.d.ts",
+      "types": "./dist/exports/index.d.ts",
       "bun": {
-        "types": "./dist/index.d.ts",
+        "types": "./dist/exports/index.d.ts",
         "default": "./dist/bun.mjs"
       },
       "deno": {
-        "types": "./dist/index.d.ts",
+        "types": "./dist/exports/index.d.ts",
         "default": "./dist/deno.mjs"
       },
       "workerd": "./dist/index.mjs",
       "browser": "./dist/browser.mjs",
+      "react-native": "./dist/browser.mjs",
       "node": {
-        "types": "./dist/index.d.ts",
+        "types": "./dist/exports/index.d.ts",
         "import": "./dist/node.mjs",
         "require": "./dist/node.cjs"
       },
@@ -27,6 +28,13 @@
       "require": "./dist/index.cjs",
       "default": "./dist/index.cjs"
     },
+    "./streaming": {
+      "types": "./dist/exports/streaming.d.ts",
+      "browser": "./dist/streaming.browser.mjs",
+      "import": "./dist/streaming.mjs",
+      "require": "./dist/streaming.cjs",
+      "default": "./dist/streaming.cjs"
+    },
     "./package.json": "./package.json"
   },
   "imports": {
@@ -47,6 +55,8 @@
     }
   },
   "type": "commonjs",
+  "react-native": "./dist/browser.mjs",
+  "browser": "./dist/browser.mjs",
   "main": "./dist/index.cjs",
   "require": "./dist/index.cjs",
   "module": "./dist/index.mjs",
@@ -64,11 +74,15 @@
   "scripts": {
     "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": "pnpm run test:unit && pnpm run test:integration",
+    "lint": "pnpm lint:eslint && pnpm lint:tsc && pnpm lint:format && pnpm lint:publint",
+    "lint:eslint": "eslint -c .eslintrc.json '{src,tests}/**/*.{js,ts}'",
+    "lint:tsc": "tsc --noEmit -p tsconfig.json",
+    "lint:format": "prettier  --check --no-error-on-unmatched-pattern {*,**/*}",
+    "lint:publint": "publint",
+    "test": "pnpm test:unit && pnpm test:integration",
     "test:unit": "jest --config jest.unit.config.js --testTimeout 1000",
     "test:integration": "jest --config jest.integration.config.js --testTimeout 360000",
-    "format": "prettier '**/*' --write",
+    "format": "prettier --write --no-error-on-unmatched-pattern {*,**/*}",
     "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",
@@ -97,16 +111,17 @@
     "docs"
   ],
   "devDependencies": {
-    "@babel/preset-env": "^7.24.0",
-    "@babel/preset-typescript": "^7.23.3",
+    "@babel/preset-env": "^7.24.5",
+    "@babel/preset-typescript": "^7.24.1",
     "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.5",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",
-    "@types/node": "^18.11.9",
+    "@types/node": "^18.19.32",
     "@types/websocket": "^1.0.10",
     "@types/ws": "^8.5.10",
-    "@typescript-eslint/eslint-plugin": "^7.2.0",
+    "@typescript-eslint/eslint-plugin": "^7.8.0",
     "dotenv": "^16.4.5",
     "eslint": "^8.57.0",
     "eslint-plugin-tsdoc": "^0.2.17",
@@ -115,19 +130,20 @@
     "jest-fetch-mock": "^3.0.3",
     "jest-junit": "^16.0.0",
     "jest-websocket-mock": "^2.5.0",
+    "jsr": "^0.12.4",
     "mock-socket": "^9.3.1",
     "openapi-typescript": "^6.7.5",
     "prettier": "^3.2.5",
     "publint": "^0.2.7",
     "rimraf": "^5.0.5",
-    "rollup": "^4.13.0",
+    "rollup": "^4.17.2",
     "ts-jest": "^29.1.2",
     "tslib": "^2.5.3",
-    "typescript": "^5.4.2",
-    "typedoc": "^0.25.12",
-    "typedoc-plugin-extras": "^3.0.0"
+    "typedoc": "^0.25.13",
+    "typedoc-plugin-extras": "^3.0.0",
+    "typescript": "^5.4.5"
   },
   "dependencies": {
-    "ws": "^8.16.0"
+    "ws": "^8.17.0"
   }
 }

package/src/exports/index.ts

@@ -0,0 +1,2 @@
+export * from "../types";
+export * from "../services";

package/src/exports/streaming.ts

@@ -0,0 +1,4 @@
+export * from "../types/asyncapi.generated";
+export * from "../types/realtime";
+export * from "../types/helpers";
+export * from "../services/realtime/service";

package/src/services/base.ts

@@ -1,26 +1,45 @@
 import { BaseServiceParams } from "..";
 import { Error as JsonError } from "..";
+import { buildUserAgent } from "../utils/userAgent";
 
 /**
  * Base class for services that communicate with the API.
  */
 export abstract class BaseService {
+  private userAgent: string | undefined;
   /**
    * Create a new service.
    * @param params - The parameters to use for the service.
    */
-  constructor(private params: BaseServiceParams) {}
+  constructor(private params: BaseServiceParams) {
+    if (params.userAgent === false) {
+      this.userAgent = undefined;
+    } else {
+      this.userAgent = buildUserAgent(params.userAgent || {});
+    }
+  }
   protected async fetch(
     input: string,
     init?: RequestInit | undefined,
   ): Promise<Response> {
     init = init ?? {};
-    init.headers = init.headers ?? {};
-    init.headers = {
+    let headers = init.headers ?? {};
+    headers = {
       Authorization: this.params.apiKey,
       "Content-Type": "application/json",
       ...init.headers,
     };
+
+    if (this.userAgent) {
+      (headers as Record<string, string>)["User-Agent"] = this.userAgent;
+      // chromium browsers have a bug where the user agent can't be modified
+      if (typeof window !== "undefined" && "chrome" in window) {
+        (headers as Record<string, string>)["AssemblyAI-Agent"] =
+          this.userAgent;
+      }
+    }
+    init.headers = headers;
+
     init.cache = "no-store";
     if (!input.startsWith("http")) input = this.params.baseUrl + input;
 

package/src/services/index.ts

@@ -38,8 +38,9 @@ class AssemblyAI {
    */
   constructor(params: BaseServiceParams) {
     params.baseUrl = params.baseUrl || defaultBaseUrl;
-    if (params.baseUrl && params.baseUrl.endsWith("/"))
+    if (params.baseUrl && params.baseUrl.endsWith("/")) {
       params.baseUrl = params.baseUrl.slice(0, -1);
+    }
     this.files = new FileService(params);
     this.transcripts = new TranscriptService(params, this.files);
     this.lemur = new LemurService(params);

package/src/types/index.ts

@@ -5,3 +5,12 @@ 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/src/types/openapi.generated.ts

@@ -497,35 +497,50 @@ export type Entity = {
  * The type of entity for the detected entity
  */
 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";
+  | "us_social_security_number"
+  | "username"
+  | "vehicle_id"
+  | "zodiac_sign";
 
 /**
  * @example

package/src/types/services/index.ts

@@ -1,6 +1,14 @@
+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/src/utils/userAgent.ts

@@ -0,0 +1,51 @@
+import { UserAgent } from "../types";
+
+export const buildUserAgent = (userAgent: UserAgent | false) =>
+  defaultUserAgentString +
+  (userAgent === false
+    ? ""
+    : " AssemblyAI/1.0 (" +
+      Object.entries({ ...defaultUserAgent, ...userAgent })
+        .map(([key, item]) =>
+          item ? `${key}=${item.name}/${item.version}` : "",
+        )
+        .join(" ") +
+      ")");
+
+let defaultUserAgentString = "";
+if (typeof navigator !== "undefined" && navigator.userAgent) {
+  defaultUserAgentString += navigator.userAgent;
+}
+
+const defaultUserAgent: UserAgent = {
+  sdk: { name: "JavaScript", version: "__SDK_VERSION__" },
+};
+
+if (typeof process !== "undefined") {
+  if (process.versions.node && defaultUserAgentString.indexOf("Node") === -1) {
+    defaultUserAgent.runtime_env = {
+      name: "Node",
+      version: process.versions.node,
+    };
+  }
+  if (process.versions.bun && defaultUserAgentString.indexOf("Bun") === -1) {
+    defaultUserAgent.runtime_env = {
+      name: "Bun",
+      version: process.versions.bun,
+    };
+  }
+}
+
+declare const Deno:
+  | {
+      version: {
+        deno: string;
+      };
+    }
+  | undefined;
+
+if (typeof Deno !== "undefined") {
+  if (process.versions.bun && defaultUserAgentString.indexOf("Deno") === -1) {
+    defaultUserAgent.runtime_env = { name: "Deno", version: Deno.version.deno };
+  }
+}