sarvamai 0.1.5a3__tar.gz → 0.1.5a4__tar.gz

sarvamai-0.1.5a4/PKG-INFO

@@ -0,0 +1,174 @@
+Metadata-Version: 2.1
+Name: sarvamai
+Version: 0.1.5a4
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Sarvam Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fsarvamai%2Fsarvam-python-sdk)
+[![pypi](https://img.shields.io/pypi/v/sarvamai)](https://pypi.python.org/pypi/sarvamai)
+
+The Sarvam Python library provides convenient access to the Sarvam API from Python.
+
+## Documentation
+
+API reference documentation is available [here](https://www.sarvam.ai/).
+
+## Installation
+
+```sh
+pip install sarvamai
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/sarvamai/sarvam-python-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from sarvamai import SarvamAI
+
+client = SarvamAI(
+    api_subscription_key="YOUR_API_SUBSCRIPTION_KEY",
+)
+client.text.translate(
+    input="input",
+    source_language_code="auto",
+    target_language_code="bn-IN",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from sarvamai import AsyncSarvamAI
+
+client = AsyncSarvamAI(
+    api_subscription_key="YOUR_API_SUBSCRIPTION_KEY",
+)
+
+
+async def main() -> None:
+    await client.text.translate(
+        input="input",
+        source_language_code="auto",
+        target_language_code="bn-IN",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from sarvamai.core.api_error import ApiError
+
+try:
+    client.text.translate(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.text.translate(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from sarvamai import SarvamAI
+
+client = SarvamAI(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.text.translate(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from sarvamai import SarvamAI
+
+client = SarvamAI(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

sarvamai-0.1.5a4/README.md

@@ -0,0 +1,147 @@
+# Sarvam Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fsarvamai%2Fsarvam-python-sdk)
+[![pypi](https://img.shields.io/pypi/v/sarvamai)](https://pypi.python.org/pypi/sarvamai)
+
+The Sarvam Python library provides convenient access to the Sarvam API from Python.
+
+## Documentation
+
+API reference documentation is available [here](https://www.sarvam.ai/).
+
+## Installation
+
+```sh
+pip install sarvamai
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/sarvamai/sarvam-python-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from sarvamai import SarvamAI
+
+client = SarvamAI(
+    api_subscription_key="YOUR_API_SUBSCRIPTION_KEY",
+)
+client.text.translate(
+    input="input",
+    source_language_code="auto",
+    target_language_code="bn-IN",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from sarvamai import AsyncSarvamAI
+
+client = AsyncSarvamAI(
+    api_subscription_key="YOUR_API_SUBSCRIPTION_KEY",
+)
+
+
+async def main() -> None:
+    await client.text.translate(
+        input="input",
+        source_language_code="auto",
+        target_language_code="bn-IN",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from sarvamai.core.api_error import ApiError
+
+try:
+    client.text.translate(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.text.translate(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from sarvamai import SarvamAI
+
+client = SarvamAI(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.text.translate(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from sarvamai import SarvamAI
+
+client = SarvamAI(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

{sarvamai-0.1.5a3 → sarvamai-0.1.5a4}/pyproject.toml

@@ -3,7 +3,7 @@ name = "sarvamai"
 
 [tool.poetry]
 name = "sarvamai"
-version = "0.1.5a3"
+version = "0.1.5a4"
 description = ""
 readme = "README.md"
 authors = []
@@ -40,13 +40,13 @@ pydantic = ">= 1.9.2"
 pydantic-core = "^2.18.2"
 typing_extensions = ">= 4.0.0"
 
-[tool.poetry.group.dev.dependencies]
-mypy = "==1.13.0"
+[tool.poetry.dev-dependencies]
+mypy = "1.0.1"
 pytest = "^7.4.0"
 pytest-asyncio = "^0.23.5"
 python-dateutil = "^2.9.0"
 types-python-dateutil = "^2.9.0.20240316"
-ruff = "==0.11.5"
+ruff = "^0.5.6"
 
 [tool.pytest.ini_options]
 testpaths = [ "tests" ]
@@ -58,26 +58,6 @@ plugins = ["pydantic.mypy"]
 [tool.ruff]
 line-length = 120
 
-[tool.ruff.lint]
-select = [
-    "E",  # pycodestyle errors
-    "F",  # pyflakes
-    "I",  # isort
-]
-ignore = [
-    "E402",  # Module level import not at top of file
-    "E501",  # Line too long
-    "E711",  # Comparison to `None` should be `cond is not None`
-    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
-    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
-    "E722",  # Do not use bare `except`
-    "E731",  # Do not assign a `lambda` expression, use a `def`
-    "F821",  # Undefined name
-    "F841"   # Local variable ... is assigned to but never used
-]
-
-[tool.ruff.lint.isort]
-section-order = ["future", "standard-library", "third-party", "first-party"]
 
 [build-system]
 requires = ["poetry-core"]

{sarvamai-0.1.5a3 → sarvamai-0.1.5a4}/src/sarvamai/__init__.py

@@ -1,7 +1,5 @@
 # This file was auto-generated by Fern from our API Definition.
 
-# isort: skip_file
-
 from .types import (
     ChatCompletionRequestAssistantMessage,
     ChatCompletionRequestMessage,
@@ -41,12 +39,12 @@ from .types import (
     TimestampsModel,
     TranslateMode,
     TranslateModel,
-    TranslatePostprocessing,
     TranslateSourceLanguage,
     TranslateSpeakerGender,
     TranslateTargetLanguage,
     TranslationResponse,
     TranslatiterateTargetLanguage,
+    TransliterateMode,
     TransliterateSourceLanguage,
     TransliterationResponse,
 )
@@ -156,13 +154,13 @@ __all__ = [
     "TooManyRequestsError",
     "TranslateMode",
     "TranslateModel",
-    "TranslatePostprocessing",
     "TranslateSourceLanguage",
     "TranslateSpeakerGender",
     "TranslateTargetLanguage",
     "TranslationResponse",
     "TranslationResponseParams",
     "TranslatiterateTargetLanguage",
+    "TransliterateMode",
     "TransliterateSourceLanguage",
     "TransliterationResponse",
     "TransliterationResponseParams",

{sarvamai-0.1.5a3 → sarvamai-0.1.5a4}/src/sarvamai/chat/__init__.py

@@ -1,4 +1,2 @@
 # This file was auto-generated by Fern from our API Definition.
 
-# isort: skip_file
-

{sarvamai-0.1.5a3 → sarvamai-0.1.5a4}/src/sarvamai/chat/client.py

@@ -1,14 +1,15 @@
 # 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 ..core.client_wrapper import SyncClientWrapper
+from .raw_client import RawChatClient
 from ..requests.chat_completion_request_message import ChatCompletionRequestMessageParams
+from ..types.reasoning_effort import ReasoningEffort
 from ..requests.stop_configuration import StopConfigurationParams
+from ..core.request_options import RequestOptions
 from ..types.create_chat_completion_response import CreateChatCompletionResponse
-from ..types.reasoning_effort import ReasoningEffort
-from .raw_client import AsyncRawChatClient, RawChatClient
+from ..core.client_wrapper import AsyncClientWrapper
+from .raw_client import AsyncRawChatClient
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -117,7 +118,7 @@ class ChatClient:
             messages=[{"content": "content", "role": "assistant"}],
         )
         """
-        _response = self._raw_client.completions(
+        response = self._raw_client.completions(
             messages=messages,
             temperature=temperature,
             top_p=top_p,
@@ -132,7 +133,7 @@ class ChatClient:
             wiki_grounding=wiki_grounding,
             request_options=request_options,
         )
-        return _response.data
+        return response.data
 
 
 class AsyncChatClient:
@@ -246,7 +247,7 @@ class AsyncChatClient:
 
         asyncio.run(main())
         """
-        _response = await self._raw_client.completions(
+        response = await self._raw_client.completions(
             messages=messages,
             temperature=temperature,
             top_p=top_p,
@@ -261,4 +262,4 @@ class AsyncChatClient:
             wiki_grounding=wiki_grounding,
             request_options=request_options,
         )
-        return _response.data
+        return response.data

{sarvamai-0.1.5a3 → sarvamai-0.1.5a4}/src/sarvamai/chat/raw_client.py

@@ -1,23 +1,24 @@
 # This file was auto-generated by Fern from our API Definition.
 
 import typing
-from json.decoder import JSONDecodeError
-
-from ..core.api_error import ApiError
-from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
-from ..core.http_response import AsyncHttpResponse, HttpResponse
-from ..core.pydantic_utilities import parse_obj_as
+from ..core.client_wrapper import SyncClientWrapper
+from ..requests.chat_completion_request_message import ChatCompletionRequestMessageParams
+from ..types.reasoning_effort import ReasoningEffort
+from ..requests.stop_configuration import StopConfigurationParams
 from ..core.request_options import RequestOptions
+from ..core.http_response import HttpResponse
+from ..types.create_chat_completion_response import CreateChatCompletionResponse
 from ..core.serialization import convert_and_respect_annotation_metadata
+from ..core.pydantic_utilities import parse_obj_as
 from ..errors.bad_request_error import BadRequestError
 from ..errors.forbidden_error import ForbiddenError
-from ..errors.internal_server_error import InternalServerError
-from ..errors.too_many_requests_error import TooManyRequestsError
 from ..errors.unprocessable_entity_error import UnprocessableEntityError
-from ..requests.chat_completion_request_message import ChatCompletionRequestMessageParams
-from ..requests.stop_configuration import StopConfigurationParams
-from ..types.create_chat_completion_response import CreateChatCompletionResponse
-from ..types.reasoning_effort import ReasoningEffort
+from ..errors.too_many_requests_error import TooManyRequestsError
+from ..errors.internal_server_error import InternalServerError
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper
+from ..core.http_response import AsyncHttpResponse
 
 # this is used as the default value for optional parameters
 OMIT = typing.cast(typing.Any, ...)
@@ -106,7 +107,6 @@ class RawChatClient:
         """
         _response = self._client_wrapper.httpx_client.request(
             "v1/chat/completions",
-            base_url=self._client_wrapper.get_environment().base,
             method="POST",
             json={
                 "messages": convert_and_respect_annotation_metadata(
@@ -145,63 +145,58 @@ class RawChatClient:
                 return HttpResponse(response=_response, data=_data)
             if _response.status_code == 400:
                 raise BadRequestError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
-                    ),
+                    )
                 )
             if _response.status_code == 403:
                 raise ForbiddenError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
-                    ),
+                    )
                 )
             if _response.status_code == 422:
                 raise UnprocessableEntityError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
-                    ),
+                    )
                 )
             if _response.status_code == 429:
                 raise TooManyRequestsError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
-                    ),
+                    )
                 )
             if _response.status_code == 500:
                 raise InternalServerError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[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)
-        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
 
 
 class AsyncRawChatClient:
@@ -287,7 +282,6 @@ class AsyncRawChatClient:
         """
         _response = await self._client_wrapper.httpx_client.request(
             "v1/chat/completions",
-            base_url=self._client_wrapper.get_environment().base,
             method="POST",
             json={
                 "messages": convert_and_respect_annotation_metadata(
@@ -326,60 +320,55 @@ class AsyncRawChatClient:
                 return AsyncHttpResponse(response=_response, data=_data)
             if _response.status_code == 400:
                 raise BadRequestError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
-                    ),
+                    )
                 )
             if _response.status_code == 403:
                 raise ForbiddenError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
-                    ),
+                    )
                 )
             if _response.status_code == 422:
                 raise UnprocessableEntityError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
-                    ),
+                    )
                 )
             if _response.status_code == 429:
                 raise TooManyRequestsError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
-                    ),
+                    )
                 )
             if _response.status_code == 500:
                 raise InternalServerError(
-                    headers=dict(_response.headers),
-                    body=typing.cast(
+                    typing.cast(
                         typing.Optional[typing.Any],
                         parse_obj_as(
                             type_=typing.Optional[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)
-        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)