Package com.mindee.v2.product.extraction.params

Class ExtractionParameters

java.lang.Object

com.mindee.v2.clientoptions.BaseProductParameters

com.mindee.v2.product.extraction.params.ExtractionParameters

@ProductAttributes(slug="extraction")
public final class ExtractionParameters
extends BaseProductParameters

Options to pass when calling methods using the API V2.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExtractionParameters.Builder	Fluent builder for ExtractionParameters.

Nested classes/interfaces inherited from class com.mindee.v2.clientoptions.BaseProductParameters

BaseProductParameters.BaseBuilder<T extends BaseProductParameters.BaseBuilder<T>>

Field Summary

Fields inherited from class com.mindee.v2.clientoptions.BaseProductParameters

alias, modelId, webhookIds

Method Summary

Modifier and Type	Method	Description
static ExtractionParameters.Builder	builder(String modelId)	Create a new builder.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Boolean	getConfidence()	Boost the precision and accuracy of all extractions.
String	getDataSchema()	Dynamic changes to the data schema of the model for this inference.
Boolean	getPolygon()	Calculate bounding box polygons for all fields.
Boolean	getRag()	Enhance extraction accuracy with Retrieval-Augmented Generation.
Boolean	getRawText()	Extract the full text content from the document as strings.
Map<String,String>	getRequestParameters()
String	getTextContext()	Additional text context used by the model during inference.
int	hashCode()

Methods inherited from class com.mindee.v2.clientoptions.BaseProductParameters

getAlias, getModelId, getWebhookIds, toString

Methods inherited from class java.lang.Object

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

Method Detail

getRequestParameters

public Map<String,String> getRequestParameters()

Overrides:

getRequestParameters in class BaseProductParameters

builder

public static ExtractionParameters.Builder builder(String modelId)

Create a new builder.

Parameters:

modelId - the mandatory model identifier

Returns:

a fresh ExtractionParameters.Builder

getRag

public Boolean getRag()

Enhance extraction accuracy with Retrieval-Augmented Generation.

getRawText

public Boolean getRawText()

Extract the full text content from the document as strings.

getPolygon

public Boolean getPolygon()

Calculate bounding box polygons for all fields.

getConfidence

public Boolean getConfidence()

Boost the precision and accuracy of all extractions. Calculate confidence scores for all fields.

getTextContext

public String getTextContext()

Additional text context used by the model during inference. Not recommended, for specific use only.

getDataSchema

public String getDataSchema()

Dynamic changes to the data schema of the model for this inference.

equals

public boolean equals(Object o)

Overrides:

equals in class BaseProductParameters

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseProductParameters

hashCode

public int hashCode()

Overrides:

hashCode in class BaseProductParameters