Package ai.extend.types

Class ExtractConfigJson

java.lang.Object

ai.extend.types.ExtractConfigJson

public final class ExtractConfigJson
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtractConfigJson.Builder

Method Summary

Modifier and Type	Method	Description
static ExtractConfigJson.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<ExtractAdvancedOptions>	getAdvancedOptions()
java.util.Optional<ExtractBaseProcessor>	getBaseProcessor()
java.util.Optional<java.lang.String>	getBaseVersion()
java.util.Optional<java.lang.String>	getExtractionRules()
java.util.Optional<ParseConfig>	getParseConfig()
java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getSchema()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getBaseProcessor

public java.util.Optional<ExtractBaseProcessor> getBaseProcessor()

getBaseVersion

public java.util.Optional<java.lang.String> getBaseVersion()

Returns:

The version of the "extraction_performance" or "extraction_light" processor to use. If not provided, the latest stable version for the selected baseProcessor will be used automatically. See Extraction Changelog for more details.

getExtractionRules

public java.util.Optional<java.lang.String> getExtractionRules()

Returns:

Custom rules to guide the extraction process in natural language.

When schema is omitted, extractionRules also serves as schema generation instructions — for example, "Invoice with vendor name, line items, and total due". Providing focused instructions produces a more targeted inferred schema.

getSchema

public java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getSchema()

Returns:

JSON Schema definition of the data to extract. Optional — if omitted, Extend automatically infers a schema from the document before running extraction. No extractor is required.

See the JSON Schema guide for details and examples of schema configuration.

getAdvancedOptions

public java.util.Optional<ExtractAdvancedOptions> getAdvancedOptions()

Returns:

Advanced configuration options.

getParseConfig

public java.util.Optional<ParseConfig> getParseConfig()

Returns:

Configuration options for the parsing process.

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

builder

public static ExtractConfigJson.Builder builder()