Merge branch 'main' of https://github.com/Axiomatic-AI/axiomatic-python-sdk

Author: lsarra-ax

pyproject.toml

@@ -3,7 +3,7 @@ name = "axiomatic"
 
 [tool.poetry]
 name = "axiomatic"
-version = "0.0.117"
+version = "0.0.121"
 description = ""
 readme = "README.md"
 authors = []

reference.md

@@ -1129,7 +1129,7 @@ client.document.equation.user_variables()
 </dl>
 </details>
 
-<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">validate</a>(...)</code></summary>
+<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">from_pdf</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -1141,8 +1141,7 @@ client.document.equation.user_variables()
 <dl>
 <dd>
 
-Validates a set of variables against stored equations to check for inconsistencies.
-Returns validation results for each relevant equation.
+Extract equations from a document into the database
 </dd>
 </dl>
 </dd>
@@ -1157,22 +1156,12 @@ Returns validation results for each relevant equation.
 <dd>
 
 ```python
-from axiomatic import Axiomatic, VariableRequirement
+from axiomatic import Axiomatic
 
 client = Axiomatic(
     api_key="YOUR_API_KEY",
 )
-client.document.equation.validate(
-    request=[
-        VariableRequirement(
-            symbol="symbol",
-            name="name",
-            value=1.1,
-            units="units",
-            tolerance=1.1,
-        )
-    ],
-)
+client.document.equation.from_pdf()
 
 ```
 </dd>
@@ -1188,7 +1177,9 @@ client.document.equation.validate(
 <dl>
 <dd>
 
-**request:** `typing.Sequence[VariableRequirement]` 
+**document:** `from __future__ import annotations
+
+core.File` — See core.File for more documentation
 
 </dd>
 </dl>
@@ -1208,7 +1199,7 @@ client.document.equation.validate(
 </dl>
 </details>
 
-<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">from_pdf</a>(...)</code></summary>
+<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">process</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -1220,7 +1211,7 @@ client.document.equation.validate(
 <dl>
 <dd>
 
-Extract equations from a document into the database
+Process all equations at once and return their annotation
 </dd>
 </dl>
 </dd>
@@ -1240,7 +1231,9 @@ from axiomatic import Axiomatic
 client = Axiomatic(
     api_key="YOUR_API_KEY",
 )
-client.document.equation.from_pdf()
+client.document.equation.process(
+    markdown="markdown",
+)
 
 ```
 </dd>
@@ -1256,9 +1249,31 @@ client.document.equation.from_pdf()
 <dl>
 <dd>
 
-**document:** `from __future__ import annotations
+**markdown:** `str` 
+    
+</dd>
+</dl>
 
-core.File` — See core.File for more documentation
+<dl>
+<dd>
+
+**images:** `typing.Optional[typing.Dict[str, str]]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**interline_equations:** `typing.Optional[typing.Sequence[str]]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**inline_equations:** `typing.Optional[typing.Sequence[str]]` 
 
 </dd>
 </dl>
@@ -1278,7 +1293,7 @@ core.File` — See core.File for more documentation
 </dl>
 </details>
 
-<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">process</a>(...)</code></summary>
+<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">validate</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -1290,7 +1305,8 @@ core.File` — See core.File for more documentation
 <dl>
 <dd>
 
-Process all equations at once and return their annotation
+Validates a set of variables against stored equations to check for inconsistencies.
+Returns validation results for each relevant equation.
 </dd>
 </dl>
 </dd>
@@ -1305,13 +1321,47 @@ Process all equations at once and return their annotation
 <dd>
 
 ```python
-from axiomatic import Axiomatic
+from axiomatic import (
+    Axiomatic,
+    DictItem,
+    EquationProcessingResponse,
+    ResponseEquation,
+    VariableRequirement,
+)
 
 client = Axiomatic(
     api_key="YOUR_API_KEY",
 )
-client.document.equation.process(
-    markdown="markdown",
+client.document.equation.validate(
+    variables=[
+        VariableRequirement(
+            symbol="symbol",
+            name="name",
+            value=1.1,
+            units="units",
+            tolerance=1.1,
+        )
+    ],
+    paper_equations=EquationProcessingResponse(
+        equations=[
+            ResponseEquation(
+                name="name",
+                description="description",
+                original_format="original_format",
+                wolfram_expressions="wolfram_expressions",
+                latex_symbols=[
+                    DictItem(
+                        key="key",
+                        value="value",
+                    )
+                ],
+                wolfram_symbols=["wolfram_symbols"],
+                narrative_assumptions=["narrative_assumptions"],
+                type=["type"],
+                field_tags=["field_tags"],
+            )
+        ],
+    ),
 )
 
 ```
@@ -1328,31 +1378,23 @@ client.document.equation.process(
 <dl>
 <dd>
 
-**markdown:** `str` 
+**variables:** `typing.Sequence[VariableRequirement]` 
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**images:** `typing.Optional[typing.Dict[str, str]]` 
+**paper_equations:** `EquationProcessingResponse` 
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**interline_equations:** `typing.Optional[typing.Sequence[str]]` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**inline_equations:** `typing.Optional[typing.Sequence[str]]` 
+**include_internal_model:** `typing.Optional[bool]` 
 
 </dd>
 </dl>
@@ -1971,6 +2013,14 @@ client.pic.circuit.validate(
 <dl>
 <dd>
 
+**use_ideal_component_models:** `typing.Optional[bool]` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
 
 </dd>

src/axiomatic/axtract/axtract_report.py

@@ -1,5 +1,5 @@
 from .relation_graph import generate_relation_graph
-from .. import EquationExtractionResponse
+from .. import EquationProcessingResponse
 import os
 import re
 
@@ -190,7 +190,7 @@
 """
 
 
-def create_report(report_data: EquationExtractionResponse, report_path: str = "./report.html"):
+def create_report(report_data: EquationProcessingResponse, report_path: str = "./report.html"):
     """
     Creates an HTML report for the extracted equations.
     """