Summary

Members	Descriptions
namespace ai::lucidtech::las::sdk

namespace ai::lucidtech::las::sdk

Summary

Members	Descriptions
class ai::lucidtech::las::sdk::APIException
class ai::lucidtech::las::sdk::Client
class ai::lucidtech::las::sdk::CreateAppClientOptions
class ai::lucidtech::las::sdk::CreateAssetOptions
class ai::lucidtech::las::sdk::CreateDocumentOptions
class ai::lucidtech::las::sdk::CreateModelOptions
class ai::lucidtech::las::sdk::CreatePredictionOptions
class ai::lucidtech::las::sdk::CreateSecretOptions
class ai::lucidtech::las::sdk::CreateTransitionOptions
class ai::lucidtech::las::sdk::CreateUserOptions
class ai::lucidtech::las::sdk::CreateWorkflowOptions
class ai::lucidtech::las::sdk::Credentials
class ai::lucidtech::las::sdk::DeleteDocumentsOptions
class ai::lucidtech::las::sdk::DeleteResourcesOptions
class ai::lucidtech::las::sdk::DockerTransitionParameters
class ai::lucidtech::las::sdk::Field
class ai::lucidtech::las::sdk::FieldConfig
class ai::lucidtech::las::sdk::ListAppClientsOptions
class ai::lucidtech::las::sdk::ListAssetsOptions
class ai::lucidtech::las::sdk::ListDocumentsOptions
class ai::lucidtech::las::sdk::ListLogsOptions
class ai::lucidtech::las::sdk::ListModelsOptions
class ai::lucidtech::las::sdk::ListPredictionsOptions
class ai::lucidtech::las::sdk::ListResourcesOptions
class ai::lucidtech::las::sdk::ListSecretsOptions
class ai::lucidtech::las::sdk::ListSortablesOptions
class ai::lucidtech::las::sdk::ListTransitionExecutionsOptions
class ai::lucidtech::las::sdk::ListTransitionsOptions
class ai::lucidtech::las::sdk::ListUsersOptions
class ai::lucidtech::las::sdk::ListWorkflowExecutionsOptions
class ai::lucidtech::las::sdk::ListWorkflowsOptions
class ai::lucidtech::las::sdk::ManualTransitionParameters
class ai::lucidtech::las::sdk::MissingAccessTokenException
class ai::lucidtech::las::sdk::MissingCredentialsException
class ai::lucidtech::las::sdk::NameAndDescriptionOptions
class ai::lucidtech::las::sdk::NullableString
class ai::lucidtech::las::sdk::Options
class ai::lucidtech::las::sdk::PreprocessConfig
class ai::lucidtech::las::sdk::TransitionParameters
class ai::lucidtech::las::sdk::UpdateAppClientOptions
class ai::lucidtech::las::sdk::UpdateAssetOptions
class ai::lucidtech::las::sdk::UpdateDocumentOptions
class ai::lucidtech::las::sdk::UpdateModelOptions
class ai::lucidtech::las::sdk::UpdateSecretOptions
class ai::lucidtech::las::sdk::UpdateTransitionExecutionOptions
class ai::lucidtech::las::sdk::UpdateTransitionOptions
class ai::lucidtech::las::sdk::UpdateUserOptions
class ai::lucidtech::las::sdk::UpdateWorkflowOptions
class ai::lucidtech::las::sdk::UserOptions
class ai::lucidtech::las::sdk::WorkflowCompletedConfig
class ai::lucidtech::las::sdk::WorkflowErrorConfig

class ai::lucidtech::las::sdk::APIException

class ai::lucidtech::las::sdk::APIException
  : public Exception

Summary

Members	Descriptions
public APIException()
public APIException(String message)
public APIException(int code,String message)

Members

public APIException()

public APIException(String message)

public APIException(int code,String message)

class ai::lucidtech::las::sdk::Client

Summary

Members	Descriptions
public Client(Credentials credentials)	A client to invoke api methods from Lucidtech AI Services.
public JSONObject createAppClient(CreateAppClientOptions options)	Create an app client, calls the POST /appClients endpoint.
public JSONObject createAppClient()	Create an app client, calls the POST /appClients endpoint.
public JSONObject updateAppClient(String appClientId,UpdateAppClientOptions options)	Update an appClient, calls the PATCH /appClients/{appClientId} endpoint.
public JSONObject listAppClients(ListAppClientsOptions options)	List appClients available, calls the GET /appClients endpoint.
public JSONObject listAppClients()	List appClients available, calls the GET /appClients endpoint.
public JSONObject deleteAppClient(String appClientId)	Delete an appClient, calls the DELETE /appClients/{appClientId} endpoint.
public JSONObject createAsset(byte [] content,CreateAssetOptions options)	Create an asset, calls the POST /assets endpoint.
public JSONObject createAsset(InputStream content,CreateAssetOptions options)	Create an asset, calls the POST /assets endpoint.
public JSONObject createAsset(byte [] content)	Create an asset, calls the POST /assets endpoint.
public JSONObject createAsset(InputStream content)	Create an asset, calls the POST /assets endpoint.
public JSONObject listAssets(ListAssetsOptions options)	List assets available, calls the GET /assets endpoint.
public JSONObject listAssets()	List assets available, calls the GET /assets endpoint.
public JSONObject getAsset(String assetId)	Get asset, calls the GET /assets/{assetId} endpoint.
public JSONObject updateAsset(String assetId,UpdateAssetOptions options)	Update an asset, calls the PATCH /assets/{assetId} endpoint.
public JSONObject deleteAsset(String assetId)	Delete an asset, calls the DELETE /assets/{assetId} endpoint.
public JSONObject createDocument(byte [] content,ContentType contentType,CreateDocumentOptions options)	Create a document, calls the POST /documents endpoint.
public JSONObject createDocument(InputStream content,ContentType contentType,CreateDocumentOptions options)	Create a document, calls the POST /documents endpoint.
public JSONObject createDocument(InputStream content,ContentType contentType)	Create a document, calls the POST /documents endpoint.
public JSONObject createDocument(byte [] content,ContentType contentType)	Create a document, calls the POST /documents endpoint.
public JSONObject listDocuments(ListDocumentsOptions options)	List documents, calls the GET /documents endpoint.
public JSONObject listDocuments()	List documents, calls the GET /documents endpoint.
public JSONObject deleteDocuments(DeleteDocumentsOptions options)	Delete documents, calls the DELETE /documents endpoint.
public JSONObject deleteDocuments()	Delete documents, calls the DELETE /documents endpoint.
public JSONObject getDocument(String documentId)	Get document, calls the GET /documents/{documentId} endpoint.
public JSONObject updateDocument(String documentId,UpdateDocumentOptions options)	Update document, calls the PATCH /documents/{documentId} endpoint.
public JSONObject getLog(String logId)	Get log, calls the GET /logs/{logId} endpoint.
public JSONObject listLogs(ListLogsOptions options)	List logs, calls the GET /logs endpoint.
public JSONObject listLogs()	List logs, calls the GET /logs endpoint.
public JSONObject createModel(int width,int height,FieldConfig fieldConfig,CreateModelOptions options)	Create a model, calls the POST /models endpoint.
public JSONObject createModel(int width,int height,FieldConfig fieldConfig)	Create a model, calls the POST /models endpoint.
public JSONObject updateModel(String modelId,UpdateModelOptions options)	Updates a model, calls the PATCH /models/{modelId} endpoint.
public JSONObject getModel(String modelId)	Get model, calls the GET /models/{modelId} endpoint.
public JSONObject listModels(ListModelsOptions options)	List models, calls the GET /models endpoint.
public JSONObject listModels()	List models available, calls the GET /models endpoint.
public JSONObject createPrediction(String documentId,String modelId,CreatePredictionOptions options)	Create a prediction on a document using specified model, calls the POST /predictions endpoint.
public JSONObject createPrediction(String documentId,String modelId)	Create a prediction on a document using specified model, calls the POST /predictions endpoint.
public JSONObject listPredictions(ListPredictionsOptions options)	List predictions available, calls the GET /predictions endpoint.
public JSONObject listPredictions()	List predictions available, calls the GET /predictions endpoint.
public JSONObject createSecret(JSONObject data,CreateSecretOptions options)	Create secret, calls the POST /secrets endpoint.
public JSONObject createSecret(Map< String, String > data,CreateSecretOptions options)	Create a secret, calls the POST /secrets endpoint.
public JSONObject createSecret(Map< String, String > data)	Create a secret, calls the POST /secrets endpoint.
public JSONObject createSecret(JSONObject data)	Create a secret, calls the POST /secrets endpoint.
public JSONObject listSecrets(ListSecretsOptions options)	List secrets, calls the GET /secrets endpoint.
public JSONObject listSecrets()	List secrets, calls the GET /secrets endpoint.
public JSONObject updateSecret(String secretId,UpdateSecretOptions options)	Update a secret, calls the PATCH /secrets/{secretId} endpoint.
public JSONObject deleteSecret(String secretId)	Delete a secret, calls the DELETE /secrets/{secretId} endpoint.
public JSONObject createTransition(TransitionType transitionType,CreateTransitionOptions options)	Create a transition, calls the POST /transitions endpoint.
public JSONObject createTransition(TransitionType transitionType)	Create a transition, calls the POST /transitions endpoint.
public JSONObject listTransitions(ListTransitionsOptions options)	List transitions, calls the GET /transitions endpoint.
public JSONObject listTransitions()	List transitions, calls the GET /transitions endpoint.
public JSONObject getTransition(String transitionId)	Get transition, calls the GET /transitions/{transitionId} endpoint.
public JSONObject updateTransition(String transitionId,UpdateTransitionOptions options)	Updates a transition, calls the PATCH /transitions/{transitionId} endpoint.
public JSONObject executeTransition(String transitionId)	Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.
public JSONObject deleteTransition(String transitionId)	Delete a transition, calls the DELETE /transitions/{transitionId} endpoint. Will fail if transition is in use by one or more workflows.
public JSONObject listTransitionExecutions(String transitionId,ListTransitionExecutionsOptions options)	List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
public JSONObject listTransitionExecutions(String transitionId)	List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
public JSONObject getTransitionExecution(String transitionId,String executionId)	Get an execution of a transition, calls the GET /transitions/{transitionId}/executions/{executionId} endpoint
public JSONObject updateTransitionExecution(String transitionId,String executionId,TransitionExecutionStatus status,UpdateTransitionExecutionOptions options)	Ends the processing of the transition execution, calls the PATCH /transitions/{transitionId}/executions/{executionId} endpoint.
public JSONObject sendHeartbeat(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 JSONObject createUser(String email,CreateUserOptions options)	Create a user, calls the POST /users endpoint.
public JSONObject createUser(String email)	Create a user, calls the POST /users endpoint.
public JSONObject listUsers(ListUsersOptions options)	List users, calls the GET /users endpoint.
public JSONObject listUsers()	List users, calls the GET /users endpoint.
public JSONObject getUser(String userId)	Get user, calls the GET /users/{userId} endpoint.
public JSONObject updateUser(String userId,UpdateUserOptions options)	Updates a user, calls the PATCH /users/{userId} endpoint.
public JSONObject deleteUser(String userId)	Delete a user, calls the PATCH /users/{userId} endpoint.
public JSONObject createWorkflow(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/setup_predict_and_approve
public JSONObject createWorkflow(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/setup_predict_and_approve
public JSONObject listWorkflows(ListWorkflowsOptions options)	List workflows, calls the GET /workflows endpoint.
public JSONObject listWorkflows()	List workflows, calls the GET /workflows endpoint.
public JSONObject getWorkflow(String workflowId)	Get workflow, calls the GET /workflows/{workflowId} endpoint.
public JSONObject updateWorkflow(String workflowId,UpdateWorkflowOptions options)	Update a workflow, calls the PATCH /workflows/{workflowId} endpoint.
public JSONObject deleteWorkflow(String workflowId)	Delete a workflow, calls the DELETE /workflows/{workflowId} endpoint.
public JSONObject executeWorkflow(String workflowId,JSONObject content)	Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.
public JSONObject listWorkflowExecutions(String workflowId,ListWorkflowExecutionsOptions options)	List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
public JSONObject listWorkflowExecutions(String workflowId)	List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
public JSONObject deleteWorkflowExecution(String workflowId,String executionId)	Delete execution from workflow, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.

Members

public Client(Credentials credentials)

A client to invoke api methods from Lucidtech AI Services.

Parameters

• credentials Credentials to use

See also: Credentials

public JSONObject createAppClient(CreateAppClientOptions options)

Create an app client, calls the POST /appClients endpoint.

See also: CreateAppClientOptions

Parameters

• 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 JSONObject createAppClient()

Create an app client, calls the POST /appClients endpoint.

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 JSONObject updateAppClient(String appClientId,UpdateAppClientOptions options)

Update an appClient, calls the PATCH /appClients/{appClientId} endpoint.

See also: UpdateAppClientOptions

Parameters

• appClientId Id of the appClient

• options Additional options to include in request body

Returns

AppClient 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 JSONObject listAppClients(ListAppClientsOptions options)

List appClients available, calls the GET /appClients endpoint.

See also: ListAppClientsOptions

Parameters

• options Additional options to pass along as query parameters

Returns

AppClients 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 JSONObject listAppClients()

List appClients available, calls the GET /appClients endpoint.

Returns

AppClients 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 JSONObject deleteAppClient(String appClientId)

Delete an appClient, calls the DELETE /appClients/{appClientId} endpoint.

Parameters

• appClientId Id of the appClient

Returns

AppClient 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 JSONObject createAsset(byte [] content,CreateAssetOptions options)

Create 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 JSONObject createAsset(InputStream content,CreateAssetOptions options)

Create 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 JSONObject createAsset(byte [] content)

Create 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 JSONObject createAsset(InputStream content)

Create 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 JSONObject listAssets(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 JSONObject listAssets()

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 JSONObject getAsset(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 JSONObject updateAsset(String assetId,UpdateAssetOptions options)

Update 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 JSONObject deleteAsset(String assetId)

Delete an asset, calls the DELETE /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 JSONObject createDocument(byte [] content,ContentType contentType,CreateDocumentOptions options)

Create 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 JSONObject createDocument(InputStream content,ContentType contentType,CreateDocumentOptions options)

Create 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 JSONObject createDocument(InputStream content,ContentType contentType)

Create 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 JSONObject createDocument(byte [] content,ContentType contentType)

Create 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 JSONObject listDocuments(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 JSONObject listDocuments()

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 JSONObject deleteDocuments(DeleteDocumentsOptions options)

Delete documents, calls the DELETE /documents endpoint.

See also: DeleteDocumentsOptions

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 JSONObject deleteDocuments()

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 JSONObject getDocument(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 JSONObject updateDocument(String documentId,UpdateDocumentOptions options)

Update document, calls the PATCH /documents/{documentId} endpoint.

See also: Client::createDocument

Parameters

• documentId The document id to post groundTruth to.

• 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 JSONObject getLog(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 JSONObject listLogs(ListLogsOptions options)

List logs, calls the GET /logs endpoint.

See also: ListLogsOptions

Parameters

• options Additional options to pass along as query parameters

Returns

Logs 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 JSONObject listLogs()

List logs, calls the GET /logs endpoint.

Returns

Logs 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 JSONObject createModel(int width,int height,FieldConfig fieldConfig,CreateModelOptions options)

Create a model, calls the POST /models endpoint.

See also: CreateModelOptions

See also: FieldConfig

Parameters

• width The number of pixels to be used for the input image width of your model

• height The number of pixels to be used for the input image height of your model

• fieldConfig Specification of the fields that the model is going to predict

• options Additional options to include in request body

Returns

Model 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 JSONObject createModel(int width,int height,FieldConfig fieldConfig)

Create a model, calls the POST /models endpoint.

See also: FieldConfig

Parameters

• width The number of pixels to be used for the input image width of your model

• height The number of pixels to be used for the input image height of your model

• fieldConfig Specification of the fields that the model is going to predict

Returns

Model 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 JSONObject updateModel(String modelId,UpdateModelOptions options)

Updates a model, calls the PATCH /models/{modelId} endpoint.

See also: UpdateModelOptions

Parameters

• modelId Id of the model

• options Additional options to include in request body

Returns

Model 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 JSONObject getModel(String modelId)

Get model, calls the GET /models/{modelId} endpoint.

Parameters

• modelId Id of the model

Returns

Model 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 JSONObject listModels(ListModelsOptions options)

List models, 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 JSONObject listModels()

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 JSONObject createPrediction(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 JSONObject createPrediction(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 JSONObject listPredictions(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 JSONObject listPredictions()

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 JSONObject createSecret(JSONObject data,CreateSecretOptions options)

Create 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 JSONObject createSecret(Map< String, String > data,CreateSecretOptions options)

Create 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 JSONObject createSecret(Map< String, String > data)

Create 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 JSONObject createSecret(JSONObject data)

Create 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 JSONObject listSecrets(ListSecretsOptions options)

List secrets, 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 JSONObject listSecrets()

List secrets, 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 JSONObject updateSecret(String secretId,UpdateSecretOptions options)

Update 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 JSONObject deleteSecret(String secretId)

Delete a secret, calls the DELETE /secrets/{secretId} endpoint.

Parameters

• secretId Id of the secret

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 JSONObject createTransition(TransitionType transitionType,CreateTransitionOptions options)

Create 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 JSONObject createTransition(TransitionType transitionType)

Create 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 JSONObject listTransitions(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 JSONObject listTransitions()

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 JSONObject getTransition(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 JSONObject updateTransition(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 JSONObject executeTransition(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 JSONObject deleteTransition(String transitionId)

Delete a transition, calls the DELETE /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 JSONObject listTransitionExecutions(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 JSONObject listTransitionExecutions(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 JSONObject getTransitionExecution(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 JSONObject updateTransitionExecution(String transitionId,String executionId,TransitionExecutionStatus status,UpdateTransitionExecutionOptions options)

Ends the processing of the transition execution, calls the PATCH /transitions/{transitionId}/executions/{executionId} 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 JSONObject sendHeartbeat(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 JSONObject createUser(String email,CreateUserOptions options)

Create a 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 JSONObject createUser(String email)

Create a 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 JSONObject listUsers(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 JSONObject listUsers()

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 JSONObject getUser(String userId)

Get user, calls the GET /users/{userId} endpoint.

Parameters

• userId Id of 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 JSONObject updateUser(String userId,UpdateUserOptions options)

Updates a user, calls the PATCH /users/{userId} endpoint.

See also: UpdateUserOptions

Parameters

• userId Id of 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 JSONObject deleteUser(String userId)

Delete a user, calls the PATCH /users/{userId} endpoint.

Parameters

• userId Id of 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 JSONObject createWorkflow(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/setup_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/setup_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 JSONObject createWorkflow(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/setup_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/setup_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 JSONObject listWorkflows(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 JSONObject listWorkflows()

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 JSONObject getWorkflow(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 JSONObject updateWorkflow(String workflowId,UpdateWorkflowOptions options)

Update 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 JSONObject deleteWorkflow(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 JSONObject executeWorkflow(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 JSONObject listWorkflowExecutions(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 JSONObject listWorkflowExecutions(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 JSONObject deleteWorkflowExecution(String workflowId,String executionId)

Delete execution from workflow, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.

See also: Client::executeWorkflow

Parameters

• workflowId Id of the workflow

• executionId Id of the execution

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

class ai::lucidtech::las::sdk::CreateAppClientOptions

class ai::lucidtech::las::sdk::CreateAppClientOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< CreateAppClientOptions >

Summary

Members	Descriptions
public CreateAppClientOptions setCallbackUrls(String [] callbackUrls)
public CreateAppClientOptions setLogoutUrls(String [] logoutUrls)
public CreateAppClientOptions setLoginUrls(String [] loginUrls)
public CreateAppClientOptions setDefaultLoginUrl(String defaultLoginUrl)
public CreateAppClientOptions setGenerateSecret(Boolean generateSecret)
public JSONObject addOptions(JSONObject body)

Members

public CreateAppClientOptions setCallbackUrls(String [] callbackUrls)

public CreateAppClientOptions setLogoutUrls(String [] logoutUrls)

public CreateAppClientOptions setLoginUrls(String [] loginUrls)

public CreateAppClientOptions setDefaultLoginUrl(String defaultLoginUrl)

public CreateAppClientOptions setGenerateSecret(Boolean generateSecret)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::CreateAssetOptions

class ai::lucidtech::las::sdk::CreateAssetOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< CreateAssetOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::CreateDocumentOptions

class ai::lucidtech::las::sdk::CreateDocumentOptions
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public CreateDocumentOptions setConsentId(String consentId)
public CreateDocumentOptions setDatasetId(String datasetId)
public CreateDocumentOptions setGroundTruth(JSONArray groundTruth)
public CreateDocumentOptions setRetentionInDays(Integer retentionInDays)
public JSONObject addOptions(JSONObject body)

Members

public CreateDocumentOptions setConsentId(String consentId)

public CreateDocumentOptions setDatasetId(String datasetId)

public CreateDocumentOptions setGroundTruth(JSONArray groundTruth)

public CreateDocumentOptions setRetentionInDays(Integer retentionInDays)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::CreateModelOptions

class ai::lucidtech::las::sdk::CreateModelOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< CreateModelOptions >

Summary

Members	Descriptions
public CreateModelOptions setPreprocessConfig(PreprocessConfig preprocessConfig)
public JSONObject addOptions(JSONObject body)

Members

public CreateModelOptions setPreprocessConfig(PreprocessConfig preprocessConfig)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::CreatePredictionOptions

class ai::lucidtech::las::sdk::CreatePredictionOptions
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public CreatePredictionOptions setMaxPages(int maxPages)
public CreatePredictionOptions setAutoRotate(boolean autoRotate)
public CreatePredictionOptions setImageQuality(ImageQuality imageQuality)
public JSONObject addOptions(JSONObject body)

Members

public CreatePredictionOptions setMaxPages(int maxPages)

public CreatePredictionOptions setAutoRotate(boolean autoRotate)

public CreatePredictionOptions setImageQuality(ImageQuality imageQuality)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::CreateSecretOptions

class ai::lucidtech::las::sdk::CreateSecretOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< CreateSecretOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::CreateTransitionOptions

class ai::lucidtech::las::sdk::CreateTransitionOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< CreateTransitionOptions >

Summary

Members	Descriptions
public CreateTransitionOptions setParameters(TransitionParameters parameters)
public CreateTransitionOptions setInputJsonSchema(JSONObject inputJsonSchema)
public CreateTransitionOptions setOutputJsonSchema(JSONObject outputJsonSchema)
public JSONObject addOptions(JSONObject body)

Members

public CreateTransitionOptions setParameters(TransitionParameters parameters)

public CreateTransitionOptions setInputJsonSchema(JSONObject inputJsonSchema)

public CreateTransitionOptions setOutputJsonSchema(JSONObject outputJsonSchema)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::CreateUserOptions

class ai::lucidtech::las::sdk::CreateUserOptions
  : public ai.lucidtech.las.sdk.UserOptions< CreateUserOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::CreateWorkflowOptions

class ai::lucidtech::las::sdk::CreateWorkflowOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< CreateWorkflowOptions >

Summary

Members	Descriptions
public CreateWorkflowOptions setCompletedConfig(WorkflowCompletedConfig completedConfig)
public CreateWorkflowOptions setErrorConfig(WorkflowErrorConfig errorConfig)
public JSONObject addOptions(JSONObject body)

Members

public CreateWorkflowOptions setCompletedConfig(WorkflowCompletedConfig completedConfig)

public CreateWorkflowOptions setErrorConfig(WorkflowErrorConfig errorConfig)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::Credentials

Summary

Members	Descriptions
public Credentials(String clientId,String clientSecret,String authEndpoint,String apiEndpoint)	Used to fetch and store credentials.
public String getAccessToken(HttpClient httpClient)	#### Parameters
public String getApiEndpoint()

Members

public Credentials(String clientId,String clientSecret,String authEndpoint,String apiEndpoint)

Used to fetch and store credentials.

Parameters

• clientId Client id

• clientSecret Client secret

• authEndpoint Auth endpoint

• apiEndpoint Domain endpoint of the api, e.g. https://{prefix}.api.lucidtech.ai/{version}

Exceptions

• [MissingCredentialsException](#classai_1_1lucidtech_1_1las_1_1sdk_1_1_missing_credentials_exception) Raised if some of credentials are missing

public String getAccessToken(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 String getApiEndpoint()

class ai::lucidtech::las::sdk::DeleteDocumentsOptions

class ai::lucidtech::las::sdk::DeleteDocumentsOptions
  : public ai.lucidtech.las.sdk.DeleteResourcesOptions< DeleteDocumentsOptions >

Summary

Members	Descriptions
public DeleteDocumentsOptions setConsentId(String [] consentId)
public DeleteDocumentsOptions setDatasetId(String [] datasetId)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)

Members

public DeleteDocumentsOptions setConsentId(String [] consentId)

public DeleteDocumentsOptions setDatasetId(String [] datasetId)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

class ai::lucidtech::las::sdk::DeleteResourcesOptions

Summary

Members	Descriptions
public T setMaxResults(int maxResults)
public T setNextToken(String nextToken)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)
protected Integer maxResults
protected String nextToken
protected void addOption(List< NameValuePair > parameters,String key,String value)
protected void addOption(List< NameValuePair > parameters,String key,String [] value)
protected void addOption(List< NameValuePair > parameters,String key,Integer value)

Members

public T setMaxResults(int maxResults)

public T setNextToken(String nextToken)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

protected Integer maxResults

protected String nextToken

protected void addOption(List< NameValuePair > parameters,String key,String value)

protected void addOption(List< NameValuePair > parameters,String key,String [] value)

protected void addOption(List< NameValuePair > parameters,String key,Integer value)

class ai::lucidtech::las::sdk::DockerTransitionParameters

class ai::lucidtech::las::sdk::DockerTransitionParameters
  : public ai.lucidtech.las.sdk.TransitionParameters

Summary

Members	Descriptions
public DockerTransitionParameters setImageUrl(String imageUrl)
public DockerTransitionParameters setSecretId(String secretId)
public DockerTransitionParameters setMemory(Integer memory)
public DockerTransitionParameters setCpu(Integer cpu)
public DockerTransitionParameters setEnvironmentSecrets(String [] environmentSecrets)
public DockerTransitionParameters setEnvironment(Map< String, String > environment)
public JSONObject addOptions(JSONObject body)

Members

public DockerTransitionParameters setImageUrl(String imageUrl)

public DockerTransitionParameters setSecretId(String secretId)

public DockerTransitionParameters setMemory(Integer memory)

public DockerTransitionParameters setCpu(Integer cpu)

public DockerTransitionParameters setEnvironmentSecrets(String [] environmentSecrets)

public DockerTransitionParameters setEnvironment(Map< String, String > environment)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::Field

class ai::lucidtech::las::sdk::Field
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public String name
public Field(String name,FieldType fieldType,Integer maxLength)
public Field setName(String name)
public Field setFieldType(FieldType fieldType)
public Field setMaxLength(Integer maxLength)
public Field setDescription(String description)
public JSONObject addOptions(JSONObject body)

Members

public String name

public Field(String name,FieldType fieldType,Integer maxLength)

public Field setName(String name)

public Field setFieldType(FieldType fieldType)

public Field setMaxLength(Integer maxLength)

public Field setDescription(String description)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::FieldConfig

class ai::lucidtech::las::sdk::FieldConfig
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public FieldConfig addField(Field field)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public FieldConfig addField(Field field)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::ListAppClientsOptions

class ai::lucidtech::las::sdk::ListAppClientsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListAppClientsOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::ListAssetsOptions

class ai::lucidtech::las::sdk::ListAssetsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListAssetsOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::ListDocumentsOptions

class ai::lucidtech::las::sdk::ListDocumentsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListDocumentsOptions >

Summary

Members	Descriptions
public ListDocumentsOptions setConsentId(String consentId)
public ListDocumentsOptions setDatasetId(String datasetId)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)

Members

public ListDocumentsOptions setConsentId(String consentId)

public ListDocumentsOptions setDatasetId(String datasetId)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

class ai::lucidtech::las::sdk::ListLogsOptions

class ai::lucidtech::las::sdk::ListLogsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListLogsOptions >

Summary

Members	Descriptions
public ListLogsOptions setTransitionId(String transitionId)
public ListLogsOptions setTransitionExecutionId(String transitionExecutionId)
public ListLogsOptions setWorkflowId(String workflowId)
public ListLogsOptions setWorkflowExecutionId(String workflowExecutionId)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)

Members

public ListLogsOptions setTransitionId(String transitionId)

public ListLogsOptions setTransitionExecutionId(String transitionExecutionId)

public ListLogsOptions setWorkflowId(String workflowId)

public ListLogsOptions setWorkflowExecutionId(String workflowExecutionId)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

class ai::lucidtech::las::sdk::ListModelsOptions

class ai::lucidtech::las::sdk::ListModelsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListModelsOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::ListPredictionsOptions

class ai::lucidtech::las::sdk::ListPredictionsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListPredictionsOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::ListResourcesOptions

Summary

Members	Descriptions
public T setMaxResults(int maxResults)
public T setNextToken(String nextToken)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)
protected void addOption(List< NameValuePair > parameters,String key,String value)
protected void addOption(List< NameValuePair > parameters,String key,String [] value)
protected void addOption(List< NameValuePair > parameters,String key,List< String > value)
protected void addOption(List< NameValuePair > parameters,String key,Integer value)

Members

public T setMaxResults(int maxResults)

public T setNextToken(String nextToken)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

protected void addOption(List< NameValuePair > parameters,String key,String value)

protected void addOption(List< NameValuePair > parameters,String key,String [] value)

protected void addOption(List< NameValuePair > parameters,String key,List< String > value)

protected void addOption(List< NameValuePair > parameters,String key,Integer value)

class ai::lucidtech::las::sdk::ListSecretsOptions

class ai::lucidtech::las::sdk::ListSecretsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListSecretsOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::ListSortablesOptions

class ai::lucidtech::las::sdk::ListSortablesOptions
  : public ai::lucidtech::las::sdk::ListResourcesOptions< T >

Summary

Members	Descriptions
public T setSortBy(String sortBy)
public T setOrder(Order order)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)
protected String sortBy
protected Order order

Members

public T setSortBy(String sortBy)

public T setOrder(Order order)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

protected String sortBy

protected Order order

class ai::lucidtech::las::sdk::ListTransitionExecutionsOptions

class ai::lucidtech::las::sdk::ListTransitionExecutionsOptions
  : public ai.lucidtech.las.sdk.ListSortablesOptions< ListTransitionExecutionsOptions >

Summary

Members	Descriptions
public ListTransitionExecutionsOptions setExecutionId(List< String > executionId)
public ListTransitionExecutionsOptions setExecutionId(String executionId)
public ListTransitionExecutionsOptions setStatus(List< TransitionExecutionStatus > status)
public ListTransitionExecutionsOptions setStatus(TransitionExecutionStatus status)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)

Members

public ListTransitionExecutionsOptions setExecutionId(List< String > executionId)

public ListTransitionExecutionsOptions setExecutionId(String executionId)

public ListTransitionExecutionsOptions setStatus(List< TransitionExecutionStatus > status)

public ListTransitionExecutionsOptions setStatus(TransitionExecutionStatus status)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

class ai::lucidtech::las::sdk::ListTransitionsOptions

class ai::lucidtech::las::sdk::ListTransitionsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListTransitionsOptions >

Summary

Members	Descriptions
public ListTransitionsOptions setTransitionType(TransitionType transitionType)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)

Members

public ListTransitionsOptions setTransitionType(TransitionType transitionType)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

class ai::lucidtech::las::sdk::ListUsersOptions

class ai::lucidtech::las::sdk::ListUsersOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListUsersOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::ListWorkflowExecutionsOptions

class ai::lucidtech::las::sdk::ListWorkflowExecutionsOptions
  : public ai.lucidtech.las.sdk.ListSortablesOptions< ListWorkflowExecutionsOptions >

Summary

Members	Descriptions
public ListWorkflowExecutionsOptions setStatus(List< WorkflowExecutionStatus > status)
public ListWorkflowExecutionsOptions setStatus(WorkflowExecutionStatus status)
public List< NameValuePair > addOptions(List< NameValuePair > parameters)

Members

public ListWorkflowExecutionsOptions setStatus(List< WorkflowExecutionStatus > status)

public ListWorkflowExecutionsOptions setStatus(WorkflowExecutionStatus status)

public List< NameValuePair > addOptions(List< NameValuePair > parameters)

class ai::lucidtech::las::sdk::ListWorkflowsOptions

class ai::lucidtech::las::sdk::ListWorkflowsOptions
  : public ai.lucidtech.las.sdk.ListResourcesOptions< ListWorkflowsOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::ManualTransitionParameters

class ai::lucidtech::las::sdk::ManualTransitionParameters
  : public ai.lucidtech.las.sdk.TransitionParameters

Summary

Members	Descriptions
public ManualTransitionParameters setAssets(Map< String, String > assets)
public JSONObject addOptions(JSONObject body)

Members

public ManualTransitionParameters setAssets(Map< String, String > assets)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::MissingAccessTokenException

class ai::lucidtech::las::sdk::MissingAccessTokenException
  : public Exception

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::MissingCredentialsException

class ai::lucidtech::las::sdk::MissingCredentialsException
  : public Exception

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::NameAndDescriptionOptions

class ai::lucidtech::las::sdk::NameAndDescriptionOptions
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public T setName(String name)
public T setDescription(String description)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public T setName(String name)

public T setDescription(String description)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::NullableString

Summary

Members	Descriptions
public Boolean hasEditedValue
public NullableString()
public void setValue(String value)

Members

public Boolean hasEditedValue

public NullableString()

public void setValue(String value)

class ai::lucidtech::las::sdk::Options

Summary

Members	Descriptions
public abstract JSONObject addOptions(JSONObject body)
protected void addOption(JSONObject body,String key,NullableString value)
protected void addOption(JSONObject body,String key,String value)
protected void addOption(JSONObject body,String key,String [] value)
protected void addOption(JSONObject body,String key,Map< String, String > value)
protected void addOption(JSONObject body,String key,Boolean value)
protected void addOption(JSONObject body,String key,Integer value)
protected void addOption(JSONObject body,String key,JSONArray value)
protected void addOption(JSONObject body,String key,JSONObject value)
protected void addOption(JSONObject body,String key,Options value)

Members

public abstract JSONObject addOptions(JSONObject body)

protected void addOption(JSONObject body,String key,NullableString value)

protected void addOption(JSONObject body,String key,String value)

protected void addOption(JSONObject body,String key,String [] value)

protected void addOption(JSONObject body,String key,Map< String, String > value)

protected void addOption(JSONObject body,String key,Boolean value)

protected void addOption(JSONObject body,String key,Integer value)

protected void addOption(JSONObject body,String key,JSONArray value)

protected void addOption(JSONObject body,String key,JSONObject value)

protected void addOption(JSONObject body,String key,Options value)

class ai::lucidtech::las::sdk::PreprocessConfig

class ai::lucidtech::las::sdk::PreprocessConfig
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public PreprocessConfig setImageQuality(ImageQuality imageQuality)
public PreprocessConfig setAutoRotate(Boolean autoRotate)
public PreprocessConfig setMaxPages(Integer maxPages)
public JSONObject addOptions(JSONObject body)

Members

public PreprocessConfig setImageQuality(ImageQuality imageQuality)

public PreprocessConfig setAutoRotate(Boolean autoRotate)

public PreprocessConfig setMaxPages(Integer maxPages)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::TransitionParameters

class ai::lucidtech::las::sdk::TransitionParameters
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public abstract JSONObject addOptions(JSONObject body)

Members

public abstract JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::UpdateAppClientOptions

class ai::lucidtech::las::sdk::UpdateAppClientOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< UpdateAppClientOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::UpdateAssetOptions

class ai::lucidtech::las::sdk::UpdateAssetOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< UpdateAssetOptions >

Summary

Members	Descriptions
public UpdateAssetOptions setContent(byte [] content)
public UpdateAssetOptions setContent(InputStream content)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public UpdateAssetOptions setContent(byte [] content)

public UpdateAssetOptions setContent(InputStream content)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::UpdateDocumentOptions

class ai::lucidtech::las::sdk::UpdateDocumentOptions
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public UpdateDocumentOptions setDatasetId(String datasetId)
public UpdateDocumentOptions setGroundTruth(JSONArray groundTruth)
public UpdateDocumentOptions setRetentionInDays(Integer retentionInDays)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public UpdateDocumentOptions setDatasetId(String datasetId)

public UpdateDocumentOptions setGroundTruth(JSONArray groundTruth)

public UpdateDocumentOptions setRetentionInDays(Integer retentionInDays)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::UpdateModelOptions

class ai::lucidtech::las::sdk::UpdateModelOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< UpdateModelOptions >

Summary

Members	Descriptions
public UpdateModelOptions setWidth(Integer width)
public UpdateModelOptions setHeight(Integer height)
public UpdateModelOptions setFieldConfig(FieldConfig fieldConfig)
public UpdateModelOptions setModelStatus(ModelStatus modelStatus)
public UpdateModelOptions setPreprocessConfig(PreprocessConfig preprocessConfig)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public UpdateModelOptions setWidth(Integer width)

public UpdateModelOptions setHeight(Integer height)

public UpdateModelOptions setFieldConfig(FieldConfig fieldConfig)

public UpdateModelOptions setModelStatus(ModelStatus modelStatus)

public UpdateModelOptions setPreprocessConfig(PreprocessConfig preprocessConfig)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::UpdateSecretOptions

class ai::lucidtech::las::sdk::UpdateSecretOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< UpdateSecretOptions >

Summary

Members	Descriptions
public UpdateSecretOptions setData(JSONObject data)
public UpdateSecretOptions setData(Map< String, String > data)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public UpdateSecretOptions setData(JSONObject data)

public UpdateSecretOptions setData(Map< String, String > data)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::UpdateTransitionExecutionOptions

class ai::lucidtech::las::sdk::UpdateTransitionExecutionOptions
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public UpdateTransitionExecutionOptions setOutput(JSONObject error)
public UpdateTransitionExecutionOptions setError(JSONObject output)
public UpdateTransitionExecutionOptions setStartTime(String startTime)
public UpdateTransitionExecutionOptions setStartTime(ZonedDateTime startTime)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public UpdateTransitionExecutionOptions setOutput(JSONObject error)

public UpdateTransitionExecutionOptions setError(JSONObject output)

public UpdateTransitionExecutionOptions setStartTime(String startTime)

public UpdateTransitionExecutionOptions setStartTime(ZonedDateTime startTime)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::UpdateTransitionOptions

class ai::lucidtech::las::sdk::UpdateTransitionOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< UpdateTransitionOptions >

Summary

Members	Descriptions
public UpdateTransitionOptions setInputJsonSchema(JSONObject schema)
public UpdateTransitionOptions setOutputJsonSchema(JSONObject schema)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public UpdateTransitionOptions setInputJsonSchema(JSONObject schema)

public UpdateTransitionOptions setOutputJsonSchema(JSONObject schema)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::UpdateUserOptions

class ai::lucidtech::las::sdk::UpdateUserOptions
  : public ai.lucidtech.las.sdk.UserOptions< UpdateUserOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::UpdateWorkflowOptions

class ai::lucidtech::las::sdk::UpdateWorkflowOptions
  : public ai.lucidtech.las.sdk.NameAndDescriptionOptions< UpdateWorkflowOptions >

Summary

Members	Descriptions

Members

class ai::lucidtech::las::sdk::UserOptions

class ai::lucidtech::las::sdk::UserOptions
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public T setName(String name)
public T setAvatar(String avatar)
public T setAvatar(byte [] avatar)
public JSONObject addOptions(JSONObject body)
public JSONObject toJson()

Members

public T setName(String name)

public T setAvatar(String avatar)

public T setAvatar(byte [] avatar)

public JSONObject addOptions(JSONObject body)

public JSONObject toJson()

class ai::lucidtech::las::sdk::WorkflowCompletedConfig

class ai::lucidtech::las::sdk::WorkflowCompletedConfig
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public WorkflowCompletedConfig setImageUrl(String imageUrl)
public WorkflowCompletedConfig setSecretId(String secretId)
public WorkflowCompletedConfig setEnvironmentSecrets(String [] environmentSecrets)
public WorkflowCompletedConfig setEnvironment(Map< String, String > environment)
public JSONObject addOptions(JSONObject body)

Members

public WorkflowCompletedConfig setImageUrl(String imageUrl)

public WorkflowCompletedConfig setSecretId(String secretId)

public WorkflowCompletedConfig setEnvironmentSecrets(String [] environmentSecrets)

public WorkflowCompletedConfig setEnvironment(Map< String, String > environment)

public JSONObject addOptions(JSONObject body)

class ai::lucidtech::las::sdk::WorkflowErrorConfig

class ai::lucidtech::las::sdk::WorkflowErrorConfig
  : public ai.lucidtech.las.sdk.Options

Summary

Members	Descriptions
public WorkflowErrorConfig setEmail(String email)
public WorkflowErrorConfig setManualRetry(Boolean manualRetry)
public JSONObject addOptions(JSONObject body)

Members

public WorkflowErrorConfig setEmail(String email)

public WorkflowErrorConfig setManualRetry(Boolean manualRetry)

public JSONObject addOptions(JSONObject body)

Generated by Moxygen