Package com.mindee.v2.clientoptions

Class BaseProductParameters

java.lang.Object

com.mindee.v2.clientoptions.BaseProductParameters

Direct Known Subclasses:

ClassificationParameters, CropParameters, ExtractionParameters, OcrParameters, SplitParameters

public abstract class BaseProductParameters
extends Object

Base parameters for sending a file to a Mindee V2 product.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	BaseProductParameters.BaseBuilder<T extends BaseProductParameters.BaseBuilder<T>>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	alias	Optional: a free-form string to tag the request with your own identifier.
protected String	modelId	Model ID to use for the inference.
protected String[]	webhookIds	Webhook IDs to call after all processing is finished.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	BaseProductParameters(String modelId, String alias, String[] webhookIds)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getAlias()	Optional: a free-form string to tag the request with your own identifier.
String	getModelId()	Model ID to use for the inference.
Map<String,String>	getRequestParameters()
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

Field Detail

modelId

protected final String modelId

Model ID to use for the inference. Required.

alias

protected final String alias

Optional: a free-form string to tag the request with your own identifier. For example, an internal document ID, reference number, or database key. If set, it will be included in the job and result responses.

webhookIds

protected final String[] webhookIds

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

Constructor Detail

BaseProductParameters

protected BaseProductParameters(String modelId,
                                String alias,
                                String[] webhookIds)

Method Detail

getRequestParameters

public Map<String,String> getRequestParameters()

getModelId

public String getModelId()

Model ID to use for the inference. Required.

getAlias

public String getAlias()

Optional: a free-form string to tag the request with your own identifier. For example, an internal document ID, reference number, or database key. If set, it will be included in the job and result responses.

getWebhookIds

public String[] getWebhookIds()

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object