Package ai.extend.types

Class ParseConfigAdvancedOptions

  • public final class ParseConfigAdvancedOptions
extends java.lang.Object

    • Method Detail

      • getPageRotationEnabled

        public java.util.Optional<java.lang.Boolean> getPageRotationEnabled()
        Returns:
        Whether to automatically detect and correct page rotation.

      • getPageRanges

        public java.util.Optional<java.util.List<PageRangesItem>> getPageRanges()

      • getExcelParsingMode

        public java.util.Optional<ParseConfigAdvancedOptionsExcelParsingMode> getExcelParsingMode()
        Returns:
        Controls how Excel files are parsed.
        • basic: Fast, deterministic parsing.
        • advanced: Enable layout block detection for complex spreadsheets. This mode incurs additional credits when enabled.

        For .xls files, basic mode is always used.

      • getExcelSkipHiddenContent

        public java.util.Optional<java.lang.Boolean> getExcelSkipHiddenContent()
        Returns:
        Whether to exclude hidden rows, columns, and sheets when parsing Excel files.

      • getExcelUseRawCellValues

        public java.util.Optional<java.lang.Boolean> getExcelUseRawCellValues()
        Returns:
        Whether to return raw calculated cell values instead of locale-formatted values when parsing Excel files. Useful when downstream processing needs the underlying numeric or unformatted data.

      • getExcelSkipCalculation

        public java.util.Optional<java.lang.Boolean> getExcelSkipCalculation()
        Returns:
        Whether to skip formula recalculation when opening Excel workbooks. Significantly improves parsing speed for formula-heavy spreadsheets. Disable if cell values depend on volatile functions like NOW() or TODAY().

      • getExcelIncludeCellMetadata

        public java.util.Optional<java.lang.Boolean> getExcelIncludeCellMetadata()
        Returns:
        Whether to include spreadsheet cell provenance when parsing Excel files in advanced mode. When enabled, table cell block details include source cell references and formulas, text or heading block details can include source ranges, and HTML table output includes data-cell and data-formula attributes.

      • getExcelIncludeCellFormatting

        public java.util.Optional<java.lang.Boolean> getExcelIncludeCellFormatting()
        Returns:
        Whether to include spreadsheet cell formatting when parsing Excel files in advanced mode. When enabled, table cell block details include structured formatting such as bold, italic, font color, and background color, and HTML table output preserves inline cell styles.

      • getVerticalGroupingThreshold

        public java.util.Optional<java.lang.Double> getVerticalGroupingThreshold()
        Returns:
        Multiplier for the Y-axis threshold used to determine if text blocks should be placed on the same line or not (0.1-5.0, default 1.0). Higher values group elements that are further apart vertically. Only applies when the spatial target is set.

      • getAlwaysConvertToPdf

        public java.util.Optional<java.lang.Boolean> getAlwaysConvertToPdf()
        Returns:
        Whether to convert supported file types (images, Word documents, PowerPoint, Excel, HTML) to PDF before parsing. This can improve parsing quality for some file types and ensures spatial output with bounding boxes.

      • getEnrichmentFormat

        public java.util.Optional<ParseConfigAdvancedOptionsEnrichmentFormat> getEnrichmentFormat()
        Returns:
        The format used for enrichment annotations in the output.
        • xml: Use XML-style tags for enrichment annotations, e.g. <page_number>1</page_number> or <barcode>1234567890</barcode>
        • bracket: Use bracket-style notation for enrichment annotations, e.g. [page_number: 1] or [barcode: 1234567890]

      • getImageConversionQuality

        public java.util.Optional<ParseConfigAdvancedOptionsImageConversionQuality> getImageConversionQuality()
        Returns:
        Controls the quality level when converting images or documents to PDF for parsing.
        • high: Maximum quality, can add some latency for large/dense documents
        • medium: Balanced quality and speed
        • low: Lower quality, smaller file sizes, faster processing

      • getFormattingDetection

        public java.util.Optional<java.util.List<ParseConfigAdvancedOptionsFormattingDetectionItem>> getFormattingDetection()
        Returns:
        Enable detection of formatting-based annotations in the document. Currently supports change tracking detection.

        When enabled, detected changes are represented inline within the content field of applicable blocks using standard HTML change-tracking elements: <ins> for insertions and <del> for deletions, grouped inside a <change> wrapper.

        Affected block types: text, heading, section_heading, header, footer.

        Note: Requires engine: "parse_performance" with engineVersion >= "2.0.0".

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object