ai.lucidtech.las.sdk

Class Client

java.lang.Object

ai.lucidtech.las.sdk.Client

public class Client
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Client(Credentials credentials) A client to invoke api methods from Lucidtech AI Services.

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	createBatch(java.lang.String description) Creates a batch handle, calls the POST /batches endpoint
org.json.JSONObject	createDocument(byte[] content, ContentType contentType, java.lang.String consentId) Creates a document handle, calls POST /documents endpoint
org.json.JSONObject	createDocument(byte[] content, ContentType contentType, java.lang.String consentId, java.util.Map<java.lang.String,java.lang.Object> options) Creates a document handle, calls POST /documents endpoint
org.json.JSONObject	createDocument(java.io.InputStream content, ContentType contentType, java.lang.String consentId) Creates a document handle, calls POST /documents endpoint
org.json.JSONObject	createDocument(java.io.InputStream content, ContentType contentType, java.lang.String consentId, java.util.Map<java.lang.String,java.lang.Object> options) Creates a document handle, calls POST /documents endpoint
org.json.JSONObject	createPrediction(java.lang.String documentId, java.lang.String modelName) Run inference and create a prediction, calls the POST /predictions endpoint
org.json.JSONObject	createPrediction(java.lang.String documentId, java.lang.String modelName, java.util.Map<java.lang.String,java.lang.Object> options) Run inference and create a prediction, calls the POST /predictions endpoint
org.json.JSONObject	deleteConsent(java.lang.String consentId) Delete documents with this consent_id, calls the DELETE /consent/{consentId} endpoint.
org.json.JSONObject	getDocument(java.lang.String documentId)
org.json.JSONObject	getUser(java.lang.String userId) Get information about user, calls the GET /users/{user_id} endpoint.
org.json.JSONObject	listDocuments()
org.json.JSONObject	listDocuments(java.util.List<org.apache.http.NameValuePair> options)
Prediction	predict(java.lang.String documentPath, java.lang.String modelName, java.lang.String consentId) Create a prediction on a document documentPath by path using model modelName.
org.json.JSONObject	updateDocument(java.lang.String documentId, org.json.JSONObject feedback) Post feedback to the REST API, calls the POST /documents/{documentId} endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client(Credentials credentials)

A client to invoke api methods from Lucidtech AI Services.

Parameters:

credentials - Credentials to use

See Also:

Credentials

Method Detail

getDocument

public org.json.JSONObject getDocument(java.lang.String documentId)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Parameters:

documentId - The document id to run inference and create a prediction on

Returns:

response from the API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listDocuments

public org.json.JSONObject listDocuments()
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

Returns:

All documents from REST API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

listDocuments

public org.json.JSONObject listDocuments(java.util.List<org.apache.http.NameValuePair> options)
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

Parameters:

options - Available options are:

Returns:

documents from REST API filtered using the passed options

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

createDocument

public org.json.JSONObject createDocument(java.io.InputStream content,
                                          ContentType contentType,
                                          java.lang.String consentId,
                                          java.util.Map<java.lang.String,java.lang.Object> options)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a document handle, calls POST /documents endpoint

Parameters:

content - Input stream

contentType - A mime type for the document handle

consentId - An identifier to mark the owner of the document handle

options - Additional options to include in request body

Returns:

Response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ContentType

createDocument

public org.json.JSONObject createDocument(java.io.InputStream content,
                                          ContentType contentType,
                                          java.lang.String consentId)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a document handle, calls POST /documents endpoint

Parameters:

content - Input stream

contentType - A mime type for the document handle

consentId - An identifier to mark the owner of the document handle

Returns:

Response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ContentType

createDocument

public org.json.JSONObject createDocument(byte[] content,
                                          ContentType contentType,
                                          java.lang.String consentId,
                                          java.util.Map<java.lang.String,java.lang.Object> options)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a document handle, calls POST /documents endpoint

Parameters:

content - Binary data

contentType - A mime type for the document handle

consentId - An identifier to mark the owner of the document handle

options - Additional options to include in request body

Returns:

Response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ContentType

createDocument

public org.json.JSONObject createDocument(byte[] content,
                                          ContentType contentType,
                                          java.lang.String consentId)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Creates a document handle, calls POST /documents endpoint

Parameters:

content - Binary data

contentType - A mime type for the document handle

consentId - An identifier to mark the owner of the document handle

Returns:

Response from API

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

ContentType

createPrediction

public org.json.JSONObject createPrediction(java.lang.String documentId,
                                            java.lang.String modelName)
                                     throws java.io.IOException,
                                            APIException,
                                            MissingAccessTokenException

Run inference and create a prediction, calls the POST /predictions endpoint

Parameters:

documentId - The document id to run inference and create a prediction. See createDocument for how to get documentId

modelName - The name of the model to use for inference

Returns:

Prediction on document

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(java.io.InputStream, ai.lucidtech.las.sdk.ContentType, java.lang.String, java.util.Map<java.lang.String, java.lang.Object>)

createPrediction

public org.json.JSONObject createPrediction(java.lang.String documentId,
                                            java.lang.String modelName,
                                            java.util.Map<java.lang.String,java.lang.Object> options)
                                     throws java.io.IOException,
                                            APIException,
                                            MissingAccessTokenException

Run inference and create a prediction, calls the POST /predictions endpoint

Parameters:

documentId - The document id to run inference and create a prediction. See createDocument for how to get documentId

modelName - The name of the model to use for inference

options - Available options are: maxPages - maximum number of pages to run predictions on autoRotate - whether or not to let the API try different rotations on

Returns:

Prediction on document

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(java.io.InputStream, ai.lucidtech.las.sdk.ContentType, java.lang.String, java.util.Map<java.lang.String, java.lang.Object>)

predict

public Prediction predict(java.lang.String documentPath,
                          java.lang.String modelName,
                          java.lang.String consentId)
                   throws java.io.IOException,
                          APIException,
                          MissingAccessTokenException

Create a prediction on a document documentPath by path using model modelName. This method takes care of creating and uploading a document as well as running inference using model to create prediction on the document.

Parameters:

documentPath - Path to document to run inference on

modelName - The name of the model to use for inference

consentId - An identifier to mark the owner of the document handle

Returns:

Prediction on document

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

updateDocument

public org.json.JSONObject updateDocument(java.lang.String documentId,
                                          org.json.JSONObject feedback)
                                   throws java.io.IOException,
                                          APIException,
                                          MissingAccessTokenException

Post feedback to the REST API, calls the POST /documents/{documentId} endpoint. Posting feedback means posting the ground truth data for the particular document. This enables the API to learn from past mistakes

Parameters:

documentId - The document id to post feedback to.

feedback - Feedback to post

Returns:

Feedback response

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(java.io.InputStream, ai.lucidtech.las.sdk.ContentType, java.lang.String, java.util.Map<java.lang.String, java.lang.Object>)

createBatch

public org.json.JSONObject createBatch(java.lang.String description)
                                throws java.io.IOException,
                                       APIException,
                                       MissingAccessTokenException

Creates a batch handle, calls the POST /batches endpoint

Parameters:

description - Creates a batch handle, calls the POST /batches endpoint

Returns:

Batch handle id and pre-signed upload url

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

deleteConsent

public org.json.JSONObject deleteConsent(java.lang.String consentId)
                                  throws java.io.IOException,
                                         APIException,
                                         MissingAccessTokenException

Delete documents with this consent_id, calls the DELETE /consent/{consentId} endpoint.

Parameters:

consentId - Delete documents with this consentId

Returns:

Feedback response

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained

See Also:

createDocument(java.io.InputStream, ai.lucidtech.las.sdk.ContentType, java.lang.String, java.util.Map<java.lang.String, java.lang.Object>)

getUser

public org.json.JSONObject getUser(java.lang.String userId)
                            throws java.io.IOException,
                                   APIException,
                                   MissingAccessTokenException

Get information about user, calls the GET /users/{user_id} endpoint.

Parameters:

userId - The user_id to get consent hash for

Returns:

User response

Throws:

java.io.IOException - General IOException

APIException - Raised when API returns an erroneous status code

MissingAccessTokenException - Raised if access token cannot be obtained