dexa-ai-sdk 0.3.2__tar.gz

dexa_ai_sdk-0.3.2/PKG-INFO

@@ -0,0 +1,223 @@
+Metadata-Version: 2.4
+Name: dexa-ai-sdk
+Version: 0.3.2
+Summary: Dexa is the Python client for the Decide + Extract API. Run decide and extract tasks against one context in a single request.
+Author: Durga Sai
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/dsainvg/decide-extract-sdk
+Project-URL: Repository, https://github.com/dsainvg/decide-extract-sdk
+Project-URL: Documentation, https://dsainvg.github.io/decide-extract-sdk/
+Project-URL: Changelog, https://github.com/dsainvg/decide-extract-sdk/blob/main/CHANGELOG.md
+Keywords: fern,sdk,openapi,llm,dexa-ai-sdk,decide,extract
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.21.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: typing-extensions>=4.0.0
+
+# Dsainvg 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=Dsainvg%2FPython)
+[![pypi](https://img.shields.io/pypi/v/dsainvg_decide_extractor_sdk)](https://pypi.python.org/pypi/dsainvg_decide_extractor_sdk)
+
+The Dsainvg Python library provides convenient access to the Dsainvg APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install dsainvg_decide_extractor_sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from dsainvg_decide_extractor_sdk import DexaAiSdk, Task_Decide
+
+client = DexaAiSdk()
+
+client.tasks.run_tasks(
+    model="model",
+    tasks=[
+        Task_Decide(
+            name="name",
+            question="question",
+        )
+    ],
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from dsainvg_decide_extractor_sdk import DexaAiSdk
+from dsainvg_decide_extractor_sdk.environment import DexaAiSdkEnvironment
+
+client = DexaAiSdk(
+    environment=DexaAiSdkEnvironment.DEFAULT,
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from dsainvg_decide_extractor_sdk import AsyncDexaAiSdk
+
+client = AsyncDexaAiSdk()
+
+
+async def main() -> None:
+    await client.tasks.run_tasks(
+        model="model",
+        tasks=[
+            Task_Decide(
+                name="name",
+                question="question",
+            )
+        ],
+    )
+
+
+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 dsainvg_decide_extractor_sdk.core.api_error import ApiError
+
+try:
+    client.tasks.run_tasks(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from dsainvg_decide_extractor_sdk import DexaAiSdk
+
+client = DexaAiSdk(...)
+response = client.tasks.with_raw_response.run_tasks(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### 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).
+
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [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#server_error_responses) (All server errors, including 500)
+
+**`recommended`**: retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.tasks.run_tasks(..., 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 dsainvg_decide_extractor_sdk import DexaAiSdk
+
+client = DexaAiSdk(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.tasks.run_tasks(..., request_options={
+    "timeout": 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 dsainvg_decide_extractor_sdk import DexaAiSdk
+
+client = DexaAiSdk(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="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!

dexa_ai_sdk-0.3.2/README.md

@@ -0,0 +1,196 @@
+# Dsainvg 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=Dsainvg%2FPython)
+[![pypi](https://img.shields.io/pypi/v/dsainvg_decide_extractor_sdk)](https://pypi.python.org/pypi/dsainvg_decide_extractor_sdk)
+
+The Dsainvg Python library provides convenient access to the Dsainvg APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install dsainvg_decide_extractor_sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from dsainvg_decide_extractor_sdk import DexaAiSdk, Task_Decide
+
+client = DexaAiSdk()
+
+client.tasks.run_tasks(
+    model="model",
+    tasks=[
+        Task_Decide(
+            name="name",
+            question="question",
+        )
+    ],
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from dsainvg_decide_extractor_sdk import DexaAiSdk
+from dsainvg_decide_extractor_sdk.environment import DexaAiSdkEnvironment
+
+client = DexaAiSdk(
+    environment=DexaAiSdkEnvironment.DEFAULT,
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from dsainvg_decide_extractor_sdk import AsyncDexaAiSdk
+
+client = AsyncDexaAiSdk()
+
+
+async def main() -> None:
+    await client.tasks.run_tasks(
+        model="model",
+        tasks=[
+            Task_Decide(
+                name="name",
+                question="question",
+            )
+        ],
+    )
+
+
+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 dsainvg_decide_extractor_sdk.core.api_error import ApiError
+
+try:
+    client.tasks.run_tasks(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from dsainvg_decide_extractor_sdk import DexaAiSdk
+
+client = DexaAiSdk(...)
+response = client.tasks.with_raw_response.run_tasks(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### 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).
+
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [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#server_error_responses) (All server errors, including 500)
+
+**`recommended`**: retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.tasks.run_tasks(..., 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 dsainvg_decide_extractor_sdk import DexaAiSdk
+
+client = DexaAiSdk(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.tasks.run_tasks(..., request_options={
+    "timeout": 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 dsainvg_decide_extractor_sdk import DexaAiSdk
+
+client = DexaAiSdk(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="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!

dexa_ai_sdk-0.3.2/__init__.py

@@ -0,0 +1,197 @@
+# 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 .types import (
+        AudioInput,
+        AudioInputType,
+        Choice,
+        ChoiceFinishReason,
+        ContentPart,
+        ContentPartLanguage,
+        ContentPartType,
+        DecideResponse,
+        DecideResult,
+        DecideTask,
+        DecideTaskTargetLanguage,
+        ErrorResponse,
+        ErrorResponseError,
+        ExtractResponse,
+        ExtractTask,
+        ExtractTaskTargetLanguage,
+        ImageInput,
+        ImageInputType,
+        ImageUrl,
+        ImageUrlDetail,
+        Message,
+        MessageContent,
+        MessageLanguage,
+        MessageRole,
+        ResponseMessage,
+        ResponseMessageLanguage,
+        ResponseMessageRole,
+        RunTasksRequest,
+        RunTasksRequestOutputLanguage,
+        RunTasksRequestResponseFormat,
+        RunTasksRequestResponseFormatType,
+        RunTasksRequestTargetLanguage,
+        RunTasksResponse,
+        Task,
+        Task_Decide,
+        Task_Extract,
+        Usage,
+    )
+    from .errors import BadRequestError, InternalServerError, UnprocessableEntityError
+    from . import tasks
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .client import AsyncDexaAiSdk, DexaAiSdk
+    from .environment import DexaAiSdkEnvironment
+    from .tasks import (
+        DecideRequestOutputLanguage,
+        DecideRequestResponseFormat,
+        DecideRequestResponseFormatType,
+        DecideRequestTargetLanguage,
+        ExtractRequestOutputLanguage,
+        ExtractRequestResponseFormat,
+        ExtractRequestResponseFormatType,
+        ExtractRequestTargetLanguage,
+    )
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncDexaAiSdk": ".client",
+    "AudioInput": ".types",
+    "AudioInputType": ".types",
+    "BadRequestError": ".errors",
+    "Choice": ".types",
+    "ChoiceFinishReason": ".types",
+    "ContentPart": ".types",
+    "ContentPartLanguage": ".types",
+    "ContentPartType": ".types",
+    "DecideRequestOutputLanguage": ".tasks",
+    "DecideRequestResponseFormat": ".tasks",
+    "DecideRequestResponseFormatType": ".tasks",
+    "DecideRequestTargetLanguage": ".tasks",
+    "DecideResponse": ".types",
+    "DecideResult": ".types",
+    "DecideTask": ".types",
+    "DecideTaskTargetLanguage": ".types",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DexaAiSdk": ".client",
+    "DexaAiSdkEnvironment": ".environment",
+    "ErrorResponse": ".types",
+    "ErrorResponseError": ".types",
+    "ExtractRequestOutputLanguage": ".tasks",
+    "ExtractRequestResponseFormat": ".tasks",
+    "ExtractRequestResponseFormatType": ".tasks",
+    "ExtractRequestTargetLanguage": ".tasks",
+    "ExtractResponse": ".types",
+    "ExtractTask": ".types",
+    "ExtractTaskTargetLanguage": ".types",
+    "ImageInput": ".types",
+    "ImageInputType": ".types",
+    "ImageUrl": ".types",
+    "ImageUrlDetail": ".types",
+    "InternalServerError": ".errors",
+    "Message": ".types",
+    "MessageContent": ".types",
+    "MessageLanguage": ".types",
+    "MessageRole": ".types",
+    "ResponseMessage": ".types",
+    "ResponseMessageLanguage": ".types",
+    "ResponseMessageRole": ".types",
+    "RunTasksRequest": ".types",
+    "RunTasksRequestOutputLanguage": ".types",
+    "RunTasksRequestResponseFormat": ".types",
+    "RunTasksRequestResponseFormatType": ".types",
+    "RunTasksRequestTargetLanguage": ".types",
+    "RunTasksResponse": ".types",
+    "Task": ".types",
+    "Task_Decide": ".types",
+    "Task_Extract": ".types",
+    "UnprocessableEntityError": ".errors",
+    "Usage": ".types",
+    "tasks": ".tasks",
+}
+
+
+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__ = [
+    "AsyncDexaAiSdk",
+    "AudioInput",
+    "AudioInputType",
+    "BadRequestError",
+    "Choice",
+    "ChoiceFinishReason",
+    "ContentPart",
+    "ContentPartLanguage",
+    "ContentPartType",
+    "DecideRequestOutputLanguage",
+    "DecideRequestResponseFormat",
+    "DecideRequestResponseFormatType",
+    "DecideRequestTargetLanguage",
+    "DecideResponse",
+    "DecideResult",
+    "DecideTask",
+    "DecideTaskTargetLanguage",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DexaAiSdk",
+    "DexaAiSdkEnvironment",
+    "ErrorResponse",
+    "ErrorResponseError",
+    "ExtractRequestOutputLanguage",
+    "ExtractRequestResponseFormat",
+    "ExtractRequestResponseFormatType",
+    "ExtractRequestTargetLanguage",
+    "ExtractResponse",
+    "ExtractTask",
+    "ExtractTaskTargetLanguage",
+    "ImageInput",
+    "ImageInputType",
+    "ImageUrl",
+    "ImageUrlDetail",
+    "InternalServerError",
+    "Message",
+    "MessageContent",
+    "MessageLanguage",
+    "MessageRole",
+    "ResponseMessage",
+    "ResponseMessageLanguage",
+    "ResponseMessageRole",
+    "RunTasksRequest",
+    "RunTasksRequestOutputLanguage",
+    "RunTasksRequestResponseFormat",
+    "RunTasksRequestResponseFormatType",
+    "RunTasksRequestTargetLanguage",
+    "RunTasksResponse",
+    "Task",
+    "Task_Decide",
+    "Task_Extract",
+    "UnprocessableEntityError",
+    "Usage",
+    "tasks",
+]

dexa_ai_sdk-0.3.2/_default_clients.py

@@ -0,0 +1,33 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError(
+                "To use the aiohttp client, install the aiohttp extra: "
+                "pip install dsainvg_decide_extractor_sdk[aiohttp]"
+            )
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)