Package ai.extend.types

Class ExtractAdvancedOptions

  • public final class ExtractAdvancedOptions
extends java.lang.Object

    • Method Detail

      • getModelReasoningInsightsEnabled

        public java.util.Optional<java.lang.Boolean> getModelReasoningInsightsEnabled()
        Returns:
        Whether to enable model reasoning insights.

      • getAdvancedMultimodalEnabled

        public java.util.Optional<java.lang.Boolean> getAdvancedMultimodalEnabled()
        Returns:
        Whether to enable advanced multimodal features.

      • getCitationsEnabled

        public java.util.Optional<java.lang.Boolean> getCitationsEnabled()
        Returns:
        Whether to enable citations in the output.

      • getCitationMode

        public java.util.Optional<ExtractAdvancedOptionsCitationMode> getCitationMode()
        Returns:
        Controls the granularity of citations returned alongside extracted values. Requires citationsEnabled=true and a base processor version that supports bounding box citations.
        • line: Use OCR lines for citations. This can return one or more relevant OCR lines for each citation. This is the default mode.
        • word: Narrow each matched citation down to the relevant OCR word span when possible. Note: this might still return line citations in cases where the citation model is unable to reliably narrow down to a word-level citation. Typically, this only makes sense when you are doing array extraction and want precise word citations from a given cell in a table to match an array property, e.g. line_items.total.
        • block: Use parser blocks (e.g. full paragraphs, key-val regions, tables, lists, etc.) and return block-level polygons for each citation. Will have highest recall in terms of overlap with the extracted value source, but least granularity.

      • getArrayCitationStrategy

        public java.util.Optional<ExtractAdvancedOptionsArrayCitationStrategy> getArrayCitationStrategy()
        Returns:
        Granularity for array citations. This requires citationsEnabled=true and a base processor version that supports property-level array citations (extraction_performance ≥ 4.4.0).

      • getArrayStrategy

        public java.util.Optional<ArrayStrategy> getArrayStrategy()
        Returns:
        Strategy for handling large arrays in documents.

      • getExcelSheetRanges

        public java.util.Optional<java.util.List<ExcelSheetRange>> getExcelSheetRanges()
        Returns:
        Ranges of sheet indices to extract from Excel documents.

      • getPageRanges

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

      • getReviewAgent

        public java.util.Optional<ExtractAdvancedOptionsReviewAgent> getReviewAgent()
        Returns:
        Configuration for the review agent that analyzes extraction results. When enabled, each field in the output metadata will include a reviewAgentScore (1-5) and may include additional insights of type issue or review_summary to help identify fields that may need manual review.

        To learn more, view the Review Agent Documentation

      • getCurrentDateEnabled

        public java.util.Optional<java.lang.Boolean> getCurrentDateEnabled()
        Returns:
        Whether to include the current date as context for the model during extraction. Defaults to false.

      • 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