assemblyai 1.0.1 → 2.0.1-beta

package/dist/types/asyncapi.generated.d.ts

@@ -0,0 +1,87 @@
+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/dist/types/index.d.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";