Package com.mindee

Class InferenceParameters

java.lang.Object

com.mindee.v2.clientOptions.BaseParameters

com.mindee.InferenceParameters

public final class InferenceParameters
extends BaseParameters

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.

Field Summary

Fields inherited from class com.mindee.v2.clientOptions.BaseParameters

alias, modelId, pollingOptions, webhookIds

Method Summary

Modifier and Type	Method	Description
static InferenceParameters.Builder	builder(String modelId)	Create a new builder.
org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder	buildHttpBody(org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder 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.
String	getTextContext()	Additional text context used by the model during inference.
int	hashCode()

Methods inherited from class com.mindee.v2.clientOptions.BaseParameters

getAlias, getModelId, getPollingOptions, getWebhookIds, toString

Methods inherited from class java.lang.Object

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

Method Detail

buildHttpBody

public org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder buildHttpBody(org.apache.hc.client5.http.entity.mime.MultipartEntityBuilder builder)

Overrides:

buildHttpBody in class BaseParameters

builder

public static InferenceParameters.Builder builder(String modelId)

Create a new builder.

Parameters:

modelId - the mandatory model identifier

Returns:

a fresh InferenceParameters.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 BaseParameters

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class BaseParameters

hashCode

public int hashCode()

Overrides:

hashCode in class BaseParameters