Package com.mindee.http

Class MindeeHttpApi

java.lang.Object

com.mindee.http.MindeeApi

com.mindee.http.MindeeHttpApi

public final class MindeeHttpApi
extends MindeeApi

HTTP Client class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MindeeHttpApi.MindeeHttpApiBuilder

Constructor Summary

Constructors

Constructor	Description
MindeeHttpApi(MindeeSettings mindeeSettings)

Method Summary

Modifier and Type	Method	Description
static MindeeHttpApi.MindeeHttpApiBuilder	builder()
<DocT extends Inference> AsyncPredictResponse<DocT>	documentQueueGet(Class<DocT> documentClass, Endpoint endpoint, String jobId)	GET job status and document for an enqueued job
<DocT extends Inference> WorkflowResponse<DocT>	executeWorkflowPost(Class<DocT> documentClass, String workflowId, RequestParameters requestParameters)	POST a prediction request for a workflow response.
<DocT extends Inference> AsyncPredictResponse<DocT>	predictAsyncPost(Class<DocT> documentClass, Endpoint endpoint, RequestParameters requestParameters)	POST a prediction request for a custom product.
<DocT extends Inference> PredictResponse<DocT>	predictPost(Class<DocT> documentClass, Endpoint endpoint, RequestParameters requestParameters)	POST a prediction request for a custom product.

Methods inherited from class com.mindee.http.MindeeApi

getUserAgent, is2xxStatusCode, readRawResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

MindeeHttpApi

public MindeeHttpApi(MindeeSettings mindeeSettings)

Method Detail

documentQueueGet

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

GET job status and document for an enqueued job

Specified by:

documentQueueGet in class MindeeApi

predictPost

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

POST a prediction request for a custom product.

Specified by:

predictPost in class MindeeApi

Throws:

IOException

predictAsyncPost

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

POST a prediction request for a custom product.

Specified by:

predictAsyncPost in class MindeeApi

Throws:

IOException

executeWorkflowPost

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

POST a prediction request for a workflow response.

Specified by:

executeWorkflowPost in class MindeeApi

Throws:

IOException

builder

public static MindeeHttpApi.MindeeHttpApiBuilder builder()