Release 0.0.83

fern-api[bot] · fern-api[bot] · commit fc21ca62e217 · 2025-02-18T10:04:34.000Z
diff --git a/README.md b/README.md
@@ -89,10 +89,10 @@ except ApiError as e:
 ### Retries
 
 The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
-as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+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 retriable when any of the following HTTP status codes is returned:
+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)
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ name = "axiomatic"
 
 [tool.poetry]
 name = "axiomatic"
-version = "0.0.82"
+version = "0.0.83"
 description = ""
 readme = "README.md"
 authors = []
diff --git a/reference.md b/reference.md
@@ -1035,6 +1035,77 @@ client.tools.list()
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## EquationProcessing
+<details><summary><code>client.equation_processing.<a href="src/axiomatic/equation_processing/client.py">extract_from_document</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Extract equations from a document into the database
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from axiomatic import Axiomatic
+
+client = Axiomatic(
+    api_key="YOUR_API_KEY",
+)
+client.equation_processing.extract_from_document()
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**document:** `from __future__ import annotations
+
+core.File` — See core.File for more documentation
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,6 @@
+httpx>=0.21.2
+pydantic>= 1.9.2
+pydantic-core==^2.18.2
+requests>2.26.0
+types-requests>2.0.0
+typing_extensions>= 4.0.0
diff --git a/src/axiomatic/__init__.py b/src/axiomatic/__init__.py
@@ -11,6 +11,8 @@
     CreateApiKeyrequest,
     CreateUserRequest,
     CreateUserResponse,
+    EquationExtraction,
+    EquationExtractionResponse,
     ExecuteCodeResponse,
     ExtractConstantsResponse,
     ExtractTextResponse,
@@ -71,7 +73,19 @@
     Z3Expression,
 )
 from .errors import UnprocessableEntityError
-from . import code_execution, document, experimental, formalization, fso, generic, lean, pic, requirements, tools
+from . import (
+    code_execution,
+    document,
+    equation_processing,
+    experimental,
+    formalization,
+    fso,
+    generic,
+    lean,
+    pic,
+    requirements,
+    tools,
+)
 from .client import AsyncAxiomatic, Axiomatic
 from .environment import AxiomaticEnvironment
 from .version import __version__
@@ -90,6 +104,8 @@
     "CreateApiKeyrequest",
     "CreateUserRequest",
     "CreateUserResponse",
+    "EquationExtraction",
+    "EquationExtractionResponse",
     "ExecuteCodeResponse",
     "ExtractConstantsResponse",
     "ExtractTextResponse",
@@ -152,6 +168,7 @@
     "__version__",
     "code_execution",
     "document",
+    "equation_processing",
     "experimental",
     "formalization",
     "fso",
diff --git a/src/axiomatic/base_client.py b/src/axiomatic/base_client.py
@@ -13,6 +13,7 @@
 from .generic.client import GenericClient
 from .document.client import DocumentClient
 from .tools.client import ToolsClient
+from .equation_processing.client import EquationProcessingClient
 from .code_execution.client import CodeExecutionClient
 from .fso.client import FsoClient
 from .pic.client import PicClient
@@ -27,6 +28,7 @@
 from .generic.client import AsyncGenericClient
 from .document.client import AsyncDocumentClient
 from .tools.client import AsyncToolsClient
+from .equation_processing.client import AsyncEquationProcessingClient
 from .code_execution.client import AsyncCodeExecutionClient
 from .fso.client import AsyncFsoClient
 from .pic.client import AsyncPicClient
@@ -101,6 +103,7 @@ def __init__(
         self.generic = GenericClient(client_wrapper=self._client_wrapper)
         self.document = DocumentClient(client_wrapper=self._client_wrapper)
         self.tools = ToolsClient(client_wrapper=self._client_wrapper)
+        self.equation_processing = EquationProcessingClient(client_wrapper=self._client_wrapper)
         self.code_execution = CodeExecutionClient(client_wrapper=self._client_wrapper)
         self.fso = FsoClient(client_wrapper=self._client_wrapper)
         self.pic = PicClient(client_wrapper=self._client_wrapper)
@@ -259,6 +262,7 @@ def __init__(
         self.generic = AsyncGenericClient(client_wrapper=self._client_wrapper)
         self.document = AsyncDocumentClient(client_wrapper=self._client_wrapper)
         self.tools = AsyncToolsClient(client_wrapper=self._client_wrapper)
+        self.equation_processing = AsyncEquationProcessingClient(client_wrapper=self._client_wrapper)
         self.code_execution = AsyncCodeExecutionClient(client_wrapper=self._client_wrapper)
         self.fso = AsyncFsoClient(client_wrapper=self._client_wrapper)
         self.pic = AsyncPicClient(client_wrapper=self._client_wrapper)
diff --git a/src/axiomatic/core/client_wrapper.py b/src/axiomatic/core/client_wrapper.py
@@ -16,7 +16,7 @@ def get_headers(self) -> typing.Dict[str, str]:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "axiomatic",
-            "X-Fern-SDK-Version": "0.0.82",
+            "X-Fern-SDK-Version": "0.0.83",
         }
         headers["X-API-Key"] = self.api_key
         return headers
diff --git a/src/axiomatic/core/http_client.py b/src/axiomatic/core/http_client.py
@@ -85,8 +85,8 @@ def _retry_timeout(response: httpx.Response, retries: int) -> float:
 
 
 def _should_retry(response: httpx.Response) -> bool:
-    retriable_400s = [429, 408, 409]
-    return response.status_code >= 500 or response.status_code in retriable_400s
+    retryable_400s = [429, 408, 409]
+    return response.status_code >= 500 or response.status_code in retryable_400s
 
 
 def remove_omit_from_dict(
diff --git a/src/axiomatic/core/pydantic_utilities.py b/src/axiomatic/core/pydantic_utilities.py
@@ -79,7 +79,7 @@ def to_jsonable_with_fallback(
 class UniversalBaseModel(pydantic.BaseModel):
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(
-            # Allow fields begining with `model_` to be used in the model
+            # Allow fields beginning with `model_` to be used in the model
             protected_namespaces=(),
         )  # type: ignore # Pydantic v2
 
@@ -128,7 +128,7 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]:
         Override the default dict method to `exclude_unset` by default. This function patches
         `exclude_unset` to work include fields within non-None default values.
         """
-        # Note: the logic here is multi-plexed given the levers exposed in Pydantic V1 vs V2
+        # Note: the logic here is multiplexed given the levers exposed in Pydantic V1 vs V2
         # Pydantic V1's .dict can be extremely slow, so we do not want to call it twice.
         #
         # We'd ideally do the same for Pydantic V2, but it shells out to a library to serialize models
diff --git a/src/axiomatic/equation_processing/__init__.py b/src/axiomatic/equation_processing/__init__.py
@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+
diff --git a/src/axiomatic/equation_processing/client.py b/src/axiomatic/equation_processing/client.py
@@ -0,0 +1,158 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ..core.client_wrapper import SyncClientWrapper
+from .. import core
+from ..core.request_options import RequestOptions
+from ..types.equation_extraction_response import EquationExtractionResponse
+from ..core.pydantic_utilities import parse_obj_as
+from ..errors.unprocessable_entity_error import UnprocessableEntityError
+from ..types.http_validation_error import HttpValidationError
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class EquationProcessingClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def extract_from_document(
+        self, *, document: core.File, request_options: typing.Optional[RequestOptions] = None
+    ) -> EquationExtractionResponse:
+        """
+        Extract equations from a document into the database
+
+        Parameters
+        ----------
+        document : core.File
+            See core.File for more documentation
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        EquationExtractionResponse
+            Successful Response
+
+        Examples
+        --------
+        from axiomatic import Axiomatic
+
+        client = Axiomatic(
+            api_key="YOUR_API_KEY",
+        )
+        client.equation_processing.extract_from_document()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "equations/",
+            method="POST",
+            data={},
+            files={
+                "document": document,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    EquationExtractionResponse,
+                    parse_obj_as(
+                        type_=EquationExtractionResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    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, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncEquationProcessingClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def extract_from_document(
+        self, *, document: core.File, request_options: typing.Optional[RequestOptions] = None
+    ) -> EquationExtractionResponse:
+        """
+        Extract equations from a document into the database
+
+        Parameters
+        ----------
+        document : core.File
+            See core.File for more documentation
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        EquationExtractionResponse
+            Successful Response
+
+        Examples
+        --------
+        import asyncio
+
+        from axiomatic import AsyncAxiomatic
+
+        client = AsyncAxiomatic(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.equation_processing.extract_from_document()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "equations/",
+            method="POST",
+            data={},
+            files={
+                "document": document,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    EquationExtractionResponse,
+                    parse_obj_as(
+                        type_=EquationExtractionResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 422:
+                raise UnprocessableEntityError(
+                    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, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
diff --git a/src/axiomatic/types/__init__.py b/src/axiomatic/types/__init__.py
diff --git a/src/axiomatic/types/equation_extraction.py b/src/axiomatic/types/equation_extraction.py
diff --git a/src/axiomatic/types/equation_extraction_response.py b/src/axiomatic/types/equation_extraction_response.py

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ def get_headers(self) -> typing.Dict[str, str]:`
`16`	`16`	`headers: typing.Dict[str, str] = {`
`17`	`17`	`"X-Fern-Language": "Python",`
`18`	`18`	`"X-Fern-SDK-Name": "axiomatic",`
`19`		`- "X-Fern-SDK-Version": "0.0.82",`
	`19`	`+ "X-Fern-SDK-Version": "0.0.83",`
`20`	`20`	`}`
`21`	`21`	`headers["X-API-Key"] = self.api_key`
`22`	`22`	`return headers`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# This file was auto-generated by Fern from our API Definition.`
	`2`	`+`