java.lang.Object
- com.mindee.MindeeClient

public class MindeeClient
extends Object

Main entrypoint for Mindee operations.

Field Summary

Fields
Modifier and Type Field Description

protected PdfOperation pdfOperation

Constructor Summary

Constructors
Constructor	Description
`MindeeClient()`	Create a default MindeeClient.
`MindeeClient(MindeeApi mindeeApi)`	Create a MindeeClient using a MindeeApi.
`MindeeClient(PdfOperation pdfOperation, MindeeApi mindeeApi)`	Create a MindeeClient.
`MindeeClient(String apiKey)`	Create a default MindeeClient.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`enqueue(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource)`	Send a local file to a Generated prediction async API queue.
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`enqueue(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource, PredictOptions predictOptions, PageOptions pageOptions)`	Send a local file to a Generated prediction async API queue.
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`enqueue(Class<T> type, Endpoint endpoint, URL sourceUrl)`	Send a remote file to a Generated prediction async API queue.
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`enqueue(Class<T> type, Endpoint endpoint, URL sourceUrl, PredictOptions predictOptions)`	Send a remote file to a Generated prediction async API queue.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueue(Class<T> type, LocalInputSource localInputSource)`	Send a local file to an async queue.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueue(Class<T> type, LocalInputSource localInputSource, PredictOptions predictOptions)`	Send a local file to an async queue.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueue(Class<T> type, LocalInputSource localInputSource, PredictOptions predictOptions, PageOptions pageOptions)`	Send a local file to an async queue.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueue(Class<T> type, URL sourceUrl)`	Send a remote file to an async queue.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueue(Class<T> type, URL sourceUrl, PredictOptions predictOptions)`	Send a remote file to an async queue.
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource)`	Send a local file to a Generated prediction API async queue, poll, and parse when complete.
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource, AsyncPollingOptions pollingOptions)`	Send a local file to a Generated prediction API async queue, poll, and parse when complete.
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource, PredictOptions predictOptions, PageOptions pageOptions, AsyncPollingOptions pollingOptions)`	Send a local file to a Generated prediction API async queue, poll, and parse when complete.
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, Endpoint endpoint, URL sourceUrl)`	Send a remote file to a Generated prediction API async queue, poll, and parse when complete.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, LocalInputSource localInputSource)`	Send a local file to an async queue, poll, and parse when complete.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, LocalInputSource localInputSource, AsyncPollingOptions pollingOptions)`	Send a local file to an async queue, poll, and parse when complete.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, LocalInputSource localInputSource, PredictOptions predictOptions)`	Send a local file to an async queue, poll, and parse when complete.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, LocalInputSource localInputSource, PredictOptions predictOptions, AsyncPollingOptions pollingOptions)`	Send a local file to an async queue, poll, and parse when complete.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, LocalInputSource localInputSource, PredictOptions predictOptions, PageOptions pageOptions, AsyncPollingOptions pollingOptions)`	Send a local file to an async queue, poll, and parse when complete.
`<T extends Inference> AsyncPredictResponse<T>`	`enqueueAndParse(Class<T> type, URL sourceUrl)`	Send a remote file to an async queue, poll, and parse when complete.
`WorkflowResponse<GeneratedV1>`	`executeWorkflow(String workflowId, LocalInputSource localInputSource)`	Send a local file to a workflow execution.
`WorkflowResponse<GeneratedV1>`	`executeWorkflow(String workflowId, LocalInputSource localInputSource, WorkflowOptions workflowOptions)`	Send a local file to a workflow execution.
`protected byte[]`	`getSplitFile(LocalInputSource localInputSource, PageOptions pageOptions)`	Retrieves the file after applying page operations to it.
`<T extends Inference> AsyncPredictResponse<T>`	`loadPrediction(Class<T> type, LocalResponse localResponse)`	Load a local prediction.
`PredictResponse<CustomV1>`	`parse(LocalInputSource localInputSource, Endpoint endpoint)`	Send a local file to a Custom prediction API and parse the results.
`PredictResponse<CustomV1>`	`parse(LocalInputSource localInputSource, Endpoint endpoint, PageOptions pageOptions)`	Send a local file to a Custom prediction API and parse the results.
`<T extends GeneratedV1> PredictResponse<T>`	`parse(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource)`	Send a local file to a Generated prediction API and parse the results.
`<T extends GeneratedV1> PredictResponse<T>`	`parse(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource, PageOptions pageOptions)`	Send a local file to a Generated prediction API and parse the results.
`<T extends GeneratedV1> PredictResponse<T>`	`parse(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource, PredictOptions predictOptions)`	Send a local file to a Generated prediction API and parse the results.
`<T extends GeneratedV1> PredictResponse<T>`	`parse(Class<T> type, Endpoint endpoint, LocalInputSource localInputSource, PredictOptions predictOptions, PageOptions pageOptions)`	Send a local file to a Standard prediction API and parse the results.
`<T extends GeneratedV1> PredictResponse<T>`	`parse(Class<T> type, Endpoint endpoint, URL documentUrl)`	Send a remote file to a Generated prediction API and parse the results.
`<T extends GeneratedV1> PredictResponse<T>`	`parse(Class<T> type, Endpoint endpoint, URL documentUrl, PredictOptions predictOptions)`	Send a remote file to a Generated prediction API and parse the results.
`<T extends Inference> PredictResponse<T>`	`parse(Class<T> type, LocalInputSource localInputSource)`	Send a local file to a Standard prediction API and parse the results.
`<T extends Inference> PredictResponse<T>`	`parse(Class<T> type, LocalInputSource localInputSource, PageOptions pageOptions)`	Send a local file to a Standard prediction API and parse the results.
`<T extends Inference> PredictResponse<T>`	`parse(Class<T> type, LocalInputSource localInputSource, PredictOptions predictOptions)`	Send a local file to a Standard prediction API and parse the results.
`<T extends Inference> PredictResponse<T>`	`parse(Class<T> type, LocalInputSource localInputSource, PredictOptions predictOptions, PageOptions pageOptions)`	Send a local file to a Standard prediction API and parse the results.
`<T extends Inference> PredictResponse<T>`	`parse(Class<T> type, URL urlInputSource)`	Send a remote file to a Standard prediction API and parse the results.
`<T extends Inference> PredictResponse<T>`	`parse(Class<T> type, URL urlInputSource, PredictOptions predictOptions)`	Send a remote file to a Standard prediction API and parse the results.
`PredictResponse<CustomV1>`	`parse(URL documentUrl, Endpoint endpoint)`	Send a remote file to a Custom prediction API and parse the results.
`<T extends GeneratedV1> AsyncPredictResponse<T>`	`parseQueued(Class<T> type, Endpoint endpoint, String jobId)`	Parse a document from a Generated prediction API async queue.
`<T extends Inference> AsyncPredictResponse<T>`	`parseQueued(Class<T> type, String jobId)`	Parse a document from an async queue.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- pdfOperation
```
protected PdfOperation pdfOperation
```

Constructor Detail
- MindeeClient
```
public MindeeClient()
```
  Create a default MindeeClient. You'll need to set the API key in the environment for this approach to work properly.
- MindeeClient
```
public MindeeClient(String apiKey)
```
  Create a default MindeeClient.
  
  Parameters:
  
  apiKey - The api key to use.
- MindeeClient
```
public MindeeClient(MindeeApi mindeeApi)
```
  Create a MindeeClient using a MindeeApi.
  
  Parameters:
  
  mindeeApi - The MindeeApi implementation to be used by the created MindeeClient.
- MindeeClient
```
public MindeeClient(PdfOperation pdfOperation,
                    MindeeApi mindeeApi)
```
  Create a MindeeClient.
  
  Parameters:
  
  pdfOperation - The PdfOperation implementation to be used by the created MindeeClient.
  
  mindeeApi - The MindeeApi implementation to be used by the created MindeeClient.

Method Detail

parseQueued

public <T extends Inference> AsyncPredictResponse<T> parseQueued(Class<T> type,
                                                                 String jobId)

Parse a document from an async queue.

Type Parameters:: T - Type of inference.
Parameters:: type - Type of inference;; jobId - ID of the job.
Returns:: A valid prediction.

enqueue

public <T extends Inference> AsyncPredictResponse<T> enqueue(Class<T> type,
                                                             LocalInputSource localInputSource)
                                                      throws IOException

Send a local file to an async queue.

Type Parameters:: T - Type of inference.
Parameters:: type - Type of inference.; localInputSource - A local input source file.
Returns:: an instance of AsyncPredictResponse.
Throws:: IOException - Throws if the file can't be accessed.

getSplitFile
```
protected byte[] getSplitFile(LocalInputSource localInputSource,
                              PageOptions pageOptions)
                       throws IOException
```
Retrieves the file after applying page operations to it.

Parameters:

localInputSource - Local input source to apply operations to.

pageOptions - Options to apply.

Returns:

A byte array of the file after applying page operations.

Throws:

IOException - Throws if the file can't be accessed.

enqueue

public <T extends Inference> AsyncPredictResponse<T> enqueue(Class<T> type,
                                                             LocalInputSource localInputSource,
                                                             PredictOptions predictOptions,
                                                             PageOptions pageOptions)
                                                      throws IOException

Send a local file to an async queue.

Type Parameters:: T - Type of inference.
Parameters:: type - Type of inference.; localInputSource - A local input source file.; predictOptions - Prediction options for the enqueuing.; pageOptions - Page options for PDF documents.
Returns:: an instance of AsyncPredictResponse.
Throws:: IOException - Throws if the file can't be accessed.

enqueue

public <T extends Inference> AsyncPredictResponse<T> enqueue(Class<T> type,
                                                             LocalInputSource localInputSource,
                                                             PredictOptions predictOptions)
                                                      throws IOException

Send a local file to an async queue.

Type Parameters:: T - Type of inference.
Parameters:: type - Type of inference.; localInputSource - A local input source file.; predictOptions - Prediction options for the enqueuing.
Returns:: an instance of AsyncPredictResponse.
Throws:: IOException - Throws if the file can't be accessed.

enqueue

public <T extends Inference> AsyncPredictResponse<T> enqueue(Class<T> type,
                                                             URL sourceUrl)
                                                      throws IOException

Send a remote file to an async queue.

Type Parameters:: T - Type of inference.
Parameters:: type - Type of inference.; sourceUrl - A URL to a remote file.
Returns:: an instance of AsyncPredictResponse.
Throws:: IOException - Throws if the file can't be accessed.

enqueue

public <T extends Inference> AsyncPredictResponse<T> enqueue(Class<T> type,
                                                             URL sourceUrl,
                                                             PredictOptions predictOptions)
                                                      throws IOException

Send a remote file to an async queue.

Type Parameters:: T - Type of inference.
Parameters:: type - Type of inference.; sourceUrl - A URL to a remote file.; predictOptions - Prediction options for the enqueuing.
Returns:: an instance of AsyncPredictResponse.
Throws:: IOException - Throws if the file can't be accessed.