Skip to content

API reference

trialdesignbench

TrialDesignBench workflow tooling.

CodexRunArtifact

Bases: BaseModel

Files created around a local Codex run.

CodexRunner

Bases: Protocol

Interface used by the step 1 pipeline to run an agent prompt.

run(*, prompt, run_directory, model, codex_bin=None, effort=DEFAULT_CODEX_EFFORT)

Run Codex and return persisted artifacts.

ConversionArtifact

Bases: BaseModel

Files and Mathpix metadata created from a source PDF.

read_text()

Read the converted Mathpix Markdown text from disk.

LocalCodexRunner dataclass

Run the prompt against a locally installed OpenAI Codex SDK/runtime.

MathpixClient dataclass

Client for uploading PDFs to Mathpix and downloading converted text.

convert_pdf(pdf_path, output_dir, *, save_tex_zip=False, poll_interval_seconds=5.0, timeout_seconds=600.0)

Convert a PDF to Mathpix Markdown and optionally save a LaTeX ZIP.

download_bytes(pdf_id, extension)

Download a completed Mathpix PDF result by extension.

download_text(pdf_id)

Download Mathpix Markdown for a completed PDF job.

submit_pdf(pdf_path, *, save_tex_zip=False)

Submit a local PDF file to Mathpix for asynchronous OCR.

wait_for_conversion(pdf_id, conversion_format, *, poll_interval_seconds, timeout_seconds)

Poll Mathpix until a requested conversion format is ready.

wait_for_pdf(pdf_id, *, poll_interval_seconds, timeout_seconds)

Poll Mathpix until PDF OCR completes or fails.

MathpixError

Bases: RuntimeError

Raised when Mathpix rejects a request or returns an unusable response.

StepOnePipeline dataclass

Ingest a SAP/protocol PDF and optionally execute Codex reproduction.

convert(pdf_path, *, save_tex_zip=False, poll_interval_seconds=5.0, timeout_seconds=600.0)

Convert a SAP/protocol PDF into Mathpix Markdown.

run(pdf_path, *, case_id=None, run_codex=True, save_tex_zip=False, model=None, codex_bin=None, effort=DEFAULT_CODEX_EFFORT, poll_interval_seconds=5.0, timeout_seconds=600.0)

Run workflow step 1 for one SAP/protocol PDF.

StepOneResult

Bases: BaseModel

Combined result for workflow step 1.

TdbConfig dataclass

Runtime configuration loaded from a workspace .env file.

build_reproduction_prompt(*, document_text, source_name, case_id=None)

Build the standard workflow step 1 prompt for a converted SAP/protocol.

configure_workspace(workspace, *, mathpix_app_id, mathpix_app_key, codex_model=DEFAULT_CODEX_MODEL, codex_bin=None)

Write user configuration values into the workspace .env file.

create_workspace(path)

Create a local TrialDesignBench workspace.

load_config(workspace)

Load configuration from a workspace .env file.