wavix-python-sdk 1.0.0__py3-none-any.whl

wavix/speech_analytics/raw_client.py

@@ -0,0 +1,527 @@
+# This file was auto-generated by Fern from our API Definition.
+
+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 encode_path_param
+from ..core.parse_error import ParsingError
+from ..core.pydantic_utilities import parse_obj_as
+from ..core.request_options import RequestOptions
+from ..errors.bad_request_error import BadRequestError
+from ..errors.not_found_error import NotFoundError
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.success_response import SuccessResponse
+from .types.create_speech_analytics_response import CreateSpeechAnalyticsResponse
+from .types.get_speech_analytics_response import GetSpeechAnalyticsResponse
+from pydantic import ValidationError
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class RawSpeechAnalyticsClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create(
+        self,
+        *,
+        file: core.File,
+        callback_url: str,
+        insights: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[CreateSpeechAnalyticsResponse]:
+        """
+        Uploads an audio file for transcription. Transcription is asynchronous; Wavix sends a POST callback to `callback_url` when it completes, including the `request_id` returned by this request.
+
+        Callback body:
+        ```json
+           {
+                "request_id": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
+                "status": "completed",
+                "error": null
+           }
+        ```
+
+        - `request_id`: ID of the transcription request.
+        - `status`: One of `completed` (transcription succeeded) or `failed` (transcription encountered an error).
+        - `error`: Error description, or `null` when the transcription succeeded.
+
+        Parameters
+        ----------
+        file : core.File
+            See core.File for more documentation
+
+        callback_url : str
+            URL that receives the POST callback when transcription completes.
+
+        insights : typing.Optional[bool]
+            When `true`, generates conversation insights alongside the transcript.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[CreateSpeechAnalyticsResponse]
+            Returns the transcription `request_id` for the uploaded file.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "v1/speech-analytics",
+            method="POST",
+            data={
+                "callback_url": callback_url,
+                "insights": insights,
+            },
+            files={
+                "file": file,
+            },
+            request_options=request_options,
+            omit=OMIT,
+            force_multipart=True,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateSpeechAnalyticsResponse,
+                    parse_obj_as(
+                        type_=CreateSpeechAnalyticsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def get(
+        self, request_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[GetSpeechAnalyticsResponse]:
+        """
+        Returns the transcription for the request identified by `request_id`, including transcript, speaker turns, and insights when available.
+
+        Parameters
+        ----------
+        request_id : str
+            The `request_id` of the transcription, returned when the file was uploaded.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[GetSpeechAnalyticsResponse]
+            Returns the completed transcription.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/speech-analytics/{encode_path_param(request_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetSpeechAnalyticsResponse,
+                    parse_obj_as(
+                        type_=GetSpeechAnalyticsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    def retranscribe(
+        self,
+        request_id: str,
+        *,
+        callback_url: str,
+        insights: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> HttpResponse[SuccessResponse]:
+        """
+        Re-runs transcription on the file identified by `request_id`, replacing the existing transcript.
+
+        Parameters
+        ----------
+        request_id : str
+            The `request_id` of the transcription, returned when the file was uploaded.
+
+        callback_url : str
+            Callback URL for transcription status updates.
+
+        insights : typing.Optional[bool]
+            Indicates whether to enable insights generation.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[SuccessResponse]
+            Returns a success confirmation. Retranscription is queued.
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            f"v1/speech-analytics/{encode_path_param(request_id)}",
+            method="PUT",
+            json={
+                "callback_url": callback_url,
+                "insights": insights,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SuccessResponse,
+                    parse_obj_as(
+                        type_=SuccessResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawSpeechAnalyticsClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create(
+        self,
+        *,
+        file: core.File,
+        callback_url: str,
+        insights: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[CreateSpeechAnalyticsResponse]:
+        """
+        Uploads an audio file for transcription. Transcription is asynchronous; Wavix sends a POST callback to `callback_url` when it completes, including the `request_id` returned by this request.
+
+        Callback body:
+        ```json
+           {
+                "request_id": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
+                "status": "completed",
+                "error": null
+           }
+        ```
+
+        - `request_id`: ID of the transcription request.
+        - `status`: One of `completed` (transcription succeeded) or `failed` (transcription encountered an error).
+        - `error`: Error description, or `null` when the transcription succeeded.
+
+        Parameters
+        ----------
+        file : core.File
+            See core.File for more documentation
+
+        callback_url : str
+            URL that receives the POST callback when transcription completes.
+
+        insights : typing.Optional[bool]
+            When `true`, generates conversation insights alongside the transcript.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[CreateSpeechAnalyticsResponse]
+            Returns the transcription `request_id` for the uploaded file.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "v1/speech-analytics",
+            method="POST",
+            data={
+                "callback_url": callback_url,
+                "insights": insights,
+            },
+            files={
+                "file": file,
+            },
+            request_options=request_options,
+            omit=OMIT,
+            force_multipart=True,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateSpeechAnalyticsResponse,
+                    parse_obj_as(
+                        type_=CreateSpeechAnalyticsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def get(
+        self, request_id: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[GetSpeechAnalyticsResponse]:
+        """
+        Returns the transcription for the request identified by `request_id`, including transcript, speaker turns, and insights when available.
+
+        Parameters
+        ----------
+        request_id : str
+            The `request_id` of the transcription, returned when the file was uploaded.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[GetSpeechAnalyticsResponse]
+            Returns the completed transcription.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/speech-analytics/{encode_path_param(request_id)}",
+            method="GET",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    GetSpeechAnalyticsResponse,
+                    parse_obj_as(
+                        type_=GetSpeechAnalyticsResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+    async def retranscribe(
+        self,
+        request_id: str,
+        *,
+        callback_url: str,
+        insights: typing.Optional[bool] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> AsyncHttpResponse[SuccessResponse]:
+        """
+        Re-runs transcription on the file identified by `request_id`, replacing the existing transcript.
+
+        Parameters
+        ----------
+        request_id : str
+            The `request_id` of the transcription, returned when the file was uploaded.
+
+        callback_url : str
+            Callback URL for transcription status updates.
+
+        insights : typing.Optional[bool]
+            Indicates whether to enable insights generation.
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[SuccessResponse]
+            Returns a success confirmation. Retranscription is queued.
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            f"v1/speech-analytics/{encode_path_param(request_id)}",
+            method="PUT",
+            json={
+                "callback_url": callback_url,
+                "insights": insights,
+            },
+            headers={
+                "content-type": "application/json",
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    SuccessResponse,
+                    parse_obj_as(
+                        type_=SuccessResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 400:
+                raise BadRequestError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 404:
+                raise NotFoundError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        parse_obj_as(
+                            type_=typing.Any,  # 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)
+        except ValidationError as e:
+            raise ParsingError(
+                status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e
+            )
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

wavix/speech_analytics/types/__init__.py

@@ -0,0 +1,47 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .create_speech_analytics_response import CreateSpeechAnalyticsResponse
+    from .get_speech_analytics_response import GetSpeechAnalyticsResponse
+    from .get_speech_analytics_response_language import GetSpeechAnalyticsResponseLanguage
+    from .get_speech_analytics_response_status import GetSpeechAnalyticsResponseStatus
+_dynamic_imports: typing.Dict[str, str] = {
+    "CreateSpeechAnalyticsResponse": ".create_speech_analytics_response",
+    "GetSpeechAnalyticsResponse": ".get_speech_analytics_response",
+    "GetSpeechAnalyticsResponseLanguage": ".get_speech_analytics_response_language",
+    "GetSpeechAnalyticsResponseStatus": ".get_speech_analytics_response_status",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "CreateSpeechAnalyticsResponse",
+    "GetSpeechAnalyticsResponse",
+    "GetSpeechAnalyticsResponseLanguage",
+    "GetSpeechAnalyticsResponseStatus",
+]

wavix/speech_analytics/types/create_speech_analytics_response.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class CreateSpeechAnalyticsResponse(UniversalBaseModel):
+    file: str = pydantic.Field()
+    """
+    Uploaded file name.
+    """
+
+    request_id: str = pydantic.Field()
+    """
+    Transcription request ID.
+    """
+
+    success: bool = pydantic.Field()
+    """
+    Indicates whether the request was successful.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/speech_analytics/types/get_speech_analytics_response.py

@@ -0,0 +1,77 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+from ...types.file_transcript_response import FileTranscriptResponse
+from ...types.file_transcript_turn import FileTranscriptTurn
+from .get_speech_analytics_response_language import GetSpeechAnalyticsResponseLanguage
+from .get_speech_analytics_response_status import GetSpeechAnalyticsResponseStatus
+
+
+class GetSpeechAnalyticsResponse(UniversalBaseModel):
+    transcript: typing.Optional[FileTranscriptResponse] = pydantic.Field(default=None)
+    """
+    Complete transcription text attributed to each channel.
+    """
+
+    turns: typing.Optional[typing.List[FileTranscriptTurn]] = pydantic.Field(default=None)
+    """
+    List of transcription turns, including speaker attribution, timestamps, and sentiment.
+    """
+
+    request_id: str = pydantic.Field()
+    """
+    Transcription request ID.
+    """
+
+    language: typing.Optional[GetSpeechAnalyticsResponseLanguage] = pydantic.Field(default=None)
+    """
+    Transcription language.
+    """
+
+    duration: typing.Optional[int] = pydantic.Field(default=None)
+    """
+    File duration in seconds.
+    """
+
+    charge: str = pydantic.Field()
+    """
+    Total transcription charge in USD.
+    """
+
+    status: GetSpeechAnalyticsResponseStatus = pydantic.Field()
+    """
+    Transcription status. Possible values are `completed`, `failed`.
+    """
+
+    transcription_date: dt.datetime = pydantic.Field()
+    """
+    Date and time of the transcription in ISO 8601 format.
+    """
+
+    transcription_score: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Conversation sentiment score. Scores from 1.0 to 3.0 are negative; scores from 4.0 to 5.0 are positive.
+    """
+
+    transcription_summary: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Transcription summary.
+    """
+
+    original_file: str = pydantic.Field()
+    """
+    Uploaded file URL.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

wavix/speech_analytics/types/get_speech_analytics_response_language.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetSpeechAnalyticsResponseLanguage = typing.Union[typing.Literal["en", "de", "es", "fr", "it"], typing.Any]

wavix/speech_analytics/types/get_speech_analytics_response_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+GetSpeechAnalyticsResponseStatus = typing.Union[typing.Literal["completed", "failed"], typing.Any]