assemblyai 3.0.1 → 3.1.1

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

@@ -1,46 +1,49 @@
 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. */
+    /** @description Base64 encoded raw audio data */
     audio_data: string;
 };
 export type FinalTranscript = RealtimeBaseTranscript & {
     /**
-     * @description Describes the type of message.
+     * @description Describes the type of message
      * @constant
      */
     message_type: "FinalTranscript";
-    /** @description Whether the text has been punctuated and cased. */
+    /** @description Whether the text is punctuated and cased */
     punctuated: boolean;
-    /** @description Whether the text has been formatted (e.g. Dollar -> $) */
+    /** @description Whether the text is formatted, for example Dollar -> $ */
     text_formatted: boolean;
 };
 /** @enum {string} */
 export type MessageType = "SessionBegins" | "PartialTranscript" | "FinalTranscript" | "SessionTerminated";
 export type PartialTranscript = RealtimeBaseTranscript & {
     /**
-     * @description Describes the type of message.
+     * @description Describes the type of message
      * @constant
      */
     message_type: "PartialTranscript";
 };
 export type RealtimeBaseMessage = {
-    /** @description Describes the type of the message. */
+    /** @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. */
+    /** @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. */
+    /** @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.
+     * @description The confidence score of the entire transcription, between 0 and 1
      */
     confidence: number;
-    /** @description The timestamp for the partial transcript. */
+    /** @description The timestamp for the partial transcript */
     created: Date;
-    /** @description The partial transcript for your audio. */
+    /** @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). */
+    /**
+     * @description An array of objects, with the information for each word in the transcription text.
+     * Includes the start and end time of the word in milliseconds, the confidence score of the word, and the text, which is the word itself.
+     */
     words: Word[];
 };
 export type RealtimeError = {
@@ -51,25 +54,25 @@ export type RealtimeTranscript = PartialTranscript | FinalTranscript;
 /** @enum {string} */
 export type RealtimeTranscriptType = "PartialTranscript" | "FinalTranscript";
 export type SessionBegins = RealtimeBaseMessage & {
-    /** @description Timestamp when this session will expire. */
+    /** @description Timestamp when this session will expire */
     expires_at: Date;
     /**
-     * @description Describes the type of the message.
+     * @description Describes the type of the message
      * @constant
      */
     message_type: "SessionBegins";
-    /** @description Unique identifier for the established session. */
+    /** @description Unique identifier for the established session */
     session_id: string;
 };
 export type SessionTerminated = RealtimeBaseMessage & {
     /**
-     * @description Describes the type of the message.
+     * @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. */
+    /** @description Set to true to end your real-time session forever */
     terminate_session: boolean;
 };
 export type Word = {

package/dist/types/deprecated.d.ts

@@ -0,0 +1,63 @@
+import { FileUploadParams } from "./files";
+import { CreateRealtimeTemporaryTokenParams, LemurActionItemsParams, LemurBaseParams, LemurQuestionAnswerParams, LemurSummaryParams, LemurTaskParams, ListTranscriptParams, TranscriptOptionalParams, TranscriptParams } from "./openapi.generated";
+import { SubmitParams, TranscribeParams } from "./transcripts";
+/**
+ * @deprecated
+ * Use`FileUploadParams` instead.
+ */
+export type FileUploadParameters = FileUploadParams;
+/**
+ * @deprecated
+ * Use`TranscribeParams` instead.
+ */
+export type TranscribeParameters = TranscribeParams;
+/**
+ * @deprecated
+ * Use`SubmitParams` instead.
+ */
+export type SubmitParameters = SubmitParams;
+/**
+ * @deprecated
+ * Use`CreateRealtimeTemporaryTokenParams` instead.
+ */
+export type CreateRealtimeTemporaryTokenParameters = CreateRealtimeTemporaryTokenParams;
+/**
+ * @deprecated
+ * Use`LemurActionItemsParams` instead.
+ */
+export type LemurActionItemsParameters = LemurActionItemsParams;
+/**
+ * @deprecated
+ * Use`LemurBaseParams` instead.
+ */
+export type LemurBaseParameters = LemurBaseParams;
+/**
+ * @deprecated
+ * Use`LemurQuestionAnswerParams` instead.
+ */
+export type LemurQuestionAnswerParameters = LemurQuestionAnswerParams;
+/**
+ * @deprecated
+ * Use`LemurSummaryParams` instead.
+ */
+export type LemurSummaryParameters = LemurSummaryParams;
+/**
+ * @deprecated
+ * Use`LemurTaskParams` instead.
+ */
+export type LemurTaskParameters = LemurTaskParams;
+/**
+ * @deprecated
+ * Use`ListTranscriptParams` instead.
+ */
+export type TranscriptListParameters = ListTranscriptParams;
+/**
+ * @deprecated
+ * Use`TranscriptOptionalParams` instead.
+ */
+export type CreateTranscriptOptionalParameters = TranscriptOptionalParams;
+/**
+ * @deprecated
+ * Use`TranscriptParams` instead.
+ */
+export type CreateTranscriptParameters = TranscriptParams;

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

@@ -1,4 +1,4 @@
 /// <reference types="node" />
-type FileUploadParameters = string | FileUploadData;
+type FileUploadParams = string | FileUploadData;
 type FileUploadData = NodeJS.ReadableStream | ReadableStream | Blob | BufferSource | ArrayBufferView | ArrayBufferLike | Uint8Array;
-export type { FileUploadParameters, FileUploadData };
+export type { FileUploadParams, FileUploadData };

package/dist/types/index.d.ts

@@ -1,6 +1,7 @@
-export type * from "./files";
-export type * from "./transcripts";
-export type * from "./realtime";
-export type * from "./services";
-export type * from "./asyncapi.generated";
-export type * from "./openapi.generated";
+export * from "./files";
+export * from "./transcripts";
+export * from "./realtime";
+export * from "./services";
+export * from "./asyncapi.generated";
+export * from "./openapi.generated";
+export * from "./deprecated";