Release 0.0.98

Author: fern-api[bot]

pyproject.toml

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

reference.md

@@ -902,8 +902,8 @@ client.tools.list()
 </dl>
 </details>
 
-## EquationValidation
-<details><summary><code>client.equation_validation.<a href="src/axiomatic/equation_validation/client.py">validate_equations</a>(...)</code></summary>
+## CodeExecution Python
+<details><summary><code>client.code_execution.python.<a href="src/axiomatic/code_execution/python/client.py">execute</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -915,8 +915,7 @@ client.tools.list()
 <dl>
 <dd>
 
-Validates a set of variables against stored equations to check for inconsistencies.
-Returns validation results for each relevant equation.
+Execute python code, and return the standard output. If an error occurs, it will be returned in the error_trace field. Importing from the following modules is supported: gdsfactory, z3, json
 </dd>
 </dl>
 </dd>
@@ -931,21 +930,13 @@ 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.equation_validation.validate_equations(
-    request=[
-        VariableRequirement(
-            symbol="symbol",
-            name="name",
-            value=1.1,
-            units="units",
-            tolerance=1.1,
-        )
-    ],
+client.code_execution.python.execute(
+    code="code",
 )
 
 ```
@@ -962,7 +953,7 @@ client.equation_validation.validate_equations(
 <dl>
 <dd>
 
-**request:** `typing.Sequence[VariableRequirement]` 
+**code:** `str` 
 
 </dd>
 </dl>
@@ -982,8 +973,8 @@ client.equation_validation.validate_equations(
 </dl>
 </details>
 
-## EquationProcessing
-<details><summary><code>client.equation_processing.<a href="src/axiomatic/equation_processing/client.py">get_all_variables</a>()</code></summary>
+## Document Plot
+<details><summary><code>client.document.plot.<a href="src/axiomatic/document/plot/client.py">points</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -995,7 +986,7 @@ client.equation_validation.validate_equations(
 <dl>
 <dd>
 
-Get all avail. vars to allow user choose requirements
+Extracts points from plots
 </dd>
 </dl>
 </dd>
@@ -1015,7 +1006,7 @@ from axiomatic import Axiomatic
 client = Axiomatic(
     api_key="YOUR_API_KEY",
 )
-client.equation_processing.get_all_variables()
+client.document.plot.points()
 
 ```
 </dd>
@@ -1031,6 +1022,40 @@ client.equation_processing.get_all_variables()
 <dl>
 <dd>
 
+**plot_img:** `from __future__ import annotations
+
+core.File` — See core.File for more documentation
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**method:** `typing.Optional[int]` — Can specify a specific method to extract points
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**plot_info:** `typing.Optional[str]` — Can add specific plot info
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**get_img_coords:** `typing.Optional[bool]` — Whether to get coords of points on image
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
 
 </dd>
@@ -1043,7 +1068,8 @@ client.equation_processing.get_all_variables()
 </dl>
 </details>
 
-<details><summary><code>client.equation_processing.<a href="src/axiomatic/equation_processing/client.py">extract_from_document</a>(...)</code></summary>
+## Document Equation
+<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">user_variables</a>()</code></summary>
 <dl>
 <dd>
 
@@ -1055,7 +1081,7 @@ client.equation_processing.get_all_variables()
 <dl>
 <dd>
 
-Extract equations from a document into the database
+Get all variables from the DB so the user can choose which variables they want to use in axtract for for their consistency checks.
 </dd>
 </dl>
 </dd>
@@ -1075,7 +1101,7 @@ from axiomatic import Axiomatic
 client = Axiomatic(
     api_key="YOUR_API_KEY",
 )
-client.equation_processing.extract_from_document()
+client.document.equation.user_variables()
 
 ```
 </dd>
@@ -1091,9 +1117,78 @@ client.equation_processing.extract_from_document()
 <dl>
 <dd>
 
-**document:** `from __future__ import annotations
+**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+    
+</dd>
+</dl>
+</dd>
+</dl>
 
-core.File` — See core.File for more documentation
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">validate</a>(...)</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Validates a set of variables against stored equations to check for inconsistencies.
+Returns validation results for each relevant equation.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```python
+from axiomatic import Axiomatic, VariableRequirement
+
+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,
+        )
+    ],
+)
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `typing.Sequence[VariableRequirement]` 
 
 </dd>
 </dl>
@@ -1113,8 +1208,7 @@ core.File` — See core.File for more documentation
 </dl>
 </details>
 
-## CodeExecution Python
-<details><summary><code>client.code_execution.python.<a href="src/axiomatic/code_execution/python/client.py">execute</a>(...)</code></summary>
+<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">from_pdf</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -1126,7 +1220,7 @@ core.File` — See core.File for more documentation
 <dl>
 <dd>
 
-Execute python code, and return the standard output. If an error occurs, it will be returned in the error_trace field. Importing from the following modules is supported: gdsfactory, z3, json
+Extract equations from a document into the database
 </dd>
 </dl>
 </dd>
@@ -1146,9 +1240,7 @@ from axiomatic import Axiomatic
 client = Axiomatic(
     api_key="YOUR_API_KEY",
 )
-client.code_execution.python.execute(
-    code="code",
-)
+client.document.equation.from_pdf()
 
 ```
 </dd>
@@ -1164,7 +1256,9 @@ client.code_execution.python.execute(
 <dl>
 <dd>
 
-**code:** `str` 
+**document:** `from __future__ import annotations
+
+core.File` — See core.File for more documentation
 
 </dd>
 </dl>
@@ -1184,8 +1278,7 @@ client.code_execution.python.execute(
 </dl>
 </details>
 
-## Document Plot
-<details><summary><code>client.document.plot.<a href="src/axiomatic/document/plot/client.py">points</a>(...)</code></summary>
+<details><summary><code>client.document.equation.<a href="src/axiomatic/document/equation/client.py">process</a>(...)</code></summary>
 <dl>
 <dd>
 
@@ -1197,7 +1290,7 @@ client.code_execution.python.execute(
 <dl>
 <dd>
 
-Extracts points from plots
+Process all equations at once and return their annotation
 </dd>
 </dl>
 </dd>
@@ -1217,7 +1310,9 @@ from axiomatic import Axiomatic
 client = Axiomatic(
     api_key="YOUR_API_KEY",
 )
-client.document.plot.points()
+client.document.equation.process(
+    markdown="markdown",
+)
 
 ```
 </dd>
@@ -1233,33 +1328,31 @@ client.document.plot.points()
 <dl>
 <dd>
 
-**plot_img:** `from __future__ import annotations
-
-core.File` — See core.File for more documentation
+**markdown:** `str` 
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**method:** `typing.Optional[int]` — Can specify a specific method to extract points
+**images:** `typing.Optional[typing.Dict[str, str]]` 
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**plot_info:** `typing.Optional[str]` — Can add specific plot info
+**interline_equations:** `typing.Optional[typing.Sequence[str]]` 
 
 </dd>
 </dl>
 
 <dl>
 <dd>
 
-**get_img_coords:** `typing.Optional[bool]` — Whether to get coords of points on image
+**inline_equations:** `typing.Optional[typing.Sequence[str]]` 
 
 </dd>
 </dl>