assemblyai 4.12.1 → 4.13.0-beta.1

package/src/types/streaming/index.ts

@@ -0,0 +1,94 @@
+export type StreamingTranscriberParams = {
+  websocketBaseUrl?: string;
+  apiKey?: string;
+  token?: string;
+  sampleRate: number;
+
+  wordFinalizationMaxWaitTime?: number;
+  endOfTurnConfidenceThreshold?: number;
+  minEndOfTurnSilenceWhenConfident?: number;
+  maxTurnSilence?: number;
+  formattedFinals?: boolean;
+};
+
+export type StreamingEvents = "open" | "close" | "turn" | "error";
+
+export type StreamingListeners = {
+  open?: (event: BeginEvent) => void;
+  close?: (code: number, reason: string) => void;
+  turn?: (event: TurnEvent) => void;
+  error?: (error: Error) => void;
+};
+
+export type StreamingTokenParams = {
+  expires_in_seconds: number;
+  max_session_duration_seconds: number;
+};
+
+export type StreamingTemporaryTokenResponse = {
+  token: string;
+};
+
+export type StreamingAudioData = ArrayBufferLike;
+
+export type BeginEvent = {
+  type: "Begin";
+  id: string;
+  expires_at: number;
+};
+
+export type TurnEvent = {
+  type: "Turn";
+  turn_order: number;
+  turn_is_formatted: boolean;
+  end_of_turn: boolean;
+  transcript: string;
+  end_of_turn_confidence: number;
+  words: StreamingWord[];
+};
+
+export type StreamingWord = {
+  start: number;
+  end: number;
+  confidence: number;
+  text: string;
+  word_is_final: boolean;
+};
+
+export type TerminationEvent = {
+  type: "Termination";
+  audio_duration_seconds: number;
+  session_duration_seconds: number;
+};
+
+export type StreamingTerminateSession = {
+  type: "Terminate";
+};
+
+export type StreamingUpdateConfiguration = {
+  type: "UpdateConfiguration";
+  word_finalization_max_wait_time?: number;
+  end_of_turn_confidence_threshold?: number;
+  min_end_of_turn_silence_when_confident?: number;
+  max_turn_silence?: number;
+  formatted_finals?: boolean;
+};
+
+export type StreamingForceEndpoint = {
+  type: "ForceEndpoint";
+};
+
+export type ErrorEvent = {
+  error: string;
+};
+
+export type StreamingEventMessage =
+  | BeginEvent
+  | TurnEvent
+  | TerminationEvent
+  | ErrorEvent;
+
+export type StreamingOperationMessage =
+  | StreamingUpdateConfiguration
+  | StreamingForceEndpoint
+  | StreamingTerminateSession;

package/src/utils/errors/index.ts

@@ -3,3 +3,9 @@ export {
   RealtimeErrorType,
   RealtimeErrorMessages,
 } from "./realtime";
+
+export {
+  StreamingError,
+  StreamingErrorType,
+  StreamingErrorMessages,
+} from "./streaming";

package/src/utils/errors/streaming.ts

@@ -0,0 +1,51 @@
+const StreamingErrorType = {
+  BadSampleRate: 4000,
+  AuthFailed: 4001,
+  InsufficientFunds: 4002,
+  FreeTierUser: 4003,
+  NonexistentSessionId: 4004,
+  SessionExpired: 4008,
+  ClosedSession: 4010,
+  RateLimited: 4029,
+  UniqueSessionViolation: 4030,
+  SessionTimeout: 4031,
+  AudioTooShort: 4032,
+  AudioTooLong: 4033,
+  AudioTooSmallToTranscode: 4034,
+  BadSchema: 4101,
+  TooManyStreams: 4102,
+  Reconnected: 4103,
+} as const;
+
+type StreamingErrorTypeCodes =
+  (typeof StreamingErrorType)[keyof typeof StreamingErrorType];
+
+const StreamingErrorMessages: Record<StreamingErrorTypeCodes, string> = {
+  [StreamingErrorType.BadSampleRate]: "Sample rate must be a positive integer",
+  [StreamingErrorType.AuthFailed]: "Not Authorized",
+  [StreamingErrorType.InsufficientFunds]: "Insufficient funds",
+  [StreamingErrorType.FreeTierUser]:
+    "This feature is paid-only and requires you to add a credit card. Please visit https://app.assemblyai.com/ to add a credit card to your account.",
+  [StreamingErrorType.NonexistentSessionId]: "Session ID does not exist",
+  [StreamingErrorType.SessionExpired]: "Session has expired",
+  [StreamingErrorType.ClosedSession]: "Session is closed",
+  [StreamingErrorType.RateLimited]: "Rate limited",
+  [StreamingErrorType.UniqueSessionViolation]: "Unique session violation",
+  [StreamingErrorType.SessionTimeout]: "Session Timeout",
+  [StreamingErrorType.AudioTooShort]: "Audio too short",
+  [StreamingErrorType.AudioTooLong]: "Audio too long",
+  [StreamingErrorType.AudioTooSmallToTranscode]: "Audio too small to transcode",
+  [StreamingErrorType.BadSchema]: "Bad schema",
+  [StreamingErrorType.TooManyStreams]: "Too many streams",
+  [StreamingErrorType.Reconnected]:
+    "This session has been reconnected. This WebSocket is no longer valid.",
+};
+
+class StreamingError extends Error {}
+
+export {
+  StreamingError,
+  StreamingErrorType,
+  StreamingErrorTypeCodes,
+  StreamingErrorMessages,
+};