@@ -1129,7 +1129,7 @@ client.document.equation.user_variables()
11291129</dl >
11301130</details >
11311131
1132- <details ><summary ><code >client.document.equation.<a href =" src/axiomatic/document/equation/client.py " >validate </a >(...)</code ></summary >
1132+ <details ><summary ><code >client.document.equation.<a href =" src/axiomatic/document/equation/client.py " >from_pdf </a >(...)</code ></summary >
11331133<dl >
11341134<dd >
11351135
@@ -1141,8 +1141,7 @@ client.document.equation.user_variables()
11411141<dl >
11421142<dd >
11431143
1144- Validates a set of variables against stored equations to check for inconsistencies.
1145- Returns validation results for each relevant equation.
1144+ Extract equations from a document into the database
11461145</dd >
11471146</dl >
11481147</dd >
@@ -1157,22 +1156,12 @@ Returns validation results for each relevant equation.
11571156<dd >
11581157
11591158``` python
1160- from axiomatic import Axiomatic, VariableRequirement
1159+ from axiomatic import Axiomatic
11611160
11621161client = Axiomatic(
11631162 api_key = " YOUR_API_KEY" ,
11641163)
1165- client.document.equation.validate(
1166- request = [
1167- VariableRequirement(
1168- symbol = " symbol" ,
1169- name = " name" ,
1170- value = 1.1 ,
1171- units = " units" ,
1172- tolerance = 1.1 ,
1173- )
1174- ],
1175- )
1164+ client.document.equation.from_pdf()
11761165
11771166```
11781167</dd >
@@ -1188,7 +1177,9 @@ client.document.equation.validate(
11881177<dl >
11891178<dd >
11901179
1191- ** request:** ` typing.Sequence[VariableRequirement] `
1180+ ** document:** `from __ future__ import annotations
1181+
1182+ core.File` — See core.File for more documentation
11921183
11931184</dd >
11941185</dl >
@@ -1208,7 +1199,7 @@ client.document.equation.validate(
12081199</dl >
12091200</details >
12101201
1211- <details ><summary ><code >client.document.equation.<a href =" src/axiomatic/document/equation/client.py " >from_pdf </a >(...)</code ></summary >
1202+ <details ><summary ><code >client.document.equation.<a href =" src/axiomatic/document/equation/client.py " >process </a >(...)</code ></summary >
12121203<dl >
12131204<dd >
12141205
@@ -1220,7 +1211,7 @@ client.document.equation.validate(
12201211<dl >
12211212<dd >
12221213
1223- Extract equations from a document into the database
1214+ Process all equations at once and return their annotation
12241215</dd >
12251216</dl >
12261217</dd >
@@ -1240,7 +1231,9 @@ from axiomatic import Axiomatic
12401231client = Axiomatic(
12411232 api_key = " YOUR_API_KEY" ,
12421233)
1243- client.document.equation.from_pdf()
1234+ client.document.equation.process(
1235+ markdown = " markdown" ,
1236+ )
12441237
12451238```
12461239</dd >
@@ -1256,9 +1249,31 @@ client.document.equation.from_pdf()
12561249<dl >
12571250<dd >
12581251
1259- ** document:** `from __ future__ import annotations
1252+ ** markdown:** ` str `
1253+
1254+ </dd >
1255+ </dl >
12601256
1261- core.File` — See core.File for more documentation
1257+ <dl >
1258+ <dd >
1259+
1260+ ** images:** ` typing.Optional[typing.Dict[str, str]] `
1261+
1262+ </dd >
1263+ </dl >
1264+
1265+ <dl >
1266+ <dd >
1267+
1268+ ** interline_equations:** ` typing.Optional[typing.Sequence[str]] `
1269+
1270+ </dd >
1271+ </dl >
1272+
1273+ <dl >
1274+ <dd >
1275+
1276+ ** inline_equations:** ` typing.Optional[typing.Sequence[str]] `
12621277
12631278</dd >
12641279</dl >
@@ -1278,7 +1293,7 @@ core.File` — See core.File for more documentation
12781293</dl >
12791294</details >
12801295
1281- <details ><summary ><code >client.document.equation.<a href =" src/axiomatic/document/equation/client.py " >process </a >(...)</code ></summary >
1296+ <details ><summary ><code >client.document.equation.<a href =" src/axiomatic/document/equation/client.py " >validate </a >(...)</code ></summary >
12821297<dl >
12831298<dd >
12841299
@@ -1290,7 +1305,8 @@ core.File` — See core.File for more documentation
12901305<dl >
12911306<dd >
12921307
1293- Process all equations at once and return their annotation
1308+ Validates a set of variables against stored equations to check for inconsistencies.
1309+ Returns validation results for each relevant equation.
12941310</dd >
12951311</dl >
12961312</dd >
@@ -1305,13 +1321,47 @@ Process all equations at once and return their annotation
13051321<dd >
13061322
13071323``` python
1308- from axiomatic import Axiomatic
1324+ from axiomatic import (
1325+ Axiomatic,
1326+ DictItem,
1327+ EquationProcessingResponse,
1328+ ResponseEquation,
1329+ VariableRequirement,
1330+ )
13091331
13101332client = Axiomatic(
13111333 api_key = " YOUR_API_KEY" ,
13121334)
1313- client.document.equation.process(
1314- markdown = " markdown" ,
1335+ client.document.equation.validate(
1336+ variables = [
1337+ VariableRequirement(
1338+ symbol = " symbol" ,
1339+ name = " name" ,
1340+ value = 1.1 ,
1341+ units = " units" ,
1342+ tolerance = 1.1 ,
1343+ )
1344+ ],
1345+ paper_equations = EquationProcessingResponse(
1346+ equations = [
1347+ ResponseEquation(
1348+ name = " name" ,
1349+ description = " description" ,
1350+ original_format = " original_format" ,
1351+ wolfram_expressions = " wolfram_expressions" ,
1352+ latex_symbols = [
1353+ DictItem(
1354+ key = " key" ,
1355+ value = " value" ,
1356+ )
1357+ ],
1358+ wolfram_symbols = [" wolfram_symbols" ],
1359+ narrative_assumptions = [" narrative_assumptions" ],
1360+ type = [" type" ],
1361+ field_tags = [" field_tags" ],
1362+ )
1363+ ],
1364+ ),
13151365)
13161366
13171367```
@@ -1328,31 +1378,23 @@ client.document.equation.process(
13281378<dl >
13291379<dd >
13301380
1331- ** markdown:** ` str `
1332-
1333- </dd >
1334- </dl >
1335-
1336- <dl >
1337- <dd >
1338-
1339- ** images:** ` typing.Optional[typing.Dict[str, str]] `
1381+ ** variables:** ` typing.Sequence[VariableRequirement] `
13401382
13411383</dd >
13421384</dl >
13431385
13441386<dl >
13451387<dd >
13461388
1347- ** interline_equations :** ` typing.Optional[typing.Sequence[str]] `
1389+ ** paper_equations :** ` EquationProcessingResponse `
13481390
13491391</dd >
13501392</dl >
13511393
13521394<dl >
13531395<dd >
13541396
1355- ** inline_equations :** ` typing.Optional[typing.Sequence[str] ] `
1397+ ** include_internal_model :** ` typing.Optional[bool ] `
13561398
13571399</dd >
13581400</dl >
@@ -2419,19 +2461,14 @@ Optimize a PIC circuit with given cost and constraints
24192461<dd >
24202462
24212463``` python
2422- from axiomatic import Axiomatic, Netlist, Parameter, StatementDictionary
2464+ from axiomatic import Axiomatic, Netlist, StatementDictionary
24232465
24242466client = Axiomatic(
24252467 api_key = " YOUR_API_KEY" ,
24262468)
24272469client.pic.circuit.optimize(
24282470 netlist = Netlist(),
24292471 statements = StatementDictionary(),
2430- parameters = [
2431- Parameter(
2432- path = " path" ,
2433- )
2434- ],
24352472)
24362473
24372474```
@@ -2464,7 +2501,7 @@ client.pic.circuit.optimize(
24642501<dl >
24652502<dd >
24662503
2467- ** parameters:** ` typing.Sequence[Parameter] `
2504+ ** parameters:** ` typing.Optional[typing. Sequence[Parameter] ] `
24682505
24692506</dd >
24702507</dl >
0 commit comments