Package com.mindee

Class InferenceParameters

java.lang.Object

com.mindee.InferenceParameters

public final class InferenceParameters
extends Object

Options to pass when calling methods using the API V2.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
InferenceParameters(String modelId, Boolean rag, Boolean rawText, Boolean polygon, Boolean confidence, String alias, String[] webhookIds, AsyncPollingOptions pollingOptions, String textContext, String dataSchema)

Method Summary

Modifier and Type	Method	Description
static InferenceParameters.Builder	builder(String modelId)	Create a new builder.
boolean	equals(Object o)
String	getAlias()	Optional alias for the file.
Boolean	getConfidence()	Boost the precision and accuracy of all extractions.
String	getDataSchema()	Dynamic changes to the data schema of the model for this inference.
String	getModelId()	Model ID to use for the inference (required).
AsyncPollingOptions	getPollingOptions()	Polling options.
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.
String	getTextContext()	Additional text context used by the model during inference.
String[]	getWebhookIds()	Webhook IDs to call after all processing is finished.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

InferenceParameters

public InferenceParameters(String modelId,
                           Boolean rag,
                           Boolean rawText,
                           Boolean polygon,
                           Boolean confidence,
                           String alias,
                           String[] webhookIds,
                           AsyncPollingOptions pollingOptions,
                           String textContext,
                           String dataSchema)

Method Detail

builder

public static InferenceParameters.Builder builder(String modelId)

Create a new builder.

Parameters:

modelId - the mandatory model identifier

Returns:

a fresh InferenceParameters.Builder

getModelId

public String getModelId()

Model ID to use for the inference (required).

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.

getAlias

public String getAlias()

Optional alias for the file.

getWebhookIds

public String[] getWebhookIds()

Webhook IDs to call after all processing is finished. If empty, no webhooks will be used.

getPollingOptions

public AsyncPollingOptions getPollingOptions()

Polling options. Set only if having timeout issues.

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 Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object