Package com.mindee.v2.http

Class MindeeApiV2

java.lang.Object

com.mindee.http.MindeeApiCommon

com.mindee.v2.http.MindeeApiV2

Direct Known Subclasses:

MindeeHttpApiV2

public abstract class MindeeApiV2
extends MindeeApiCommon

Defines required methods for an API.

Constructor Summary

Constructors

Constructor	Description
MindeeApiV2()

Method Summary

Modifier and Type	Method	Description
protected ProductInfo	getParamsProductInfo(Class<? extends BaseParameters> responseClass)
protected ProductInfo	getResponseProductInfo(Class<? extends CommonResponse> responseClass)
protected ErrorResponse	makeUnknownError(int statusCode)	Creates an "unknown error" response from an HTTP status code.
abstract JobResponse	reqGetJob(String jobId)	Attempts to poll the queue.
abstract <TResponse extends CommonResponse> TResponse	reqGetResult(Class<TResponse> responseClass, String inferenceId)	Retrieves the inference from a 302 redirect.
abstract SearchResponse	reqGetSearchModels(String modelName, String modelType)	Retrieves a list of models.
abstract JobResponse	reqPostEnqueue(LocalInputSource inputSource, BaseParameters options)	Send a file to the prediction queue with a local file.
abstract JobResponse	reqPostEnqueue(URLInputSource inputSource, BaseParameters options)	Send a file to the prediction queue with a remote file.

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

MindeeApiV2

public MindeeApiV2()

Method Detail

reqPostEnqueue

public abstract JobResponse reqPostEnqueue(LocalInputSource inputSource,
                                           BaseParameters options)
                                    throws IOException

Send a file to the prediction queue with a local file.

Parameters:

inputSource - Local input source from URL.

options - parameters.

Throws:

IOException

reqPostEnqueue

public abstract JobResponse reqPostEnqueue(URLInputSource inputSource,
                                           BaseParameters options)
                                    throws IOException

Send a file to the prediction queue with a remote file.

Parameters:

inputSource - Remote input source from URL.

options - parameters.

Throws:

IOException

reqGetJob

public abstract JobResponse reqGetJob(String jobId)

Attempts to poll the queue.

Parameters:

jobId - id of the job to get.

reqGetResult

public abstract <TResponse extends CommonResponse> TResponse reqGetResult(Class<TResponse> responseClass,
                                                                          String inferenceId)

Retrieves the inference from a 302 redirect.

Parameters:

inferenceId - ID of the inference to poll.

reqGetSearchModels

public abstract SearchResponse reqGetSearchModels(String modelName,
                                                  String modelType)

Retrieves a list of models.

Parameters:

modelName - search term for model name

modelType - search term for model type

makeUnknownError

protected ErrorResponse makeUnknownError(int statusCode)

Creates an "unknown error" response from an HTTP status code.

getResponseProductInfo

protected ProductInfo getResponseProductInfo(Class<? extends CommonResponse> responseClass)

getParamsProductInfo

protected ProductInfo getParamsProductInfo(Class<? extends BaseParameters> responseClass)