assemblyai 1.0.0 → 2.0.0-beta

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export type * from "./core";
+export type * from "./lemur";
+export type * from "./models";
+export type * from "./realtime";
+export type * from "./services";
+export type * from "./shared";

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

@@ -0,0 +1,79 @@
+type LeMURModel = "default" | "basic";
+type LeMURContext = string | object | LeMURContext[];
+type LeMURBaseServiceParams = {
+    /**
+     * A list of completed transcripts with text. Up to 100 files max, or 100 hours max. Whichever is lower.
+     */
+    transcript_ids: string[];
+    /**
+     * The model that is used for the final prompt after compression is performed (options: "basic" and "default").
+     */
+    final_model?: LeMURModel;
+    /**
+     * Max output size in tokens. Up to 4000 allowed.
+     */
+    max_output_size?: number;
+};
+type SummaryParams = LeMURBaseServiceParams & {
+    /**
+     * How you want the summary to be returned. This can be any text. Examples: "TLDR", "bullet points"
+     */
+    answer_format?: string;
+    /**
+     * Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
+     */
+    context?: LeMURContext;
+};
+type Question = {
+    /**
+     * The question you wish to ask. For more complex questions use default model.
+     */
+    question: string;
+    /**
+     * Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
+     */
+    context?: LeMURContext;
+    /**
+     * How you want the answer to be returned. This can be any text. Cannot be used with answer_options. Examples: "short sentence", "bullet points"
+     */
+    answer_format?: string;
+    /**
+     * What discrete options to return. Useful for precise responses. Cannot be used with answer_format. Example: ["Yes", "No"]
+     */
+    answer_options?: string[];
+};
+type QuestionAnswerParams = LeMURBaseServiceParams & {
+    /**
+     * Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
+     */
+    context?: LeMURContext;
+    /**
+     * 	A list of questions to ask. Question format listed below.
+     */
+    questions: Question[];
+};
+type ActionItemsParams = LeMURBaseServiceParams & {
+    /**
+     * Any context about the transcripts you wish to provide. This can be a string, or free-form JSON.
+     */
+    context?: LeMURContext;
+};
+type TaskParams = LeMURBaseServiceParams & {
+    /**
+     * Your text to prompt the model to produce a desired output, including any context you want to pass into the model.
+     */
+    prompt: string;
+};
+type LeMURResponse = {
+    response: string;
+    request_id: string;
+};
+type QuestionAnswer = {
+    question: string;
+    answer: string;
+};
+type LeMURQuestionAnswerResponse = {
+    response: QuestionAnswer[];
+    request_id: string;
+};
+export type { SummaryParams, QuestionAnswerParams, ActionItemsParams, TaskParams, LeMURResponse, LeMURQuestionAnswerResponse, LeMURBaseServiceParams, };

package/dist/types/models/auto_chapter.d.ts

@@ -0,0 +1,8 @@
+type AutoChapter = {
+    summary: string;
+    headline: string;
+    gist: string;
+    start: number;
+    end: number;
+};
+export type { AutoChapter };

package/dist/types/models/auto_highlights.d.ts

@@ -0,0 +1,11 @@
+import { ModelResultStatus } from "./shared";
+type AutoHighlightsResult = {
+    text: string;
+    count: number;
+    rank: number;
+};
+type AutoHighlights = {
+    status: ModelResultStatus;
+    results: AutoHighlightsResult[];
+};
+export type { AutoHighlights };

package/dist/types/models/content_safety.d.ts

@@ -0,0 +1,25 @@
+import { ModelResultStatus, ModelSummary } from "./shared";
+import { Timestamp } from "@/types/shared";
+type ContentSafetyLabel = {
+    label: string;
+    confidence: number;
+    severity: number | null;
+};
+type ContentSafetyResult = {
+    text: string;
+    labels: ContentSafetyLabel[];
+    timestamp: Timestamp;
+};
+type ContentSafetySeverityScore = {
+    low: number;
+    medium: number;
+    high: number;
+};
+type ContentSafetySeverityScoreSummary = Record<string, ContentSafetySeverityScore>;
+type ContentSafetyLabels = {
+    status: ModelResultStatus;
+    results: ContentSafetyResult[];
+    summary: ModelSummary;
+    severity_score_summary: ContentSafetySeverityScoreSummary;
+};
+export type { ContentSafetyLabels };

package/dist/types/models/entity_detection.d.ts

@@ -0,0 +1,7 @@
+type Entity = {
+    entity_type: string;
+    text: string;
+    start: number;
+    end: number;
+};
+export type { Entity };

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

@@ -0,0 +1,8 @@
+export type * from "./auto_chapter";
+export type * from "./auto_highlights";
+export type * from "./content_safety";
+export type * from "./entity_detection";
+export type * from "./pii";
+export type * from "./sentiment_analysis";
+export type * from "./summarization";
+export type * from "./topic_detection";

package/dist/types/models/pii.d.ts

@@ -0,0 +1,3 @@
+type PIIRedactionPolicies = "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";
+type PIIAudioQuality = "mp3" | "wav";
+export type { PIIRedactionPolicies, PIIAudioQuality };

package/dist/types/models/sentiment_analysis.d.ts

@@ -0,0 +1,9 @@
+type Sentiment = "NEUTRAL" | "POSITIVE" | "NEGATIVE";
+type SentimentAnalysis = {
+    text: string;
+    start: number;
+    end: number;
+    sentiment: Sentiment;
+    confidence: number;
+};
+export type { SentimentAnalysis };

package/dist/types/models/shared.d.ts

@@ -0,0 +1,3 @@
+type ModelResultStatus = "success" | "error";
+type ModelSummary = Record<string, number>;
+export type { ModelResultStatus, ModelSummary };

package/dist/types/models/summarization.d.ts

@@ -0,0 +1,3 @@
+type SummaryType = "bullets" | "bullets_verbose" | "gist" | "headline" | "paragraph";
+type SummaryModel = "informative" | "conversational" | "catchy";
+export type { SummaryType, SummaryModel };

package/dist/types/models/topic_detection.d.ts

@@ -0,0 +1,17 @@
+import { ModelResultStatus, ModelSummary } from "./shared";
+import { Timestamp } from "@/types/shared";
+type TopicDetectionLabel = {
+    relevance: number;
+    label: string;
+};
+type TopicDetectionResults = {
+    text: string;
+    labels: TopicDetectionLabel[];
+    timestamp: Timestamp;
+};
+type TopicDetection = {
+    status: ModelResultStatus;
+    results: TopicDetectionResults[];
+    summary: ModelSummary;
+};
+export type { TopicDetection };

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

@@ -0,0 +1,17 @@
+type RealtimeConnectionParams = {
+    sampleRate?: number;
+    wordBoost?: string[];
+};
+type RealtimeListener = "data" | "error" | "open" | "close";
+type RealtimeTranscriptType = "PartialTranscript" | "FinalTranscript";
+type RealtimeTranscript = {
+    text: string;
+    message_type: RealtimeTranscriptType;
+};
+type RealtimeListeners = {
+    data?: (transcript: RealtimeTranscript) => void;
+    error?: (error: Error) => void;
+    open?: () => void;
+    close?: (code: number, reason: string) => void;
+};
+export type { RealtimeConnectionParams, RealtimeListener, RealtimeTranscript, RealtimeTranscriptType, RealtimeListeners, };

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

@@ -0,0 +1,80 @@
+/**
+ * Interface for classes that can create resources.
+ * @template T The type of the resource.
+ * @template Props The type of the properties required to create the resource.
+ */
+interface Createable<T, Props, Settings = Record<string, any>> {
+    /**
+     * Create a new resource.
+     * @param data The properties of the new resource.
+     * @param settings The settings used for creating the new resource.
+     * @return A promise that resolves to the newly created resource.
+     */
+    create(params: Props, settings?: Settings | null): Promise<T>;
+}
+/**
+ * Interface for classes that can retrieve resources.
+ * @template T The type of the resource.
+ * @template Id The type of the resource's identifier. Defaults to string.
+ */
+interface Retrieveable<T, Id = string> {
+    /**
+     * Retrieve a resource.
+     * @param id The identifier of the resource to retrieve.
+     * @return A promise that resolves to the retrieved resource.
+     */
+    retrieve(id: Id): Promise<T>;
+}
+/**
+ * Interface for classes that can delete resources.
+ * @template T The type of the resource.
+ * @template Id The type of the resource's identifier. Defaults to string.
+ */
+interface Deletable<T, Id = string> {
+    /**
+     * Delete a resource.
+     * @param id The identifier of the resource to delete.
+     * @return A promise that resolves to a boolean indicating whether the deletion was successful.
+     */
+    delete(id: Id): Promise<T>;
+}
+/**
+ * Interface for classes that can list resources.
+ * @template T The type of the resource.
+ */
+interface Listable<T, Page = string> {
+    /**
+     * List all resources.
+     * @return A promise that resolves to an array of resources.
+     */
+    list(page?: Page): Promise<T>;
+}
+/**
+ * Interface for classes that can connect to resources.
+ * @template T The type of the resource's data.
+ */
+interface Connectable<T, Params> {
+    /**
+     * Connect to a resource.
+     * @param event The event to listen for.
+     * @param listener The listener for the event.
+     */
+    on(event: "data", listener: (data: T) => void): void;
+    on(event: "error", listener: (error: Error) => void): void;
+    on(event: "open", listener: () => void): void;
+    on(event: "close", listener: (code: number, reason: string) => void): void;
+    /**
+     * Send data to the resource.
+     * @param data The data to send.
+     */
+    send(data: ArrayBuffer): void;
+    /**
+     * Connect to the resource.
+     */
+    connect(params: Params): void;
+    /**
+     * Disconnect from the resource.
+     */
+    disconnect(): void;
+}
+export type { Createable, Retrieveable, Deletable, Listable, Connectable };

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

@@ -0,0 +1,9 @@
+type BaseServiceParams = {
+    token: string;
+    baseUrl?: string;
+};
+type Upload = {
+    upload_url: string;
+};
+export type * from "./abstractions";
+export type { BaseServiceParams, Upload };

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

@@ -0,0 +1,2 @@
+export type * from "./pagination";
+export type * from "./timestamp";

package/dist/types/shared/pagination.d.ts

@@ -0,0 +1,7 @@
+type PageDetails = {
+    limit: number;
+    result_count: number;
+    next_url: string | null;
+    previous_url: string | null;
+};
+export type { PageDetails };

package/dist/types/shared/timestamp.d.ts

@@ -0,0 +1,5 @@
+type Timestamp = {
+    start: number;
+    end: number;
+};
+export type { Timestamp };

package/dist/utils/errors/index.d.ts

@@ -0,0 +1 @@
+export { default as RealtimeError, RealtimeErrorType, RealtimeErrorMessages, } from "./realtime";

package/dist/utils/errors/realtime.d.ts

@@ -0,0 +1,26 @@
+declare enum RealtimeErrorType {
+    BadSampleRate = 4000,
+    AuthFailed = 4001,
+    InsufficientFunds = 4002,
+    FreeAccount = 4003,
+    NonexistentSessionId = 4004,
+    SessionExpired = 4008,
+    ClosedSession = 4010,
+    RateLimited = 4029,
+    UniqueSessionViolation = 4030,
+    SessionTimeout = 4031,
+    AudioTooShort = 4032,
+    AudioTooLong = 4033,
+    BadJson = 4100,
+    BadSchema = 4101,
+    TooManyStreams = 4102,
+    Reconnected = 4103,
+    ReconnectAttemptsExhausted = 1013
+}
+declare const RealtimeErrorMessages: Record<RealtimeErrorType, string>;
+declare class RealtimeError extends Error {
+    code: RealtimeErrorType;
+    constructor(code: RealtimeErrorType);
+}
+export { RealtimeErrorType, RealtimeErrorMessages };
+export default RealtimeError;

package/package.json

@@ -1,31 +1,65 @@
 {
   "name": "assemblyai",
-  "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
+  "version": "2.0.0-beta",
+  "description": "The AssemblyAI Node.js 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.",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "typings": "dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/AssemblyAI/assemblyai-node-sdk.git"
+    "url": "git+https://github.com/AssemblyAI/assemblyai-typescript-sdk.git"
   },
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/AssemblyAI/assemblyai-node-sdk/issues"
+  "publishConfig": {
+    "tag": "beta",
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
   },
-  "homepage": "https://github.com/AssemblyAI/assemblyai-node-sdk#readme",
-  "dependencies": {
-    "request": "^2.88.0"
+  "scripts": {
+    "build": "pnpm clean && pnpm rollup -c",
+    "clean": "rimraf dist",
+    "lint": "tslint -p tsconfig.json",
+    "test": "pnpm lint && pnpm test:unit",
+    "test:unit": "jest --config jest.config.rollup.ts",
+    "prettier": "prettier --write 'src/**/*.ts'"
   },
+  "keywords": [
+    "AssemblyAI",
+    "Speech-to-text"
+  ],
+  "author": "AssemblyAI (https://www.assemblyai.com)",
+  "license": "MIT",
+  "homepage": "https://www.assemblyai.com/docs",
+  "files": [
+    "dist",
+    "src",
+    "types"
+  ],
   "devDependencies": {
-    "eslint": "^5.4.0",
-    "eslint-config-standard": "^11.0.0",
-    "eslint-plugin-import": "^2.14.0",
-    "eslint-plugin-node": "^7.0.1",
-    "eslint-plugin-promise": "^4.0.0",
-    "eslint-plugin-standard": "^3.1.0"
+    "@types/jest": "^29.5.2",
+    "@types/node": "^20.5.7",
+    "@types/ws": "^8.5.5",
+    "eslint": "^8.43.0",
+    "i": "^0.3.7",
+    "jest": "^29.5.0",
+    "jest-cli": "^29.5.0",
+    "jest-junit": "^16.0.0",
+    "jest-mock-extended": "^3.0.4",
+    "mock-socket": "^9.2.1",
+    "npm": "^9.7.1",
+    "prettier": "^2.8.8",
+    "rimraf": "^5.0.1",
+    "rollup": "^3.25.1",
+    "rollup-plugin-typescript2": "^0.34.1",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.5.3",
+    "tslint": "^6.1.3",
+    "typescript": "^5.1.3",
+    "jest-websocket-mock": "^2.4.1"
+  },
+  "dependencies": {
+    "axios": "^1.4.0",
+    "ws": "^8.13.0"
   }
 }

package/src/index.ts

@@ -0,0 +1,2 @@
+import AssemblyAI from "./services";
+export default AssemblyAI;

package/src/services/base.ts

@@ -0,0 +1,16 @@
+import axios, { AxiosInstance } from "axios";
+import { BaseServiceParams } from "@/types";
+
+/**
+ * Base class for services that communicate with the API.
+ */
+abstract class BaseService {
+  /**
+   * Create a new service.
+   * @param params The AxiosInstance to send HTTP requests to the API.
+   */
+  constructor(protected client: AxiosInstance) {}
+}
+
+export type { BaseServiceParams };
+export default BaseService;

package/src/services/files/index.ts

@@ -0,0 +1,22 @@
+import fs from "fs/promises";
+import BaseService from "@/services/base";
+import { Upload } from "@/types";
+
+export default class FileService extends BaseService {
+  /**
+   * Upload a local file to AssemblyAI.
+   * @param path The local file to upload.
+   * @return A promise that resolves to the uploaded file URL.
+   */
+  async upload(path: string): Promise<string> {
+    const file = await fs.readFile(path);
+
+    const { data } = await this.client.post<Upload>("/v2/upload", file, {
+      headers: {
+        "Content-Type": "application/octet-stream",
+      },
+    });
+
+    return data.upload_url;
+  }
+}

package/src/services/index.ts

@@ -0,0 +1,66 @@
+import axios, { isAxiosError } from "axios";
+import { BaseServiceParams } from "./base";
+import LeMURService from "./lemur";
+import RealtimeService from "./realtime";
+import TranscriptService from "./transcripts";
+import FileService from "./files";
+
+export default class AssemblyAI {
+  /**
+   * The files service.
+   */
+  public files: FileService;
+
+  /**
+   * The transcripts service.
+   */
+  public transcripts: TranscriptService;
+
+  /**
+   * The LeMUR service.
+   */
+  public lemur: LeMURService;
+
+  /**
+   * The realtime service.
+   */
+  public realtime: (params?: { baseUrl: string }) => RealtimeService;
+
+  /**
+   * Create a new AssemblyAI client.
+   * @param params The parameters for the service, including the API token and base URL, if any.
+   */
+  constructor(params: BaseServiceParams) {
+    params.baseUrl = params.baseUrl || "https://api.assemblyai.com";
+    const client = this.createClient(params);
+    this.files = new FileService(client);
+    this.transcripts = new TranscriptService(client, this.files);
+    this.lemur = new LeMURService(client);
+    this.realtime = ({ baseUrl } = { baseUrl: "" }) => {
+      if (!baseUrl) {
+        const url = new URL(params.baseUrl as string);
+        url.protocol = "wss:";
+        baseUrl = url.toString();
+      }
+      return new RealtimeService({
+        token: params.token,
+        baseUrl,
+      });
+    };
+  }
+
+  private createClient(params: BaseServiceParams) {
+    const client = axios.create({
+      baseURL: params.baseUrl,
+      headers: { Authorization: params.token },
+    });
+
+    client.interceptors.response.use(null, (error) => {
+      if (isAxiosError(error) && error.response?.data?.error) {
+        return Promise.reject(new Error(error.response.data.error));
+      }
+      return Promise.reject(error);
+    });
+    return client;
+  }
+}

package/src/services/lemur/index.ts

@@ -0,0 +1,45 @@
+import {
+  LeMURResponse,
+  SummaryParams,
+  QuestionAnswerParams,
+  ActionItemsParams,
+  TaskParams,
+  LeMURQuestionAnswerResponse,
+} from "@/types";
+import BaseService from "@/services/base";
+
+export default class LeMURService extends BaseService {
+  async summary(params: SummaryParams): Promise<LeMURResponse> {
+    const { data } = await this.client.post<LeMURResponse>(
+      "/lemur/v3/generate/summary",
+      params
+    );
+    return data;
+  }
+
+  async questionAnswer(
+    params: QuestionAnswerParams
+  ): Promise<LeMURQuestionAnswerResponse> {
+    const { data } = await this.client.post<LeMURQuestionAnswerResponse>(
+      "/lemur/v3/generate/question-answer",
+      params
+    );
+    return data;
+  }
+
+  async actionItems(params: ActionItemsParams): Promise<LeMURResponse> {
+    const { data } = await this.client.post<LeMURResponse>(
+      "/lemur/v3/generate/action-items",
+      params
+    );
+    return data;
+  }
+
+  async task(params: TaskParams): Promise<LeMURResponse> {
+    const { data } = await this.client.post<LeMURResponse>(
+      "/lemur/v3/generate/task",
+      params
+    );
+    return data;
+  }
+}