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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True)

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

transcriber class-attribute instance-attribute

transcriber: Optional[str] = dataclass_field(default=None, kw_only=True)

The transcriber.

TranscriptionInput dataclass

TranscriptionInput(notification_config: Dict[str, Any], *, source_config: Optional[Dict[str, Any]] = None, metadata: Optional[str] = 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] = dataclass_field(default=None, kw_only=True)

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True)

The delete after seconds.

transcriber class-attribute instance-attribute

transcriber: Optional[str] = dataclass_field(default=None, kw_only=True)

The transcriber.

verbatim class-attribute instance-attribute

verbatim: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether verbatim.

rush class-attribute instance-attribute

rush: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether to rush.

test_mode class-attribute instance-attribute

test_mode: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether test mode.

skip_diarization class-attribute instance-attribute

skip_diarization: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether to skip diarization.

skip_postprocessing class-attribute instance-attribute

skip_postprocessing: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether to skip postprocessing.

skip_punctuation class-attribute instance-attribute

skip_punctuation: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether to skip punctuations.

remove_disfluencies class-attribute instance-attribute

remove_disfluencies: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether to remove disfluencies.

remove_atmospherics class-attribute instance-attribute

remove_atmospherics: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether to remove atmospherics.

filter_profanity class-attribute instance-attribute

filter_profanity: Optional[bool] = dataclass_field(default=None, kw_only=True)

Whether to filter profanity.

speaker_channels_count class-attribute instance-attribute

speaker_channels_count: Optional[int] = dataclass_field(default=None, kw_only=True)

The speaker channels count.

speakers_count class-attribute instance-attribute

speakers_count: Optional[int] = dataclass_field(default=None, kw_only=True)

The speakers count.

custom_vocabulary_id class-attribute instance-attribute

custom_vocabulary_id: Optional[str] = dataclass_field(default=None, kw_only=True)

The custom vocabulary identifier.

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True)

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

transcriber class-attribute instance-attribute

transcriber: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The email address.

free_balance class-attribute instance-attribute

free_balance: Optional[float] = dataclass_field(default=None, kw_only=True)

The free balance.

purchased_balance class-attribute instance-attribute

purchased_balance: Optional[float] = dataclass_field(default=None, kw_only=True)

The purchased balance.

total_balance class-attribute instance-attribute

total_balance: Optional[int] = dataclass_field(default=None, kw_only=True)

The total balance.

invoiced_balance class-attribute instance-attribute

invoiced_balance: Optional[float] = dataclass_field(default=None, kw_only=True)

The invoiced balance.

balance_seconds class-attribute instance-attribute

balance_seconds: Optional[int] = dataclass_field(default=None, kw_only=True)

The balance seconds.

hipaa_enabled class-attribute instance-attribute

hipaa_enabled: Optional[bool] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The language.

metadata class-attribute instance-attribute

metadata: Optional[str] = dataclass_field(default=None, kw_only=True)

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True)

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True)

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The language.

metadata class-attribute instance-attribute

metadata: Optional[str] = dataclass_field(default=None, kw_only=True)

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True)

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = dataclass_field(default=None, kw_only=True)

The callback URL address.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True)

The language.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

callback_url class-attribute instance-attribute

callback_url: Optional[str] = dataclass_field(default=None, kw_only=True)

The callback URL address.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The metadata.

delete_after_seconds class-attribute instance-attribute

delete_after_seconds: Optional[int] = dataclass_field(default=None, kw_only=True)

The delete after seconds.

transcript_text class-attribute instance-attribute

transcript_text: Optional[str] = dataclass_field(default=None, kw_only=True)

The transcript text.

language class-attribute instance-attribute

language: Optional[str] = dataclass_field(default=None, kw_only=True)

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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, 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] = dataclass_field(default=None, kw_only=True)

The identifier.

status class-attribute instance-attribute

status: Optional[str] = dataclass_field(default=None, kw_only=True)

The status.

created_on class-attribute instance-attribute

created_on: Optional[str] = dataclass_field(default=None, kw_only=True)

When created on.

type_ class-attribute instance-attribute

type_: Optional[str] = dataclass_field(default=None, kw_only=True, 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, credential: AsyncTokenCredential | AzureKeyCredential, *, max_retry_attempts: int = 3, timeout: float = 30.0, use_exponential_backoff: bool = True, initial_retry_delay_seconds: float = 0.5, maximum_retry_delay_seconds: float = 120.0, retry_jitter_factor: float = 0.1, retry_unsafe_http_methods: bool = False, transport: Optional[AsyncHttpTransport] = None, **kwargs: Any)

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
credential	AsyncTokenCredential | AzureKeyCredential	Caller-owned Azure Core credential.	required
max_retry_attempts	int	The maximum number of request attempts.	3
timeout	float	The network timeout in seconds for each request. The value configures Azure Core retry and transport deadlines. Nonpositive values disable SDK and transport deadlines.	30.0
use_exponential_backoff	bool	Whether retries use exponential backoff.	True
initial_retry_delay_seconds	float	The initial retry delay in seconds.	0.5
maximum_retry_delay_seconds	float	The maximum retry delay in seconds.	120.0
retry_jitter_factor	float	The jitter fraction applied to retry delays.	0.1
retry_unsafe_http_methods	bool	Whether unsafe HTTP methods may be retried.	False
transport	Optional[AsyncHttpTransport]	Optional Azure Core async HTTP transport closed by the client through its asynchronous lifecycle.	None
**kwargs	Any	Optional Azure Core pipeline policy settings.	{}

Methods:

transcription_get async

transcription_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get transcription job

Returns information about a transcription job.

Swagger operation ID: TranscriptionGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

transcription_delete async

transcription_delete(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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).

Swagger operation ID: TranscriptionDelete.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_transcriptions_get

list_transcriptions_get(*, limit: Optional[int] = None, starting_after: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get transcription job list

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

Returns a single-page Azure Core async collection.

Swagger operation ID: TranscriptionsGet.

Parameters:

Name	Type	Description	Default
limit	Optional[int]	The limit.	None
starting_after	Optional[str]	The starting after.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

transcription async

transcription(input: TranscriptionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Submit transcription job

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

Swagger operation ID: TranscriptionPost.

Parameters:

Name	Type	Description	Default
input	TranscriptionInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_transcript_get

list_transcript_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get transcript

Returns the transcript for a completed transcription job.

Returns a single-page Azure Core async collection.

Swagger operation ID: TranscriptGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

captions_get async

captions_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get captions

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

Swagger operation ID: CaptionsGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

account_get async

account_get(*, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get account

Get the developer's account information.

Swagger operation ID: AccountGet.

Parameters:

Name	Type	Description	Default
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_vocabularies_get

list_vocabularies_get(*, limit: Optional[int] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get list of vocabularies

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

Returns a single-page Azure Core async collection.

Swagger operation ID: VocabulariesGet.

Parameters:

Name	Type	Description	Default
limit	Optional[int]	The limit.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

vocabulary async

vocabulary(input: VocabularyInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Submit custom vocabulary

Submits a Custom Vocabulary for asynchronous processing.

Swagger operation ID: VocabularyPost.

Parameters:

Name	Type	Description	Default
input	VocabularyInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

vocabulary_get async

vocabulary_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get vocabulary

Retrieve a custom vocabulary processing information.

Swagger operation ID: VocabularyGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

vocabulary_delete async

vocabulary_delete(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> 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.

Swagger operation ID: VocabularyDelete.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_extractions_get

list_extractions_get(*, limit: Optional[int] = None, starting_after: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get topic extraction jobs

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

Returns a single-page Azure Core async collection.

Swagger operation ID: ExtractionsGet.

Parameters:

Name	Type	Description	Default
limit	Optional[int]	The limit.	None
starting_after	Optional[str]	The starting after.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

extraction async

extraction(input: ExtractionInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Submit topic extraction job

Starts an asynchronous job to extract topics from a transcript.

Swagger operation ID: ExtractionPost.

Parameters:

Name	Type	Description	Default
input	ExtractionInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

extraction_get async

extraction_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get topic extraction job

Returns information about a topic extraction job.

Swagger operation ID: ExtractionGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

extraction_delete async

extraction_delete(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete topic extraction jo

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

Swagger operation ID: ExtractionDelete.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_extraction_result_get

list_extraction_result_get(id: str, *, threshold: Optional[float] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get topic extraction result

Returns the results for a completed topic extraction job.

Returns a single-page Azure Core async collection.

Swagger operation ID: ExtractionResultGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
threshold	Optional[float]	The threshold.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

analysises_get async

analysises_get(*, limit: Optional[int] = None, starting_after: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> None

Get sentiment analysis jobs

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

Swagger operation ID: AnalysisesGet.

Parameters:

Name	Type	Description	Default
limit	Optional[int]	The limit.	None
starting_after	Optional[str]	The starting after.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Name	Type	Description
None	None	The operation completes without a response body.

Raises:

Type	Description
ConnectorException	If the connector request fails.

analysis async

analysis(input: AnalysisInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Submit sentiment analysis job

Starts an asynchronous job to analyze sentiments in a transcript.

Swagger operation ID: AnalysisPost.

Parameters:

Name	Type	Description	Default
input	AnalysisInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

analysis_get async

analysis_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get sentiment analysis job

Returns information about a sentiment analysis job.

Swagger operation ID: AnalysisGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

analysis_delete async

analysis_delete(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete sentiment analysis job

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

Swagger operation ID: AnalysisDelete.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_analysis_result_get

list_analysis_result_get(id: str, *, filter_for: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get sentiment analysis result

Returns the results for a completed sentiment analysis job.

Returns a single-page Azure Core async collection.

Swagger operation ID: AnalysisResultGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
filter_for	Optional[str]	The filter for.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_identifications_get

list_identifications_get(*, limit: Optional[int] = None, starting_after: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get language identification jobs

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

Returns a single-page Azure Core async collection.

Swagger operation ID: IdentificationsGet.

Parameters:

Name	Type	Description	Default
limit	Optional[int]	The limit.	None
starting_after	Optional[str]	The starting after.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

identification async

identification(input: IdentificationInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Submit language identification job

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

Swagger operation ID: IdentificationPost.

Parameters:

Name	Type	Description	Default
input	IdentificationInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

identification_get async

identification_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get language identification job

Returns information about a language identification job.

Swagger operation ID: IdentificationGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

identification_delete async

identification_delete(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete language identification job

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

Swagger operation ID: IdentificationDelete.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

identification_result_get async

identification_result_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get language identification result

Returns the results for a completed language identification job.

Swagger operation ID: IdentificationResultGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_alignments_get

list_alignments_get(*, limit: Optional[int] = None, starting_after: Optional[str] = None, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get forced alignment jobs

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

Returns a single-page Azure Core async collection.

Swagger operation ID: AlignmentsGet.

Parameters:

Name	Type	Description	Default
limit	Optional[int]	The limit.	None
starting_after	Optional[str]	The starting after.	None
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.

alignment async

alignment(input: AlignmentInput | Mapping[str, Any], *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Submit forced alignment job

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

Swagger operation ID: AlignmentPost.

Parameters:

Name	Type	Description	Default
input	AlignmentInput | Mapping[str, Any]	The request body. Mapping keys use serialized Swagger wire names.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

alignment_get async

alignment_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Get forced alignment job

Returns information about a forced alignment job.

Swagger operation ID: AlignmentGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

alignment_delete async

alignment_delete(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> dict[str, Any] | None

Delete forced alignment job

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

Swagger operation ID: AlignmentDelete.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
dict[str, Any] | None	dict[str, Any] | None: The connector operation result.

Raises:

Type	Description
ConnectorException	If the connector request fails.

list_alignment_transcript_get

list_alignment_transcript_get(id: str, *, timeout: Optional[float] = None, headers: Optional[Mapping[str, str]] = None, client_request_id: Optional[str] = None, response_hook: Optional[ConnectorResponseHook] = None) -> AsyncItemPaged[dict[str, Any]]

Get forced alignment transcript

Returns the results for a completed forced alignment job.

Returns a single-page Azure Core async collection.

Swagger operation ID: AlignmentTranscriptGet.

Parameters:

Name	Type	Description	Default
id	str	The identifier.	required
timeout	Optional[float]	The request timeout in seconds.	None
headers	Optional[Mapping[str, str]]	Additional HTTP request headers.	None
client_request_id	Optional[str]	A caller-provided request identifier.	None
response_hook	Optional[ConnectorResponseHook]	A callback invoked with the connector response.	None

Returns:

Type	Description
AsyncItemPaged[dict[str, Any]]	AsyncItemPaged[dict[str, Any]]: An Azure Core pager over connector results. Consume it with async for.

Raises:

Type	Description
ConnectorException	If the connector request fails.