Package com.mindee.v1.http

Class MindeeHttpApiV1

java.lang.Object

com.mindee.http.MindeeApiCommon

com.mindee.v1.http.MindeeApiV1

com.mindee.v1.http.MindeeHttpApiV1

public final class MindeeHttpApiV1
extends MindeeApiV1

HTTP Client class.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MindeeHttpApiV1.MindeeHttpApiV1Builder

Constructor Summary

Constructors

Constructor	Description
MindeeHttpApiV1(MindeeSettings mindeeSettings)

Method Summary

Modifier and Type	Method	Description
static MindeeHttpApiV1.MindeeHttpApiV1Builder	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.MindeeApiCommon

getUserAgent, isInvalidStatusCode, readRawResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

MindeeHttpApiV1

public MindeeHttpApiV1(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 MindeeApiV1

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 MindeeApiV1

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 MindeeApiV1

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 MindeeApiV1

Throws:

IOException

builder

public static MindeeHttpApiV1.MindeeHttpApiV1Builder builder()