camb-sdk 1.5.4__py3-none-any.whl

camb/translation/client.py

@@ -0,0 +1,631 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.formalities import Formalities
+from ..types.gender import Gender
+from ..types.languages import Languages
+from ..types.orchestrator_pipeline_result import OrchestratorPipelineResult
+from ..types.translation_result import TranslationResult
+from .raw_client import AsyncRawTranslationClient, RawTranslationClient
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class TranslationClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawTranslationClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawTranslationClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawTranslationClient
+        """
+        return self._raw_client
+
+    def translation_stream(
+        self,
+        *,
+        source_language: Languages,
+        target_language: Languages,
+        text: str,
+        traceparent: typing.Optional[str] = None,
+        formality: typing.Optional[Formalities] = OMIT,
+        gender: typing.Optional[Gender] = OMIT,
+        team_id: typing.Optional[int] = OMIT,
+        project_name: typing.Optional[str] = OMIT,
+        project_description: typing.Optional[str] = OMIT,
+        folder_id: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Any:
+        """
+        Parameters
+        ----------
+        source_language : Languages
+
+        target_language : Languages
+
+        text : str
+
+        traceparent : typing.Optional[str]
+
+        formality : typing.Optional[Formalities]
+
+        gender : typing.Optional[Gender]
+
+        team_id : typing.Optional[int]
+
+        project_name : typing.Optional[str]
+
+        project_description : typing.Optional[str]
+
+        folder_id : typing.Optional[int]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Any
+            Text translation stream
+
+        Examples
+        --------
+        from camb import CambApi
+
+        client = CambApi(
+            api_key="YOUR_API_KEY",
+        )
+        client.translation.translation_stream(
+            source_language=1,
+            target_language=1,
+            text="text",
+        )
+        """
+        _response = self._raw_client.translation_stream(
+            source_language=source_language,
+            target_language=target_language,
+            text=text,
+            traceparent=traceparent,
+            formality=formality,
+            gender=gender,
+            team_id=team_id,
+            project_name=project_name,
+            project_description=project_description,
+            folder_id=folder_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def create_translation(
+        self,
+        *,
+        texts: typing.Sequence[str],
+        source_language: Languages,
+        target_language: Languages,
+        run_id: typing.Optional[int] = None,
+        project_name: typing.Optional[str] = OMIT,
+        project_description: typing.Optional[str] = OMIT,
+        folder_id: typing.Optional[int] = OMIT,
+        age: typing.Optional[int] = OMIT,
+        formality: typing.Optional[Formalities] = OMIT,
+        gender: typing.Optional[Gender] = OMIT,
+        chosen_dictionaries: typing.Optional[typing.Sequence[int]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Any:
+        """
+        Parameters
+        ----------
+        texts : typing.Sequence[str]
+
+        source_language : Languages
+
+        target_language : Languages
+
+        run_id : typing.Optional[int]
+
+        project_name : typing.Optional[str]
+
+        project_description : typing.Optional[str]
+
+        folder_id : typing.Optional[int]
+
+        age : typing.Optional[int]
+
+        formality : typing.Optional[Formalities]
+
+        gender : typing.Optional[Gender]
+
+        chosen_dictionaries : typing.Optional[typing.Sequence[int]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Any
+            Successful Response
+
+        Examples
+        --------
+        from camb import CambApi
+
+        client = CambApi(
+            api_key="YOUR_API_KEY",
+        )
+        client.translation.create_translation(
+            texts=["texts"],
+            source_language=1,
+            target_language=1,
+        )
+        """
+        _response = self._raw_client.create_translation(
+            texts=texts,
+            source_language=source_language,
+            target_language=target_language,
+            run_id=run_id,
+            project_name=project_name,
+            project_description=project_description,
+            folder_id=folder_id,
+            age=age,
+            formality=formality,
+            gender=gender,
+            chosen_dictionaries=chosen_dictionaries,
+            request_options=request_options,
+        )
+        return _response.data
+
+    def get_translation_task_status(
+        self,
+        task_id: str,
+        *,
+        run_id: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrchestratorPipelineResult:
+        """
+        Parameters
+        ----------
+        task_id : str
+
+        run_id : typing.Optional[int]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrchestratorPipelineResult
+            Successful Response
+
+        Examples
+        --------
+        from camb import CambApi
+
+        client = CambApi(
+            api_key="YOUR_API_KEY",
+        )
+        client.translation.get_translation_task_status(
+            task_id="task_id",
+        )
+        """
+        _response = self._raw_client.get_translation_task_status(
+            task_id, run_id=run_id, request_options=request_options
+        )
+        return _response.data
+
+    def get_translation_result(
+        self,
+        run_id: typing.Optional[int],
+        *,
+        traceparent: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> TranslationResult:
+        """
+        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]
+
+        traceparent : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TranslationResult
+            Successful Response
+
+        Examples
+        --------
+        from camb import CambApi
+
+        client = CambApi(
+            api_key="YOUR_API_KEY",
+        )
+        client.translation.get_translation_result(
+            run_id=1,
+        )
+        """
+        _response = self._raw_client.get_translation_result(
+            run_id, traceparent=traceparent, request_options=request_options
+        )
+        return _response.data
+
+    def get_translation_results(
+        self,
+        *,
+        run_ids: typing.Sequence[int],
+        run_id: typing.Optional[int] = None,
+        traceparent: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Dict[str, TranslationResult]:
+        """
+        Parameters
+        ----------
+        run_ids : typing.Sequence[int]
+
+        run_id : typing.Optional[int]
+
+        traceparent : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, TranslationResult]
+            Successful Response
+
+        Examples
+        --------
+        from camb import CambApi
+
+        client = CambApi(
+            api_key="YOUR_API_KEY",
+        )
+        client.translation.get_translation_results(
+            run_ids=[1],
+        )
+        """
+        _response = self._raw_client.get_translation_results(
+            run_ids=run_ids, run_id=run_id, traceparent=traceparent, request_options=request_options
+        )
+        return _response.data
+
+
+class AsyncTranslationClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawTranslationClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawTranslationClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawTranslationClient
+        """
+        return self._raw_client
+
+    async def translation_stream(
+        self,
+        *,
+        source_language: Languages,
+        target_language: Languages,
+        text: str,
+        traceparent: typing.Optional[str] = None,
+        formality: typing.Optional[Formalities] = OMIT,
+        gender: typing.Optional[Gender] = OMIT,
+        team_id: typing.Optional[int] = OMIT,
+        project_name: typing.Optional[str] = OMIT,
+        project_description: typing.Optional[str] = OMIT,
+        folder_id: typing.Optional[int] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Any:
+        """
+        Parameters
+        ----------
+        source_language : Languages
+
+        target_language : Languages
+
+        text : str
+
+        traceparent : typing.Optional[str]
+
+        formality : typing.Optional[Formalities]
+
+        gender : typing.Optional[Gender]
+
+        team_id : typing.Optional[int]
+
+        project_name : typing.Optional[str]
+
+        project_description : typing.Optional[str]
+
+        folder_id : typing.Optional[int]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Any
+            Text translation stream
+
+        Examples
+        --------
+        import asyncio
+
+        from camb import AsyncCambApi
+
+        client = AsyncCambApi(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.translation.translation_stream(
+                source_language=1,
+                target_language=1,
+                text="text",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.translation_stream(
+            source_language=source_language,
+            target_language=target_language,
+            text=text,
+            traceparent=traceparent,
+            formality=formality,
+            gender=gender,
+            team_id=team_id,
+            project_name=project_name,
+            project_description=project_description,
+            folder_id=folder_id,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def create_translation(
+        self,
+        *,
+        texts: typing.Sequence[str],
+        source_language: Languages,
+        target_language: Languages,
+        run_id: typing.Optional[int] = None,
+        project_name: typing.Optional[str] = OMIT,
+        project_description: typing.Optional[str] = OMIT,
+        folder_id: typing.Optional[int] = OMIT,
+        age: typing.Optional[int] = OMIT,
+        formality: typing.Optional[Formalities] = OMIT,
+        gender: typing.Optional[Gender] = OMIT,
+        chosen_dictionaries: typing.Optional[typing.Sequence[int]] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Any:
+        """
+        Parameters
+        ----------
+        texts : typing.Sequence[str]
+
+        source_language : Languages
+
+        target_language : Languages
+
+        run_id : typing.Optional[int]
+
+        project_name : typing.Optional[str]
+
+        project_description : typing.Optional[str]
+
+        folder_id : typing.Optional[int]
+
+        age : typing.Optional[int]
+
+        formality : typing.Optional[Formalities]
+
+        gender : typing.Optional[Gender]
+
+        chosen_dictionaries : typing.Optional[typing.Sequence[int]]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Any
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from camb import AsyncCambApi
+
+        client = AsyncCambApi(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.translation.create_translation(
+                texts=["texts"],
+                source_language=1,
+                target_language=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_translation(
+            texts=texts,
+            source_language=source_language,
+            target_language=target_language,
+            run_id=run_id,
+            project_name=project_name,
+            project_description=project_description,
+            folder_id=folder_id,
+            age=age,
+            formality=formality,
+            gender=gender,
+            chosen_dictionaries=chosen_dictionaries,
+            request_options=request_options,
+        )
+        return _response.data
+
+    async def get_translation_task_status(
+        self,
+        task_id: str,
+        *,
+        run_id: typing.Optional[int] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> OrchestratorPipelineResult:
+        """
+        Parameters
+        ----------
+        task_id : str
+
+        run_id : typing.Optional[int]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        OrchestratorPipelineResult
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from camb import AsyncCambApi
+
+        client = AsyncCambApi(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.translation.get_translation_task_status(
+                task_id="task_id",
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_translation_task_status(
+            task_id, run_id=run_id, request_options=request_options
+        )
+        return _response.data
+
+    async def get_translation_result(
+        self,
+        run_id: typing.Optional[int],
+        *,
+        traceparent: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> TranslationResult:
+        """
+        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]
+
+        traceparent : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        TranslationResult
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from camb import AsyncCambApi
+
+        client = AsyncCambApi(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.translation.get_translation_result(
+                run_id=1,
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_translation_result(
+            run_id, traceparent=traceparent, request_options=request_options
+        )
+        return _response.data
+
+    async def get_translation_results(
+        self,
+        *,
+        run_ids: typing.Sequence[int],
+        run_id: typing.Optional[int] = None,
+        traceparent: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> typing.Dict[str, TranslationResult]:
+        """
+        Parameters
+        ----------
+        run_ids : typing.Sequence[int]
+
+        run_id : typing.Optional[int]
+
+        traceparent : typing.Optional[str]
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        typing.Dict[str, TranslationResult]
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from camb import AsyncCambApi
+
+        client = AsyncCambApi(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.translation.get_translation_results(
+                run_ids=[1],
+            )
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.get_translation_results(
+            run_ids=run_ids, run_id=run_id, traceparent=traceparent, request_options=request_options
+        )
+        return _response.data