Package ai.extend.types

Class ExtractionConfig

java.lang.Object

ai.extend.types.ExtractionConfig

public final class ExtractionConfig
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtractionConfig.Builder

Method Summary

Modifier and Type	Method	Description
static ExtractionConfig.Builder	builder()
boolean	equals(java.lang.Object other)
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalProperties()
java.util.Optional<ExtractionAdvancedOptions>	getAdvancedOptions()
java.util.Optional<ExtractionConfigBaseProcessor>	getBaseProcessor()
java.util.Optional<java.lang.String>	getBaseVersion()
java.util.Optional<java.lang.String>	getExtractionRules()
java.util.Optional<java.util.List<ExtractionField>>	getFields()
java.util.Optional<ParseConfig>	getParser()
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<ExtractionConfigBaseProcessor> getBaseProcessor()

Returns:

The base processor to use. For extractors, this must be either "extraction_performance" or "extraction_light". See Extraction Changelog for more details.

getBaseVersion

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

Returns:

The version of the "extraction_performance" or "extraction_light" processor to use. If this is provided, the baseProcessor must also be provided. 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.

getSchema

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

Returns:

JSON Schema definition of the data to extract. Either fields or schema must be provided.

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

getFields

public java.util.Optional<java.util.List<ExtractionField>> getFields()

Returns:

Array of fields to extract from the document. Either fields or schema must be provided.

We recommend using schema for new implementations.

getAdvancedOptions

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

Returns:

Advanced configuration options.

getParser

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

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 ExtractionConfig.Builder builder()