Package com.mindee.v1.http

Class MindeeApiV1

java.lang.Object

com.mindee.http.MindeeApiCommon

com.mindee.v1.http.MindeeApiV1

Direct Known Subclasses:

MindeeHttpApiV1

public abstract class MindeeApiV1
extends MindeeApiCommon

Defines required methods for an API.

Constructor Summary

Constructors

Constructor	Description
MindeeApiV1()

Method Summary

Modifier and Type	Method	Description
abstract <DocT extends Inference> AsyncPredictResponse<DocT>	documentQueueGet(Class<DocT> documentClass, Endpoint endpoint, String jobId)	Get a document from the predict queue.
abstract <DocT extends Inference> WorkflowResponse<DocT>	executeWorkflowPost(Class<DocT> documentClass, String workflowId, RequestParameters requestParameters)	Execute a workflow.
abstract <DocT extends Inference> AsyncPredictResponse<DocT>	predictAsyncPost(Class<DocT> documentClass, Endpoint endpoint, RequestParameters requestParameters)	Send a file to the prediction queue.
abstract <DocT extends Inference> PredictResponse<DocT>	predictPost(Class<DocT> documentClass, Endpoint endpoint, RequestParameters requestParameters)	Send a file to the prediction API.

Methods inherited from class com.mindee.http.MindeeApiCommon

getUserAgent, isInvalidStatusCode, readRawResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MindeeApiV1

public MindeeApiV1()

Method Detail

documentQueueGet

public abstract <DocT extends Inference> AsyncPredictResponse<DocT> documentQueueGet(Class<DocT> documentClass,
                                                                                     Endpoint endpoint,
                                                                                     String jobId)

Get a document from the predict queue.

predictAsyncPost

public abstract <DocT extends Inference> AsyncPredictResponse<DocT> predictAsyncPost(Class<DocT> documentClass,
                                                                                     Endpoint endpoint,
                                                                                     RequestParameters requestParameters)
                                                                              throws IOException

Send a file to the prediction queue.

Throws:

IOException

predictPost

public abstract <DocT extends Inference> PredictResponse<DocT> predictPost(Class<DocT> documentClass,
                                                                           Endpoint endpoint,
                                                                           RequestParameters requestParameters)
                                                                    throws IOException

Send a file to the prediction API.

Throws:

IOException

executeWorkflowPost

public abstract <DocT extends Inference> WorkflowResponse<DocT> executeWorkflowPost(Class<DocT> documentClass,
                                                                                    String workflowId,
                                                                                    RequestParameters requestParameters)
                                                                             throws IOException

Execute a workflow.

Throws:

IOException