Package com.assemblyai.api.resources.transcripts

Class TranscriptsClient

java.lang.Object

com.assemblyai.api.resources.transcripts.TranscriptsClient

Direct Known Subclasses:

PollingTranscriptsClient

public class TranscriptsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
TranscriptsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Transcript	delete(java.lang.String transcriptId)	Delete the transcript
Transcript	delete(java.lang.String transcriptId, RequestOptions requestOptions)	Delete the transcript
Transcript	get(java.lang.String transcriptId)	Get the transcript resource.
Transcript	get(java.lang.String transcriptId, RequestOptions requestOptions)	Get the transcript resource.
ParagraphsResponse	getParagraphs(java.lang.String transcriptId)	Get the transcript split by paragraphs.
ParagraphsResponse	getParagraphs(java.lang.String transcriptId, RequestOptions requestOptions)	Get the transcript split by paragraphs.
RedactedAudioResponse	getRedactedAudio(java.lang.String transcriptId)	Retrieve the redacted audio object containing the status and URL to the redacted audio.
RedactedAudioResponse	getRedactedAudio(java.lang.String transcriptId, RequestOptions requestOptions)	Retrieve the redacted audio object containing the status and URL to the redacted audio.
SentencesResponse	getSentences(java.lang.String transcriptId)	Get the transcript split by sentences.
SentencesResponse	getSentences(java.lang.String transcriptId, RequestOptions requestOptions)	Get the transcript split by sentences.
java.lang.String	getSubtitles(java.lang.String transcriptId, SubtitleFormat subtitleFormat)	Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.
java.lang.String	getSubtitles(java.lang.String transcriptId, SubtitleFormat subtitleFormat, GetSubtitlesParams request)	Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.
java.lang.String	getSubtitles(java.lang.String transcriptId, SubtitleFormat subtitleFormat, GetSubtitlesParams request, RequestOptions requestOptions)	Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.
TranscriptList	list()	Retrieve a list of transcripts you created.
TranscriptList	list(ListTranscriptParams request)	Retrieve a list of transcripts you created.
TranscriptList	list(ListTranscriptParams request, RequestOptions requestOptions)	Retrieve a list of transcripts you created.
Transcript	submit(TranscriptParams request)	Create a transcript from an audio or video file that is accessible via a URL.
Transcript	submit(TranscriptParams request, RequestOptions requestOptions)	Create a transcript from an audio or video file that is accessible via a URL.
WordSearchResponse	wordSearch(java.lang.String transcriptId)	Search through the transcript for a specific set of keywords.
WordSearchResponse	wordSearch(java.lang.String transcriptId, WordSearchParams request)	Search through the transcript for a specific set of keywords.
WordSearchResponse	wordSearch(java.lang.String transcriptId, WordSearchParams request, RequestOptions requestOptions)	Search through the transcript for a specific set of keywords.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

TranscriptsClient

public TranscriptsClient(ClientOptions clientOptions)

Method Detail

list

public TranscriptList list()

Retrieve a list of transcripts you created. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.

list

public TranscriptList list(ListTranscriptParams request)

Retrieve a list of transcripts you created. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.

list

public TranscriptList list(ListTranscriptParams request,
                           RequestOptions requestOptions)

Retrieve a list of transcripts you created. Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.

submit

public Transcript submit(TranscriptParams request)

Create a transcript from an audio or video file that is accessible via a URL.

submit

public Transcript submit(TranscriptParams request,
                         RequestOptions requestOptions)

Create a transcript from an audio or video file that is accessible via a URL.

get

public Transcript get(java.lang.String transcriptId)

Get the transcript resource. The transcript is ready when the "status" is "completed".

get

public Transcript get(java.lang.String transcriptId,
                      RequestOptions requestOptions)

Get the transcript resource. The transcript is ready when the "status" is "completed".

delete

public Transcript delete(java.lang.String transcriptId)

Delete the transcript

delete

public Transcript delete(java.lang.String transcriptId,
                         RequestOptions requestOptions)

Delete the transcript

getSubtitles

public java.lang.String getSubtitles(java.lang.String transcriptId,
                                     SubtitleFormat subtitleFormat)

Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.

getSubtitles

public java.lang.String getSubtitles(java.lang.String transcriptId,
                                     SubtitleFormat subtitleFormat,
                                     GetSubtitlesParams request)

Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.

getSubtitles

public java.lang.String getSubtitles(java.lang.String transcriptId,
                                     SubtitleFormat subtitleFormat,
                                     GetSubtitlesParams request,
                                     RequestOptions requestOptions)

Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.

getSentences

public SentencesResponse getSentences(java.lang.String transcriptId)

Get the transcript split by sentences. The API will attempt to semantically segment the transcript into sentences to create more reader-friendly transcripts.

getSentences

public SentencesResponse getSentences(java.lang.String transcriptId,
                                      RequestOptions requestOptions)

Get the transcript split by sentences. The API will attempt to semantically segment the transcript into sentences to create more reader-friendly transcripts.

getParagraphs

public ParagraphsResponse getParagraphs(java.lang.String transcriptId)

Get the transcript split by paragraphs. The API will attempt to semantically segment your transcript into paragraphs to create more reader-friendly transcripts.

getParagraphs

public ParagraphsResponse getParagraphs(java.lang.String transcriptId,
                                        RequestOptions requestOptions)

Get the transcript split by paragraphs. The API will attempt to semantically segment your transcript into paragraphs to create more reader-friendly transcripts.

wordSearch

public WordSearchResponse wordSearch(java.lang.String transcriptId)

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.

wordSearch

public WordSearchResponse wordSearch(java.lang.String transcriptId,
                                     WordSearchParams request)

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.

wordSearch

public WordSearchResponse wordSearch(java.lang.String transcriptId,
                                     WordSearchParams request,
                                     RequestOptions requestOptions)

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.

getRedactedAudio

public RedactedAudioResponse getRedactedAudio(java.lang.String transcriptId)

Retrieve the redacted audio object containing the status and URL to the redacted audio.

getRedactedAudio

public RedactedAudioResponse getRedactedAudio(java.lang.String transcriptId,
                                              RequestOptions requestOptions)

Retrieve the redacted audio object containing the status and URL to the redacted audio.