Package ai.extend.types

Class ExtractAdvancedOptions.Builder

java.lang.Object

ai.extend.types.ExtractAdvancedOptions.Builder

Enclosing class:

ExtractAdvancedOptions

public static final class ExtractAdvancedOptions.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
ExtractAdvancedOptions.Builder	advancedMultimodalEnabled(java.lang.Boolean advancedMultimodalEnabled)
ExtractAdvancedOptions.Builder	advancedMultimodalEnabled(java.util.Optional<java.lang.Boolean> advancedMultimodalEnabled)	Whether to enable advanced multimodal features.
ExtractAdvancedOptions.Builder	arrayCitationStrategy(ExtractAdvancedOptionsArrayCitationStrategy arrayCitationStrategy)
ExtractAdvancedOptions.Builder	arrayCitationStrategy(java.util.Optional<ExtractAdvancedOptionsArrayCitationStrategy> arrayCitationStrategy)	Granularity for array citations.
ExtractAdvancedOptions.Builder	arrayStrategy(ArrayStrategy arrayStrategy)
ExtractAdvancedOptions.Builder	arrayStrategy(java.util.Optional<ArrayStrategy> arrayStrategy)	Strategy for handling large arrays in documents.
ExtractAdvancedOptions	build()
ExtractAdvancedOptions.Builder	chunkingOptions(ExtractChunkingOptions chunkingOptions)
ExtractAdvancedOptions.Builder	chunkingOptions(java.util.Optional<ExtractChunkingOptions> chunkingOptions)
ExtractAdvancedOptions.Builder	citationMode(ExtractAdvancedOptionsCitationMode citationMode)
ExtractAdvancedOptions.Builder	citationMode(java.util.Optional<ExtractAdvancedOptionsCitationMode> citationMode)	Controls the granularity of citations returned alongside extracted values.
ExtractAdvancedOptions.Builder	citationsEnabled(java.lang.Boolean citationsEnabled)
ExtractAdvancedOptions.Builder	citationsEnabled(java.util.Optional<java.lang.Boolean> citationsEnabled)	Whether to enable citations in the output.
ExtractAdvancedOptions.Builder	currentDateEnabled(java.lang.Boolean currentDateEnabled)
ExtractAdvancedOptions.Builder	currentDateEnabled(java.util.Optional<java.lang.Boolean> currentDateEnabled)	Whether to include the current date as context for the model during extraction.
ExtractAdvancedOptions.Builder	excelSheetRanges(java.util.List<ExcelSheetRange> excelSheetRanges)
ExtractAdvancedOptions.Builder	excelSheetRanges(java.util.Optional<java.util.List<ExcelSheetRange>> excelSheetRanges)	Ranges of sheet indices to extract from Excel documents.
ExtractAdvancedOptions.Builder	excelSheetSelectionStrategy(ExtractAdvancedOptionsExcelSheetSelectionStrategy excelSheetSelectionStrategy)
ExtractAdvancedOptions.Builder	excelSheetSelectionStrategy(java.util.Optional<ExtractAdvancedOptionsExcelSheetSelectionStrategy> excelSheetSelectionStrategy)	Strategy for selecting sheets from Excel documents.
ExtractAdvancedOptions.Builder	from(ExtractAdvancedOptions other)
ExtractAdvancedOptions.Builder	modelReasoningInsightsEnabled(java.lang.Boolean modelReasoningInsightsEnabled)
ExtractAdvancedOptions.Builder	modelReasoningInsightsEnabled(java.util.Optional<java.lang.Boolean> modelReasoningInsightsEnabled)	Whether to enable model reasoning insights.
ExtractAdvancedOptions.Builder	pageRanges(java.util.List<PageRangesItem> pageRanges)
ExtractAdvancedOptions.Builder	pageRanges(java.util.Optional<java.util.List<PageRangesItem>> pageRanges)
ExtractAdvancedOptions.Builder	reviewAgent(ExtractAdvancedOptionsReviewAgent reviewAgent)
ExtractAdvancedOptions.Builder	reviewAgent(java.util.Optional<ExtractAdvancedOptionsReviewAgent> reviewAgent)	Configuration for the review agent that analyzes extraction results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

from

public ExtractAdvancedOptions.Builder from(ExtractAdvancedOptions other)

modelReasoningInsightsEnabled

public ExtractAdvancedOptions.Builder modelReasoningInsightsEnabled(java.util.Optional<java.lang.Boolean> modelReasoningInsightsEnabled)

Whether to enable model reasoning insights.

modelReasoningInsightsEnabled

public ExtractAdvancedOptions.Builder modelReasoningInsightsEnabled(java.lang.Boolean modelReasoningInsightsEnabled)

advancedMultimodalEnabled

public ExtractAdvancedOptions.Builder advancedMultimodalEnabled(java.util.Optional<java.lang.Boolean> advancedMultimodalEnabled)

Whether to enable advanced multimodal features.

advancedMultimodalEnabled

public ExtractAdvancedOptions.Builder advancedMultimodalEnabled(java.lang.Boolean advancedMultimodalEnabled)

citationsEnabled

public ExtractAdvancedOptions.Builder citationsEnabled(java.util.Optional<java.lang.Boolean> citationsEnabled)

Whether to enable citations in the output.

citationsEnabled

public ExtractAdvancedOptions.Builder citationsEnabled(java.lang.Boolean citationsEnabled)

citationMode

public ExtractAdvancedOptions.Builder citationMode(java.util.Optional<ExtractAdvancedOptionsCitationMode> citationMode)

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.

citationMode

public ExtractAdvancedOptions.Builder citationMode(ExtractAdvancedOptionsCitationMode citationMode)

arrayCitationStrategy

public ExtractAdvancedOptions.Builder arrayCitationStrategy(java.util.Optional<ExtractAdvancedOptionsArrayCitationStrategy> arrayCitationStrategy)

Granularity for array citations. This requires citationsEnabled=true and a base processor version that supports property-level array citations (extraction_performance ≥ 4.4.0).

arrayCitationStrategy

public ExtractAdvancedOptions.Builder arrayCitationStrategy(ExtractAdvancedOptionsArrayCitationStrategy arrayCitationStrategy)

arrayStrategy

public ExtractAdvancedOptions.Builder arrayStrategy(java.util.Optional<ArrayStrategy> arrayStrategy)

Strategy for handling large arrays in documents.

arrayStrategy

public ExtractAdvancedOptions.Builder arrayStrategy(ArrayStrategy arrayStrategy)

chunkingOptions

public ExtractAdvancedOptions.Builder chunkingOptions(java.util.Optional<ExtractChunkingOptions> chunkingOptions)

chunkingOptions

public ExtractAdvancedOptions.Builder chunkingOptions(ExtractChunkingOptions chunkingOptions)

excelSheetRanges

public ExtractAdvancedOptions.Builder excelSheetRanges(java.util.Optional<java.util.List<ExcelSheetRange>> excelSheetRanges)

Ranges of sheet indices to extract from Excel documents.

excelSheetRanges

public ExtractAdvancedOptions.Builder excelSheetRanges(java.util.List<ExcelSheetRange> excelSheetRanges)

excelSheetSelectionStrategy

public ExtractAdvancedOptions.Builder excelSheetSelectionStrategy(java.util.Optional<ExtractAdvancedOptionsExcelSheetSelectionStrategy> excelSheetSelectionStrategy)

Strategy for selecting sheets from Excel documents.

excelSheetSelectionStrategy

public ExtractAdvancedOptions.Builder excelSheetSelectionStrategy(ExtractAdvancedOptionsExcelSheetSelectionStrategy excelSheetSelectionStrategy)

pageRanges

public ExtractAdvancedOptions.Builder pageRanges(java.util.Optional<java.util.List<PageRangesItem>> pageRanges)

pageRanges

public ExtractAdvancedOptions.Builder pageRanges(java.util.List<PageRangesItem> pageRanges)

reviewAgent

public ExtractAdvancedOptions.Builder reviewAgent(java.util.Optional<ExtractAdvancedOptionsReviewAgent> reviewAgent)

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

reviewAgent

public ExtractAdvancedOptions.Builder reviewAgent(ExtractAdvancedOptionsReviewAgent reviewAgent)

currentDateEnabled

public ExtractAdvancedOptions.Builder currentDateEnabled(java.util.Optional<java.lang.Boolean> currentDateEnabled)

Whether to include the current date as context for the model during extraction. Defaults to false.

currentDateEnabled

public ExtractAdvancedOptions.Builder currentDateEnabled(java.lang.Boolean currentDateEnabled)

build

public ExtractAdvancedOptions build()