xberg
library
Classes
AccelerationConfig
Hardware acceleration configuration for ONNX Runtime models.
AnnotationKind
ArcEmbeddingBackend
ArchiveEntry
A single file extracted from an archive.
ArchiveMetadata
Archive (ZIP/TAR/7Z) metadata.
ArcOcrBackend
ArcPostProcessor
ArcRenderer
ArcRerankerBackend
ArcTokenizerBackend
ArcValidator
Attributes
Element attributes in Djot.
AudioMetadata
Audio/video file metadata.
AuthConfig
BBox
Bounding box in original image coordinates (x1, y1) top-left, (x2, y2) bottom-right.
BedrockConfig
AWS Bedrock configuration for bedrock/-prefixed models.
BibtexMetadata
BibTeX bibliography metadata.
BoundingBox
Bounding box coordinates for element positioning.
BrowserConfig
Browser fallback configuration.
CacheStats
Aggregate statistics for a xberg cache directory.
CaptioningConfig
Configuration for the VLM captioning post-processor.
CellChange
A single changed cell within a table.
Chunk
A text chunk with optional embedding and metadata.
ChunkClassificationConfig
Configuration for the chunk-classification post-processor.
ChunkClassificationDefinition
A single labeled definition the chunk classifier may emit.
ChunkInfo
Information about a single chunk.
ChunkingConfig
Chunking configuration.
ChunkingReason
ChunkMetadata
Metadata about a chunk's position in the original document.
ChunkSizing
Citation
A structured citation from a citation block.
CitationMetadata
Citation file metadata (RIS, PubMed, EndNote).
ClassificationLabel
A single label + confidence pair.
CodeChunkInfo
A single structurally-meaningful code chunk produced by tree-sitter parsing.
CodeDataAttribute
An XML-style attribute attached to an Element node.
CodeDataNode
A node in the hierarchical data tree produced by data-format extraction.
CodeMetadata
Code-format metadata: the structural chunks produced by tree-sitter parsing.
ConcurrencyConfig
Controls thread usage for constrained environments.
ConfidenceSemantics
ContentConfig
Content extraction and conversion configuration.
ContentFilterConfig
Cross-extractor content filtering configuration.
ContributorRole
JATS contributor with role.
ConversionOptions
Main conversion options for HTML to Markdown conversion.
CoreProperties
Dublin Core metadata from docProps/core.xml
CrawlConfig
Configuration for crawl, scrape, and map operations.
CredentialProviderConfig
CsvConfig
Configuration for CSV/TSV extraction.
CsvMetadata
CSV/TSV file metadata.
DbfFieldInfo
dBASE field information.
DbfMetadata
dBASE (DBF) file metadata.
DeepseekOcrBackendOptions
Runtime options accepted by the candle-deepseek-ocr backend.
DetectionResult
Page-level detection result containing all detections and page metadata.
DetectResponse
MIME type detection response.
DiffHunk
A single contiguous hunk in a unified diff.
DiffLine
DiffOptions
Options controlling how two ExtractedDocument values are compared.
DjotAttributeGroup
Attributes associated with a named Djot element.
DjotContent
Comprehensive Djot document structure with semantic preservation.
DjotImage
Image element in Djot.
DjotLink
Link element in Djot.
DoctorCheck
A single doctor verdict: what was checked, the outcome, and why.
DoctorReport
Aggregate doctor report over all configured backends and settings.
DocumentBoundary
Detected document boundary within a PDF.
DocumentCounts
Cheap structural counts for an extracted document.
Abstract class for the DocumentExtractor Rust trait.
DocumentMetadata
Metadata about a document for analysis.
DocumentNode
A single node in the document tree.
DocumentRelationship
A resolved relationship between two nodes in the document tree.
DocumentRevision
A single tracked change embedded in a document.
DocumentStructure
Top-level structured document representation.
DocumentSummary
Summary of an extracted document.
DocxAppProperties
Application properties from docProps/app.xml for DOCX
DocxMetadata
Word document metadata.
Element
Semantic element extracted from document.
ElementMetadata
Metadata for a semantic element.
EmailAttachment
Email attachment representation.
EmailConfig
Configuration for email extraction.
Email extraction result.
EmailMetadata
Email metadata extracted from .eml and .msg files.
EmbeddedChanges
Changes to embedded archive children between two results.
EmbeddedDiff
Diff for a single embedded archive entry that appears in both results.
EmbeddedFile
Embedded file descriptor extracted from the PDF name tree.
EmbeddingBackend
Abstract class for the EmbeddingBackend Rust trait.
EmbeddingBackendDartImpl
EmbeddingConfig
Embedding configuration for text chunks.
EmbeddingModelType
Entity
A single named entity detected in the extracted text.
EntityCategory
EpubMetadata
EPUB metadata (Dublin Core extensions).
ErrorMetadata
Error metadata (for batch operations).
ExcelMetadata
Excel/spreadsheet format metadata.
ExcelSheet
Single Excel worksheet.
ExcelWorkbook
Excel workbook representation.
ExternalRedactionFinding
One finding reported by an external content-inspection engine.
Document extracted by the core extraction pipeline.
Extracted image from a document.
A URI extracted from a document.
Unified extraction input for all public extraction entry points.
Combined confidence on [0, 1].
Main extraction configuration.
The complete diff between two ExtractedDocument values.
Non-fatal per-input extraction error captured by `ExtractionResult`.
Unified extraction result envelope.
Summary for a unified extraction call.
FictionBookMetadata
FictionBook (FB2) metadata.
Per-file extraction configuration overrides for batch processing.
Footnote in Djot.
A footnote anchor reference in markdown text.
Configuration for markdown footnote and citation parsing.
A footnote definition from markdown text.
FormatMetadata
FormattedBlock
Block-level element in a Djot document.
Formula
A mathematical formula extracted from a document.
Configuration for GeoJSON extraction.
GlmOcrBackendOptions
Runtime options accepted by the candle-glm-ocr backend.
GridCell
Individual grid cell with position and span metadata.
Header/heading element metadata.
HeadingContext
Heading context for a chunk within a Markdown document.
HeadingLevel
A single heading in the hierarchy.
HeuristicsConfig
Configuration for document chunking and analysis heuristics.
HeuristicsError
HierarchicalBlock
HierarchicalBoundingBox
A text block with hierarchy level assignment.
HierarchyConfig
Hierarchy extraction configuration for PDF text structure analysis.
HostMatcher
HtmlMetadata
HTML metadata extracted from HTML documents.
HtmlOutputConfig
Configuration for styled HTML output.
ImageDimensions
Image dimensions in pixels.
ImageDpi
Horizontal and vertical image resolution in dots per inch.
Image extraction configuration.
ImageMetadata
Image metadata extracted from image files.
ImageMetadataType
Image element metadata.
ImageOutputFormat
ImagePreprocessingConfig
Image preprocessing configuration for OCR.
ImagePreprocessingMetadata
InlineElement
Inline element within a block.
JatsMetadata
JATS (Journal Article Tag Suite) metadata.
KeyValueAttribute
A string key-value attribute.
Keyword
Extracted keyword with metadata.
KeywordConfig
Keyword extraction configuration.
LanguageConfidence
Structured per-language detection result: confidence, document share, and script —
the information the ISO-code-only detected_languages list cannot convey (#261).
LanguageDetectionConfig
Language detection configuration.
LateInteractionConfig
Configuration for the late-interaction (ColBERT) pipeline.
LateInteractionMatch
A single document match returned by `max_sim_rank`, with its position in
the input and MaxSim score.
LateInteractionModelType
LateInteractionPreset
Static metadata for a bundled ColBERT preset (WASM/Android-safe, no ORT).
LayoutDetection
A single layout detection result.
LayoutDetectionConfig
Layout detection configuration.
LayoutRegion
A detected layout region on a page.
LinkMetadata
Link element metadata.
LlmBudgetConfig
Budget enforcement configuration.
LlmCacheConfig
Response cache configuration.
LlmConfig
Configuration for an LLM provider/model via liter-llm.
LlmProviderConfig
A custom provider configuration entry, in addition to liter-llm's built-in providers.
LlmRateLimitConfig
Per-model rate limiting configuration.
LlmUsage
Token usage and cost data for a single LLM call made during extraction.
LoadError
MapResult
The result of a map operation, containing discovered URLs.
MarkdownCodeBlock
A fenced code block extracted from Markdown.
MarkdownLink
A link extracted from Markdown.
Metadata
Extraction result metadata.
MetaSchema
ModelPaths
Combined paths to all models needed for OCR (backward compatibility).
MultidocInput
Input signals for multi-document boundary detection.
MultidocThresholds
Thresholds for multi-document boundary detection.
MultiVectorEmbedding
A ColBERT multi-vector embedding: one row per attention-live token.
NerConfig
Configuration for the NER post-processor.
NgramRange
Inclusive word-count range used to form keyword candidates.
NoChunkingReason
NodeContent
OcrBackend
Abstract class for the OcrBackend Rust trait.
OcrBackendCapabilities
A registered OCR backend's declared name and language capabilities.
OcrBackendDartImpl
OcrBoundingGeometry
OcrConfidence
Confidence scores for an OCR element.
OcrConfig
OCR configuration.
OcrElement
A unified OCR element representing detected text with full metadata.
OcrElementConfig
Configuration for OCR element extraction.
OCR extraction result.
OcrMetadata
OCR processing metadata.
OcrPageFailure
A page whose OCR failed while extraction of the document continued.
OcrPipelineConfig
Multi-backend OCR pipeline with quality-based fallback.
OcrPipelineStage
A single backend stage in the OCR pipeline.
OcrPoint
A point in OCR raster pixel coordinates.
OcrQualityThresholds
Quality thresholds for OCR fallback decisions and pipeline quality gating.
OcrRotation
Rotation information for an OCR element.
OcrStrategy
OcrTable
Table detected via OCR.
OcrTableBoundingBox
Bounding box for an OCR-detected table in pixel coordinates.
OrientationResult
Document orientation detection result.
OutputFormat
PaddleOcrConfig
Configuration for PaddleOCR backend.
PaddleOcrVlBackendOptions
Runtime options accepted by the candle-paddleocr-vl backend.
PageBoundary
Byte offset boundary for a page.
PageClassification
Classification result for a single page.
PageClassificationConfig
Configuration for the page-classification post-processor.
PageConfig
Page extraction and tracking configuration.
PageContent
Content for a single page/slide.
PageDimensions
Metadata for individual page/slide/sheet.
PageHierarchy
Page hierarchy structure containing heading levels and block information.
PageInfo
PageOcrConfidence
Aggregate OCR legibility score for a page, reported by the backend that produced its text.
Page range for a chunk (0-indexed, inclusive).
PageSignals
Per-page signals extracted from PDF content.
PageSpan
A single page covered by a chunk, with an optional bounding box on that page.
PageStructure
Unified page structure for documents.
PatternMatch
One detected PII span in the input text.
PdfAnnotation
A PDF annotation extracted from a document page.
PdfConfig
PDF-specific configuration.
PdfFormField
A form field extracted from a PDF's AcroForm or XFA structure.
PdfMetadata
PDF-specific metadata.
PiiCategory
PixelDimensions
Image preprocessing metadata.
PostProcessor
Abstract class for the PostProcessor Rust trait.
PostProcessorConfig
Post-processor configuration.
PostProcessorDartImpl
PptxAppProperties
Application properties from docProps/app.xml for PPTX
PowerPoint (PPTX) extraction result.
PptxMetadata
PowerPoint presentation metadata.
PreprocessingOptions
HTML preprocessing options for document cleanup before conversion.
PresentationHyperlink
A hyperlink discovered in a presentation slide.
Preset
A curated structured-extraction preset loaded from the embedded library.
PresetSample
Pointer to a sample input + its reference output bundled with the preset.
PresetSummary
Lightweight projection of `Preset` used by the registry list endpoint
(omits the full schema and prompt to keep the payload small).
ProcessingWarning
A non-fatal warning from a processing pipeline stage.
PropertyChange
A single run-level or style-level property change.
ProxyConfig
Proxy configuration for HTTP requests.
PstMetadata
Outlook PST archive metadata.
QrBoundingBox
Pixel-space bounding box of a QR code inside its source image.
QrCode
One QR code decoded from an extracted image.
RakeParams
RAKE-specific parameters.
RecognizedTable
Pre-computed table markdown for a table detection region.
RedactionConfig
Configuration for the redaction post-processor.
RedactionFinding
One redaction event: which span was rewritten, why, and with what.
RedactionPattern
One user-supplied regex pattern to redact.
RedactionReport
Audit report describing what the redaction processor found and how it replaced it.
RedactionTerm
One user-supplied literal term to redact.
Registry
Renderer
Abstract class for the Renderer Rust trait.
RendererDartImpl
RerankedDocument
A single document returned by the reranker, with its position in the input and score.
RerankerBackend
Abstract class for the RerankerBackend Rust trait.
RerankerBackendDartImpl
RerankerConfig
Configuration for the reranking pipeline.
RerankerModelType
ResolvedPreset
A preset merged with caller-supplied overrides (custom schema, prompt suffix,
context map). Output is what the pipeline orchestrator consumes.
RevisionAnchor
RevisionDelta
The content changes that make up a single revision.
SecurityLimits
Configuration for security limits across extractors.
ServerConfig
API server configuration.
SitemapUrl
A URL entry from a sitemap.
SparseEmbedding
A sparse learned embedding: vocabulary term indices and their weights.
SparseEmbeddingConfig
Configuration for the sparse-embedding pipeline.
SparseEmbeddingModelType
SparseEmbeddingPreset
Static metadata for a bundled SPLADE preset (WASM/Android-safe, no ORT).
SsrfPolicy
SSRF policy configuration.
StructuredData
Structured data (Schema.org, microdata, RDFa) block.
StructuredDataResult
Result of parsing a structured data file (JSON, JSONL, YAML, or TOML).
Configuration for LLM-based structured data extraction.
SummarizationConfig
Configuration for the summarisation post-processor.
SupportedFormat
A supported document format entry.
SvgOptions
SVG-specific configuration for the image-encode pipeline.
Table
Extracted table structure.
TableCell
Individual table cell with content and optional styling.
TableCellStyle
The paragraph style a single table cell's text carries, located by grid position.
TableDiff
Cell-level changes for a pair of tables that share the same index.
TableGrid
Structured table grid with cell-level metadata.
TesseractConfig
Tesseract OCR configuration.
TextAnnotation
Inline text annotation — byte-range based formatting and links.
Plain text and Markdown extraction result.
TextMetadata
Text/Markdown metadata.
TokenCounter
TokenizerBackend
Abstract class for the TokenizerBackend Rust trait.
TokenizerBackendDartImpl
TokenReductionConfig
Configuration for the token-reduction pipeline.
TokenReductionOptions
Token reduction configuration.
TranscriptionConfig
Configuration for audio/video transcription (speech-to-text).
Translation
Translation of the extracted content.
TranslationConfig
Configuration for the translation post-processor.
TreeSitterConfig
Configuration for tree-sitter language pack integration.
TreeSitterProcessConfig
Processing options for tree-sitter code analysis.
TrocrBackendOptions
Runtime options accepted by the candle-trocr backend.
URL ingestion and crawl configuration.
UserChunkConfig
User-provided chunk configuration.
Validator
Abstract class for the Validator Rust trait.
ValidatorDartImpl
VlmFallbackPolicy
XbergBridge
XbergError
XlsxAppProperties
Application properties from docProps/app.xml for XLSX
XML extraction result.
XmlMetadata
XML metadata extracted during XML parsing.
YakeParams
YAKE-specific parameters.
YearRange
Year range for bibliographic metadata.
Functions
classifyChunksOwned ({required ExtractedDocument result , required ChunkClassificationConfig config })
→ Future <ExtractedDocument >
Classify a document's chunks and return the updated document.
Clear all registered DocumentExtractor plugins.
Calls the host crate's configured clear function and stringifies any error.
clearEmbeddingBackends ()
→ Future <void >
Clear all registered EmbeddingBackend plugins.
Calls the host crate's configured clear function and stringifies any error.
clearOcrBackends ()
→ Future <void >
Clear all registered OcrBackend plugins.
Calls the host crate's configured clear function and stringifies any error.
clearPostProcessors ()
→ Future <void >
Clear all registered PostProcessor plugins.
Calls the host crate's configured clear function and stringifies any error.
clearRenderers ()
→ Future <void >
Clear all registered Renderer plugins.
Calls the host crate's configured clear function and stringifies any error.
clearRerankerBackends ()
→ Future <void >
Clear all registered RerankerBackend plugins.
Calls the host crate's configured clear function and stringifies any error.
clearTokenizerBackends ()
→ Future <void >
Clear all registered TokenizerBackend plugins.
Calls the host crate's configured clear function and stringifies any error.
clearValidators ()
→ Future <void >
Clear all registered Validator plugins.
Calls the host crate's configured clear function and stringifies any error.
createAccelerationConfigFromJson ({required String json })
→ Future <AccelerationConfig >
createAnnotationKindFromJson ({required String json })
→ Future <AnnotationKind >
createArchiveEntryFromJson ({required String json })
→ Future <ArchiveEntry >
createArchiveMetadataFromJson ({required String json })
→ Future <ArchiveMetadata >
createAssetCategoryFromJson ({required String json })
→ Future <AssetCategory >
createAttributesFromJson ({required String json })
→ Future <Attributes >
createAudioMetadataFromJson ({required String json })
→ Future <AudioMetadata >
createAuthConfigFromJson ({required String json })
→ Future <AuthConfig >
createBBoxFromJson ({required String json })
→ Future <BBox >
createBedrockConfigFromJson ({required String json })
→ Future <BedrockConfig >
createBibtexMetadataFromJson ({required String json })
→ Future <BibtexMetadata >
createBlockTypeFromJson ({required String json })
→ Future <BlockType >
createBoundaryReasonFromJson ({required String json })
→ Future <BoundaryReason >
createBoundingBoxFromJson ({required String json })
→ Future <BoundingBox >
createBrowserBackendFromJson ({required String json })
→ Future <BrowserBackend >
createBrowserConfigFromJson ({required String json })
→ Future <BrowserConfig >
createBrowserModeFromJson ({required String json })
→ Future <BrowserMode >
createBrowserWaitFromJson ({required String json })
→ Future <BrowserWait >
createCacheStatsFromJson ({required String json })
→ Future <CacheStats >
createCallModeFromJson ({required String json })
→ Future <CallMode >
createCandleDeepseekOcrDtypeFromJson ({required String json })
→ Future <CandleDeepseekOcrDtype >
createCandleDevicePreferenceFromJson ({required String json })
→ Future <CandleDevicePreference >
createCandleTrocrVariantFromJson ({required String json })
→ Future <CandleTrocrVariant >
createCaptionAltTextModeFromJson ({required String json })
→ Future <CaptionAltTextMode >
createCaptioningConfigFromJson ({required String json })
→ Future <CaptioningConfig >
createCellChangeFromJson ({required String json })
→ Future <CellChange >
createChunkClassificationConfigFromJson ({required String json })
→ Future <ChunkClassificationConfig >
createChunkClassificationDefinitionFromJson ({required String json })
→ Future <ChunkClassificationDefinition >
createChunkerTypeFromJson ({required String json })
→ Future <ChunkerType >
createChunkFromJson ({required String json })
→ Future <Chunk >
createChunkInfoFromJson ({required String json })
→ Future <ChunkInfo >
createChunkingConfigFromJson ({required String json })
→ Future <ChunkingConfig >
createChunkingReasonFromJson ({required String json })
→ Future <ChunkingReason >
createChunkMetadataFromJson ({required String json })
→ Future <ChunkMetadata >
createChunkSizingFromJson ({required String json })
→ Future <ChunkSizing >
createChunkTypeFromJson ({required String json })
→ Future <ChunkType >
createCitationFromJson ({required String json })
→ Future <Citation >
createCitationMetadataFromJson ({required String json })
→ Future <CitationMetadata >
createClassificationLabelFromJson ({required String json })
→ Future <ClassificationLabel >
createCodeChunkInfoFromJson ({required String json })
→ Future <CodeChunkInfo >
createCodeContentModeFromJson ({required String json })
→ Future <CodeContentMode >
createCodeDataAttributeFromJson ({required String json })
→ Future <CodeDataAttribute >
createCodeDataNodeFromJson ({required String json })
→ Future <CodeDataNode >
createCodeDataNodeKindFromJson ({required String json })
→ Future <CodeDataNodeKind >
createCodeMetadataFromJson ({required String json })
→ Future <CodeMetadata >
createConcurrencyConfigFromJson ({required String json })
→ Future <ConcurrencyConfig >
createConfidenceSemanticsFromJson ({required String json })
→ Future <ConfidenceSemantics >
createContentConfigFromJson ({required String json })
→ Future <ContentConfig >
createContentFilterConfigFromJson ({required String json })
→ Future <ContentFilterConfig >
createContentFilterKindFromJson ({required String json })
→ Future <ContentFilterKind >
createContentLayerFromJson ({required String json })
→ Future <ContentLayer >
createContributorRoleFromJson ({required String json })
→ Future <ContributorRole >
createConversionOptionsFromJson ({required String json })
→ Future <ConversionOptions >
createCorePropertiesFromJson ({required String json })
→ Future <CoreProperties >
createCrawlConfigFromJson ({required String json })
→ Future <CrawlConfig >
createCrawlStrategyKindFromJson ({required String json })
→ Future <CrawlStrategyKind >
createCredentialProviderConfigFromJson ({required String json })
→ Future <CredentialProviderConfig >
createCsvConfigFromJson ({required String json })
→ Future <CsvConfig >
createCsvMetadataFromJson ({required String json })
→ Future <CsvMetadata >
createDbfFieldInfoFromJson ({required String json })
→ Future <DbfFieldInfo >
createDbfMetadataFromJson ({required String json })
→ Future <DbfMetadata >
createDeepseekOcrBackendOptionsFromJson ({required String json })
→ Future <DeepseekOcrBackendOptions >
createDetectionResultFromJson ({required String json })
→ Future <DetectionResult >
createDetectResponseFromJson ({required String json })
→ Future <DetectResponse >
createDiffHunkFromJson ({required String json })
→ Future <DiffHunk >
createDiffLineFromJson ({required String json })
→ Future <DiffLine >
createDiffOptionsFromJson ({required String json })
→ Future <DiffOptions >
createDjotAttributeGroupFromJson ({required String json })
→ Future <DjotAttributeGroup >
createDjotContentFromJson ({required String json })
→ Future <DjotContent >
createDjotImageFromJson ({required String json })
→ Future <DjotImage >
createDjotLinkFromJson ({required String json })
→ Future <DjotLink >
createDoctorCheckFromJson ({required String json })
→ Future <DoctorCheck >
createDoctorReportFromJson ({required String json })
→ Future <DoctorReport >
createDocumentBoundaryFromJson ({required String json })
→ Future <DocumentBoundary >
createDocumentContentEncodingFromJson ({required String json })
→ Future <DocumentContentEncoding >
createDocumentCountsFromJson ({required String json })
→ Future <DocumentCounts >
Construct a DocumentExtractorDartImpl from Dart callback closures.
FRB synthesises a Dart-callable function type for each closure parameter,
which is the whole point of taking them as impl Fn(...) -> DartFnFuture<R>
parameters rather than storing them as Box<dyn Fn(...)> fields on an opaque
struct (FRB v2 silently drops factories that return opaque structs whose fields
it cannot bridge). The returned wrapper holds an Arc<dyn Trait + Send + Sync>
whose backing object carries the supplied callbacks privately.
plugin_name and plugin_version are required for the Plugin super-trait.
createDocumentMetadataFromJson ({required String json })
→ Future <DocumentMetadata >
createDocumentNodeFromJson ({required String json })
→ Future <DocumentNode >
createDocumentRelationshipFromJson ({required String json })
→ Future <DocumentRelationship >
createDocumentRevisionFromJson ({required String json })
→ Future <DocumentRevision >
createDocumentStructureFromJson ({required String json })
→ Future <DocumentStructure >
createDocumentSummaryFromJson ({required String json })
→ Future <DocumentSummary >
createDocxAppPropertiesFromJson ({required String json })
→ Future <DocxAppProperties >
createDocxMetadataFromJson ({required String json })
→ Future <DocxMetadata >
createElementFromJson ({required String json })
→ Future <Element >
createElementMetadataFromJson ({required String json })
→ Future <ElementMetadata >
createElementTypeFromJson ({required String json })
→ Future <ElementType >
createEmailAttachmentFromJson ({required String json })
→ Future <EmailAttachment >
createEmailConfigFromJson ({required String json })
→ Future <EmailConfig >
createEmailMetadataFromJson ({required String json })
→ Future <EmailMetadata >
createEmbeddedChangesFromJson ({required String json })
→ Future <EmbeddedChanges >
createEmbeddedDiffFromJson ({required String json })
→ Future <EmbeddedDiff >
createEmbeddedFileFromJson ({required String json })
→ Future <EmbeddedFile >
createEmbeddingBackendDartImpl ({required String pluginName , required String pluginVersion , required FutureOr <PlatformInt64 > dimensions (), required FutureOr <List <Float64List > > embed (List <String > ) })
→ Future <EmbeddingBackendDartImpl >
Construct a EmbeddingBackendDartImpl from Dart callback closures.
FRB synthesises a Dart-callable function type for each closure parameter,
which is the whole point of taking them as impl Fn(...) -> DartFnFuture<R>
parameters rather than storing them as Box<dyn Fn(...)> fields on an opaque
struct (FRB v2 silently drops factories that return opaque structs whose fields
it cannot bridge). The returned wrapper holds an Arc<dyn Trait + Send + Sync>
whose backing object carries the supplied callbacks privately.
plugin_name and plugin_version are required for the Plugin super-trait.
createEmbeddingConfigFromJson ({required String json })
→ Future <EmbeddingConfig >
createEmbeddingModelTypeFromJson ({required String json })
→ Future <EmbeddingModelType >
createEmbeddingsEmbeddingBackendFromJson ({required String json })
→ Future <EmbeddingsEmbeddingBackend >
createEntityCategoryFromJson ({required String json })
→ Future <EntityCategory >
createEntityFromJson ({required String json })
→ Future <Entity >
createEpubMetadataFromJson ({required String json })
→ Future <EpubMetadata >
createErrorMetadataFromJson ({required String json })
→ Future <ErrorMetadata >
createExcelMetadataFromJson ({required String json })
→ Future <ExcelMetadata >
createExcelSheetFromJson ({required String json })
→ Future <ExcelSheet >
createExcelWorkbookFromJson ({required String json })
→ Future <ExcelWorkbook >
createExecutionProviderTypeFromJson ({required String json })
→ Future <ExecutionProviderType >
createExternalRedactionFindingFromJson ({required String json })
→ Future <ExternalRedactionFinding >
createFictionBookMetadataFromJson ({required String json })
→ Future <FictionBookMetadata >
createFormatMetadataFromJson ({required String json })
→ Future <FormatMetadata >
createFormattedBlockFromJson ({required String json })
→ Future <FormattedBlock >
createFormFieldTypeFromJson ({required String json })
→ Future <FormFieldType >
createFormulaFromJson ({required String json })
→ Future <Formula >
createFormulaModelFromJson ({required String json })
→ Future <FormulaModel >
createGlmOcrBackendOptionsFromJson ({required String json })
→ Future <GlmOcrBackendOptions >
createGlmOcrLayoutModeFromJson ({required String json })
→ Future <GlmOcrLayoutMode >
createGlmOcrTaskKindFromJson ({required String json })
→ Future <GlmOcrTaskKind >
createGridCellFromJson ({required String json })
→ Future <GridCell >
createHeadingContextFromJson ({required String json })
→ Future <HeadingContext >
createHeadingLevelFromJson ({required String json })
→ Future <HeadingLevel >
createHeuristicsConfigFromJson ({required String json })
→ Future <HeuristicsConfig >
createHierarchicalBlockFromJson ({required String json })
→ Future <HierarchicalBlock >
createHierarchicalBoundingBoxFromJson ({required String json })
→ Future <HierarchicalBoundingBox >
createHierarchyConfigFromJson ({required String json })
→ Future <HierarchyConfig >
createHostMatcherFromJson ({required String json })
→ Future <HostMatcher >
createHtmlMetadataFromJson ({required String json })
→ Future <HtmlMetadata >
createHtmlOutputConfigFromJson ({required String json })
→ Future <HtmlOutputConfig >
createHtmlThemeFromJson ({required String json })
→ Future <HtmlTheme >
createImageDimensionsFromJson ({required String json })
→ Future <ImageDimensions >
createImageDpiFromJson ({required String json })
→ Future <ImageDpi >
createImageKindFromJson ({required String json })
→ Future <ImageKind >
createImageMetadataFromJson ({required String json })
→ Future <ImageMetadata >
createImageMetadataTypeFromJson ({required String json })
→ Future <ImageMetadataType >
createImageOutputFormatFromJson ({required String json })
→ Future <ImageOutputFormat >
createImagePreprocessingConfigFromJson ({required String json })
→ Future <ImagePreprocessingConfig >
createImagePreprocessingMetadataFromJson ({required String json })
→ Future <ImagePreprocessingMetadata >
createImageTypeFromJson ({required String json })
→ Future <ImageType >
createInlineElementFromJson ({required String json })
→ Future <InlineElement >
createInlineTypeFromJson ({required String json })
→ Future <InlineType >
createJatsMetadataFromJson ({required String json })
→ Future <JatsMetadata >
createJupyterCellRenderingFromJson ({required String json })
→ Future <JupyterCellRendering >
createKeyValueAttributeFromJson ({required String json })
→ Future <KeyValueAttribute >
createKeywordAlgorithmFromJson ({required String json })
→ Future <KeywordAlgorithm >
createKeywordConfigFromJson ({required String json })
→ Future <KeywordConfig >
createKeywordFromJson ({required String json })
→ Future <Keyword >
createLanguageConfidenceFromJson ({required String json })
→ Future <LanguageConfidence >
createLanguageDetectionConfigFromJson ({required String json })
→ Future <LanguageDetectionConfig >
createLateInteractionConfigFromJson ({required String json })
→ Future <LateInteractionConfig >
createLateInteractionMatchFromJson ({required String json })
→ Future <LateInteractionMatch >
createLateInteractionModelTypeFromJson ({required String json })
→ Future <LateInteractionModelType >
createLateInteractionPresetFromJson ({required String json })
→ Future <LateInteractionPreset >
createLayoutClassFromJson ({required String json })
→ Future <LayoutClass >
createLayoutDetectionConfigFromJson ({required String json })
→ Future <LayoutDetectionConfig >
createLayoutDetectionFromJson ({required String json })
→ Future <LayoutDetection >
createLayoutRegionFromJson ({required String json })
→ Future <LayoutRegion >
createLayoutStrategyFromJson ({required String json })
→ Future <LayoutStrategy >
createLinkMetadataFromJson ({required String json })
→ Future <LinkMetadata >
createLinkTypeFromJson ({required String json })
→ Future <LinkType >
createLlmBudgetConfigFromJson ({required String json })
→ Future <LlmBudgetConfig >
createLlmCacheConfigFromJson ({required String json })
→ Future <LlmCacheConfig >
createLlmConfigFromJson ({required String json })
→ Future <LlmConfig >
createLlmProviderConfigFromJson ({required String json })
→ Future <LlmProviderConfig >
createLlmRateLimitConfigFromJson ({required String json })
→ Future <LlmRateLimitConfig >
createLlmUsageFromJson ({required String json })
→ Future <LlmUsage >
createMapResultFromJson ({required String json })
→ Future <MapResult >
createMarkdownCodeBlockFromJson ({required String json })
→ Future <MarkdownCodeBlock >
createMarkdownLinkFromJson ({required String json })
→ Future <MarkdownLink >
createMergeModeFromJson ({required String json })
→ Future <MergeMode >
createMetadataFromJson ({required String json })
→ Future <Metadata >
createMimeDetectionPolicyFromJson ({required String json })
→ Future <MimeDetectionPolicy >
createModelPathsFromJson ({required String json })
→ Future <ModelPaths >
createMultidocInputFromJson ({required String json })
→ Future <MultidocInput >
createMultidocThresholdsFromJson ({required String json })
→ Future <MultidocThresholds >
createMultiVectorEmbeddingFromJson ({required String json })
→ Future <MultiVectorEmbedding >
createNerBackendKindFromJson ({required String json })
→ Future <NerBackendKind >
createNerConfigFromJson ({required String json })
→ Future <NerConfig >
createNgramRangeFromJson ({required String json })
→ Future <NgramRange >
createNoChunkingReasonFromJson ({required String json })
→ Future <NoChunkingReason >
createNodeContentFromJson ({required String json })
→ Future <NodeContent >
createOcrBackendCapabilitiesFromJson ({required String json })
→ Future <OcrBackendCapabilities >
createOcrBackendDartImpl ({required String pluginName , required String pluginVersion , required FutureOr <ExtractedDocument > processImage (Uint8List , OcrConfig ), required FutureOr <ExtractedDocument > processImageFile (String , OcrConfig ), required FutureOr <bool > supportsLanguage (String ), required FutureOr <OcrBackendType > backendType (), required FutureOr <List <String > > supportedLanguages (), required FutureOr <List <String > > supportedLanguagesFor (OcrConfig ), required FutureOr <bool > supportsLanguageFor (OcrConfig , String ), required FutureOr <bool > supportsTableDetection (), required FutureOr <bool > supportsDocumentProcessing (), required FutureOr <bool > emitsStructuredMarkdown (), required FutureOr <ConfidenceSemantics > confidenceSemantics (), required FutureOr <PageOrientationHandling > pageOrientationHandling (), required FutureOr <ExtractedDocument > processDocument (String , OcrConfig ) })
→ Future <OcrBackendDartImpl >
Construct a OcrBackendDartImpl from Dart callback closures.
FRB synthesises a Dart-callable function type for each closure parameter,
which is the whole point of taking them as impl Fn(...) -> DartFnFuture<R>
parameters rather than storing them as Box<dyn Fn(...)> fields on an opaque
struct (FRB v2 silently drops factories that return opaque structs whose fields
it cannot bridge). The returned wrapper holds an Arc<dyn Trait + Send + Sync>
whose backing object carries the supplied callbacks privately.
plugin_name and plugin_version are required for the Plugin super-trait.
createOcrBackendTypeFromJson ({required String json })
→ Future <OcrBackendType >
createOcrBoundingGeometryFromJson ({required String json })
→ Future <OcrBoundingGeometry >
createOcrConfidenceFromJson ({required String json })
→ Future <OcrConfidence >
createOcrConfigFromJson ({required String json })
→ Future <OcrConfig >
createOcrElementConfigFromJson ({required String json })
→ Future <OcrElementConfig >
createOcrElementFromJson ({required String json })
→ Future <OcrElement >
createOcrElementLevelFromJson ({required String json })
→ Future <OcrElementLevel >
createOcrMetadataFromJson ({required String json })
→ Future <OcrMetadata >
createOcrPageFailureFromJson ({required String json })
→ Future <OcrPageFailure >
createOcrPipelineConfigFromJson ({required String json })
→ Future <OcrPipelineConfig >
createOcrPipelineStageFromJson ({required String json })
→ Future <OcrPipelineStage >
createOcrPointFromJson ({required String json })
→ Future <OcrPoint >
createOcrQualityThresholdsFromJson ({required String json })
→ Future <OcrQualityThresholds >
createOcrRotationFromJson ({required String json })
→ Future <OcrRotation >
createOcrStrategyFromJson ({required String json })
→ Future <OcrStrategy >
createOcrTableBoundingBoxFromJson ({required String json })
→ Future <OcrTableBoundingBox >
createOcrTableFromJson ({required String json })
→ Future <OcrTable >
createOrientationResultFromJson ({required String json })
→ Future <OrientationResult >
createOutputFormatFromJson ({required String json })
→ Future <OutputFormat >
createPaddleInferenceBackendFromJson ({required String json })
→ Future <PaddleInferenceBackend >
createPaddleLanguageFromJson ({required String json })
→ Future <PaddleLanguage >
createPaddleOcrConfigFromJson ({required String json })
→ Future <PaddleOcrConfig >
createPaddleOcrVlBackendOptionsFromJson ({required String json })
→ Future <PaddleOcrVlBackendOptions >
createPaddleOcrVlTaskKindFromJson ({required String json })
→ Future <PaddleOcrVlTaskKind >
createPageBoundaryFromJson ({required String json })
→ Future <PageBoundary >
createPageClassificationConfigFromJson ({required String json })
→ Future <PageClassificationConfig >
createPageClassificationFromJson ({required String json })
→ Future <PageClassification >
createPageConfigFromJson ({required String json })
→ Future <PageConfig >
createPageContentFromJson ({required String json })
→ Future <PageContent >
createPageDimensionsFromJson ({required String json })
→ Future <PageDimensions >
createPageHierarchyFromJson ({required String json })
→ Future <PageHierarchy >
createPageInfoFromJson ({required String json })
→ Future <PageInfo >
createPageOcrConfidenceFromJson ({required String json })
→ Future <PageOcrConfidence >
createPageOrientationHandlingFromJson ({required String json })
→ Future <PageOrientationHandling >
createPageSignalsFromJson ({required String json })
→ Future <PageSignals >
createPageSpanFromJson ({required String json })
→ Future <PageSpan >
createPageStructureFromJson ({required String json })
→ Future <PageStructure >
createPageUnitTypeFromJson ({required String json })
→ Future <PageUnitType >
createPatternMatchFromJson ({required String json })
→ Future <PatternMatch >
createPdfAnnotationFromJson ({required String json })
→ Future <PdfAnnotation >
createPdfAnnotationTypeFromJson ({required String json })
→ Future <PdfAnnotationType >
createPdfBackendFromJson ({required String json })
→ Future <PdfBackend >
createPdfConfigFromJson ({required String json })
→ Future <PdfConfig >
createPdfFormFieldFromJson ({required String json })
→ Future <PdfFormField >
createPdfMetadataFromJson ({required String json })
→ Future <PdfMetadata >
createPiiCategoryFromJson ({required String json })
→ Future <PiiCategory >
createPixelDimensionsFromJson ({required String json })
→ Future <PixelDimensions >
createPostProcessorConfigFromJson ({required String json })
→ Future <PostProcessorConfig >
createPostProcessorDartImpl ({required String pluginName , required String pluginVersion , required FutureOr <void > process (ExtractedDocument , ExtractionConfig ), required FutureOr <ProcessingStage > processingStage (), required FutureOr <bool > shouldProcess (ExtractedDocument , ExtractionConfig ), required FutureOr <PlatformInt64 > estimatedDurationMs (ExtractedDocument ), required FutureOr <PlatformInt64 > priority () })
→ Future <PostProcessorDartImpl >
Construct a PostProcessorDartImpl from Dart callback closures.
FRB synthesises a Dart-callable function type for each closure parameter,
which is the whole point of taking them as impl Fn(...) -> DartFnFuture<R>
parameters rather than storing them as Box<dyn Fn(...)> fields on an opaque
struct (FRB v2 silently drops factories that return opaque structs whose fields
it cannot bridge). The returned wrapper holds an Arc<dyn Trait + Send + Sync>
whose backing object carries the supplied callbacks privately.
plugin_name and plugin_version are required for the Plugin super-trait.
createPptxAppPropertiesFromJson ({required String json })
→ Future <PptxAppProperties >
createPptxMetadataFromJson ({required String json })
→ Future <PptxMetadata >
createPreprocessingOptionsFromJson ({required String json })
→ Future <PreprocessingOptions >
createPresentationHyperlinkFromJson ({required String json })
→ Future <PresentationHyperlink >
createPresetCategoryFromJson ({required String json })
→ Future <PresetCategory >
createPresetFromJson ({required String json })
→ Future <Preset >
createPresetSampleFromJson ({required String json })
→ Future <PresetSample >
createPresetSummaryFromJson ({required String json })
→ Future <PresetSummary >
createProbeStatusFromJson ({required String json })
→ Future <ProbeStatus >
createProcessingStageFromJson ({required String json })
→ Future <ProcessingStage >
createProcessingWarningFromJson ({required String json })
→ Future <ProcessingWarning >
createPropertyChangeFromJson ({required String json })
→ Future <PropertyChange >
createProxyConfigFromJson ({required String json })
→ Future <ProxyConfig >
createPsmModeFromJson ({required String json })
→ Future <PSMMode >
createPstMetadataFromJson ({required String json })
→ Future <PstMetadata >
createQrBoundingBoxFromJson ({required String json })
→ Future <QrBoundingBox >
createQrCodeFromJson ({required String json })
→ Future <QrCode >
createRakeParamsFromJson ({required String json })
→ Future <RakeParams >
createRecognizedTableFromJson ({required String json })
→ Future <RecognizedTable >
createRedactionConfigFromJson ({required String json })
→ Future <RedactionConfig >
createRedactionFindingFromJson ({required String json })
→ Future <RedactionFinding >
createRedactionOffsetEncodingFromJson ({required String json })
→ Future <RedactionOffsetEncoding >
createRedactionPatternFromJson ({required String json })
→ Future <RedactionPattern >
createRedactionReportFromJson ({required String json })
→ Future <RedactionReport >
createRedactionStrategyFromJson ({required String json })
→ Future <RedactionStrategy >
createRedactionTermFromJson ({required String json })
→ Future <RedactionTerm >
createReductionLevelFromJson ({required String json })
→ Future <ReductionLevel >
createRegionKindFromJson ({required String json })
→ Future <RegionKind >
createRelationshipKindFromJson ({required String json })
→ Future <RelationshipKind >
createRendererDartImpl ({required String pluginName , required String pluginVersion , required FutureOr <String > renderResult (ExtractedDocument ) })
→ Future <RendererDartImpl >
Construct a RendererDartImpl from Dart callback closures.
FRB synthesises a Dart-callable function type for each closure parameter,
which is the whole point of taking them as impl Fn(...) -> DartFnFuture<R>
parameters rather than storing them as Box<dyn Fn(...)> fields on an opaque
struct (FRB v2 silently drops factories that return opaque structs whose fields
it cannot bridge). The returned wrapper holds an Arc<dyn Trait + Send + Sync>
whose backing object carries the supplied callbacks privately.
plugin_name and plugin_version are required for the Plugin super-trait.
createRerankedDocumentFromJson ({required String json })
→ Future <RerankedDocument >
createRerankerBackendDartImpl ({required String pluginName , required String pluginVersion , required FutureOr <Float64List > rerank (String , List <String > ) })
→ Future <RerankerBackendDartImpl >
Construct a RerankerBackendDartImpl from Dart callback closures.
FRB synthesises a Dart-callable function type for each closure parameter,
which is the whole point of taking them as impl Fn(...) -> DartFnFuture<R>
parameters rather than storing them as Box<dyn Fn(...)> fields on an opaque
struct (FRB v2 silently drops factories that return opaque structs whose fields
it cannot bridge). The returned wrapper holds an Arc<dyn Trait + Send + Sync>
whose backing object carries the supplied callbacks privately.
plugin_name and plugin_version are required for the Plugin super-trait.
createRerankerConfigFromJson ({required String json })
→ Future <RerankerConfig >
createRerankerHeadFromJson ({required String json })
→ Future <RerankerHead >
createRerankerModelTypeFromJson ({required String json })
→ Future <RerankerModelType >
createResolvedPresetFromJson ({required String json })
→ Future <ResolvedPreset >
createResultFormatFromJson ({required String json })
→ Future <ResultFormat >
createRevisionAnchorFromJson ({required String json })
→ Future <RevisionAnchor >
createRevisionDeltaFromJson ({required String json })
→ Future <RevisionDelta >
createRevisionKindFromJson ({required String json })
→ Future <RevisionKind >
createSchemaComplianceFromJson ({required String json })
→ Future <SchemaCompliance >
createSecurityLimitsFromJson ({required String json })
→ Future <SecurityLimits >
createServerConfigFromJson ({required String json })
→ Future <ServerConfig >
createSitemapUrlFromJson ({required String json })
→ Future <SitemapUrl >
createSparseEmbeddingConfigFromJson ({required String json })
→ Future <SparseEmbeddingConfig >
createSparseEmbeddingFromJson ({required String json })
→ Future <SparseEmbedding >
createSparseEmbeddingModelTypeFromJson ({required String json })
→ Future <SparseEmbeddingModelType >
createSparseEmbeddingPresetFromJson ({required String json })
→ Future <SparseEmbeddingPreset >
createSsrfPolicyFromJson ({required String json })
→ Future <SsrfPolicy >
createStructuredDataFromJson ({required String json })
→ Future <StructuredData >
createStructuredDataResultFromJson ({required String json })
→ Future <StructuredDataResult >
createStructuredDataTypeFromJson ({required String json })
→ Future <StructuredDataType >
createSummarizationConfigFromJson ({required String json })
→ Future <SummarizationConfig >
createSummaryStrategyFromJson ({required String json })
→ Future <SummaryStrategy >
createSupportedFormatFromJson ({required String json })
→ Future <SupportedFormat >
createSvgOptionsFromJson ({required String json })
→ Future <SvgOptions >
createTableCellFromJson ({required String json })
→ Future <TableCell >
createTableCellStyleFromJson ({required String json })
→ Future <TableCellStyle >
createTableChunkingModeFromJson ({required String json })
→ Future <TableChunkingMode >
createTableDiffFromJson ({required String json })
→ Future <TableDiff >
createTableFromJson ({required String json })
→ Future <Table >
createTableGridFromJson ({required String json })
→ Future <TableGrid >
createTableModelFromJson ({required String json })
→ Future <TableModel >
createTableOverlapPreferenceFromJson ({required String json })
→ Future <TableOverlapPreference >
createTesseractConfigFromJson ({required String json })
→ Future <TesseractConfig >
createTextAnnotationFromJson ({required String json })
→ Future <TextAnnotation >
createTextDirectionFromJson ({required String json })
→ Future <TextDirection >
createTextMetadataFromJson ({required String json })
→ Future <TextMetadata >
createTierStrategyFromJson ({required String json })
→ Future <TierStrategy >
createTokenizerBackendDartImpl ({required String pluginName , required String pluginVersion , required FutureOr <PlatformInt64 > countTokens (String ) })
→ Future <TokenizerBackendDartImpl >
Construct a TokenizerBackendDartImpl from Dart callback closures.
FRB synthesises a Dart-callable function type for each closure parameter,
which is the whole point of taking them as impl Fn(...) -> DartFnFuture<R>
parameters rather than storing them as Box<dyn Fn(...)> fields on an opaque
struct (FRB v2 silently drops factories that return opaque structs whose fields
it cannot bridge). The returned wrapper holds an Arc<dyn Trait + Send + Sync>
whose backing object carries the supplied callbacks privately.
plugin_name and plugin_version are required for the Plugin super-trait.
createTokenReductionConfigFromJson ({required String json })
→ Future <TokenReductionConfig >
createTokenReductionOptionsFromJson ({required String json })
→ Future <TokenReductionOptions >
createTranscriptionConfigFromJson ({required String json })
→ Future <TranscriptionConfig >
createTranslationConfigFromJson ({required String json })
→ Future <TranslationConfig >
createTranslationFromJson ({required String json })
→ Future <Translation >
createTreeSitterConfigFromJson ({required String json })
→ Future <TreeSitterConfig >
createTreeSitterProcessConfigFromJson ({required String json })
→ Future <TreeSitterProcessConfig >
createTrocrBackendOptionsFromJson ({required String json })
→ Future <TrocrBackendOptions >
createUriKindFromJson ({required String json })
→ Future <UriKind >
createUserChunkConfigFromJson ({required String json })
→ Future <UserChunkConfig >
createValidatorDartImpl ({required String pluginName , required String pluginVersion , required FutureOr <void > validate (ExtractedDocument , ExtractionConfig ), required FutureOr <bool > shouldValidate (ExtractedDocument , ExtractionConfig ), required FutureOr <PlatformInt64 > priority () })
→ Future <ValidatorDartImpl >
Construct a ValidatorDartImpl from Dart callback closures.
FRB synthesises a Dart-callable function type for each closure parameter,
which is the whole point of taking them as impl Fn(...) -> DartFnFuture<R>
parameters rather than storing them as Box<dyn Fn(...)> fields on an opaque
struct (FRB v2 silently drops factories that return opaque structs whose fields
it cannot bridge). The returned wrapper holds an Arc<dyn Trait + Send + Sync>
whose backing object carries the supplied callbacks privately.
plugin_name and plugin_version are required for the Plugin super-trait.
createVlmFallbackPolicyFromJson ({required String json })
→ Future <VlmFallbackPolicy >
createWhisperModelFromJson ({required String json })
→ Future <WhisperModel >
createXlsxAppPropertiesFromJson ({required String json })
→ Future <XlsxAppProperties >
createXmlMetadataFromJson ({required String json })
→ Future <XmlMetadata >
createYakeParamsFromJson ({required String json })
→ Future <YakeParams >
createYearRangeFromJson ({required String json })
→ Future <YearRange >
doctor ({required ExtractionConfig config })
→ Future <DoctorReport >
Probe the backends and settings in config and report what will actually
execute on this host.
Extract content from a single bytes or URI input.
Extract content from multiple bytes or URI inputs.
Extract one bytes input and redact a JSON array or JSON Lines payload from an external inspection engine.
findUnmarkedClaims ({required String markdown })
→ Future <List <String > >
Find unmarked claims in markdown text.
List names of all registered document extractors.
listEmbeddingBackends ()
→ Future <List <String > >
List the names of all registered embedding backends.
listOcrBackendCapabilities ()
→ Future <List <OcrBackendCapabilities > >
List every registered OCR backend's name alongside its declared supported languages.
listOcrBackendCapabilitiesFor ({required OcrConfig config })
→ Future <List <OcrBackendCapabilities > >
list_ocr_backend_capabilities, reporting each backend's languages under config.
listOcrBackends ()
→ Future <List <String > >
List all registered OCR backends.
listPostProcessors ()
→ Future <List <String > >
List all registered post-processor names.
listRenderers ()
→ Future <List <String > >
List names of all registered renderers.
listRerankerBackends ()
→ Future <List <String > >
List the names of all registered reranker backends.
listSupportedFormats ()
→ Future <List <SupportedFormat > >
List all supported document formats.
listTokenizerBackends ()
→ Future <List <String > >
List the names of all registered tokenizer backends.
listValidators ()
→ Future <List <String > >
List names of all registered validators.
mapUrl ({required String uri , required UrlExtractionConfig config })
→ Future <MapResult >
Discover all pages and sitemaps reachable from uri without extracting document content.
maxSimRank ({required MultiVectorEmbedding query , required List <MultiVectorEmbedding > docs })
→ Future <List <LateInteractionMatch > >
Rank a set of documents against a query by MaxSim score, descending.
maxSimScore ({required MultiVectorEmbedding query , required MultiVectorEmbedding doc })
→ Future <double >
Score a query against a document using ColBERT's MaxSim operator: for each
query token vector, take the maximum dot product against any document
token vector, then sum across query tokens.
ocrBackendSupportsLanguage ({required String backend , required String language })
→ Future <bool >
Check whether a specific registered OCR backend supports a language.
ocrBackendSupportsLanguageFor ({required String backend , required String language , required OcrConfig config })
→ Future <bool >
ocr_backend_supports_language, answering under config.
pdfPageCount ({required List <int > pdfBytes , String ? password })
→ Future <PlatformInt64 >
Count the pages in a PDF without rendering any of them.
redactExternal ({required ExtractedDocument document , required RedactionConfig config , required String findingsJson , String ? offsetEncoding , PlatformInt64? maxFindings })
→ Future <ExtractedDocument >
Redact an owned document using a JSON array or JSON Lines payload from an external inspection engine.
Register a Dart implementation as a DocumentExtractor plugin.
registerEmbeddingBackend ({required EmbeddingBackendDartImpl impl })
→ Future <void >
Register a Dart implementation as a EmbeddingBackend plugin.
registerOcrBackend ({required OcrBackendDartImpl impl })
→ Future <void >
Register a Dart implementation as a OcrBackend plugin.
registerPostProcessor ({required PostProcessorDartImpl impl })
→ Future <void >
Register a Dart implementation as a PostProcessor plugin.
registerRenderer ({required RendererDartImpl impl })
→ Future <void >
Register a Dart implementation as a Renderer plugin.
registerRerankerBackend ({required RerankerBackendDartImpl impl })
→ Future <void >
Register a Dart implementation as a RerankerBackend plugin.
registerTokenizerBackend ({required TokenizerBackendDartImpl impl })
→ Future <void >
Register a Dart implementation as a TokenizerBackend plugin.
registerValidator ({required ValidatorDartImpl impl })
→ Future <void >
Register a Dart implementation as a Validator plugin.
Unregister a previously-registered DocumentExtractor plugin by name.
Removes the plugin from xberg::plugins::registry::get_document_extractor_registry() and stringifies any host error.
unregisterEmbeddingBackend ({required String name })
→ Future <void >
Unregister a previously-registered EmbeddingBackend plugin by name.
Removes the plugin from xberg::plugins::registry::get_embedding_backend_registry() and stringifies any host error.
unregisterOcrBackend ({required String name })
→ Future <void >
Unregister a previously-registered OcrBackend plugin by name.
Removes the plugin from xberg::plugins::registry::get_ocr_backend_registry() and stringifies any host error.
unregisterPostProcessor ({required String name })
→ Future <void >
Unregister a previously-registered PostProcessor plugin by name.
Removes the plugin from xberg::plugins::registry::get_post_processor_registry() and stringifies any host error.
unregisterRenderer ({required String name })
→ Future <void >
Unregister a previously-registered Renderer plugin by name.
Removes the plugin from xberg::plugins::registry::get_renderer_registry() and stringifies any host error.
unregisterRerankerBackend ({required String name })
→ Future <void >
Unregister a previously-registered RerankerBackend plugin by name.
Removes the plugin from xberg::plugins::registry::get_reranker_backend_registry() and stringifies any host error.
unregisterTokenizerBackend ({required String name })
→ Future <void >
Unregister a previously-registered TokenizerBackend plugin by name.
Removes the plugin from xberg::plugins::registry::get_tokenizer_backend_registry() and stringifies any host error.
unregisterValidator ({required String name })
→ Future <void >
Unregister a previously-registered Validator plugin by name.
Removes the plugin from xberg::plugins::registry::get_validator_registry() and stringifies any host error.
verifyExcerpt ({required String excerpt , required String sourceText })
→ Future <bool >
Verify that an excerpt appears verbatim in source text.