assemblyai 2.0.0-beta → 2.0.1

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

@@ -1,42 +1,59 @@
 import BaseService from "@/services/base";
-import TranscriptSubtitleService from "./subtitles";
-import { ParagraphsBody, SentencesBody, Transcript, TranscriptList, TranscriptParams, TranscriptPollingSettings, Createable, Deletable, Listable, Retrieveable } from "@/types";
-import TranscriptRedactionService from "./redactions";
+import { ParagraphsResponse, SentencesResponse, Transcript, TranscriptList, CreateTranscriptParameters, CreateTranscriptOptions, Createable, Deletable, Listable, Retrieveable, SubtitleFormat, RedactedAudioResponse } from "@/types";
 import { AxiosInstance } from "axios";
 import FileService from "../files";
-export default class TranscriptService extends BaseService implements Createable<Transcript, TranscriptParams, TranscriptPollingSettings>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
+export default class TranscriptService extends BaseService implements Createable<Transcript, CreateTranscriptParameters, CreateTranscriptOptions>, Retrieveable<Transcript>, Deletable<Transcript>, Listable<TranscriptList> {
     private files;
+    constructor(client: AxiosInstance, files: FileService);
     /**
-     * The subtitles service.
+     * Create a 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 newly created transcript.
      */
-    subtitles: TranscriptSubtitleService;
+    create(params: CreateTranscriptParameters, options?: CreateTranscriptOptions): Promise<Transcript>;
+    private poll;
     /**
-     * The redactions service.
+     * Retrieve a transcript.
+     * @param id The identifier of the transcript.
+     * @returns A promise that resolves to the transcript.
      */
-    redactions: TranscriptRedactionService;
-    constructor(client: AxiosInstance, files: FileService);
-    create(params: TranscriptParams, settings?: TranscriptPollingSettings | null): Promise<Transcript>;
-    private poll;
-    retrieve(id: string): Promise<Transcript>;
-    list(nextUrl?: string): Promise<TranscriptList>;
-    delete(id: string): Promise<Transcript>;
+    get(id: string): Promise<Transcript>;
+    /**
+     * Retrieves a paged list of transcript listings.
+     * @param nextUrl The URL to retrieve the transcript list from. If not provided, the first page will be retrieved.
+     * @returns
+     */
+    list(nextUrl?: string | null): Promise<TranscriptList>;
     /**
-     * Retrieve all segments of a transcript.
+     * Delete a transcript
      * @param id The identifier of the transcript.
-     * @param type The type of segment to retrieve.
-     * @return A promise that resolves to the retrieved resource.
+     * @returns A promise that resolves to the transcript.
      */
-    private segments;
+    delete(id: string): Promise<Transcript>;
     /**
      * Retrieve all sentences of a transcript.
      * @param id The identifier of the transcript.
      * @return A promise that resolves to the sentences.
      */
-    sentences(id: string): Promise<SentencesBody>;
+    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.
      */
-    paragraphs(id: string): Promise<ParagraphsBody>;
+    paragraphs(id: string): Promise<ParagraphsResponse>;
+    /**
+     * Retrieve subtitles of a transcript.
+     * @param id The identifier of the transcript.
+     * @param format The format of the subtitles.
+     * @return A promise that resolves to the subtitles text.
+     */
+    subtitles(id: string, format?: SubtitleFormat): Promise<string>;
+    /**
+     * Retrieve redactions of a transcript.
+     * @param id The identifier of the transcript.
+     * @return A promise that resolves to the subtitles text.
+     */
+    redactions(id: string): Promise<RedactedAudioResponse>;
 }

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

@@ -1,6 +1,5 @@
-export type * from "./core";
-export type * from "./lemur";
-export type * from "./models";
+export type * from "./transcripts";
 export type * from "./realtime";
 export type * from "./services";
-export type * from "./shared";
+export type * from "./asyncapi.generated";
+export type * from "./openapi.generated";