Package com.mindee.http

Class MindeeHttpApiV2

java.lang.Object

com.mindee.http.MindeeApiCommon

com.mindee.http.MindeeApiV2

com.mindee.http.MindeeHttpApiV2

public final class MindeeHttpApiV2
extends MindeeApiV2

HTTP Client class for the V2 API.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MindeeHttpApiV2.MindeeHttpApiV2Builder

Constructor Summary

Constructors

Constructor	Description
MindeeHttpApiV2(MindeeSettingsV2 mindeeSettings)

Method Summary

Modifier and Type	Method	Description
static MindeeHttpApiV2.MindeeHttpApiV2Builder	builder()
InferenceResponse	reqGetInference(String inferenceId)	Retrieves the inference from a 302 redirect.
JobResponse	reqGetJob(String jobId)	Attempts to poll the queue.
JobResponse	reqPostInferenceEnqueue(LocalInputSource inputSource, InferenceParameters options)	Enqueues a doc with the POST method.
JobResponse	reqPostInferenceEnqueue(URLInputSource inputSource, InferenceParameters options)	Enqueues a doc with the POST method.

Methods inherited from class com.mindee.http.MindeeApiV2

makeUnknownError

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

MindeeHttpApiV2

public MindeeHttpApiV2(MindeeSettingsV2 mindeeSettings)

Method Detail

reqPostInferenceEnqueue

public JobResponse reqPostInferenceEnqueue(LocalInputSource inputSource,
                                           InferenceParameters options)

Enqueues a doc with the POST method.

Specified by:

reqPostInferenceEnqueue in class MindeeApiV2

Parameters:

inputSource - Input source to send.

options - Options to send the file along with.

Returns:

A job response.

reqPostInferenceEnqueue

public JobResponse reqPostInferenceEnqueue(URLInputSource inputSource,
                                           InferenceParameters options)

Enqueues a doc with the POST method.

Specified by:

reqPostInferenceEnqueue in class MindeeApiV2

Parameters:

inputSource - Input source to send.

options - Options to send the file along with.

Returns:

A job response.

reqGetJob

public JobResponse reqGetJob(String jobId)

Description copied from class: MindeeApiV2

Attempts to poll the queue.

Specified by:

reqGetJob in class MindeeApiV2

Parameters:

jobId - id of the job to get.

reqGetInference

public InferenceResponse reqGetInference(String inferenceId)

Description copied from class: MindeeApiV2

Retrieves the inference from a 302 redirect.

Specified by:

reqGetInference in class MindeeApiV2

Parameters:

inferenceId - ID of the inference to poll.

builder

public static MindeeHttpApiV2.MindeeHttpApiV2Builder builder()