latest

Summary
Members
Descriptions
namespaceai::lucidtech::las::sdk​
​
namespace ai::lucidtech::las::sdk
Summary
Members
Descriptions
classai::lucidtech::las::sdk::Client​
​
classai::lucidtech::las::sdk::Credentials​
​
class ai::lucidtech::las::sdk::Client
Summary
Members
Descriptions
public inlineClient(Credentialscredentials)
A client to invoke api methods from Lucidtech AI Services.
public inline JSONObjectcreateAsset(byte[] content,CreateAssetOptions options)
Creates an asset, calls the POST /assets endpoint.
public inline JSONObjectcreateAsset(InputStream content,CreateAssetOptions options)
Creates an asset, calls the POST /assets endpoint.
public inline JSONObjectcreateAsset(byte[] content)
Creates an asset, calls the POST /assets endpoint.
public inline JSONObjectcreateAsset(InputStream content)
Creates an asset, calls the POST /assets endpoint.
public inline JSONObjectlistAssets(ListAssetsOptions options)
List assets available, calls the GET /assets endpoint.
public inline JSONObjectlistAssets()
List assets available, calls the GET /assets endpoint.
public inline JSONObjectgetAsset(String assetId)
Get asset, calls the GET /assets/{assetId} endpoint.
public inline JSONObjectupdateAsset(String assetId,UpdateAssetOptions options)
Updates an asset, calls the PATCH /assets/{assetId} endpoint.
public inline JSONObjectcreateBatch(CreateBatchOptions options)
Creates a batch, calls the POST /batches endpoint.
public inline JSONObjectcreateBatch()
Creates a batch, calls the POST /batches endpoint.
public inline JSONObjectcreateDocument(byte[] content,ContentType contentType,CreateDocumentOptions options)
Creates a document, calls the POST /documents endpoint.
public inline JSONObjectcreateDocument(InputStream content,ContentType contentType,CreateDocumentOptions options)
Creates a document, calls the POST /documents endpoint.
public inline JSONObjectcreateDocument(InputStream content,ContentType contentType)
Creates a document, calls the POST /documents endpoint.
public inline JSONObjectcreateDocument(byte[] content,ContentType contentType)
Creates a document, calls the POST /documents endpoint.
public inline JSONObjectlistDocuments(ListDocumentsOptions options)
List documents, calls the GET /documents endpoint.
public inline JSONObjectlistDocuments()
List documents, calls the GET /documents endpoint.
public inline JSONObjectdeleteDocuments()
Delete documents, calls the DELETE /documents endpoint.
public inline JSONObjectdeleteDocuments(String consentId)
Delete documents with the provided consentId, calls the DELETE /documents endpoint.
public inline JSONObjectgetDocument(String documentId)
Get document, calls the GET /documents/{documentId} endpoint.
public inline JSONObjectupdateDocument(String documentId,JSONArray groundTruth)
Update ground truth for a document, calls the PATCH /documents/{documentId} endpoint.
public inline JSONObjectgetLog(String logId)
Get log, calls the GET /logs/{logId} endpoint.
public inline JSONObjectlistModels(ListModelsOptions options)
List models available, calls the GET /models endpoint.
public inline JSONObjectlistModels()
List models available, calls the GET /models endpoint.
public inline JSONObjectcreatePrediction(String documentId,String modelId,CreatePredictionOptions options)
Create a prediction on a document using specified model, calls the POST /predictions endpoint.
public inline JSONObjectcreatePrediction(String documentId,String modelId)
Create a prediction on a document using specified model, calls the POST /predictions endpoint.
public inline JSONObjectlistPredictions(ListPredictionsOptions options)
List predictions available, calls the GET /predictions endpoint.
public inline JSONObjectlistPredictions()
List predictions available, calls the GET /predictions endpoint.
public inline JSONObjectcreateSecret(JSONObject data,CreateSecretOptions options)
Creates a secret, calls the POST /secrets endpoint.
public inline JSONObjectcreateSecret(Map< String, String > data,CreateSecretOptions options)
Creates a secret, calls the POST /secrets endpoint.
public inline JSONObjectcreateSecret(Map< String, String > data)
Creates a secret, calls the POST /secrets endpoint.
public inline JSONObjectcreateSecret(JSONObject data)
Creates a secret, calls the POST /secrets endpoint.
public inline JSONObjectlistSecrets(ListSecretsOptions options)
List secrets available, calls the GET /secrets endpoint.
public inline JSONObjectlistSecrets()
List secrets available, calls the GET /secrets endpoint.
public inline JSONObjectupdateSecret(String secretId,UpdateSecretOptions options)
Updates a secret, calls the PATCH /secrets/{secretId} endpoint.
public inline JSONObjectcreateTransition(TransitionType transitionType,CreateTransitionOptions options)
Creates a transition, calls the POST /transitions endpoint.
public inline JSONObjectcreateTransition(TransitionType transitionType)
Creates a transition, calls the POST /transitions endpoint.
public inline JSONObjectlistTransitions(ListTransitionsOptions options)
List transitions, calls the GET /transitions endpoint.
public inline JSONObjectlistTransitions()
List transitions, calls the GET /transitions endpoint.
public inline JSONObjectgetTransition(String transitionId)
Get transition, calls the GET /transitions/{transitionId} endpoint.
public inline JSONObjectupdateTransition(String transitionId,UpdateTransitionOptions options)
Updates a transition, calls the PATCH /transitions/{transitionId} endpoint.
public inline JSONObjectexecuteTransition(String transitionId)
Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.
public inline JSONObjectdeleteTransition(String transitionId)
Delete a transition, calls the PATCH /transitions/{transitionId} endpoint. Will fail if transition is in use by one or more workflows.
public inline JSONObjectlistTransitionExecutions(String transitionId,ListTransitionExecutionsOptions options)
List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
public inline JSONObjectlistTransitionExecutions(String transitionId)
List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
public inline JSONObjectgetTransitionExecution(String transitionId,String executionId)
Get an execution of a transition, calls the GET /transitions/{transitionId}/executions/{executionId} endpoint
public inline JSONObjectupdateTransitionExecution(String transitionId,String executionId,TransitionExecutionStatus status,UpdateTransitionExecutionOptions options)
Ends the processing of the transition execution, calls the PATCH /transitions/{transition_id}/executions/{execution_id} endpoint.
public inline JSONObjectsendHeartbeat(String transitionId,String executionId)
Send heartbeat for a manual execution to signal that we are still working on it. Must be done at minimum once every 60 seconds or the transition execution will time out, calls the POST /transitions/{transitionId}/executions/{executionId}/heartbeats endpoint.
public inline JSONObjectcreateUser(String email,CreateUserOptions options)
Creates a new user, calls the POST /users endpoint.
public inline JSONObjectcreateUser(String email)
Creates a new user, calls the POST /users endpoint.
public inline JSONObjectlistUsers(ListUsersOptions options)
List users, calls the GET /users endpoint.
public inline JSONObjectlistUsers()
List users, calls the GET /users endpoint.
public inline JSONObjectgetUser(String userId)
Get information about a specific user, calls the GET /users/{user_id} endpoint.
public inline JSONObjectupdateUser(String userId,UpdateUserOptions options)
Updates a user, calls the PATCH /users/{userId} endpoint.
public inline JSONObjectdeleteUser(String userId)
Delete a user, calls the PATCH /users/{userId} endpoint.
public inline JSONObjectcreateWorkflow(JSONObject specification,CreateWorkflowOptions options)
Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow. see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve​
public inline JSONObjectcreateWorkflow(JSONObject specification)
Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow. see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve​
public inline JSONObjectlistWorkflows(ListWorkflowsOptions options)
List workflows, calls the GET /workflows endpoint.
public inline JSONObjectlistWorkflows()
List workflows, calls the GET /workflows endpoint.
public inline JSONObjectgetWorkflow(String workflowId)
Get workflow, calls the GET /workflows/{workflowId} endpoint.
public inline JSONObjectupdateWorkflow(String workflowId,UpdateWorkflowOptions options)
Updates a workflow, calls the PATCH /workflows/{workflowId} endpoint.
public inline JSONObjectdeleteWorkflow(String workflowId)
Delete a workflow, calls the DELETE /workflows/{workflowId} endpoint.
public inline JSONObjectexecuteWorkflow(String workflowId,JSONObject content)
Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.
public inline JSONObjectlistWorkflowExecutions(String workflowId,ListWorkflowExecutionsOptions options)
List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
public inline JSONObjectlistWorkflowExecutions(String workflowId)
List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
public inline JSONObjectdeleteWorkflowExecution(String workflowId,String executionId)
Deletes the execution with the provided executionId from workflowId, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.
Members
public inlineClient(Credentialscredentials)
A client to invoke api methods from Lucidtech AI Services.
Parameters
credentials Credentials to use 
See also: Credentials​
public inline JSONObjectcreateAsset(byte[] content,CreateAssetOptions options)
Creates an asset, calls the POST /assets endpoint.
See also: CreateAssetOptions
Parameters
content Binary data
options Additional options to include in request body
Returns
Asset response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateAsset(InputStream content,CreateAssetOptions options)
Creates an asset, calls the POST /assets endpoint.
See also: CreateAssetOptions
Parameters
content Data from input stream
options Additional options to include in request body
Returns
Asset response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateAsset(byte[] content)
Creates an asset, calls the POST /assets endpoint.
Parameters
content Binary data 
Returns
Asset response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateAsset(InputStream content)
Creates an asset, calls the POST /assets endpoint.
Parameters
content Data from input stream 
Returns
Asset response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistAssets(ListAssetsOptions options)
List assets available, calls the GET /assets endpoint.
See also: ListAssetsOptions
Parameters
options Additional options to pass along as query parameters 
Returns
Assets response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistAssets()
List assets available, calls the GET /assets endpoint.
Returns
Assets response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectgetAsset(String assetId)
Get asset, calls the GET /assets/{assetId} endpoint.
Parameters
assetId Id of the asset 
Returns
Asset response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectupdateAsset(String assetId,UpdateAssetOptions options)
Updates an asset, calls the PATCH /assets/{assetId} endpoint.
See also: UpdateAssetOptions
Parameters
assetId Id of the asset
options Additional options to include in request body
Returns
Asset response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateBatch(CreateBatchOptions options)
Creates a batch, calls the POST /batches endpoint.
See also: CreateBatchOptions
Parameters
options Additional options to include in request body 
Returns
Batch response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateBatch()
Creates a batch, calls the POST /batches endpoint.
Returns
Batch response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateDocument(byte[] content,ContentType contentType,CreateDocumentOptions options)
Creates a document, calls the POST /documents endpoint.
See also: CreateDocumentOptions
Parameters
content Binary data
contentType A mime type for the document
options Additional options to include in request body
Returns
Document response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateDocument(InputStream content,ContentType contentType,CreateDocumentOptions options)
Creates a document, calls the POST /documents endpoint.
See also: CreateDocumentOptions
Parameters
content Data from input stream
contentType A mime type for the document
options Additional options to include in request body
Returns
Document response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateDocument(InputStream content,ContentType contentType)
Creates a document, calls the POST /documents endpoint.
See also: CreateDocumentOptions
Parameters
content Data from input stream
contentType A mime type for the document
Returns
Document response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateDocument(byte[] content,ContentType contentType)
Creates a document, calls the POST /documents endpoint.
See also: CreateDocumentOptions
Parameters
content Binary data
contentType A mime type for the document
Returns
Document response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistDocuments(ListDocumentsOptions options)
List documents, calls the GET /documents endpoint.
See also: ListDocumentsOptions
Parameters
options Additional options to pass along as query parameters 
Returns
Documents response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistDocuments()
List documents, calls the GET /documents endpoint.
Returns
Documents response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectdeleteDocuments()
Delete documents, calls the DELETE /documents endpoint.
See also: Client::createDocument​
Returns
Documents response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectdeleteDocuments(String consentId)
Delete documents with the provided consentId, calls the DELETE /documents endpoint.
See also: Client::createDocument​
Parameters
consentId Delete documents with this consentId 
Returns
Documents response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectgetDocument(String documentId)
Get document, calls the GET /documents/{documentId} endpoint.
Parameters
documentId Id of the document 
Returns
Document response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectupdateDocument(String documentId,JSONArray groundTruth)
Update ground truth for a document, calls the PATCH /documents/{documentId} endpoint.
See also: Client::createDocument​
Parameters
documentId The document id to post groundTruth to.
groundTruth List of json objects containing label and value for the ground truth
Returns
Document response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectgetLog(String logId)
Get log, calls the GET /logs/{logId} endpoint.
Parameters
logId Id of the log 
Returns
Log response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistModels(ListModelsOptions options)
List models available, calls the GET /models endpoint.
See also: ListModelsOptions
Parameters
options Additional options to pass along as query parameters 
Returns
Models response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistModels()
List models available, calls the GET /models endpoint.
Returns
Models response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreatePrediction(String documentId,String modelId,CreatePredictionOptions options)
Create a prediction on a document using specified model, calls the POST /predictions endpoint.
See also: Client::createDocument​
See also: CreatePredictionOptions
Parameters
documentId The document id to run inference and create a prediction on.
modelId The id of the model to use for inference
options Additional options to include in request body
Returns
Prediction response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreatePrediction(String documentId,String modelId)
Create a prediction on a document using specified model, calls the POST /predictions endpoint.
See also: Client::createDocument​
Parameters
documentId The document id to run inference and create a prediction on.
modelId The id of the model to use for inference
Returns
Prediction response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistPredictions(ListPredictionsOptions options)
List predictions available, calls the GET /predictions endpoint.
See also: ListPredictionsOptions
Parameters
options Additional options to pass along as query parameters 
Returns
Predictions response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistPredictions()
List predictions available, calls the GET /predictions endpoint.
Returns
Predictions response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateSecret(JSONObject data,CreateSecretOptions options)
Creates a secret, calls the POST /secrets endpoint.
See also: CreateSecretOptions
Parameters
data Key-Value pairs to store secretly
options Additional options to include in request body
Returns
Secret response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateSecret(Map< String, String > data,CreateSecretOptions options)
Creates a secret, calls the POST /secrets endpoint.
See also: CreateSecretOptions
Parameters
data Key-Value pairs to store secretly
options Additional options to include in request body
Returns
Secret response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateSecret(Map< String, String > data)
Creates a secret, calls the POST /secrets endpoint.
Parameters
data Key-Value pairs to store secretly 
Returns
Secret response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateSecret(JSONObject data)
Creates a secret, calls the POST /secrets endpoint.
Parameters
data Key-Value pairs to store secretly 
Returns
Secret response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistSecrets(ListSecretsOptions options)
List secrets available, calls the GET /secrets endpoint.
See also: ListSecretsOptions
Parameters
options Additional options to pass along as query parameters 
Returns
Secrets response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistSecrets()
List secrets available, calls the GET /secrets endpoint.
Returns
Secrets response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectupdateSecret(String secretId,UpdateSecretOptions options)
Updates a secret, calls the PATCH /secrets/{secretId} endpoint.
See also: UpdateSecretOptions
Parameters
secretId Id of the secret
options Additional options to include in request body
Returns
Secret response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateTransition(TransitionType transitionType,CreateTransitionOptions options)
Creates a transition, calls the POST /transitions endpoint.
See also: CreateTransitionOptions
See also: TransitionType
Parameters
transitionType Type of transition
options Additional options to include in request body
Returns
Transition response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateTransition(TransitionType transitionType)
Creates a transition, calls the POST /transitions endpoint.
See also: TransitionType
Parameters
transitionType Type of transition 
Returns
Transition response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistTransitions(ListTransitionsOptions options)
List transitions, calls the GET /transitions endpoint.
See also: ListTransitionsOptions
Parameters
options Additional options to pass along as query parameters 
Returns
Transitions response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistTransitions()
List transitions, calls the GET /transitions endpoint.
Returns
Transitions response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectgetTransition(String transitionId)
Get transition, calls the GET /transitions/{transitionId} endpoint.
Parameters
transitionId Id of the transition 
Returns
Transition response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectupdateTransition(String transitionId,UpdateTransitionOptions options)
Updates a transition, calls the PATCH /transitions/{transitionId} endpoint.
See also: UpdateTransitionOptions
Parameters
transitionId Id of the transition
options Additional options to include in request body
Returns
Transition response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectexecuteTransition(String transitionId)
Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.
Parameters
transitionId Id of the transition 
Returns
TransitionExecution response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectdeleteTransition(String transitionId)
Delete a transition, calls the PATCH /transitions/{transitionId} endpoint. Will fail if transition is in use by one or more workflows.
Parameters
transitionId Id of the transition 
Returns
Transition response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistTransitionExecutions(String transitionId,ListTransitionExecutionsOptions options)
List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
See also: ListTransitionExecutionsOptions
Parameters
transitionId Id of the transition
options Additional options to pass along as query parameters
Returns
Transition executions response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistTransitionExecutions(String transitionId)
List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
Parameters
transitionId Id of the transition 
Returns
Transition executions response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectgetTransitionExecution(String transitionId,String executionId)
Get an execution of a transition, calls the GET /transitions/{transitionId}/executions/{executionId} endpoint
Parameters
transitionId Id of the transition
executionId Id of the execution
Returns
TransitionExecution response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectupdateTransitionExecution(String transitionId,String executionId,TransitionExecutionStatus status,UpdateTransitionExecutionOptions options)
Ends the processing of the transition execution, calls the PATCH /transitions/{transition_id}/executions/{execution_id} endpoint.
See also: UpdateTransitionExecutionOptions
See also: TransitionExecutionStatus
Parameters
transitionId Id of the transition
executionId Id of the execution
status Status of the execution
options Additional options to include in request body
Returns
Transition response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectsendHeartbeat(String transitionId,String executionId)
Send heartbeat for a manual execution to signal that we are still working on it. Must be done at minimum once every 60 seconds or the transition execution will time out, calls the POST /transitions/{transitionId}/executions/{executionId}/heartbeats endpoint.
Parameters
transitionId Id of the transition
executionId Id of the execution
Returns
Empty response
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateUser(String email,CreateUserOptions options)
Creates a new user, calls the POST /users endpoint.
See also: CreateUserOptions
Parameters
email Email of the new user
options Additional options to include in request body
Returns
User response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateUser(String email)
Creates a new user, calls the POST /users endpoint.
Parameters
email Email to the new user 
Returns
User response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistUsers(ListUsersOptions options)
List users, calls the GET /users endpoint.
See also: ListUsersOptions
Parameters
options Additional options to pass along as query parameters 
Returns
Users response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistUsers()
List users, calls the GET /users endpoint.
Returns
Users response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectgetUser(String userId)
Get information about a specific user, calls the GET /users/{user_id} endpoint.
Parameters
userId The Id of the user 
Returns
User response
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectupdateUser(String userId,UpdateUserOptions options)
Updates a user, calls the PATCH /users/{userId} endpoint.
See also: UpdateUserOptions
Parameters
userId Id of the user
options Additional options to include in request body
Returns
User response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectdeleteUser(String userId)
Delete a user, calls the PATCH /users/{userId} endpoint.
Parameters
userId Id of the user 
Returns
User response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateWorkflow(JSONObject specification,CreateWorkflowOptions options)
Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow. see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve​
See also: CreateWorkflowOptions
Parameters
specification Specification of the workflow, currently supporting ASL: https://states-language.net/spec.html. Check out the tutorials for more information: see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve#creating-the-workflow​
options Additional options to include in request body
Returns
Workflow response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectcreateWorkflow(JSONObject specification)
Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow. see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve​
Parameters
specification Specification of the workflow, currently supporting ASL: https://states-language.net/spec.html. Check out the tutorials for more information: see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve#creating-the-workflow​
Returns
Workflow response from API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistWorkflows(ListWorkflowsOptions options)
List workflows, calls the GET /workflows endpoint.
See also: ListWorkflowsOptions
Parameters
options Additional options to pass along as query parameters 
Returns
Workflows response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistWorkflows()
List workflows, calls the GET /workflows endpoint.
Returns
Workflows response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectgetWorkflow(String workflowId)
Get workflow, calls the GET /workflows/{workflowId} endpoint.
Parameters
workflowId Id of the workflow 
Returns
Workflow response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectupdateWorkflow(String workflowId,UpdateWorkflowOptions options)
Updates a workflow, calls the PATCH /workflows/{workflowId} endpoint.
See also: UpdateWorkflowOptions
Parameters
workflowId Id of the workflow
options Additional options to include in request body
Returns
Workflow response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectdeleteWorkflow(String workflowId)
Delete a workflow, calls the DELETE /workflows/{workflowId} endpoint.
See also: Client::createWorkflow​
Parameters
workflowId Id of the workflow 
Returns
Workflow response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectexecuteWorkflow(String workflowId,JSONObject content)
Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.
Parameters
workflowId Id of the workflow
content Input to the first step of the workflow
Returns
WorkflowExecution response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistWorkflowExecutions(String workflowId,ListWorkflowExecutionsOptions options)
List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
See also: ListWorkflowExecutionsOptions
Parameters
workflowId Id of the workflow
options Additional options to pass along as query parameters
Returns
Workflow executions response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectlistWorkflowExecutions(String workflowId)
List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
Parameters
workflowId Id of the workflow 
Returns
Workflow executions response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
public inline JSONObjectdeleteWorkflowExecution(String workflowId,String executionId)
Deletes the execution with the provided executionId from workflowId, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.
See also: Client::executeWorkflow​
Parameters
workflowId Id of the workflow
executionId Id of the execution
Returns
WorklowExecution response from REST API
Exceptions
IOException General IOException
APIException Raised when API returns an erroneous status code
MissingAccessTokenException Raised if access token cannot be obtained
class ai::lucidtech::las::sdk::Credentials
Summary
Members
Descriptions
public inlineCredentials(String clientId,String clientSecret,String apiKey,String authEndpoint,String apiEndpoint)
Used to fetch and store credentials.
public inline StringgetAccessToken(HttpClient httpClient)
#### Parameters
public inline StringgetApiKey()
​
public inline StringgetApiEndpoint()
​
Members
public inlineCredentials(String clientId,String clientSecret,String apiKey,String authEndpoint,String apiEndpoint)
Used to fetch and store credentials.
Parameters
clientId Client id
clientSecret Client secret
apiKey API key
authEndpoint Auth endpoint
apiEndpoint Domain endpoint of the api, e.g. https://{prefix}.api.lucidtech.ai/{version}​
Exceptions
MissingCredentialsException Raised if some of credentials are missing
public inline StringgetAccessToken(HttpClient httpClient)
Parameters
httpClient Instance of HttpClient used to access the authentication endpoint 
Returns
Access token, downloading it if necessary
Exceptions
MissingAccessTokenException Raised if access token cannot be obtained
public inline StringgetApiKey()
public inline StringgetApiEndpoint()
Generated by Moxygen​

Reference - Previous

Java SDK

Last updated 4 days ago

Members	Descriptions
`classai::lucidtech::las::sdk::Client`
`classai::lucidtech::las::sdk::Credentials`

Members	Descriptions
`public inlineClient(Credentialscredentials)`	A client to invoke api methods from Lucidtech AI Services.
`public inline JSONObjectcreateAsset(byte[] content,CreateAssetOptions options)`	Creates an asset, calls the POST /assets endpoint.
`public inline JSONObjectcreateAsset(InputStream content,CreateAssetOptions options)`	Creates an asset, calls the POST /assets endpoint.
`public inline JSONObjectcreateAsset(byte[] content)`	Creates an asset, calls the POST /assets endpoint.
`public inline JSONObjectcreateAsset(InputStream content)`	Creates an asset, calls the POST /assets endpoint.
`public inline JSONObjectlistAssets(ListAssetsOptions options)`	List assets available, calls the GET /assets endpoint.
`public inline JSONObjectlistAssets()`	List assets available, calls the GET /assets endpoint.
`public inline JSONObjectgetAsset(String assetId)`	Get asset, calls the GET /assets/{assetId} endpoint.
`public inline JSONObjectupdateAsset(String assetId,UpdateAssetOptions options)`	Updates an asset, calls the PATCH /assets/{assetId} endpoint.
`public inline JSONObjectcreateBatch(CreateBatchOptions options)`	Creates a batch, calls the POST /batches endpoint.
`public inline JSONObjectcreateBatch()`	Creates a batch, calls the POST /batches endpoint.
`public inline JSONObjectcreateDocument(byte[] content,ContentType contentType,CreateDocumentOptions options)`	Creates a document, calls the POST /documents endpoint.
`public inline JSONObjectcreateDocument(InputStream content,ContentType contentType,CreateDocumentOptions options)`	Creates a document, calls the POST /documents endpoint.
`public inline JSONObjectcreateDocument(InputStream content,ContentType contentType)`	Creates a document, calls the POST /documents endpoint.
`public inline JSONObjectcreateDocument(byte[] content,ContentType contentType)`	Creates a document, calls the POST /documents endpoint.
`public inline JSONObjectlistDocuments(ListDocumentsOptions options)`	List documents, calls the GET /documents endpoint.
`public inline JSONObjectlistDocuments()`	List documents, calls the GET /documents endpoint.
`public inline JSONObjectdeleteDocuments()`	Delete documents, calls the DELETE /documents endpoint.
`public inline JSONObjectdeleteDocuments(String consentId)`	Delete documents with the provided consentId, calls the DELETE /documents endpoint.
`public inline JSONObjectgetDocument(String documentId)`	Get document, calls the GET /documents/{documentId} endpoint.
`public inline JSONObjectupdateDocument(String documentId,JSONArray groundTruth)`	Update ground truth for a document, calls the PATCH /documents/{documentId} endpoint.
`public inline JSONObjectgetLog(String logId)`	Get log, calls the GET /logs/{logId} endpoint.
`public inline JSONObjectlistModels(ListModelsOptions options)`	List models available, calls the GET /models endpoint.
`public inline JSONObjectlistModels()`	List models available, calls the GET /models endpoint.
`public inline JSONObjectcreatePrediction(String documentId,String modelId,CreatePredictionOptions options)`	Create a prediction on a document using specified model, calls the POST /predictions endpoint.
`public inline JSONObjectcreatePrediction(String documentId,String modelId)`	Create a prediction on a document using specified model, calls the POST /predictions endpoint.
`public inline JSONObjectlistPredictions(ListPredictionsOptions options)`	List predictions available, calls the GET /predictions endpoint.
`public inline JSONObjectlistPredictions()`	List predictions available, calls the GET /predictions endpoint.
`public inline JSONObjectcreateSecret(JSONObject data,CreateSecretOptions options)`	Creates a secret, calls the POST /secrets endpoint.
`public inline JSONObjectcreateSecret(Map< String, String > data,CreateSecretOptions options)`	Creates a secret, calls the POST /secrets endpoint.
`public inline JSONObjectcreateSecret(Map< String, String > data)`	Creates a secret, calls the POST /secrets endpoint.
`public inline JSONObjectcreateSecret(JSONObject data)`	Creates a secret, calls the POST /secrets endpoint.
`public inline JSONObjectlistSecrets(ListSecretsOptions options)`	List secrets available, calls the GET /secrets endpoint.
`public inline JSONObjectlistSecrets()`	List secrets available, calls the GET /secrets endpoint.
`public inline JSONObjectupdateSecret(String secretId,UpdateSecretOptions options)`	Updates a secret, calls the PATCH /secrets/{secretId} endpoint.
`public inline JSONObjectcreateTransition(TransitionType transitionType,CreateTransitionOptions options)`	Creates a transition, calls the POST /transitions endpoint.
`public inline JSONObjectcreateTransition(TransitionType transitionType)`	Creates a transition, calls the POST /transitions endpoint.
`public inline JSONObjectlistTransitions(ListTransitionsOptions options)`	List transitions, calls the GET /transitions endpoint.
`public inline JSONObjectlistTransitions()`	List transitions, calls the GET /transitions endpoint.
`public inline JSONObjectgetTransition(String transitionId)`	Get transition, calls the GET /transitions/{transitionId} endpoint.
`public inline JSONObjectupdateTransition(String transitionId,UpdateTransitionOptions options)`	Updates a transition, calls the PATCH /transitions/{transitionId} endpoint.
`public inline JSONObjectexecuteTransition(String transitionId)`	Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.
`public inline JSONObjectdeleteTransition(String transitionId)`	Delete a transition, calls the PATCH /transitions/{transitionId} endpoint. Will fail if transition is in use by one or more workflows.
`public inline JSONObjectlistTransitionExecutions(String transitionId,ListTransitionExecutionsOptions options)`	List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
`public inline JSONObjectlistTransitionExecutions(String transitionId)`	List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
`public inline JSONObjectgetTransitionExecution(String transitionId,String executionId)`	Get an execution of a transition, calls the GET /transitions/{transitionId}/executions/{executionId} endpoint
`public inline JSONObjectupdateTransitionExecution(String transitionId,String executionId,TransitionExecutionStatus status,UpdateTransitionExecutionOptions options)`	Ends the processing of the transition execution, calls the PATCH /transitions/{transition_id}/executions/{execution_id} endpoint.
`public inline JSONObjectsendHeartbeat(String transitionId,String executionId)`	Send heartbeat for a manual execution to signal that we are still working on it. Must be done at minimum once every 60 seconds or the transition execution will time out, calls the POST /transitions/{transitionId}/executions/{executionId}/heartbeats endpoint.
`public inline JSONObjectcreateUser(String email,CreateUserOptions options)`	Creates a new user, calls the POST /users endpoint.
`public inline JSONObjectcreateUser(String email)`	Creates a new user, calls the POST /users endpoint.
`public inline JSONObjectlistUsers(ListUsersOptions options)`	List users, calls the GET /users endpoint.
`public inline JSONObjectlistUsers()`	List users, calls the GET /users endpoint.
`public inline JSONObjectgetUser(String userId)`	Get information about a specific user, calls the GET /users/{user_id} endpoint.
`public inline JSONObjectupdateUser(String userId,UpdateUserOptions options)`	Updates a user, calls the PATCH /users/{userId} endpoint.
`public inline JSONObjectdeleteUser(String userId)`	Delete a user, calls the PATCH /users/{userId} endpoint.
`public inline JSONObjectcreateWorkflow(JSONObject specification,CreateWorkflowOptions options)`	Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow. see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve
`public inline JSONObjectcreateWorkflow(JSONObject specification)`	Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow. see https://docs.lucidtech.ai/getting-started/tutorials/tutorial_custom_predict_and_approve
`public inline JSONObjectlistWorkflows(ListWorkflowsOptions options)`	List workflows, calls the GET /workflows endpoint.
`public inline JSONObjectlistWorkflows()`	List workflows, calls the GET /workflows endpoint.
`public inline JSONObjectgetWorkflow(String workflowId)`	Get workflow, calls the GET /workflows/{workflowId} endpoint.
`public inline JSONObjectupdateWorkflow(String workflowId,UpdateWorkflowOptions options)`	Updates a workflow, calls the PATCH /workflows/{workflowId} endpoint.
`public inline JSONObjectdeleteWorkflow(String workflowId)`	Delete a workflow, calls the DELETE /workflows/{workflowId} endpoint.
`public inline JSONObjectexecuteWorkflow(String workflowId,JSONObject content)`	Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.
`public inline JSONObjectlistWorkflowExecutions(String workflowId,ListWorkflowExecutionsOptions options)`	List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
`public inline JSONObjectlistWorkflowExecutions(String workflowId)`	List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
`public inline JSONObjectdeleteWorkflowExecution(String workflowId,String executionId)`	Deletes the execution with the provided executionId from workflowId, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.

Members	Descriptions
`public inlineCredentials(String clientId,String clientSecret,String apiKey,String authEndpoint,String apiEndpoint)`	Used to fetch and store credentials.
`public inline StringgetAccessToken(HttpClient httpClient)`	#### Parameters
`public inline StringgetApiKey()`
`public inline StringgetApiEndpoint()`