Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- ai.doctruth - package ai.doctruth
-
Public API of DocTruth: auditable LLM extraction for Java.
- ai.doctruth.cli - package ai.doctruth.cli
- ai.doctruth.internal.constraint - package ai.doctruth.internal.constraint
- ai.doctruth.spi - package ai.doctruth.spi
-
Service Provider Interface (SPI) extension points for DocTruth.
- AnthropicProvider - Class in ai.doctruth
-
Anthropic Messages API provider.
- AnthropicProvider(String) - Constructor for class ai.doctruth.AnthropicProvider
-
Build a provider against the public Anthropic endpoint and "claude-sonnet-4-5".
- AnthropicProvider(String, URI, String) - Constructor for class ai.doctruth.AnthropicProvider
-
Build a provider against an explicit endpoint and model name.
- apiKey() - Method in class ai.doctruth.AnthropicProvider
- apiKey() - Method in class ai.doctruth.DeepSeekProvider
- apiKey() - Method in class ai.doctruth.GeminiProvider
- apiKey() - Method in class ai.doctruth.OpenAiProvider
- assemble(ParsedDocument) - Method in interface ai.doctruth.ContextStrategy
-
Render the document into a single user-prompt string, applying this strategy's truncation / windowing rules.
- assemble(ParsedDocument) - Method in record class ai.doctruth.Hierarchical
-
v0.1.0-alpha stub: not yet implemented.
- assemble(ParsedDocument) - Method in record class ai.doctruth.PriorityTruncate
-
Assemble
docinto a single user-prompt string. - assemble(ParsedDocument) - Method in record class ai.doctruth.SlidingWindow
-
Render
docinto a single bounded-prefix window. - at() - Method in record class ai.doctruth.spi.AuditEvent
-
Returns the value of the
atrecord component. - attributes() - Method in record class ai.doctruth.spi.AuditEvent
-
Returns the value of the
attributesrecord component. - AuditEvent - Record Class in ai.doctruth.spi
-
A single audit event emitted by the library — extraction success, extraction failure, citation-below-threshold, etc.
- AuditEvent(String, Instant, Map) - Constructor for record class ai.doctruth.spi.AuditEvent
-
Creates an instance of a
AuditEventrecord class. - AuditEventListener - Interface in ai.doctruth.spi
-
Callback the library invokes for every auditable event.
B
- BlockKind - Enum Class in ai.doctruth
-
Visual / structural classification of a
TextSectionas detected by Layer 1 parsing — a geometric / typographic judgement, NOT a semantic one. - BODY - Enum constant in enum class ai.doctruth.BlockKind
-
A regular body paragraph.
- box() - Method in record class ai.doctruth.spi.OcrRegion
-
Returns the value of the
boxrecord component.
C
- caption() - Method in record class ai.doctruth.FigureSection
-
Returns the value of the
captionrecord component. - charOffset() - Method in record class ai.doctruth.SourceLocation
-
Returns the value of the
charOffsetrecord component. - Citation - Record Class in ai.doctruth
-
The verifiable evidence anchor for a single extracted field.
- Citation(SourceLocation, String, double) - Constructor for record class ai.doctruth.Citation
-
Creates an instance of a
Citationrecord class. - citations() - Method in record class ai.doctruth.ExtractionResult
-
Returns the value of the
citationsrecord component. - complete(ProviderRequest) - Method in class ai.doctruth.AnthropicProvider
- complete(ProviderRequest) - Method in class ai.doctruth.DeepSeekProvider
- complete(ProviderRequest) - Method in class ai.doctruth.GeminiProvider
- complete(ProviderRequest) - Method in interface ai.doctruth.LlmProvider
-
Execute one extraction call against the provider.
- complete(ProviderRequest) - Method in class ai.doctruth.OpenAiProvider
- confidence() - Method in record class ai.doctruth.ExtractionResult
-
Returns the value of the
confidencerecord component. - confidence() - Method in record class ai.doctruth.spi.OcrPageResult
-
Returns the value of the
confidencerecord component. - confidence() - Method in record class ai.doctruth.spi.OcrRegion
-
Returns the value of the
confidencerecord component. - Confidence - Record Class in ai.doctruth
-
A confidence score for a single extracted field, plus a free-form rationale.
- Confidence(double, String) - Constructor for record class ai.doctruth.Confidence
-
Creates an instance of a
Confidencerecord class. - ConstraintSet<T> - Class in ai.doctruth.internal.constraint
- ContextStrategy - Interface in ai.doctruth
-
How a
ParsedDocumentis rendered into the bounded context window of an LLM call. - CsvDocumentParser - Class in ai.doctruth
-
Layer 1 entry point: read a CSV file from disk into a
ParsedDocumentcontaining exactly oneTableSectionthat mirrors the CSV row-major.
D
- DeepSeekProvider - Class in ai.doctruth
-
DeepSeek Chat Completions provider.
- DeepSeekProvider(String) - Constructor for class ai.doctruth.DeepSeekProvider
- DeepSeekProvider(String, URI, String) - Constructor for class ai.doctruth.DeepSeekProvider
- details() - Method in record class ai.doctruth.Provenance
-
Returns the value of the
detailsrecord component. - docId() - Method in record class ai.doctruth.ParsedDocument
-
Returns the value of the
docIdrecord component. - DocTruth - Class in ai.doctruth
-
Public entry point for the library.
- DocTruthCli - Class in ai.doctruth.cli
-
Minimal command-line entry point for build-time migration helpers.
- DocTruthCli() - Constructor for class ai.doctruth.cli.DocTruthCli
- DocumentMetadata - Record Class in ai.doctruth
-
Metadata for a
ParsedDocument: the source filename, total page count, and (optionally) the timestamp at which the source document was authored / published. - DocumentMetadata(String, int, Optional) - Constructor for record class ai.doctruth.DocumentMetadata
-
Creates an instance of a
DocumentMetadatarecord class. - DocxDocumentParser - Class in ai.doctruth
-
Layer 1 entry point: read a DOCX file from disk into a
ParsedDocumentwith oneTextSectionper non-blank paragraph and oneTableSectionper table.
E
- empty() - Static method in class ai.doctruth.internal.constraint.ConstraintSet
- empty(int) - Static method in record class ai.doctruth.spi.OcrPageResult
-
Empty result for blank or non-OCR-able pages.
- endpoint() - Method in class ai.doctruth.OpenAiProvider
- equals(Object) - Method in record class ai.doctruth.Citation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.Confidence
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.DocumentMetadata
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.ExtractionResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.FigureSection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.Hierarchical
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.ParsedDocument
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.PriorityTruncate
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.Provenance
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.ProvenanceDetails
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.ProviderOptions
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.ProviderRequest
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.ProviderResponse
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.ProviderUsage
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.SlidingWindow
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.SourceLocation
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.spi.AuditEvent
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.spi.OcrBox
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.spi.OcrPageResult
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.spi.OcrRegion
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.TableSection
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in record class ai.doctruth.TextSection
-
Indicates whether some other object is "equal to" this one.
- errorCode() - Method in exception class ai.doctruth.ExtractionException
- errorCode() - Method in exception class ai.doctruth.ParseException
- errorCode() - Method in exception class ai.doctruth.ProviderException
- exactQuote() - Method in record class ai.doctruth.Citation
-
Returns the value of the
exactQuoterecord component. - extract(String, Class) - Method in class ai.doctruth.DocTruth
-
Stage an extraction call: pair a free-text prompt with the target type.
- extractedAt() - Method in record class ai.doctruth.Provenance
-
Returns the value of the
extractedAtrecord component. - ExtractionBuilder<T> - Class in ai.doctruth
-
Immutable fluent builder for one extraction call.
- ExtractionException - Exception Class in ai.doctruth
-
Thrown from the public extraction API when an extraction run fails after exhausting retries or when an invariant is violated mid-flight.
- ExtractionException(String, String, int) - Constructor for exception class ai.doctruth.ExtractionException
- ExtractionException(String, String, int, Throwable) - Constructor for exception class ai.doctruth.ExtractionException
- ExtractionResult<T> - Record Class in ai.doctruth
-
The output of
DocTruth.extract(...).run(): the extracted value plus per-field citations, per-field confidence scores, and run-level provenance. - ExtractionResult(T, Map, Map, Provenance) - Constructor for record class ai.doctruth.ExtractionResult
-
Creates an instance of a
ExtractionResultrecord class. - extractJson(String, JsonSchema) - Method in class ai.doctruth.DocTruth
-
Stage a JSON Schema-driven extraction call.
F
- FigureSection - Record Class in ai.doctruth
-
A figure (image, chart, diagram) recovered from the source document, represented by its caption text plus a
SourceLocation. - FigureSection(String, SourceLocation) - Constructor for record class ai.doctruth.FigureSection
-
Creates an instance of a
FigureSectionrecord class. - from(LlmProvider) - Static method in class ai.doctruth.DocTruth
-
Begin an extraction pipeline against the given provider.
- from(String) - Static method in class ai.doctruth.JsonSchema
- from(Path) - Static method in class ai.doctruth.JsonSchema
G
- GeminiProvider - Class in ai.doctruth
-
Google Gemini
generateContentprovider. - GeminiProvider(String) - Constructor for class ai.doctruth.GeminiProvider
-
Production constructor — talks to
generativelanguage.googleapis.com. - GeminiProvider(String, URI, String) - Constructor for class ai.doctruth.GeminiProvider
-
Test / advanced-user constructor: point at an alternative base URL (e.g.
H
- hashCode() - Method in record class ai.doctruth.Citation
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.Confidence
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.DocumentMetadata
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.ExtractionResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.FigureSection
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.Hierarchical
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.ParsedDocument
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.PriorityTruncate
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.Provenance
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.ProvenanceDetails
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.ProviderOptions
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.ProviderRequest
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.ProviderResponse
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.ProviderUsage
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.SlidingWindow
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.SourceLocation
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.spi.AuditEvent
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.spi.OcrBox
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.spi.OcrPageResult
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.spi.OcrRegion
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.TableSection
-
Returns a hash code value for this object.
- hashCode() - Method in record class ai.doctruth.TextSection
-
Returns a hash code value for this object.
- HEADING - Enum constant in enum class ai.doctruth.BlockKind
-
A heading-like block — bigger font OR all-caps short text.
- height() - Method in record class ai.doctruth.spi.OcrBox
-
Returns the value of the
heightrecord component. - height() - Method in record class ai.doctruth.spi.OcrRegion
- Hierarchical - Record Class in ai.doctruth
-
Multi-level summarisation: condense the document at increasing granularities, hand the LLM the level that fits the budget.
- Hierarchical(int) - Constructor for record class ai.doctruth.Hierarchical
-
Creates an instance of a
Hierarchicalrecord class. - httpStatus() - Method in exception class ai.doctruth.ProviderException
I
- IDENTITY - Static variable in interface ai.doctruth.spi.SignatureProvider
-
Identity — returns the JSON unchanged.
- inputTokens() - Method in record class ai.doctruth.ProviderUsage
-
Returns the value of the
inputTokensrecord component.
J
- JsonExtractionBuilder - Class in ai.doctruth
-
Immutable fluent builder for JSON Schema-driven extraction.
- JsonSchema - Class in ai.doctruth
-
Caller-supplied JSON Schema for schema-bound extraction.
K
- kind() - Method in record class ai.doctruth.spi.AuditEvent
-
Returns the value of the
kindrecord component. - kind() - Method in record class ai.doctruth.TextSection
-
Returns the value of the
kindrecord component.
L
- lineEnd() - Method in record class ai.doctruth.SourceLocation
-
Returns the value of the
lineEndrecord component. - lineStart() - Method in record class ai.doctruth.SourceLocation
-
Returns the value of the
lineStartrecord component. - LIST - Enum constant in enum class ai.doctruth.BlockKind
-
A list item (bulleted or numbered).
- LlmProvider - Interface in ai.doctruth
-
The Layer 2 backend abstraction: an LLM API client.
- location() - Method in record class ai.doctruth.Citation
-
Returns the value of the
locationrecord component. - location() - Method in record class ai.doctruth.FigureSection
-
Returns the value of the
locationrecord component. - location() - Method in record class ai.doctruth.TableSection
-
Returns the value of the
locationrecord component. - location() - Method in record class ai.doctruth.TextSection
-
Returns the value of the
locationrecord component.
M
- main(String[]) - Static method in class ai.doctruth.cli.DocTruthCli
- matchScore() - Method in record class ai.doctruth.Citation
-
Returns the value of the
matchScorerecord component. - maxChars() - Method in record class ai.doctruth.PriorityTruncate
-
Returns the value of the
maxCharsrecord component. - maxDepth() - Method in record class ai.doctruth.Hierarchical
-
Returns the value of the
maxDepthrecord component. - maxRetries() - Method in record class ai.doctruth.ProviderOptions
-
Returns the value of the
maxRetriesrecord component. - metadata() - Method in record class ai.doctruth.ParsedDocument
-
Returns the value of the
metadatarecord component. - model() - Method in class ai.doctruth.OpenAiProvider
- model() - Method in record class ai.doctruth.Provenance
-
Returns the value of the
modelrecord component. - modelVersion() - Method in record class ai.doctruth.Provenance
-
Returns the value of the
modelVersionrecord component. - modelVersion() - Method in record class ai.doctruth.ProviderUsage
-
Returns the value of the
modelVersionrecord component.
N
- name() - Method in class ai.doctruth.AnthropicProvider
- name() - Method in class ai.doctruth.DeepSeekProvider
- name() - Method in class ai.doctruth.GeminiProvider
- name() - Method in interface ai.doctruth.LlmProvider
-
Logical lower-case name of the provider, e.g.
- name() - Method in class ai.doctruth.OpenAiProvider
- node() - Method in class ai.doctruth.JsonSchema
- NOOP - Static variable in interface ai.doctruth.spi.AuditEventListener
-
No-op listener — drops every event.
- NOOP - Static variable in interface ai.doctruth.spi.OcrEngine
-
No-op engine — returns empty text on every page.
O
- ocr(BufferedImage, int) - Method in interface ai.doctruth.spi.OcrEngine
-
OCR a single rendered page image.
- OcrBox - Record Class in ai.doctruth.spi
-
Pixel bounding box for one OCR region on a rendered page image.
- OcrBox(int, int, int, int) - Constructor for record class ai.doctruth.spi.OcrBox
-
Creates an instance of a
OcrBoxrecord class. - OcrEngine - Interface in ai.doctruth.spi
-
Optional OCR backend, plugged into
PdfDocumentParserto recover text from scanned (image-only) pages. - OcrPageResult - Record Class in ai.doctruth.spi
-
Output of one
ocrcall. - OcrPageResult(String, double, List, int) - Constructor for record class ai.doctruth.spi.OcrPageResult
-
Creates an instance of a
OcrPageResultrecord class. - OcrRegion - Record Class in ai.doctruth.spi
-
One OCR-recovered text region with its pixel bounding box on the rendered page image.
- OcrRegion(String, int, int, int, int, double) - Constructor for record class ai.doctruth.spi.OcrRegion
- OcrRegion(String, OcrBox, double) - Constructor for record class ai.doctruth.spi.OcrRegion
-
Creates an instance of a
OcrRegionrecord class. - onEvent(AuditEvent) - Method in interface ai.doctruth.spi.AuditEventListener
- onOverBudget() - Method in record class ai.doctruth.PriorityTruncate
-
Returns the value of the
onOverBudgetrecord component. - OpenAiProvider - Class in ai.doctruth
-
OpenAI Chat-Completions API provider.
- OpenAiProvider(String) - Constructor for class ai.doctruth.OpenAiProvider
-
Standard constructor — points at the public OpenAI endpoint with the default model.
- OpenAiProvider(String, URI, String) - Constructor for class ai.doctruth.OpenAiProvider
-
Constructor for callers who need to override the endpoint (Azure-OpenAI / proxy / recorded WireMock) or pin a specific model name.
- options() - Method in record class ai.doctruth.ProviderRequest
-
Returns the value of the
optionsrecord component. - OTHER - Enum constant in enum class ai.doctruth.BlockKind
-
Could not classify — default for parsers that don't analyse layout.
- outputTokens() - Method in record class ai.doctruth.ProviderUsage
-
Returns the value of the
outputTokensrecord component. - OverBudgetPolicy - Enum Class in ai.doctruth
-
What a
PriorityTruncatestrategy does when the priority sections alone exceed the configuredmaxCharsbudget. - overlapChars() - Method in record class ai.doctruth.SlidingWindow
-
Returns the value of the
overlapCharsrecord component.
P
- pageCount() - Method in record class ai.doctruth.DocumentMetadata
-
Returns the value of the
pageCountrecord component. - pageEnd() - Method in record class ai.doctruth.SourceLocation
-
Returns the value of the
pageEndrecord component. - pageNumber() - Method in exception class ai.doctruth.ParseException
- pageNumber() - Method in record class ai.doctruth.spi.OcrPageResult
-
Returns the value of the
pageNumberrecord component. - pageStart() - Method in record class ai.doctruth.SourceLocation
-
Returns the value of the
pageStartrecord component. - parse(Path) - Static method in class ai.doctruth.CsvDocumentParser
-
Parse the CSV at
csvPathinto aParsedDocument. - parse(Path) - Static method in class ai.doctruth.DocxDocumentParser
-
Parse the DOCX at
docxPathinto aParsedDocument. - parse(Path) - Static method in class ai.doctruth.PdfDocumentParser
-
Parse the PDF at
pdfPathinto aParsedDocument. - parse(Path) - Static method in class ai.doctruth.XlsxDocumentParser
-
Parse the XLSX at
xlsxPathinto aParsedDocument. - ParsedDocument - Record Class in ai.doctruth
- ParsedDocument(String, List, DocumentMetadata) - Constructor for record class ai.doctruth.ParsedDocument
-
Creates an instance of a
ParsedDocumentrecord class. - ParsedSection - Interface in ai.doctruth
-
A single section of a parsed source document.
- ParseException - Exception Class in ai.doctruth
-
Thrown by Layer 1 document parsers (PDF / DOCX) when a source file cannot be parsed or when a structural invariant is violated.
- ParseException(String, String, String, OptionalInt) - Constructor for exception class ai.doctruth.ParseException
- ParseException(String, String, String, OptionalInt, Throwable) - Constructor for exception class ai.doctruth.ParseException
- PdfDocumentParser - Class in ai.doctruth
-
Layer 1 entry point: read a PDF file from disk into a
ParsedDocumentwith source locations preserved per detected layout block. - prioritySectionPatterns() - Method in record class ai.doctruth.PriorityTruncate
-
Returns the value of the
prioritySectionPatternsrecord component. - PriorityTruncate - Record Class in ai.doctruth
-
Smart-context strategy for keeping priority sections while trimming everything else to fit.
- PriorityTruncate(List, int, OverBudgetPolicy) - Constructor for record class ai.doctruth.PriorityTruncate
-
Creates an instance of a
PriorityTruncaterecord class. - provenance() - Method in record class ai.doctruth.ExtractionResult
-
Returns the value of the
provenancerecord component. - Provenance - Record Class in ai.doctruth
-
Bi-temporal provenance for an
ExtractionResult: the model that produced it, when the extraction ran, and (optionally) when the source document was authored, the region the extraction was processed in, and the retention horizon of the audit record. - Provenance(String, String, Instant, Optional, ProvenanceDetails) - Constructor for record class ai.doctruth.Provenance
-
Creates an instance of a
Provenancerecord class. - Provenance(String, String, Instant, Optional, Optional, Optional, int) - Constructor for record class ai.doctruth.Provenance
- ProvenanceDetails - Record Class in ai.doctruth
-
Supplemental provenance metadata kept behind
Provenanceso the public provenance record stays small while preserving retry, data-residency, and retention semantics. - ProvenanceDetails(Optional, Optional, int) - Constructor for record class ai.doctruth.ProvenanceDetails
-
Creates an instance of a
ProvenanceDetailsrecord class. - ProviderException - Exception Class in ai.doctruth
-
Thrown by Layer 2 LLM providers (Anthropic, OpenAI, Gemini, DeepSeek) when an upstream call fails.
- ProviderException(String, String, String, OptionalInt, boolean) - Constructor for exception class ai.doctruth.ProviderException
- ProviderException(String, String, String, OptionalInt, boolean, Throwable) - Constructor for exception class ai.doctruth.ProviderException
- providerName() - Method in exception class ai.doctruth.ProviderException
- ProviderOptions - Record Class in ai.doctruth
-
Per-call knobs passed to an
LlmProvideron every request. - ProviderOptions(int, Duration) - Constructor for record class ai.doctruth.ProviderOptions
-
Creates an instance of a
ProviderOptionsrecord class. - ProviderRequest - Record Class in ai.doctruth
-
What the library hands an
LlmProvideron every call: the system prompt, the user prompt (rendered from aParsedDocumentby the configuredContextStrategy), the JSON Schema for the target type, and the per-call options. - ProviderRequest(String, String, JsonNode, ProviderOptions) - Constructor for record class ai.doctruth.ProviderRequest
-
Creates an instance of a
ProviderRequestrecord class. - ProviderResponse - Record Class in ai.doctruth
-
What an
LlmProviderreturns on a successful call: the raw JSON the LLM produced plus the per-callProviderUsage. - ProviderResponse(String, ProviderUsage) - Constructor for record class ai.doctruth.ProviderResponse
-
Creates an instance of a
ProviderResponserecord class. - ProviderUsage - Record Class in ai.doctruth
-
Token-usage and model-version data returned by an LLM provider on every successful call.
- ProviderUsage(int, int, String) - Constructor for record class ai.doctruth.ProviderUsage
-
Creates an instance of a
ProviderUsagerecord class. - ProvOExporter - Class in ai.doctruth.internal.audit
-
Render an
ExtractionResultas W3C PROV-O JSON-LD.
R
- rationale() - Method in record class ai.doctruth.Confidence
-
Returns the value of the
rationalerecord component. - rawJson() - Method in record class ai.doctruth.ProviderResponse
-
Returns the value of the
rawJsonrecord component. - region() - Method in interface ai.doctruth.LlmProvider
-
Optional region identifier for the provider's deployment, e.g.
- region() - Method in record class ai.doctruth.Provenance
- region() - Method in record class ai.doctruth.ProvenanceDetails
-
Returns the value of the
regionrecord component. - regions() - Method in record class ai.doctruth.spi.OcrPageResult
-
Returns the value of the
regionsrecord component. - requireCitation(String) - Method in class ai.doctruth.JsonExtractionBuilder
- responseSchema() - Method in record class ai.doctruth.ProviderRequest
-
Returns the value of the
responseSchemarecord component. - retainUntil() - Method in record class ai.doctruth.Provenance
- retainUntil() - Method in record class ai.doctruth.ProvenanceDetails
-
Returns the value of the
retainUntilrecord component. - retries() - Method in exception class ai.doctruth.ExtractionException
- retries() - Method in record class ai.doctruth.Provenance
- retries() - Method in record class ai.doctruth.ProvenanceDetails
-
Returns the value of the
retriesrecord component. - retryable() - Method in exception class ai.doctruth.ProviderException
- rows() - Method in record class ai.doctruth.TableSection
-
Returns the value of the
rowsrecord component. - run(ParsedDocument) - Method in class ai.doctruth.ExtractionBuilder
-
Execute the configured extraction.
- runJson(ParsedDocument) - Method in class ai.doctruth.JsonExtractionBuilder
S
- score() - Method in record class ai.doctruth.Confidence
-
Returns the value of the
scorerecord component. - sections() - Method in record class ai.doctruth.ParsedDocument
-
Returns the value of the
sectionsrecord component. - sign(String) - Method in interface ai.doctruth.spi.SignatureProvider
-
Sign or wrap
auditJsonand return the result. - SignatureProvider - Interface in ai.doctruth.spi
-
Sign / wrap an audit JSON document for tamper-evident persistence.
- SlidingWindow - Record Class in ai.doctruth
-
Fixed-size character windows with optional overlap.
- SlidingWindow(int, int) - Constructor for record class ai.doctruth.SlidingWindow
-
Creates an instance of a
SlidingWindowrecord class. - sourceFilename() - Method in record class ai.doctruth.DocumentMetadata
-
Returns the value of the
sourceFilenamerecord component. - SourceLocation - Record Class in ai.doctruth
-
A 1-indexed page + line span into a parsed source document, plus a 0-indexed character offset into the source page text.
- SourceLocation(int, int, int, int, int) - Constructor for record class ai.doctruth.SourceLocation
-
Creates an instance of a
SourceLocationrecord class. - sourceName() - Method in exception class ai.doctruth.ParseException
- sourcePublishedAt() - Method in record class ai.doctruth.DocumentMetadata
-
Returns the value of the
sourcePublishedAtrecord component. - sourcePublishedAt() - Method in record class ai.doctruth.Provenance
-
Returns the value of the
sourcePublishedAtrecord component. - STRICT - Enum constant in enum class ai.doctruth.OverBudgetPolicy
- systemPrompt() - Method in record class ai.doctruth.ProviderRequest
-
Returns the value of the
systemPromptrecord component.
T
- TableSection - Record Class in ai.doctruth
-
A flat string-cell table recovered from the source document, anchored to a
SourceLocation. - TableSection(List, SourceLocation) - Constructor for record class ai.doctruth.TableSection
-
Creates an instance of a
TableSectionrecord class. - text() - Method in record class ai.doctruth.spi.OcrPageResult
-
Returns the value of the
textrecord component. - text() - Method in record class ai.doctruth.spi.OcrRegion
-
Returns the value of the
textrecord component. - text() - Method in record class ai.doctruth.TextSection
-
Returns the value of the
textrecord component. - TextSection - Record Class in ai.doctruth
-
A run of plain text recovered from the source document, anchored to a
SourceLocationand tagged with aBlockKindthat classifies the geometric / typographic shape of the block (HEADING / BODY / LIST / OTHER). - TextSection(String, SourceLocation) - Constructor for record class ai.doctruth.TextSection
-
Backward-compat 2-arg constructor — defaults
kindtoBlockKind.OTHER. - TextSection(String, SourceLocation, BlockKind) - Constructor for record class ai.doctruth.TextSection
-
Creates an instance of a
TextSectionrecord class. - timeout() - Method in record class ai.doctruth.ProviderOptions
-
Returns the value of the
timeoutrecord component. - toAuditJson() - Method in record class ai.doctruth.ExtractionResult
-
Render this result as a W3C PROV-O JSON-LD audit document — the format auditors and compliance teams already know how to ingest.
- toAuditJson(SignatureProvider) - Method in record class ai.doctruth.ExtractionResult
-
Render this result as audit JSON and pipe through
signerfor tamper-evident persistence. - toAuditJson(Path) - Method in record class ai.doctruth.ExtractionResult
-
Write
ExtractionResult.toAuditJson()topath, creating parent directories if needed. - toAuditJson(Path, SignatureProvider) - Method in record class ai.doctruth.ExtractionResult
-
Write
ExtractionResult.toAuditJson(SignatureProvider)topath, creating parent directories if needed. - toJson(ExtractionResult) - Static method in class ai.doctruth.internal.audit.ProvOExporter
- toString() - Method in record class ai.doctruth.Citation
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.Confidence
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.DocumentMetadata
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.ExtractionResult
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.FigureSection
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.Hierarchical
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.ParsedDocument
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.PriorityTruncate
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.Provenance
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.ProvenanceDetails
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.ProviderOptions
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.ProviderRequest
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.ProviderResponse
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.ProviderUsage
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.SlidingWindow
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.SourceLocation
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.spi.AuditEvent
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.spi.OcrBox
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.spi.OcrPageResult
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.spi.OcrRegion
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.TableSection
-
Returns a string representation of this record class.
- toString() - Method in record class ai.doctruth.TextSection
-
Returns a string representation of this record class.
U
- usage() - Method in record class ai.doctruth.ProviderResponse
-
Returns the value of the
usagerecord component. - userPrompt() - Method in record class ai.doctruth.ProviderRequest
-
Returns the value of the
userPromptrecord component.
V
- validate(T, int) - Method in class ai.doctruth.internal.constraint.ConstraintSet
- value() - Method in record class ai.doctruth.ExtractionResult
-
Returns the value of the
valuerecord component. - valueOf(String) - Static method in enum class ai.doctruth.BlockKind
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class ai.doctruth.OverBudgetPolicy
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class ai.doctruth.BlockKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class ai.doctruth.OverBudgetPolicy
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- WARN_AND_INCLUDE - Enum constant in enum class ai.doctruth.OverBudgetPolicy
- width() - Method in record class ai.doctruth.spi.OcrBox
-
Returns the value of the
widthrecord component. - width() - Method in record class ai.doctruth.spi.OcrRegion
- windowChars() - Method in record class ai.doctruth.SlidingWindow
-
Returns the value of the
windowCharsrecord component. - withAuditListener(AuditEventListener) - Method in class ai.doctruth.ExtractionBuilder
-
Plug an
AuditEventListenerinto this builder so every extraction emits one SIEM-friendly event. - withBitemporal() - Method in class ai.doctruth.ExtractionBuilder
- withBitemporal() - Method in class ai.doctruth.JsonExtractionBuilder
- withConfidence() - Method in class ai.doctruth.ExtractionBuilder
- withConfidence() - Method in class ai.doctruth.JsonExtractionBuilder
- withContextStrategy(ContextStrategy) - Method in class ai.doctruth.ExtractionBuilder
- withContextStrategy(ContextStrategy) - Method in class ai.doctruth.JsonExtractionBuilder
- withField(String, Class, Predicate, String) - Method in class ai.doctruth.internal.constraint.ConstraintSet
- withFieldConstraint(String, Class, Predicate, String) - Method in class ai.doctruth.ExtractionBuilder
- withMaxRetries(int) - Method in class ai.doctruth.ExtractionBuilder
- withMaxRetries(int) - Method in class ai.doctruth.JsonExtractionBuilder
- withObject(Predicate, String) - Method in class ai.doctruth.internal.constraint.ConstraintSet
- withObjectConstraint(Predicate, String) - Method in class ai.doctruth.ExtractionBuilder
- withProvenance() - Method in class ai.doctruth.ExtractionBuilder
- withProvenance() - Method in class ai.doctruth.JsonExtractionBuilder
- withSourcePublishedAt(Instant) - Method in class ai.doctruth.ExtractionBuilder
- withSourcePublishedAt(Instant) - Method in class ai.doctruth.JsonExtractionBuilder
X
- x() - Method in record class ai.doctruth.spi.OcrBox
-
Returns the value of the
xrecord component. - x() - Method in record class ai.doctruth.spi.OcrRegion
- XlsxDocumentParser - Class in ai.doctruth
-
Layer 1 entry point: read an XLSX file from disk into a
ParsedDocumentwith oneTableSectionper non-empty sheet.
Y
- y() - Method in record class ai.doctruth.spi.OcrBox
-
Returns the value of the
yrecord component. - y() - Method in record class ai.doctruth.spi.OcrRegion
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form