assemblyai 1.0.1 → 2.0.1-beta

package/src/services/transcripts/index.ts

@@ -0,0 +1,178 @@
+import BaseService from "@/services/base";
+import {
+  ParagraphsResponse,
+  SentencesResponse,
+  Transcript,
+  TranscriptList,
+  CreateTranscriptParameters,
+  CreateTranscriptOptions,
+  Createable,
+  Deletable,
+  Listable,
+  Retrieveable,
+  SubtitleFormat,
+  RedactedAudioResponse,
+} from "@/types";
+import { AxiosInstance } from "axios";
+import FileService from "../files";
+
+export default class TranscriptService
+  extends BaseService
+  implements
+    Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>,
+    Retrieveable<Transcript>,
+    Deletable<Transcript>,
+    Listable<TranscriptList>
+{
+  constructor(client: AxiosInstance, private files: FileService) {
+    super(client);
+  }
+
+  /**
+   * Create a transcript.
+   * @param params The parameters to create a transcript.
+   * @param options The options used for creating the new transcript.
+   * @returns A promise that resolves to the newly created transcript.
+   */
+  async create(
+    params: CreateTranscriptParameters,
+    options?: CreateTranscriptOptions
+  ): Promise<Transcript> {
+    const path = getPath(params.audio_url);
+    if (path !== null) {
+      const uploadUrl = await this.files.upload(path);
+      params.audio_url = uploadUrl;
+    }
+
+    const res = await this.client.post<Transcript>("/v2/transcript", params);
+
+    if (options?.poll ?? true) {
+      return await this.poll(res.data.id, options);
+    }
+
+    return res.data;
+  }
+
+  private async poll(
+    transcriptId: string,
+    options?: CreateTranscriptOptions
+  ): Promise<Transcript> {
+    const startTime = Date.now();
+    while (true) {
+      const transcript = await this.get(transcriptId);
+      if (transcript.status === "completed" || transcript.status === "error") {
+        return transcript;
+      } else if (
+        Date.now() - startTime <
+        (options?.pollingTimeout ?? 180_000)
+      ) {
+        await new Promise((resolve) =>
+          setTimeout(resolve, options?.pollingInterval ?? 3_000)
+        );
+      } else {
+        throw new Error("Polling timeout");
+      }
+    }
+  }
+
+  /**
+   * Retrieve a transcript.
+   * @param id The identifier of the transcript.
+   * @returns A promise that resolves to the transcript.
+   */
+  async get(id: string): Promise<Transcript> {
+    const res = await this.client.get<Transcript>(`/v2/transcript/${id}`);
+    return res.data;
+  }
+
+  // TODO: add options overload to support list querystring parameters
+  /**
+   * Retrieves a paged list of transcript listings.
+   * @param nextUrl The URL to retrieve the transcript list from. If not provided, the first page will be retrieved.
+   * @returns
+   */
+  async list(nextUrl?: string | null): Promise<TranscriptList> {
+    const { data } = await this.client.get<TranscriptList>(
+      nextUrl ?? "/v2/transcript"
+    );
+    for (const transcriptListItem of data.transcripts) {
+      transcriptListItem.created = new Date(transcriptListItem.created);
+      if (transcriptListItem.completed) {
+        transcriptListItem.completed = new Date(transcriptListItem.completed);
+      }
+    }
+
+    return data as unknown as TranscriptList;
+  }
+
+  /**
+   * Delete a transcript
+   * @param id The identifier of the transcript.
+   * @returns A promise that resolves to the transcript.
+   */
+  async delete(id: string): Promise<Transcript> {
+    const res = await this.client.delete<Transcript>(`/v2/transcript/${id}`);
+    return res.data;
+  }
+
+  /**
+   * Retrieve all sentences of a transcript.
+   * @param id The identifier of the transcript.
+   * @return A promise that resolves to the sentences.
+   */
+  async sentences(id: string): Promise<SentencesResponse> {
+    const { data } = await this.client.get<SentencesResponse>(
+      `/v2/transcript/${id}/sentences`
+    );
+    return data;
+  }
+
+  /**
+   * Retrieve all paragraphs of a transcript.
+   * @param id The identifier of the transcript.
+   * @return A promise that resolves to the paragraphs.
+   */
+  async paragraphs(id: string): Promise<ParagraphsResponse> {
+    const { data } = await this.client.get<ParagraphsResponse>(
+      `/v2/transcript/${id}/paragraphs`
+    );
+    return data;
+  }
+
+  /**
+   * Retrieve subtitles of a transcript.
+   * @param id The identifier of the transcript.
+   * @param format The format of the subtitles.
+   * @return A promise that resolves to the subtitles text.
+   */
+  async subtitles(id: string, format: SubtitleFormat = "srt"): Promise<string> {
+    const { data } = await this.client.get<string>(
+      `/v2/transcript/${id}/${format}`
+    );
+
+    return data;
+  }
+
+  /**
+   * Retrieve redactions of a transcript.
+   * @param id The identifier of the transcript.
+   * @return A promise that resolves to the subtitles text.
+   */
+  async redactions(id: string): Promise<RedactedAudioResponse> {
+    const { data } = await this.client.get<RedactedAudioResponse>(
+      `/v2/transcript/${id}/redacted-audio`
+    );
+    return data;
+  }
+}
+
+function getPath(path: string) {
+  let url: URL;
+  try {
+    url = new URL(path);
+    if (url.protocol === "file:") return url.pathname;
+    else return null;
+  } catch {
+    return path;
+  }
+}

package/src/types/asyncapi.generated.ts

@@ -0,0 +1,124 @@
+// this file is generated by typescript/scripts/generate-types.ts
+/* tslint:disable */
+/* eslint-disable */
+
+/** OneOf type helpers */
+type Without<T, U> = { [P in Exclude<keyof T, keyof U>]?: never };
+type XOR<T, U> = T | U extends object
+  ? (Without<T, U> & U) | (Without<U, T> & T)
+  : T | U;
+type OneOf<T extends any[]> = T extends [infer Only]
+  ? Only
+  : T extends [infer A, infer B, ...infer Rest]
+  ? OneOf<[XOR<A, B>, ...Rest]>
+  : never;
+
+export type AudioData = {
+  /** @description Raw audio data, base64 encoded. This can be the raw data recorded directly from a microphone or read from an audio file. */
+  audio_data: string;
+};
+
+export type FinalTranscript = RealtimeBaseTranscript & {
+  /**
+   * @description Describes the type of message.
+   * @constant
+   */
+  message_type: "FinalTranscript";
+  /** @description Whether the text has been punctuated and cased. */
+  punctuated: boolean;
+  /** @description Whether the text has been formatted (e.g. Dollar -> $) */
+  text_formatted: boolean;
+};
+
+/** @enum {string} */
+export type MessageType =
+  | "SessionBegins"
+  | "PartialTranscript"
+  | "FinalTranscript"
+  | "SessionTerminated";
+
+export type PartialTranscript = RealtimeBaseTranscript & {
+  /**
+   * @description Describes the type of message.
+   * @constant
+   */
+  message_type: "PartialTranscript";
+};
+
+export type RealtimeBaseMessage = {
+  /** @description Describes the type of the message. */
+  message_type: MessageType;
+};
+
+export type RealtimeBaseTranscript = {
+  /** @description End time of audio sample relative to session start, in milliseconds. */
+  audio_end: number;
+  /** @description Start time of audio sample relative to session start, in milliseconds. */
+  audio_start: number;
+  /**
+   * Format: double
+   * @description The confidence score of the entire transcription, between 0 and 1.
+   */
+  confidence: number;
+  /** @description The timestamp for the partial transcript. */
+  created: Date;
+  /** @description The partial transcript for your audio. */
+  text: string;
+  /** @description An array of objects, with the information for each word in the transcription text. Includes the start/end time (in milliseconds) of the word, the confidence score of the word, and the text (i.e. the word itself). */
+  words: Word[];
+};
+
+export type RealtimeError = {
+  error: string;
+};
+
+export type RealtimeMessage =
+  | SessionBegins
+  | PartialTranscript
+  | FinalTranscript
+  | SessionTerminated
+  | RealtimeError;
+
+export type RealtimeTranscript = PartialTranscript | FinalTranscript;
+
+/** @enum {string} */
+export type RealtimeTranscriptType = "PartialTranscript" | "FinalTranscript";
+
+export type SessionBegins = RealtimeBaseMessage & {
+  /** @description Timestamp when this session will expire. */
+  expires_at: Date;
+  /**
+   * @description Describes the type of the message.
+   * @constant
+   */
+  message_type: "SessionBegins";
+  /** @description Unique identifier for the established session. */
+  session_id: string;
+};
+
+export type SessionTerminated = RealtimeBaseMessage & {
+  /**
+   * @description Describes the type of the message.
+   * @constant
+   */
+  message_type: "SessionTerminated";
+};
+
+export type TerminateSession = RealtimeBaseMessage & {
+  /** @description A boolean value to communicate that you wish to end your real-time session forever. */
+  terminate_session: boolean;
+};
+
+export type Word = {
+  /**
+   * Format: double
+   * @description Confidence score of the word
+   */
+  confidence: number;
+  /** @description End time of the word in milliseconds */
+  end: number;
+  /** @description Start time of the word in milliseconds */
+  start: number;
+  /** @description The word itself */
+  text: string;
+};

package/src/types/index.ts

@@ -0,0 +1,5 @@
+export type * from "./transcripts";
+export type * from "./realtime";
+export type * from "./services";
+export type * from "./asyncapi.generated";
+export type * from "./openapi.generated";