Class TranscriptService

Hierarchy

  • BaseService
    • TranscriptService

Constructors

constructor

Methods

create delete get list paragraphs redactedAudio redactedAudioFile redactions sentences submit subtitles transcribe waitUntilReady wordSearch fetch fetchJson

Constructors

constructor

Methods

create

  • create(params, options?): Promise<Transcript>

  • Create a transcript.

    Parameters

    Returns Promise<Transcript>

    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.

delete

  • delete(id): Promise<Transcript>

  • Delete a transcript

    Parameters

    • id: string

      The identifier of the transcript.

    Returns Promise<Transcript>

    A promise that resolves to the transcript.

get

  • get(id): Promise<Transcript>

  • Retrieve a transcript.

    Parameters

    • id: string

      The identifier of the transcript.

    Returns Promise<Transcript>

    A promise that resolves to the transcript.

list

  • list(params?): Promise<TranscriptList>

  • Retrieves a page of transcript listings.

    Parameters

    • Optionalparams: string | ListTranscriptParams

      The parameters to filter the transcript list by, or the URL to retrieve the transcript list from.

    Returns Promise<TranscriptList>

paragraphs

  • paragraphs(id): Promise<ParagraphsResponse>

  • Retrieve all paragraphs of a transcript.

    Parameters

    • id: string

      The identifier of the transcript.

    Returns Promise<ParagraphsResponse>

    A promise that resolves to the paragraphs.

redactedAudio

  • redactedAudio(id): Promise<RedactedAudioResponse>

  • Retrieve the redacted audio URL of a transcript.

    Parameters

    • id: string

      The identifier of the transcript.

    Returns Promise<RedactedAudioResponse>

    A promise that resolves to the details of the redacted audio.

redactedAudioFile

  • redactedAudioFile(id): Promise<RedactedAudioFile>

  • Retrieve the redacted audio file of a transcript.

    Parameters

    • id: string

      The identifier of the transcript.

    Returns Promise<RedactedAudioFile>

    A promise that resolves to the fetch HTTP response of the redacted audio file.

redactions

  • redactions(id): Promise<RedactedAudioResponse>

  • Retrieve the redacted audio URL of a transcript.

    Parameters

    • id: string

      The identifier of the transcript.

    Returns Promise<RedactedAudioResponse>

    A promise that resolves to the details of the redacted audio.

    Deprecated

    Use redactedAudio instead.

sentences

  • sentences(id): Promise<SentencesResponse>

  • Retrieve all sentences of a transcript.

    Parameters

    • id: string

      The identifier of the transcript.

    Returns Promise<SentencesResponse>

    A promise that resolves to the sentences.

submit

  • submit(params): Promise<Transcript>

  • Submits a transcription job for an audio file. This will not wait until the transcript status is "completed" or "error".

    Parameters

    • params: TranscribeParams

      The parameters to start the transcription of an audio file.

    Returns Promise<Transcript>

    A promise that resolves to the queued transcript.

subtitles

  • subtitles(id, format?, chars_per_caption?): Promise<string>

  • Retrieve subtitles of a transcript.

    Parameters

    • id: string

      The identifier of the transcript.

    • Optionalformat: SubtitleFormat

      The format of the subtitles.

    • Optionalchars_per_caption: number

      The maximum number of characters per caption.

    Returns Promise<string>

    A promise that resolves to the subtitles text.

transcribe

  • transcribe(params, options?): Promise<Transcript>

  • Transcribe an audio file. This will create a transcript and wait until the transcript status is "completed" or "error".

    Parameters

    Returns Promise<Transcript>

    A promise that resolves to the transcript. The transcript status is "completed" or "error".

waitUntilReady

  • waitUntilReady(transcriptId, options?): Promise<Transcript>

  • Wait until the transcript ready, either the status is "completed" or "error".

    Parameters

    • transcriptId: string

      The ID of the transcript.

    • Optionaloptions: PollingOptions

      The options to wait until the transcript is ready.

    Returns Promise<Transcript>

    A promise that resolves to the transcript. The transcript status is "completed" or "error".

wordSearch

  • wordSearch(id, words): Promise<WordSearchResponse>

  • 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.

    Parameters

    • id: string

      The identifier of the transcript.

    • words: string[]

      Keywords to search for.

    Returns Promise<WordSearchResponse>

    A promise that resolves to the sentences.

Protectedfetch

  • fetch(input, init?): Promise<Response>

  • Parameters

    • input: string
    • Optionalinit: RequestInit

    Returns Promise<Response>

ProtectedfetchJson

  • fetchJson<T>(input, init?): Promise<T>

  • Type Parameters

    • T

    Parameters

    • input: string
    • Optionalinit: RequestInit

    Returns Promise<T>

Settings

Member Visibility

On This Page

Constructors
Methods