assemblyai 4.3.0 → 4.3.2

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

@@ -1,86 +1,86 @@
 import { BaseService } from "../base";
-import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, TranscriptParams, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse, ListTranscriptParams, WordSearchResponse, BaseServiceParams, PollingOptions, TranscribeParams, TranscribeOptions, SubmitParams } from "../..";
+import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, TranscriptParams, CreateTranscriptOptions, SubtitleFormat, RedactedAudioResponse, ListTranscriptParams, WordSearchResponse, BaseServiceParams, PollingOptions, TranscribeParams, TranscribeOptions, SubmitParams } from "../..";
 import { FileService } from "../files";
-export declare class TranscriptService extends BaseService implements Createable<Transcript, TranscriptParams, CreateTranscriptOptions>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
+export declare class TranscriptService extends BaseService {
     private files;
     constructor(params: BaseServiceParams, files: FileService);
     /**
      * Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".
-     * @param params The parameters to transcribe an audio file.
-     * @param options The options to transcribe an audio file.
+     * @param params - The parameters to transcribe an audio file.
+     * @param options - The options to transcribe an audio file.
      * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
     transcribe(params: TranscribeParams, options?: TranscribeOptions): Promise<Transcript>;
     /**
      * Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".
-     * @param params The parameters to start the transcription of an audio file.
+     * @param params - The parameters to start the transcription of an audio file.
      * @returns A promise that resolves to the queued transcript.
      */
     submit(params: SubmitParams): Promise<Transcript>;
     /**
      * Create a transcript.
-     * @param params The parameters to create a transcript.
-     * @param options The options used for creating the new 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 transcript.
      * @deprecated Use `transcribe` instead to transcribe a audio file that includes polling, or `submit` to transcribe a audio file without polling.
      */
     create(params: TranscriptParams, options?: CreateTranscriptOptions): Promise<Transcript>;
     /**
      * Wait until the transcript ready, either the status is "completed" or "error".
-     * @param transcriptId The ID of the transcript.
-     * @param options The options to wait until the transcript is ready.
+     * @param transcriptId - The ID of the transcript.
+     * @param options - The options to wait until the transcript is ready.
      * @returns A promise that resolves to the transcript. The transcript status is "completed" or "error".
      */
     waitUntilReady(transcriptId: string, options?: PollingOptions): Promise<Transcript>;
     /**
      * Retrieve a transcript.
-     * @param id The identifier of the transcript.
+     * @param id - The identifier of the transcript.
      * @returns A promise that resolves to the transcript.
      */
     get(id: string): Promise<Transcript>;
     /**
      * Retrieves a page of transcript listings.
-     * @param parameters The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
+     * @param params - The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.
      */
-    list(parameters?: ListTranscriptParams | string): Promise<TranscriptList>;
+    list(params?: ListTranscriptParams | string): Promise<TranscriptList>;
     /**
      * Delete a transcript
-     * @param id The identifier of the transcript.
+     * @param id - The identifier of the transcript.
      * @returns A promise that resolves to the transcript.
      */
     delete(id: string): Promise<Transcript>;
     /**
      * Search through the transcript for a specific set of keywords.
      * You can search for individual words, numbers, or phrases containing up to five words or numbers.
-     * @param id The identifier of the transcript.
-     * @param words Keywords to search for.
-     * @return A promise that resolves to the sentences.
+     * @param id - The identifier of the transcript.
+     * @param words - Keywords to search for.
+     * @returns A promise that resolves to the sentences.
      */
     wordSearch(id: string, words: string[]): Promise<WordSearchResponse>;
     /**
      * Retrieve all sentences of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the sentences.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the sentences.
      */
     sentences(id: string): Promise<SentencesResponse>;
     /**
      * Retrieve all paragraphs of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the paragraphs.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the paragraphs.
      */
     paragraphs(id: string): Promise<ParagraphsResponse>;
     /**
      * Retrieve subtitles of a transcript.
-     * @param id The identifier of the transcript.
-     * @param format The format of the subtitles.
-     * @param chars_per_caption The maximum number of characters per caption.
-     * @return A promise that resolves to the subtitles text.
+     * @param id - The identifier of the transcript.
+     * @param format - The format of the subtitles.
+     * @param chars_per_caption - The maximum number of characters per caption.
+     * @returns A promise that resolves to the subtitles text.
      */
     subtitles(id: string, format?: SubtitleFormat, chars_per_caption?: number): Promise<string>;
     /**
      * Retrieve redactions of a transcript.
-     * @param id The identifier of the transcript.
-     * @return A promise that resolves to the subtitles text.
+     * @param id - The identifier of the transcript.
+     * @returns A promise that resolves to the subtitles text.
      */
     redactions(id: string): Promise<RedactedAudioResponse>;
 }

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

@@ -1,64 +1,80 @@
 /**
- * Format: binary
- * @description Binary audio data
+ * Binary audio data
  */
 export type AudioData = ArrayBufferLike;
 /**
- * @description The encoding of the audio data
- * @default pcm_s16le
- * @enum {string}
+ * The encoding of the audio data
+ * @defaultValue "pcm_s16"le
  */
 export type AudioEncoding = "pcm_s16le" | "pcm_mulaw";
-/** @description Configure the threshold for how long to wait before ending an utterance. Default is 700ms. */
+/**
+ * Configure the threshold for how long to wait before ending an utterance. Default is 700ms.
+ */
 export type ConfigureEndUtteranceSilenceThreshold = {
-    /** @description The duration threshold in milliseconds */
+    /**
+     * The duration threshold in milliseconds
+     */
     end_utterance_silence_threshold: number;
 };
 export type FinalTranscript = RealtimeBaseTranscript & {
     /**
-     * @description Describes the type of message
-     * @constant
+     * Describes the type of message
      */
     message_type: "FinalTranscript";
-    /** @description Whether the text is punctuated and cased */
+    /**
+     * Whether the text is punctuated and cased
+     */
     punctuated: boolean;
-    /** @description Whether the text is formatted, for example Dollar -> $ */
+    /**
+     * Whether the text is formatted, for example Dollar -> $
+     */
     text_formatted: boolean;
 };
-/** @description Manually end an utterance */
+/**
+ * Manually end an utterance
+ */
 export type ForceEndUtterance = {
-    /** @description A boolean value to communicate that you wish to force the end of the utterance */
+    /**
+     * A boolean value to communicate that you wish to force the end of the utterance
+     */
     force_end_utterance: boolean;
 };
-/** @enum {string} */
 export type MessageType = "SessionBegins" | "PartialTranscript" | "FinalTranscript" | "SessionTerminated";
 export type PartialTranscript = RealtimeBaseTranscript & {
     /**
-     * @description Describes the type of message
-     * @constant
+     * Describes the type of message
      */
     message_type: "PartialTranscript";
 };
 export type RealtimeBaseMessage = {
-    /** @description Describes the type of the message */
+    /**
+     * Describes the type of the message
+     */
     message_type: MessageType;
 };
 export type RealtimeBaseTranscript = {
-    /** @description End time of audio sample relative to session start, in milliseconds */
+    /**
+     * 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 */
+    /**
+     * 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
+     * The confidence score of the entire transcription, between 0 and 1
      */
     confidence: number;
-    /** @description The timestamp for the partial transcript */
+    /**
+     * The timestamp for the partial transcript
+     */
     created: Date;
-    /** @description The partial transcript for your audio */
+    /**
+     * The partial transcript for your audio
+     */
     text: string;
     /**
-     * @description An array of objects, with the information for each word in the transcription text.
+     * 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[];
@@ -68,43 +84,48 @@ export type RealtimeError = {
 };
 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 */
+    /**
+     * Timestamp when this session will expire
+     */
     expires_at: Date;
     /**
-     * @description Describes the type of the message
-     * @constant
+     * Describes the type of the message
      */
     message_type: "SessionBegins";
     /**
-     * Format: uuid
-     * @description Unique identifier for the established session
+     * Unique identifier for the established session
      */
     session_id: string;
 };
 export type SessionTerminated = RealtimeBaseMessage & {
     /**
-     * @description Describes the type of the message
-     * @constant
+     * Describes the type of the message
      */
     message_type: "SessionTerminated";
 };
-export type TerminateSession = RealtimeBaseMessage & {
-    /** @description Set to true to end your real-time session forever */
+export type TerminateSession = {
+    /**
+     * Set to true to end your real-time session forever
+     */
     terminate_session: boolean;
 };
 export type Word = {
     /**
-     * Format: double
-     * @description Confidence score of the word
+     * Confidence score of the word
      */
     confidence: number;
-    /** @description End time of the word in milliseconds */
+    /**
+     * End time of the word in milliseconds
+     */
     end: number;
-    /** @description Start time of the word in milliseconds */
+    /**
+     * Start time of the word in milliseconds
+     */
     start: number;
-    /** @description The word itself */
+    /**
+     * The word itself
+     */
     text: string;
 };