# This file was auto-generated by Fern from our API Definition. import json import typing from json.decoder import JSONDecodeError from .. import core from ..core.api_error import ApiError from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ..core.http_response import AsyncHttpResponse, HttpResponse from ..core.jsonable_encoder import jsonable_encoder from ..core.pydantic_utilities import parse_obj_as from ..core.request_options import RequestOptions from ..core.serialization import convert_and_respect_annotation_metadata from ..errors.unprocessable_entity_error import UnprocessableEntityError from ..types.http_validation_error import HttpValidationError from ..types.languages import Languages from ..types.orchestrator_pipeline_call_result import OrchestratorPipelineCallResult from ..types.orchestrator_pipeline_result import OrchestratorPipelineResult from ..types.subtitle_formatting_options import SubtitleFormattingOptions from ..types.transcript_data_type import TranscriptDataType from ..types.transcript_export_result import TranscriptExportResult from ..types.transcript_file_format import TranscriptFileFormat from ..types.transcription_result import TranscriptionResult # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class RawTranscriptionClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper def create_transcription( self, *, language: Languages, run_id: typing.Optional[int] = None, media_file: typing.Optional[core.File] = OMIT, media_url: typing.Optional[str] = OMIT, file: typing.Optional[core.File] = OMIT, audio_url: typing.Optional[str] = OMIT, project_name: typing.Optional[str] = OMIT, project_description: typing.Optional[str] = OMIT, folder_id: typing.Optional[int] = OMIT, transcription_mode: typing.Optional[typing.Literal["fast", "slow"]] = "fast", formatting_options: typing.Optional[typing.Union[SubtitleFormattingOptions, typing.Dict[str, typing.Any]]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[OrchestratorPipelineCallResult]: """ Parameters ---------- language : Languages Signed URL to audio file for transcription run_id : typing.Optional[int] media_file : typing.Optional[core.File] See core.File for more documentation media_url : typing.Optional[str] Signed URL to media file for transcription file : typing.Optional[core.File] See core.File for more documentation audio_url : typing.Optional[str] [DEPRECATED] Use 'media_url' instead project_name : typing.Optional[str] project_description : typing.Optional[str] folder_id : typing.Optional[int] transcription_mode : typing.Optional[typing.Literal["fast", "slow"]] Transcription mode: `fast` (default) or `slow`. formatting_options : typing.Optional[typing.Union[SubtitleFormattingOptions, typing.Dict[str, typing.Any]]] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[OrchestratorPipelineCallResult] Successful Response """ _response = self._client_wrapper.httpx_client.request( "transcribe", method="POST", params={ "run_id": run_id, }, data={ "language": language, "media_url": media_url, "audio_url": audio_url, "project_name": project_name, "project_description": project_description, "folder_id": folder_id, "transcription_mode": transcription_mode, "formatting_options": _serialize_formatting_options(formatting_options), }, files={ **({"media_file": media_file} if media_file is not None else {}), **({"file": file} if file is not None else {}), }, request_options=request_options, omit=OMIT, force_multipart=True, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( OrchestratorPipelineCallResult, parse_obj_as( type_=OrchestratorPipelineCallResult, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, parse_obj_as( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def get_transcription_task_status( self, task_id: str, *, run_id: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[OrchestratorPipelineResult]: """ Parameters ---------- task_id : str run_id : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[OrchestratorPipelineResult] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"transcribe/{jsonable_encoder(task_id)}", method="GET", params={ "run_id": run_id, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( OrchestratorPipelineResult, parse_obj_as( type_=OrchestratorPipelineResult, # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, parse_obj_as( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def get_transcription_result( self, run_id: typing.Optional[int], *, word_level_timestamps: typing.Optional[bool] = None, format_type: typing.Optional[TranscriptFileFormat] = None, data_type: typing.Optional[TranscriptDataType] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[typing.Union[TranscriptionResult, TranscriptExportResult]]: """ NOTE: This endpoint should be called only by the users to get values for their runs via API. Further we need to validate if the user has access to the run_id, otherwise we should not return the output urls. Parameters ---------- run_id : typing.Optional[int] word_level_timestamps : typing.Optional[bool] format_type : typing.Optional[TranscriptFileFormat] data_type : typing.Optional[TranscriptDataType] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[typing.Union[TranscriptionResult, TranscriptExportResult]] Successful Response """ _response = self._client_wrapper.httpx_client.request( f"transcription-result/{jsonable_encoder(run_id)}", method="GET", params={ "word_level_timestamps": word_level_timestamps, "format_type": format_type, "data_type": data_type, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( typing.Union[TranscriptionResult, TranscriptExportResult], parse_obj_as( type_=typing.Union[TranscriptionResult, TranscriptExportResult], # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, parse_obj_as( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def get_transcription_results( self, *, run_ids: typing.Sequence[int], run_id: typing.Optional[int] = None, traceparent: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> HttpResponse[typing.Dict[str, TranscriptionResult]]: """ Parameters ---------- run_ids : typing.Sequence[int] run_id : typing.Optional[int] traceparent : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- HttpResponse[typing.Dict[str, TranscriptionResult]] Successful Response """ _response = self._client_wrapper.httpx_client.request( "transcription-results", method="POST", params={ "run_id": run_id, }, json={ "run_ids": run_ids, }, headers={ "content-type": "application/json", "traceparent": str(traceparent) if traceparent is not None else None, }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( typing.Dict[str, TranscriptionResult], parse_obj_as( type_=typing.Dict[str, TranscriptionResult], # type: ignore object_=_response.json(), ), ) return HttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, parse_obj_as( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) class AsyncRawTranscriptionClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper async def create_transcription( self, *, language: Languages, run_id: typing.Optional[int] = None, media_file: typing.Optional[core.File] = OMIT, media_url: typing.Optional[str] = OMIT, file: typing.Optional[core.File] = OMIT, audio_url: typing.Optional[str] = OMIT, project_name: typing.Optional[str] = OMIT, project_description: typing.Optional[str] = OMIT, folder_id: typing.Optional[int] = OMIT, transcription_mode: typing.Optional[typing.Literal["fast", "slow"]] = "fast", formatting_options: typing.Optional[typing.Union[SubtitleFormattingOptions, typing.Dict[str, typing.Any]]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[OrchestratorPipelineCallResult]: """ Parameters ---------- language : Languages Signed URL to audio file for transcription run_id : typing.Optional[int] media_file : typing.Optional[core.File] See core.File for more documentation media_url : typing.Optional[str] Signed URL to media file for transcription file : typing.Optional[core.File] See core.File for more documentation audio_url : typing.Optional[str] [DEPRECATED] Use 'media_url' instead project_name : typing.Optional[str] project_description : typing.Optional[str] folder_id : typing.Optional[int] transcription_mode : typing.Optional[typing.Literal["fast", "slow"]] Transcription mode: `fast` (default) or `slow`. formatting_options : typing.Optional[typing.Union[SubtitleFormattingOptions, typing.Dict[str, typing.Any]]] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[OrchestratorPipelineCallResult] Successful Response """ _response = await self._client_wrapper.httpx_client.request( "transcribe", method="POST", params={ "run_id": run_id, }, data={ "language": language, "media_url": media_url, "audio_url": audio_url, "project_name": project_name, "project_description": project_description, "folder_id": folder_id, "transcription_mode": transcription_mode, "formatting_options": _serialize_formatting_options(formatting_options), }, files={ **({"media_file": media_file} if media_file is not None else {}), **({"file": file} if file is not None else {}), }, request_options=request_options, omit=OMIT, force_multipart=True, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( OrchestratorPipelineCallResult, parse_obj_as( type_=OrchestratorPipelineCallResult, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, parse_obj_as( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def get_transcription_task_status( self, task_id: str, *, run_id: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[OrchestratorPipelineResult]: """ Parameters ---------- task_id : str run_id : typing.Optional[int] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[OrchestratorPipelineResult] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"transcribe/{jsonable_encoder(task_id)}", method="GET", params={ "run_id": run_id, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( OrchestratorPipelineResult, parse_obj_as( type_=OrchestratorPipelineResult, # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, parse_obj_as( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def get_transcription_result( self, run_id: typing.Optional[int], *, word_level_timestamps: typing.Optional[bool] = None, format_type: typing.Optional[TranscriptFileFormat] = None, data_type: typing.Optional[TranscriptDataType] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[typing.Union[TranscriptionResult, TranscriptExportResult]]: """ NOTE: This endpoint should be called only by the users to get values for their runs via API. Further we need to validate if the user has access to the run_id, otherwise we should not return the output urls. Parameters ---------- run_id : typing.Optional[int] word_level_timestamps : typing.Optional[bool] format_type : typing.Optional[TranscriptFileFormat] data_type : typing.Optional[TranscriptDataType] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[typing.Union[TranscriptionResult, TranscriptExportResult]] Successful Response """ _response = await self._client_wrapper.httpx_client.request( f"transcription-result/{jsonable_encoder(run_id)}", method="GET", params={ "word_level_timestamps": word_level_timestamps, "format_type": format_type, "data_type": data_type, }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( typing.Union[TranscriptionResult, TranscriptExportResult], parse_obj_as( type_=typing.Union[TranscriptionResult, TranscriptExportResult], # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, parse_obj_as( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) async def get_transcription_results( self, *, run_ids: typing.Sequence[int], run_id: typing.Optional[int] = None, traceparent: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> AsyncHttpResponse[typing.Dict[str, TranscriptionResult]]: """ Parameters ---------- run_ids : typing.Sequence[int] run_id : typing.Optional[int] traceparent : typing.Optional[str] request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- AsyncHttpResponse[typing.Dict[str, TranscriptionResult]] Successful Response """ _response = await self._client_wrapper.httpx_client.request( "transcription-results", method="POST", params={ "run_id": run_id, }, json={ "run_ids": run_ids, }, headers={ "content-type": "application/json", "traceparent": str(traceparent) if traceparent is not None else None, }, request_options=request_options, omit=OMIT, ) try: if 200 <= _response.status_code < 300: _data = typing.cast( typing.Dict[str, TranscriptionResult], parse_obj_as( type_=typing.Dict[str, TranscriptionResult], # type: ignore object_=_response.json(), ), ) return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 422: raise UnprocessableEntityError( headers=dict(_response.headers), body=typing.cast( HttpValidationError, parse_obj_as( type_=HttpValidationError, # type: ignore object_=_response.json(), ), ), ) _response_json = _response.json() except JSONDecodeError: raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) def _serialize_formatting_options( formatting_options: typing.Optional[typing.Union[SubtitleFormattingOptions, typing.Dict[str, typing.Any]]], ) -> typing.Any: if formatting_options is OMIT or formatting_options is None: return formatting_options return json.dumps( jsonable_encoder( convert_and_respect_annotation_metadata( object_=formatting_options, annotation=SubtitleFormattingOptions, direction="write" ) ) )