assemblyai 2.0.0-beta → 2.0.1

package/src/types/realtime/index.ts

@@ -1,28 +1,68 @@
-type RealtimeConnectionParams = {
+import {
+  FinalTranscript,
+  PartialTranscript,
+  RealtimeTranscript,
+  RealtimeTranscriptType,
+} from "../asyncapi.generated";
+
+type CreateRealtimeServiceParams = {
+  realtimeUrl?: string;
   sampleRate?: number;
   wordBoost?: string[];
-};
+} & (
+  | {
+      apiKey?: string;
+    }
+  | {
+      token: string;
+    }
+);
 
-type RealtimeListener = "data" | "error" | "open" | "close";
+type RealtimeServiceParams = {
+  realtimeUrl?: string;
+  sampleRate?: number;
+  wordBoost?: string[];
+} & (
+  | {
+      apiKey: string;
+    }
+  | {
+      token: string;
+    }
+);
 
-type RealtimeTranscriptType = "PartialTranscript" | "FinalTranscript";
+type RealtimeEvents =
+  | "open"
+  | "close"
+  | "transcript"
+  | "transcript.partial"
+  | "transcript.final"
+  | "error";
 
-type RealtimeTranscript = {
-  text: string;
-  message_type: RealtimeTranscriptType;
+type SessionBeginsEventData = {
+  sessionId: string;
+  expiresAt: Date;
 };
 
 type RealtimeListeners = {
-  data?: (transcript: RealtimeTranscript) => void;
-  error?: (error: Error) => void;
-  open?: () => void;
+  open?: (event: SessionBeginsEventData) => void;
   close?: (code: number, reason: string) => void;
+  transcript?: (transcript: RealtimeTranscript) => void;
+  "transcript.partial"?: (transcript: PartialTranscript) => void;
+  "transcript.final"?: (transcript: FinalTranscript) => void;
+  error?: (error: Error) => void;
+};
+
+type RealtimeTokenParams = {
+  expires_in: number;
 };
 
 export type {
-  RealtimeConnectionParams,
-  RealtimeListener,
-  RealtimeTranscript,
+  CreateRealtimeServiceParams,
+  RealtimeServiceParams,
+  RealtimeEvents,
   RealtimeTranscriptType,
+  SessionBeginsEventData,
   RealtimeListeners,
+  RealtimeTokenParams,
 };

package/src/types/services/abstractions.ts

@@ -1,16 +1,16 @@
 /**
  * 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.
+ * @template Parameters The type of the parameters required to create the resource.
  */
-interface Createable<T, Props, Settings = Record<string, any>> {
+interface Createable<T, Parameters, Options = 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.
+   * @param params The parameters of the new resource.
+   * @param options The options used for creating the new resource.
    * @return A promise that resolves to the newly created resource.
    */
-  create(params: Props, settings?: Settings | null): Promise<T>;
+  create(params: Parameters, options?: Options): Promise<T>;
 }
 
 /**
@@ -20,11 +20,11 @@ interface Createable<T, Props, Settings = Record<string, any>> {
  */
 interface Retrieveable<T, Id = string> {
   /**
-   * Retrieve a resource.
+   * Get 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>;
+  get(id: Id): Promise<T>;
 }
 
 /**
@@ -53,36 +53,4 @@ interface Listable<T, Page = string> {
   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 };
+export type { Createable, Retrieveable, Deletable, Listable };

package/src/types/services/index.ts

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

package/src/types/transcripts/index.ts

@@ -0,0 +1,5 @@
+export type CreateTranscriptOptions = {
+  poll?: boolean;
+  pollingInterval?: number;
+  pollingTimeout?: number;
+};

package/src/utils/axios.ts

@@ -0,0 +1,19 @@
+import axios, { isAxiosError } from "axios";
+import { BaseServiceParams } from "../.";
+
+export function createAxiosClient(params: BaseServiceParams) {
+  const client = axios.create({
+    baseURL: params.baseUrl,
+    headers: { Authorization: params.apiKey },
+  });
+
+  client.interceptors.response.use(undefined, throwApiError);
+  return client;
+}
+
+export function throwApiError(error: unknown) {
+  if (isAxiosError(error) && error.response?.data?.error) {
+    return Promise.reject(new Error(error.response.data.error));
+  }
+  return Promise.reject(error);
+}

package/src/utils/errors/realtime.ts

@@ -1,8 +1,8 @@
 enum RealtimeErrorType {
   BadSampleRate = 4000,
   AuthFailed = 4001,
-  InsufficientFunds = 4002,
-  FreeAccount = 4003,
+  // Both InsufficientFunds and FreeAccount error use 4002
+  InsufficientFundsOrFreeAccount = 4002,
   NonexistentSessionId = 4004,
   SessionExpired = 4008,
   ClosedSession = 4010,
@@ -21,9 +21,8 @@ enum RealtimeErrorType {
 const RealtimeErrorMessages: Record<RealtimeErrorType, string> = {
   [RealtimeErrorType.BadSampleRate]: "Sample rate must be a positive integer",
   [RealtimeErrorType.AuthFailed]: "Not Authorized",
-  [RealtimeErrorType.InsufficientFunds]: "Insufficient funds",
-  [RealtimeErrorType.FreeAccount]:
-    "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.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",
@@ -40,19 +39,7 @@ const RealtimeErrorMessages: Record<RealtimeErrorType, string> = {
     "Reconnect attempts exhausted",
 };
 
-class RealtimeError extends Error {
-  public code: RealtimeErrorType;
-
-  constructor(code: RealtimeErrorType) {
-    const message = RealtimeErrorMessages[code];
-    super(message);
-
-    this.name = this.constructor.name;
-    this.code = code;
-
-    Error.captureStackTrace(this, this.constructor);
-  }
-}
+class RealtimeError extends Error {}
 
 export { RealtimeErrorType, RealtimeErrorMessages };
 export default RealtimeError;

package/dist/services/transcripts/redactions.d.ts

@@ -1,14 +0,0 @@
-import BaseService from "@/services/base";
-import { Retrieveable } from "@/types";
-type TranscriptRedactionParams = {
-    transcript_id: string;
-    path: string;
-};
-type TranscriptRedactionResponse = {
-    status: "redacted_audio_ready";
-    redacted_audio_url: string;
-};
-export default class TranscriptRedactionService extends BaseService implements Retrieveable<TranscriptRedactionResponse, TranscriptRedactionParams> {
-    retrieve(params: TranscriptRedactionParams): Promise<TranscriptRedactionResponse>;
-}
-export {};

package/dist/services/transcripts/subtitles.d.ts

@@ -1,12 +0,0 @@
-import BaseService from "@/services/base";
-import { Retrieveable } from "@/types";
-type Subtitle = string;
-type SubtitleFormat = "vtt" | "srt";
-type TranscriptionSubtitleParams = {
-    transcript_id: string;
-    format: SubtitleFormat;
-};
-export default class TranscriptSubtitleService extends BaseService implements Retrieveable<Subtitle, TranscriptionSubtitleParams> {
-    retrieve({ transcript_id, format, }: TranscriptionSubtitleParams): Promise<Subtitle>;
-}
-export {};

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

@@ -1,2 +0,0 @@
-export type * from "./transcript";
-export type * from "./segments";

package/dist/types/core/params.d.ts

@@ -1,2 +0,0 @@
-type WordBoostWeight = "low" | "default" | "high";
-export type { WordBoostWeight };

package/dist/types/core/segments.d.ts

@@ -1,28 +0,0 @@
-type SegmentType = "paragraphs" | "sentences";
-type Segment<T> = T & {
-    id: string;
-    confidence: number;
-    audio_duration: number;
-};
-type ParagraphsBody = Segment<{
-    paragraphs: Utterance[];
-}>;
-type SentencesBody = Segment<{
-    sentences: Utterance[];
-}>;
-type Word = {
-    text: string;
-    start: number;
-    end: number;
-    confidence: number;
-    speaker?: string | null;
-};
-type Utterance = {
-    start: number;
-    end: number;
-    confidence: number;
-    speaker?: string;
-    text: string;
-    words: Word[];
-};
-export type { Word, Utterance, ParagraphsBody, SentencesBody, SegmentType };

package/dist/types/core/transcript.d.ts

@@ -1,113 +0,0 @@
-import { AutoChapter, AutoHighlights, ContentSafetyLabels, Entity, PIIAudioQuality, PIIRedactionPolicies, SentimentAnalysis, SummaryModel, SummaryType, TopicDetection } from "@/types/models";
-import { PageDetails } from "@/types/shared";
-import { Utterance, Word } from "./segments";
-import { WordBoostWeight } from "./params";
-type TranscriptStatus = "queued" | "processing" | "completed" | "error";
-type TranscriptBase = {
-    status?: TranscriptStatus | null;
-    audio_url: string;
-    audio_start_from?: number | null;
-    audio_end_at?: number | null;
-    filter_profanity?: boolean;
-    custom_spelling?: null;
-    disfluencies?: boolean;
-    dual_channel?: boolean | null;
-    punctuate?: boolean;
-    speaker_labels?: boolean;
-    format_text?: boolean;
-    auto_chapters?: boolean;
-    content_safety?: boolean;
-    entity_detection?: boolean;
-    language_code?: string;
-    language_detection?: boolean;
-    iab_categories?: boolean;
-    auto_highlights?: boolean;
-    summarization?: boolean;
-    summary_type?: SummaryType;
-    summary_model?: SummaryModel;
-    redact_pii?: boolean;
-    redact_pii_sub?: string;
-    redact_pii_audio_quality?: PIIAudioQuality;
-    redact_pii_audio?: boolean;
-    redact_pii_policies?: PIIRedactionPolicies[];
-    sentiment_analysis?: boolean;
-    webhook_auth_header_name?: null;
-    webhook_auth?: boolean;
-    webhook_status_code?: null | number;
-    webhook_url?: null | string;
-    word_boost?: string[];
-    boost_param?: WordBoostWeight;
-};
-type TranscriptParams = Omit<TranscriptBase, "status">;
-type TranscriptQueued = TranscriptBase & {
-    id: string;
-    status: "queued";
-};
-type TranscriptProcessing = TranscriptBase & {
-    id: string;
-    status: "processing";
-};
-type TranscriptCompleted = TranscriptBase & {
-    status: "completed";
-    id: string;
-    audio_duration?: number;
-    words?: Word[];
-    utterances?: Utterance[];
-    text?: string;
-    confidence?: number;
-    chapters?: AutoChapter[] | null;
-    content_safety_labels?: ContentSafetyLabels;
-    entities?: Entity[];
-    iab_categories_result?: TopicDetection;
-    auto_highlights_result?: AutoHighlights;
-    summary?: string;
-    sentiment_analysis_results?: SentimentAnalysis[];
-    /**
-     * @deprecated Acoustic Model is deprecated and will be removed in a future release
-     */
-    acoustic_model?: unknown;
-    /**
-     * @deprecated Speed Boost is deprecated and will be removed in a future release
-     */
-    speed_boost?: boolean;
-    /**
-     * @deprecated Language Model is deprecated and will be removed in a future release
-     */
-    language_model?: unknown;
-};
-type TranscriptFailed = TranscriptBase & {
-    status: "error";
-    id: string;
-    error?: string;
-};
-type Transcript = Readonly<TranscriptQueued> | Readonly<TranscriptProcessing> | Readonly<TranscriptCompleted> | Readonly<TranscriptFailed>;
-type TranscriptPollingSettings = {
-    pollingInterval: number;
-    pollingTimeout: number;
-    resolver?: (transcript: Transcript) => boolean;
-};
-type TranscriptListInternal = {
-    page_details: PageDetails;
-    transcripts: TranscriptListItemInternal[];
-};
-type TranscriptListItemInternal = {
-    id: string;
-    resource_url: string;
-    status: TranscriptStatus;
-    created: string;
-    completed: string;
-    audio_url: string;
-};
-type TranscriptList = {
-    page_details: PageDetails;
-    transcripts: TranscriptListItem[];
-};
-type TranscriptListItem = {
-    id: string;
-    resource_url: string;
-    status: TranscriptStatus;
-    created: Date;
-    completed: Date;
-    audio_url: string;
-};
-export type { Transcript, TranscriptStatus, TranscriptParams, TranscriptList, TranscriptListItem, TranscriptListInternal, TranscriptListItemInternal, TranscriptPollingSettings, };

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

@@ -1,79 +0,0 @@
-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

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

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

@@ -1,11 +0,0 @@
-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

@@ -1,25 +0,0 @@
-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

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

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

@@ -1,8 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

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

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

@@ -1,3 +0,0 @@
-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

@@ -1,17 +0,0 @@
-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/shared/index.d.ts

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

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

@@ -1,7 +0,0 @@
-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

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

package/src/services/transcripts/redactions.ts

@@ -1,27 +0,0 @@
-import BaseService from "@/services/base";
-import { Retrieveable } from "@/types";
-
-type TranscriptRedactionParams = {
-  transcript_id: string;
-  path: string;
-};
-
-type TranscriptRedactionResponse = {
-  status: "redacted_audio_ready";
-  redacted_audio_url: string;
-};
-
-export default class TranscriptRedactionService
-  extends BaseService
-  implements
-    Retrieveable<TranscriptRedactionResponse, TranscriptRedactionParams>
-{
-  async retrieve(
-    params: TranscriptRedactionParams
-  ): Promise<TranscriptRedactionResponse> {
-    const { data } = await this.client.get<TranscriptRedactionResponse>(
-      `/v2/transcript/${params.transcript_id}/redacted-audio`
-    );
-    return data;
-  }
-}