RevaiClient

Classes

TranscriptionGetResponse dataclass

TranscriptionGetResponse(id: Optional[str] = None, status: Optional[str] = None, language: Optional[str] = None, created_on: Optional[str] = None, transcriber: Optional[str] = None)

Response for Get transcription job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

language class-attribute instance-attribute

language: Optional[str] = None

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

transcriber class-attribute instance-attribute

transcriber: Optional[str] = None

The transcriber.

TranscriptionInput dataclass

TranscriptionInput(source_config: Optional[Dict[str, Any]] = None, metadata: Optional[str] = None, notification_config: Optional[Dict[str, Any]] = None, delete_after_seconds: Optional[int] = None, transcriber: Optional[str] = None, verbatim: Optional[bool] = None, rush: Optional[bool] = None, test_mode: Optional[bool] = None, segments_to_transcribe: Optional[List[Dict[str, Any]]] = None, speakers_names: Optional[List[Dict[str, Any]]] = None, skip_diarization: Optional[bool] = None, skip_postprocessing: Optional[bool] = None, skip_punctuation: Optional[bool] = None, remove_disfluencies: Optional[bool] = None, remove_atmospherics: Optional[bool] = None, filter_profanity: Optional[bool] = None, speaker_channels_count: Optional[int] = None, speakers_count: Optional[int] = None, custom_vocabulary_id: Optional[str] = None, custom_vocabularies: Optional[List[Dict[str, Any]]] = None, language: Optional[str] = None)

Submit transcription job

Attributes

metadata class-attribute instance-attribute

metadata: Optional[str] = None

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = None

The delete after seconds.

transcriber class-attribute instance-attribute

transcriber: Optional[str] = None

The transcriber.

verbatim class-attribute instance-attribute

verbatim: Optional[bool] = None

Whether verbatim.

rush class-attribute instance-attribute

rush: Optional[bool] = None

Whether to rush.

test_mode class-attribute instance-attribute

test_mode: Optional[bool] = None

Whether test mode.

skip_diarization class-attribute instance-attribute

skip_diarization: Optional[bool] = None

Whether to skip diarization.

skip_postprocessing class-attribute instance-attribute

skip_postprocessing: Optional[bool] = None

Whether to skip postprocessing.

skip_punctuation class-attribute instance-attribute

skip_punctuation: Optional[bool] = None

Whether to skip punctuations.

remove_disfluencies class-attribute instance-attribute

remove_disfluencies: Optional[bool] = None

Whether to remove disfluencies.

remove_atmospherics class-attribute instance-attribute

remove_atmospherics: Optional[bool] = None

Whether to remove atmospherics.

filter_profanity class-attribute instance-attribute

filter_profanity: Optional[bool] = None

Whether to filter profanity.

speaker_channels_count class-attribute instance-attribute

speaker_channels_count: Optional[int] = None

The speaker channels count.

speakers_count class-attribute instance-attribute

speakers_count: Optional[int] = None

The speakers count.

custom_vocabulary_id class-attribute instance-attribute

custom_vocabulary_id: Optional[str] = None

The custom vocabulary identifier.

language class-attribute instance-attribute

language: Optional[str] = None

The language.

TranscriptionPostResponse dataclass

TranscriptionPostResponse(id: Optional[str] = None, status: Optional[str] = None, language: Optional[str] = None, created_on: Optional[str] = None, transcriber: Optional[str] = None)

Response for Submit transcription job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

language class-attribute instance-attribute

language: Optional[str] = None

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

transcriber class-attribute instance-attribute

transcriber: Optional[str] = None

The transcriber.

TranscriptGetResponse dataclass

TranscriptGetResponse(monologues: Optional[List[Dict[str, Any]]] = None)

Response for Get transcript

AccountGetResponse dataclass

AccountGetResponse(email: Optional[str] = None, free_balance: Optional[float] = None, purchased_balance: Optional[float] = None, total_balance: Optional[int] = None, invoiced_balance: Optional[float] = None, balance_seconds: Optional[int] = None, hipaa_enabled: Optional[bool] = None)

Response for Get account

Attributes

email class-attribute instance-attribute

email: Optional[str] = None

The email address.

free_balance class-attribute instance-attribute

free_balance: Optional[float] = None

The free balance.

purchased_balance class-attribute instance-attribute

purchased_balance: Optional[float] = None

The purchased balance.

total_balance class-attribute instance-attribute

total_balance: Optional[int] = None

The total balance.

invoiced_balance class-attribute instance-attribute

invoiced_balance: Optional[float] = None

The invoiced balance.

balance_seconds class-attribute instance-attribute

balance_seconds: Optional[int] = None

The balance seconds.

hipaa_enabled class-attribute instance-attribute

hipaa_enabled: Optional[bool] = None

Whether HIPAA is enabled.

VocabularyInput dataclass

VocabularyInput(metadata: Optional[str] = None, notification_config: Optional[Dict[str, Any]] = None, custom_vocabularies: Optional[List[Dict[str, Any]]] = None)

Submit custom vocabulary

Attributes

metadata class-attribute instance-attribute

metadata: Optional[str] = None

The metadata.

VocabularyPostResponse dataclass

VocabularyPostResponse(id: Optional[str] = None, status: Optional[str] = None, created_on: Optional[str] = None, callback_url: Optional[str] = None)

Response for Submit custom vocabulary

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = None

The callback URL address.

VocabularyGetResponse dataclass

VocabularyGetResponse(id: Optional[str] = None, status: Optional[str] = None, created_on: Optional[str] = None, callback_url: Optional[str] = None)

Response for Get vocabulary

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = None

The callback URL address.

ExtractionInput dataclass

ExtractionInput(language: Optional[str] = None, metadata: Optional[str] = None, notification_config: Optional[Dict[str, Any]] = None, delete_after_seconds: Optional[int] = None, json: Optional[Dict[str, Any]] = None)

Submit topic extraction job

Attributes

language class-attribute instance-attribute

language: Optional[str] = None

The language.

metadata class-attribute instance-attribute

metadata: Optional[str] = None

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = None

The delete after seconds.

ExtractionPostResponse dataclass

ExtractionPostResponse(id: Optional[str] = None, status: Optional[str] = None, language: Optional[str] = None, created_on: Optional[str] = None, type_: Optional[str] = None)

Response for Submit topic extraction job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

language class-attribute instance-attribute

language: Optional[str] = None

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type.

ExtractionGetResponse dataclass

ExtractionGetResponse(id: Optional[str] = None, status: Optional[str] = None, language: Optional[str] = None, created_on: Optional[str] = None, type_: Optional[str] = None)

Response for Get topic extraction job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

language class-attribute instance-attribute

language: Optional[str] = None

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type.

ExtractionResultGetResponse dataclass

ExtractionResultGetResponse(topics: Optional[List[Dict[str, Any]]] = None)

Response for Get topic extraction result

AnalysisInput dataclass

AnalysisInput(language: Optional[str] = None, metadata: Optional[str] = None, notification_config: Optional[Dict[str, Any]] = None, delete_after_seconds: Optional[int] = None, json: Optional[Dict[str, Any]] = None)

Submit sentiment analysis job

Attributes

language class-attribute instance-attribute

language: Optional[str] = None

The language.

metadata class-attribute instance-attribute

metadata: Optional[str] = None

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = None

The delete after seconds.

AnalysisPostResponse dataclass

AnalysisPostResponse(id: Optional[str] = None, status: Optional[str] = None, language: Optional[str] = None, created_on: Optional[str] = None, callback_url: Optional[str] = None, type_: Optional[str] = None)

Response for Submit sentiment analysis job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

language class-attribute instance-attribute

language: Optional[str] = None

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = None

The callback URL address.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type.

AnalysisGetResponse dataclass

AnalysisGetResponse(id: Optional[str] = None, status: Optional[str] = None, language: Optional[str] = None, created_on: Optional[str] = None, callback_url: Optional[str] = None, type_: Optional[str] = None)

Response for Get sentiment analysis job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

language class-attribute instance-attribute

language: Optional[str] = None

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = None

The callback URL address.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type.

AnalysisResultGetResponse dataclass

AnalysisResultGetResponse(messages: Optional[List[Dict[str, Any]]] = None)

Response for Get sentiment analysis result

IdentificationInput dataclass

IdentificationInput(metadata: Optional[str] = None, notification_config: Optional[Dict[str, Any]] = None, delete_after_seconds: Optional[int] = None, source_config: Optional[Dict[str, Any]] = None)

Submit language identification job

Attributes

metadata class-attribute instance-attribute

metadata: Optional[str] = None

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = None

The delete after seconds.

IdentificationPostResponse dataclass

IdentificationPostResponse(id: Optional[str] = None, status: Optional[str] = None, created_on: Optional[str] = None, type_: Optional[str] = None)

Response for Submit language identification job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type.

IdentificationGetResponse dataclass

IdentificationGetResponse(id: Optional[str] = None, status: Optional[str] = None, created_on: Optional[str] = None, type_: Optional[str] = None)

Response for Get language identification job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type.

IdentificationResultGetResponse dataclass

IdentificationResultGetResponse(top_language: Optional[str] = None, language_confidences: Optional[List[Dict[str, Any]]] = None)

Response for Get language identification result

Attributes

top_language class-attribute instance-attribute

top_language: Optional[str] = None

The top language.

AlignmentInput dataclass

AlignmentInput(metadata: Optional[str] = None, notification_config: Optional[Dict[str, Any]] = None, delete_after_seconds: Optional[int] = None, source_config: Optional[Dict[str, Any]] = None, transcript_text: Optional[str] = None, language: Optional[str] = None)

Submit forced alignment job

Attributes

metadata class-attribute instance-attribute

metadata: Optional[str] = None

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = None

The delete after seconds.

transcript_text class-attribute instance-attribute

transcript_text: Optional[str] = None

The transcript text.

language class-attribute instance-attribute

language: Optional[str] = None

The language.

AlignmentPostResponse dataclass

AlignmentPostResponse(id: Optional[str] = None, status: Optional[str] = None, created_on: Optional[str] = None, type_: Optional[str] = None)

Response for Submit forced alignment job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type.

AlignmentGetResponse dataclass

AlignmentGetResponse(id: Optional[str] = None, status: Optional[str] = None, created_on: Optional[str] = None, type_: Optional[str] = None)

Response for Get forced alignment job

Attributes

id class-attribute instance-attribute

id: Optional[str] = None

The identifier.

status class-attribute instance-attribute

status: Optional[str] = None

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = None

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = field(default=None, metadata={'wire_name': 'type'})

The type.

AlignmentTranscriptGetResponse dataclass

AlignmentTranscriptGetResponse(monologues: Optional[List[Dict[str, Any]]] = None)

Response for Get forced alignment transcript

RevaiClient

RevaiClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for revai connector.

Initialize a RevaiClient.

Parameters:

Name	Type	Description	Default
connection_runtime_url	str	The connection runtime URL from Azure Portal.	required
token_provider	Optional[TokenProvider]	Optional token provider. Defaults to ManagedIdentityTokenProvider.	None
options	Optional[ConnectorClientOptions]	Optional connector client options.	None

Methods:

transcription_get_async async

transcription_get_async(id: str) -> dict[str, Any] | None

Get transcription job

Returns information about a transcription job.

transcription_delete_async async

transcription_delete_async(id: str) -> dict[str, Any] | None

Delete transcription job

Deletes a transcription job. All data related to the job, such as input media and transcript, will be permanently deleted. A job can only be deleted once it's completed (either with success or failure).

transcriptions_get_async async

transcriptions_get_async(limit: Optional[int] = None, starting_after: Optional[str] = None) -> dict[str, Any] | None

Get transcription job list

Retrieve a list of transcription jobs submitted within the last 30 days.

transcription_async async

transcription_async(input: TranscriptionInput) -> dict[str, Any] | None

Submit transcription job

Starts an asynchronous job to transcribe speech-to-text for a media file.

transcript_get_async async

transcript_get_async(id: str) -> dict[str, Any] | None

Get transcript

Returns the transcript for a completed transcription job.

captions_get_async async

captions_get_async(id: str) -> dict[str, Any] | None

Get captions

Returns the caption output for a transcription job. We currently support the SubRip (SRT) format.

account_get_async async

account_get_async() -> dict[str, Any] | None

Get account

Get the developer's account information.

vocabularies_get_async async

vocabularies_get_async(limit: Optional[int] = None) -> dict[str, Any] | None

Get list of vocabularies

Retrieves a list of most recent custom vocabularies' processing information.

vocabulary_async async

vocabulary_async(input: VocabularyInput) -> dict[str, Any] | None

Submit custom vocabulary

Submits a Custom Vocabulary for asynchronous processing.

vocabulary_get_async async

vocabulary_get_async(id: str) -> dict[str, Any] | None

Get vocabulary

Retrieve a custom vocabulary processing information.

vocabulary_delete_async async

vocabulary_delete_async(id: str) -> dict[str, Any] | None

Delete vocabulary

Deletes a custom vocabulary. All data related to the custom vocabulary, such as webhooks and metadata, will be permanently deleted.

extractions_get_async async

extractions_get_async(limit: Optional[int] = None, starting_after: Optional[str] = None) -> dict[str, Any] | None

Get topic extraction jobs

Retrieves a list of topic extraction jobs submitted within the last 30 days in reverse chronological order.

extraction_async async

extraction_async(input: ExtractionInput) -> dict[str, Any] | None

Submit topic extraction job

Starts an asynchronous job to extract topics from a transcript.

extraction_get_async async

extraction_get_async(id: str) -> dict[str, Any] | None

Get topic extraction job

Returns information about a topic extraction job.

extraction_delete_async async

extraction_delete_async(id: str) -> dict[str, Any] | None

Delete topic extraction jo

Deletes a topic extraction job. All data related to the job will be permanently deleted.

extraction_result_get_async async

extraction_result_get_async(id: str, threshold: Optional[float] = None) -> dict[str, Any] | None

Get topic extraction result

Returns the results for a completed topic extraction job.

analysises_get_async async

analysises_get_async(limit: Optional[int] = None, starting_after: Optional[str] = None) -> None

Get sentiment analysis jobs

Gets a list of sentiment analysis jobs submitted within the last 30 days in reverse chronological order.

analysis_async async

analysis_async(input: AnalysisInput) -> dict[str, Any] | None

Submit sentiment analysis job

Starts an asynchronous job to analyze sentiments in a transcript.

analysis_get_async async

analysis_get_async(id: str) -> dict[str, Any] | None

Get sentiment analysis job

Returns information about a sentiment analysis job.

analysis_delete_async async

analysis_delete_async(id: str) -> dict[str, Any] | None

Delete sentiment analysis job

Deletes a sentiment analysis job. All data related to the job will be permanently deleted.

analysis_result_get_async async

analysis_result_get_async(id: str, filter_for: Optional[str] = None) -> dict[str, Any] | None

Get sentiment analysis result

Returns the results for a completed sentiment analysis job.

identifications_get_async async

identifications_get_async(limit: Optional[int] = None, starting_after: Optional[str] = None) -> dict[str, Any] | None

Get language identification jobs

Retrieves a list of language identification jobs submitted within the last 30 days in reverse chronological order.

identification_async async

identification_async(input: IdentificationInput) -> dict[str, Any] | None

Submit language identification job

Starts an asynchronous job to identify the most probable language in the audio.

identification_get_async async

identification_get_async(id: str) -> dict[str, Any] | None

Get language identification job

Returns information about a language identification job.

identification_delete_async async

identification_delete_async(id: str) -> dict[str, Any] | None

Delete language identification job

Deletes a language identification job. All data related to the job will be permanently deleted.

identification_result_get_async async

identification_result_get_async(id: str) -> dict[str, Any] | None

Get language identification result

Returns the results for a completed language identification job.

alignments_get_async async

alignments_get_async(limit: Optional[int] = None, starting_after: Optional[str] = None) -> dict[str, Any] | None

Get forced alignment jobs

Retrieve a list of alignment jobs submitted within the last 30 days in reverse chronological order.

alignment_async async

alignment_async(input: AlignmentInput) -> dict[str, Any] | None

Submit forced alignment job

Starts an asynchronous job to obtain precise word timings for an audio file and text transcript.

alignment_get_async async

alignment_get_async(id: str) -> dict[str, Any] | None

Get forced alignment job

Returns information about a forced alignment job.

alignment_delete_async async

alignment_delete_async(id: str) -> dict[str, Any] | None

Delete forced alignment job

Deletes a forced alignment job. All data related to the job will be permanently deleted.

alignment_transcript_get_async async

alignment_transcript_get_async(id: str) -> dict[str, Any] | None

Get forced alignment transcript

Returns the results for a completed forced alignment job.