client.trigger_error_sentry_debug_get()
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.trigger_error_sentry_debug_get()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.health_check_health_check_get()
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.health_check_health_check_get()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.lean.formalize(...)
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.lean.formalize( query="query", )
-
-
-
query:
str
-
universe:
typing.Optional[str]
-
k_best:
typing.Optional[int]
-
max_attempts:
typing.Optional[int]
-
verbose:
typing.Optional[bool]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.lean.execute(...)
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.lean.execute( code="code", )
-
-
-
code:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.lean.suggest(...)
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.lean.suggest( prompt="prompt", code_prefix="code_prefix", )
-
-
-
prompt:
str
-
code_prefix:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.lean.prove(...)
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.lean.prove( code="code", )
-
-
-
code:
str
-
universe:
typing.Optional[str]
-
k_best:
typing.Optional[int]
-
max_attempts:
typing.Optional[int]
-
verbose:
typing.Optional[bool]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.formalization.formalize(...)
-
-
-
Formalize a query into a dictionary of constraints
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.formalization.formalize( query="query", )
-
-
-
query:
str
-
domain:
typing.Optional[typing.Literal["PIC"]]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.formalization.validate(...)
-
-
-
Validate a set of values with respect to a dictionary of constraints
-
-
-
from axiomatic import Axiomatic, FormalizeResponse client = Axiomatic( api_key="YOUR_API_KEY", ) client.formalization.validate( constraints=FormalizeResponse( variables={"key": "value"}, expressions=[], ), values={"key": "value"}, )
-
-
-
constraints:
FormalizeResponse
-
values:
typing.Dict[str, str]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.text(...)
-
-
-
Extracts text from documents
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.text()
-
-
-
file: `from future import annotations
core.File` — See core.File for more documentation
-
method:
typing.Optional[str]— Method to use for text-only extraction.It uses a very simple pdf text extractor.
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.parse(...)
-
-
-
Extracts text from files. It uses advanced pdf segmentation.
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.parse()
-
-
-
file: `from future import annotations
core.File` — See core.File for more documentation
-
method:
typing.Optional[ParseMethods]— Method to use for text extraction
-
ocr:
typing.Optional[bool]— Whether to use OCR
-
layout_model:
typing.Optional[str]— Method for layout parsing
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.parse_from_arxiv_url(...)
-
-
-
Extracts text from arxiv urls. It uses advanced pdf segmentation.
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.parse_from_arxiv_url()
-
-
-
arxiv_url:
typing.Optional[str]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.constants(...)
-
-
-
Extracts specific constants from documents
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.constants( constants=["constants"], )
-
-
-
file: `from future import annotations
core.File` — See core.File for more documentation
-
constants:
typing.List[str]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.tools.schedule(...)
-
-
-
Schedule a job to execute python code for long running executions and return the standard output. If an error occurs, it will be returned in the error_trace field. The Following tools are currently supported: fdtd, femwell, optiland, jaxfem
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.tools.schedule( tool_name="tool_name", code="code", )
-
-
-
tool_name:
str
-
code:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.tools.status(...)
-
-
-
Get the status of the remote execution job for a given tool using the job_id
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.tools.status( job_id="job_id", )
-
-
-
job_id:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.tools.list()
-
-
-
Get the list of available tools to execute code.
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.tools.list()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.digital_twin.optimize(...)
-
-
-
Fits a digital twin model to input data using numerical optimization.
Accepts parameter guesses, bounds, inputs, targets, and constants — all with units — and returns the optimized parameters that minimize the model's error using a selected cost function. Args: OptimizerBody: The input data and optimization parameters. Returns: OptimizerResult: The result of the optimization.
-
-
-
from axiomatic import ( Axiomatic, NamedQuantity, NamedQuantityList, ParameterBound, Quantity, ) client = Axiomatic( api_key="YOUR_API_KEY", ) client.digital_twin.optimize( model_name="RingModulatorSiliconOnInsulatorAllPassWavelength", parameters=[ NamedQuantity( name="name", value=Quantity( magnitude=1.1, unit="unit", ), ) ], parameter_bounds=[ ParameterBound( name="name", lower=Quantity( magnitude=1.1, unit="unit", ), upper=Quantity( magnitude=1.1, unit="unit", ), ) ], constants=[ NamedQuantity( name="name", value=Quantity( magnitude=1.1, unit="unit", ), ) ], input=NamedQuantityList( name="name", unit="unit", magnitudes=[1.1], ), target=NamedQuantityList( name="name", unit="unit", magnitudes=[1.1], ), )
-
-
-
model_name:
ModelNames
-
parameters:
typing.Sequence[NamedQuantity]
-
parameter_bounds:
typing.Sequence[ParameterBound]
-
constants:
typing.Sequence[NamedQuantity]
-
input:
NamedQuantityList
-
target:
NamedQuantityList
-
tolerance:
typing.Optional[float]
-
max_time:
typing.Optional[int]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.digital_twin.evaluate(...)
-
-
-
Evaluate Digital Twin Model
This endpoint takes model parameters and target functions as input, then returns the evaluated values for each target function using the specified model. It can be used for model validation, simulation, and prediction tasks.
-
-
-
from axiomatic import ( Axiomatic, EvaluatePoint, InputValues, NamedQuantity, Quantity, ) client = Axiomatic( api_key="YOUR_API_KEY", ) client.digital_twin.evaluate( model_name="RingModulatorSiliconOnInsulatorAllPassWavelength", parameters=[ NamedQuantity( name="name", value=Quantity( magnitude=1.1, unit="unit", ), ) ], target_function="delta_n_eff", target_unit="target_unit", input_values=InputValues( name="name", unit="unit", points=[ EvaluatePoint( value_x=1.1, percentage_coord_x=1.1, value_y=1.1, percentage_coord_y=1.1, ) ], ), )
-
-
-
model_name:
ModelNames
-
parameters:
typing.Sequence[NamedQuantity]
-
target_function:
Targets
-
target_unit:
str
-
input_values:
InputValues
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.digital_twin.list_models()
-
-
-
Retrieves a list of available digital twin models and their parameter definitions.
Returns the name, description (if available), and parameter details (name, unit, lower and upper bound) for each model.
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.digital_twin.list_models()
-
-
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.code_execution.python.execute(...)
-
-
-
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
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.code_execution.python.execute( code="code", )
-
-
-
code:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.plot.points(...)
-
-
-
Extracts points from plots
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.plot.points()
-
-
-
plot_img: `from future import annotations
core.File` — See core.File for more documentation
-
method:
typing.Optional[int]— Can specify a specific method to extract points
-
plot_info:
typing.Optional[str]— Can add specific plot info
-
get_img_coords:
typing.Optional[bool]— Whether to get coords of points on image
-
v2:
typing.Optional[bool]— Get v2 of plot parser output. (v1 will be deprecated soon)
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.plot.split(...)
-
-
-
Splits a plot into multiple subplots if they exist
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.plot.split()
-
-
-
plot_img: `from future import annotations
core.File` — See core.File for more documentation
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.expression.validate(...)
-
-
-
Validates a set of variables against stored expressions to check for inconsistencies. Returns validation results for each relevant expression.
-
-
-
from axiomatic import ( Axiomatic, Expression, ExpressionProcessingResponse, Symbol, ValidationRequirement, ValidationResult, ) client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.expression.validate( variables=[ ValidationRequirement( symbol=Symbol( name="name", wolfram_format="wolfram_format", latex_representation="latex_representation", dimension="dimension", description="description", type="scalar", validations={ "key": ValidationResult( is_valid=True, message="message", ) }, ), value=1.1, ) ], paper_expressions=ExpressionProcessingResponse( expressions=[ Expression( name="name", description="description", original_format="original_format", wolfram_expression="wolfram_expression", symbols={ "key": Symbol( name="name", wolfram_format="wolfram_format", latex_representation="latex_representation", dimension="dimension", description="description", type="scalar", validations={ "key": ValidationResult( is_valid=True, message="message", ) }, ) }, narrative_assumptions=["narrative_assumptions"], exp_validations={ "key": ValidationResult( is_valid=True, message="message", ) }, ) ], ), )
-
-
-
variables:
typing.Sequence[ValidationRequirement]
-
paper_expressions:
ExpressionProcessingResponse
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.expression.process_depricated_version(...)
-
-
-
Process all expressions at once and return their annotation
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.expression.process_depricated_version( markdown="markdown", )
-
-
-
markdown:
str
-
images:
typing.Optional[typing.Dict[str, str]]
-
interline_equations:
typing.Optional[typing.Sequence[str]]
-
inline_equations:
typing.Optional[typing.Sequence[str]]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.expression.process(...)
-
-
-
process expressions from document in parallel
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.expression.process( markdown="markdown", )
-
-
-
markdown:
str
-
images:
typing.Optional[typing.Dict[str, str]]
-
interline_equations:
typing.Optional[typing.Sequence[str]]
-
inline_equations:
typing.Optional[typing.Sequence[str]]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.document.expression.sympy_plot(...)
-
-
-
generate a sympy plot for a given expression
-
-
-
from axiomatic import ( Axiomatic, Expression, Symbol, SympyPlotVariable, ValidationResult, ) client = Axiomatic( api_key="YOUR_API_KEY", ) client.document.expression.sympy_plot( expression=Expression( name="name", description="description", original_format="original_format", wolfram_expression="wolfram_expression", symbols={ "key": Symbol( name="name", wolfram_format="wolfram_format", latex_representation="latex_representation", dimension="dimension", description="description", type="scalar", validations={ "key": ValidationResult( is_valid=True, message="message", ) }, ) }, narrative_assumptions=["narrative_assumptions"], exp_validations={ "key": ValidationResult( is_valid=True, message="message", ) }, ), variables=[ SympyPlotVariable( symbol="symbol", span=[1.1], feature="x", ) ], )
-
-
-
expression:
Expression
-
variables:
typing.Sequence[SympyPlotVariable]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.formalization.constraints.verify(...)
-
-
-
Verifies that a set of constraints are consistent
-
-
-
from axiomatic import Axiomatic, FormalizeResponse client = Axiomatic( api_key="YOUR_API_KEY", ) client.formalization.constraints.verify( constraints=FormalizeResponse( variables={"key": "value"}, expressions=[], ), )
-
-
-
constraints:
FormalizeResponse
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.formalization.solution.find(...)
-
-
-
Finds a solution to a set of constraints provided partial values
-
-
-
from axiomatic import Axiomatic, FormalizeResponse client = Axiomatic( api_key="YOUR_API_KEY", ) client.formalization.solution.find( constraints=FormalizeResponse( variables={"key": "value"}, expressions=[], ), values={"key": 1}, )
-
-
-
constraints:
FormalizeResponse
-
values:
typing.Dict[str, SolutionBodyValuesValue]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.fso.lens.generate(...)
-
-
-
Generate GDS factory code to create a PIC component
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.fso.lens.generate( query="query", )
-
-
-
query:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.lean.z3.execute(...)
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.lean.z3.execute( code="code", )
-
-
-
code:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.document.summarize(...)
-
-
-
Summarize a PIC document
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.document.summarize( markdown="markdown", images={"key": "value"}, )
-
-
-
markdown:
str
-
images:
typing.Dict[str, str]
-
question:
typing.Optional[str]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.parse(...)
-
-
-
Parse a piece of text into a valid formal statement, if possible.
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.parse( text="text", )
-
-
-
text:
str
-
informalize:
typing.Optional[bool]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.informalize(...)
-
-
-
Informalize a formal statement about a circuit into a natural language text.
-
-
-
from axiomatic import Axiomatic, ParameterConstraint client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.informalize( statement=ParameterConstraint( text="text", ), )
-
-
-
statement:
Statement
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.validate(...)
-
-
-
Validates a set of statements against a netlist.
-
-
-
from axiomatic import Axiomatic, Netlist, StatementDictionary client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.validate( netlist=Netlist(), statements=StatementDictionary(), )
-
-
-
netlist:
Netlist
-
statements:
StatementDictionary
-
mapping:
typing.Optional[typing.Dict[str, typing.Optional[Computation]]]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.formalize(...)
-
-
-
Formalize a query about a circuit into a dictionary of constraints. Extends previous statements if provided.
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.formalize( query="query", )
-
-
-
query:
str
-
pdk:
typing.Optional[PdkType]
-
statements:
typing.Optional[StatementDictionary]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.mapping(...)
-
-
-
Map variables in the constraints to computations on the netlist.
-
-
-
from axiomatic import Axiomatic, Netlist, StatementDictionary client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.mapping( statements=StatementDictionary(), netlist=Netlist(), )
-
-
-
statements:
StatementDictionary
-
netlist:
Netlist
-
max_iter:
typing.Optional[int]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.generate(...)
-
-
-
Generate GDS factory code to create a circuit
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.generate( query="query", )
-
-
-
query:
str
-
max_iterations:
typing.Optional[int]
-
llm_model:
typing.Optional[str]
-
apply_orientation:
typing.Optional[bool]
-
apply_placement:
typing.Optional[bool]
-
apply_routing:
typing.Optional[bool]
-
return_cell:
typing.Optional[bool]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.refine(...)
-
-
-
Refine GDS factory code to create a circuit
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.refine( query="query", )
-
-
-
query:
str
-
max_iterations:
typing.Optional[int]
-
feedback:
typing.Optional[str]
-
code:
typing.Optional[str]
-
llm_model:
typing.Optional[str]
-
apply_orientation:
typing.Optional[bool]
-
apply_placement:
typing.Optional[bool]
-
apply_routing:
typing.Optional[bool]
-
return_cell:
typing.Optional[bool]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.optimize(...)
-
-
-
Optimize a PIC circuit with given cost and constraints
-
-
-
from axiomatic import Axiomatic, Netlist, StatementDictionary client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.optimize( netlist=Netlist(), statements=StatementDictionary(), )
-
-
-
netlist:
Netlist
-
statements:
StatementDictionary
-
parameters:
typing.Optional[typing.Sequence[Parameter]]
-
mapping:
typing.Optional[typing.Dict[str, typing.Optional[Computation]]]
-
config:
typing.Optional[OptimizeConfig]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.placementoptimize(...)
-
-
-
Optimizes the placement of a circuit
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.placementoptimize( netlist={"key": "value"}, )
-
-
-
netlist:
typing.Dict[str, typing.Optional[typing.Any]]
-
method:
typing.Optional[str]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.verify(...)
-
-
-
Verifies that the code for a circuit
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.verify( code="code", )
-
-
-
code:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.get_sax_spectrum(...)
-
-
-
Get the spectrum of a circuit over various wavelengths and settings
-
-
-
from axiomatic import Axiomatic, Netlist client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.get_sax_spectrum( netlist=Netlist(), wavelengths=[1.1], )
-
-
-
netlist:
Netlist
-
wavelengths:
typing.Sequence[float]
-
port_pairs:
typing.Optional[typing.Sequence[typing.Sequence[typing.Optional[typing.Any]]]]
-
settings:
typing.Optional[Settings]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.get_optimizable_parameters(...)
-
-
-
Gets the optimizable parameters of a circuit.
-
-
-
from axiomatic import Axiomatic, Netlist client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.get_optimizable_parameters( netlist=Netlist(), )
-
-
-
netlist:
Netlist
-
get_key_parameters:
typing.Optional[bool]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.circuit.update_code(...)
-
-
-
Update GDS code to match the netlist
-
-
-
from axiomatic import Axiomatic, Netlist client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.circuit.update_code( code="code", netlist=Netlist(), )
-
-
-
code:
str
-
netlist:
Netlist
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.component.generate(...)
-
-
-
Generate GDS factory code to create a PIC component
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.component.generate( query="query", )
-
-
-
query:
str
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-
client.pic.component.refine(...)
-
-
-
Refine GDS factory code to create a circuit
-
-
-
from axiomatic import Axiomatic client = Axiomatic( api_key="YOUR_API_KEY", ) client.pic.component.refine( query="query", )
-
-
-
query:
str
-
feedback:
typing.Optional[str]
-
code:
typing.Optional[str]
-
request_options:
typing.Optional[RequestOptions]— Request-specific configuration.
-
-