Class TranscriptService

Hierarchy

BaseService
- TranscriptService

Index

Constructors

Methods

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

Constructors

constructor

new TranscriptService(params, files): TranscriptService
Parameters
- params: BaseServiceParams
- files: FileService
Returns TranscriptService
Overrides BaseService.constructor
- Defined in services/transcripts/index.ts:24

Methods

create

create(params, options?): Promise<Transcript>
Create a transcript.
Parameters
- params: TranscriptParams
  The parameters to create a transcript.
- Optionaloptions: CreateTranscriptOptions
  The options used for creating the new transcript.
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.
- Defined in services/transcripts/index.ts:91

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.
- Defined in services/transcripts/index.ts:183

`Protected`fetch

fetch(input, init?): Promise<Response>
Parameters
- input: string
- Optionalinit: RequestInit
Returns Promise<Response>
Inherited from BaseService.fetch
- Defined in services/base.ts:22

`Protected`fetchJson

fetchJson<T>(input, init?): Promise<T>
Type Parameters
- T
Parameters
- input: string
- Optionalinit: RequestInit
Returns Promise<T>
Inherited from BaseService.fetchJson
- Defined in services/base.ts:69

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.
- Defined in services/transcripts/index.ts:147

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>
- Defined in services/transcripts/index.ts:155

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.
- Defined in services/transcripts/index.ts:215

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.
- Defined in services/transcripts/index.ts:258

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.
- Defined in services/transcripts/index.ts:269

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.
- Defined in services/transcripts/index.ts:249

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.
- Defined in services/transcripts/index.ts:206

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.
- Defined in services/transcripts/index.ts:50

subtitles

subtitles(id, format?, chars_per_caption?): Promise<string>
Retrieve subtitles of a transcript.
Parameters
- id: string
  The identifier of the transcript.
- format: SubtitleFormat = "srt"
  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.
- Defined in services/transcripts/index.ts:228

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
- params: TranscribeParams
  The parameters to transcribe an audio file.
- Optionaloptions: PollingOptions
  The options to transcribe an audio file.
Returns Promise<Transcript>
A promise that resolves to the transcript. The transcript status is "completed" or "error".
- Defined in services/transcripts/index.ts:37

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".
- Defined in services/transcripts/index.ts:119

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.
- Defined in services/transcripts/index.ts:194

Class TranscriptService

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TranscriptService

Methods

create

Parameters

Returns Promise<Transcript>

Deprecated

delete

Parameters

Returns Promise<Transcript>

Protectedfetch

Parameters

Returns Promise<Response>

ProtectedfetchJson

Type Parameters

Parameters

Returns Promise<T>

get

Parameters

Returns Promise<Transcript>

list

Parameters

Returns Promise<TranscriptList>

paragraphs

Parameters

Returns Promise<ParagraphsResponse>

redactedAudio

Parameters

Returns Promise<RedactedAudioResponse>

redactedAudioFile

Parameters

Returns Promise<RedactedAudioFile>

redactions

Parameters

Returns Promise<RedactedAudioResponse>

Deprecated

sentences

Parameters

Returns Promise<SentencesResponse>

submit

Parameters

Returns Promise<Transcript>

subtitles

Parameters

Returns Promise<string>

transcribe

Parameters

Returns Promise<Transcript>

waitUntilReady

Parameters

Returns Promise<Transcript>

wordSearch

Parameters

Returns Promise<WordSearchResponse>

Settings

On This Page

`Protected`fetch

`Protected`fetchJson