api-reference.md

API Reference

extract_pii

::: openmed.extract_pii

deidentify

::: openmed.deidentify

reidentify

::: openmed.reidentify

Structured errors

The complete hierarchy, compatibility guarantees, and REST/MCP mappings are documented in Structured public errors.

OpenMedError

::: openmed.core.errors.OpenMedError

InputError

::: openmed.core.errors.InputError

ConfigurationError

::: openmed.core.errors.ConfigurationError

CapabilityError

::: openmed.core.errors.CapabilityError

MissingExtraError

::: openmed.core.errors.MissingExtraError

ModelLoadError

::: openmed.core.errors.ModelLoadError

PolicyError

::: openmed.core.errors.PolicyError

BudgetExceededError

::: openmed.core.errors.BudgetExceededError

InternalError

::: openmed.core.errors.InternalError

InferenceError

::: openmed.core.errors.InferenceError

redact_detail

::: openmed.core.errors.redact_detail

analyze_text

::: openmed.analyze_text

list_models

::: openmed.list_models

BatchProcessor

::: openmed.BatchProcessor

PIIEntity

::: openmed.PIIEntity

DeidentificationResult

::: openmed.DeidentificationResult

PDF redaction and fidelity

::: openmed.multimodal.render_redacted_pdf

::: openmed.multimodal.verify_redacted_pdf

::: openmed.multimodal.verify_redacted_text_removed

::: openmed.multimodal.measure_pdf_layout_fidelity

PipelineTelemetry

::: openmed.core.telemetry.PipelineTelemetry

StageTelemetry

::: openmed.core.telemetry.StageTelemetry