latest

Summary

Members

Descriptions

namespaceLucidtech::Las

namespaceLucidtech::Las::Core

namespaceLucidtech::Las::Utils

namespace Lucidtech::Las

Summary

Members

Descriptions

classLucidtech::Las::Client

Client to invoke api methods from Lucidtech AI Services.

class Lucidtech::Las::Client

Client to invoke api methods from Lucidtech AI Services.

Summary

Members

Descriptions

{property} RestClientRestSharpClient

{property}Credentials`[LasCredentials`](#a00043_1aed1258913a65f014aa0ce4ef63bd6dfe)

public inlineClient(Credentialscredentials)

Client constructor.

public inlineClient()

Client constructor with credentials read from local file.

public inline objectCreateAsset(byte [] content,Dictionary< string, string?>? attributes)

Creates an asset, calls the POST /assets endpoint.

public inline objectListAssets(int? maxResults,string? nextToken)

List available assets, calls the GET /assets endpoint.

public inline objectGetAsset(string assetId)

Get asset from the REST API, calls the GET /assets/{assetId} endpoint.

public inline objectUpdateAsset(string assetId,byte? [] content,Dictionary< string, string?>? attributes)

Updates an asset, calls the PATCH /assets/{assetId} endpoint.

public inline objectCreateDocument(byte [] content,string contentType,string? consentId,string? batchId,List< Dictionary< string, string >>? groundTruth)

Creates a document handle, calls the POST /documents endpoint

public inline objectListDocuments(string? batchId,string? consentId,int? maxResults,string? nextToken)

Get documents from the REST API, calls the GET /documents endpoint.

public inline objectGetDocument(string documentId)

Get document from the REST API, calls the GET /documents/{documentId} endpoint.

public inline objectUpdateDocument(string documentId,List< Dictionary< string, string >> groundTruth)

Update ground truth of the document, calls the POST /documents/{documentId} endpoint. This enables the API to learn from past mistakes.

public inline objectDeleteDocuments(string? consentId)

Delete documents with specified consentId, calls DELETE /documents endpoint.

public inline objectCreateBatch(string? name,string? description)

Create a batch handle, calls the POST /batches endpoint.

public inline objectCreatePrediction(string documentId,string modelId,int? maxPages,bool? autoRotate,string? imageQuality)

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

public inline objectListPredictions(int? maxResults,string? nextToken)

List predictions available, calls the GET /predictions endpoint.

public inline objectListModels(int? maxResults,string? nextToken)

List models available, calls the GET /models endpoint.

public inline objectCreateSecret(Dictionary< string, string > data,Dictionary< string, string?>? attributes)

Creates an secret, calls the POST /secrets endpoint.

public inline objectListSecrets(int? maxResults,string? nextToken)

List secrets available, calls the GET /secrets endpoint.

public inline objectUpdateSecret(string secretId,Dictionary< string, string >? data,Dictionary< string, string?>? attributes)

Updates a secret, calls the PATCH /secrets/secretId endpoint.

public inline objectCreateTransition(string transitionType,Dictionary< string, string >? inputJsonSchema,Dictionary< string, string >? outputJsonSchema,Dictionary< string, object?>? parameters,Dictionary< string, string?>? attributes)

Creates a transition, calls the POST /transitions endpoint.

public inline objectListTransitions(string? transitionType,int? maxResults,string? nextToken)

List transitions, calls the GET /transitions endpoint.

public inline objectGetTransition(string transitionId)

Get information about a specific transition, calls the GET /transitions/{transition_id} endpoint.

public inline objectDeleteTransition(string transitionId)

Delete a transition, calls the DELETE /transitions/{transition_id} endpoint. Will fail if transition is in use by one or more workflows.

public inline objectGetTransitionExecution(string transitionId,string executionId)

Get an execution of a transition, calls the GET /transitions/{transitionId}/executions/{executionId} endpoint

public inline objectUpdateTransition(string transitionId,Dictionary< string, string >? inputJsonSchema,Dictionary< string, string >? outputJsonSchema,Dictionary< string, string?> attributes)

Updates an existing transition, calls the PATCH /transitions/{transitionId} endpoint.

public inline objectExecuteTransition(string transitionId)

Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.

public inline objectListTransitionExecutions(string transitionId,string? status,List< string >? executionIds,int? maxResults,string? nextToken,string? sortBy,string? order)

List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.

public inline objectListTransitionExecutions(string transitionId,List< string >? statuses,List< string >? executionIds,int? maxResults,string? nextToken,string? sortBy,string? order)

List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.

public inline objectUpdateTransitionExecution(string transitionId,string executionId,string status,Dictionary< string, string >? output,Dictionary< string, string >? error,string? startTime)

Ends the processing of the transition execution, calls the PATCH /transitions/{transitionId}/executions/{executionId} endpoint.

public inline objectSendHeartbeat(string transitionId,string executionId)

Send heartbeat for a manual execution, calls the POST /transitions/{transitionId}/executions/{executionId}/heartbeats endpoint.

public inline objectCreateUser(string email,Dictionary< string, string?>? attributes)

Creates a new user, calls the POST /users endpoint.

public inline objectListUsers(int? maxResults,string? nextToken)

List users, calls the GET /users endpoint.

public inline objectGetUser(string userId)

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

public inline objectDeleteUser(string userId)

Delete the user with the provided user_id, calls the DELETE /users/{userId} endpoint.

public inline objectUpdateUser(string userId,Dictionary< string, object?> attributes)

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

public inline objectCreateWorkflow(Dictionary< string, object > spec,Dictionary< string, string >? errorConfig,Dictionary< string, string?>? attributes)

Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow.

public inline objectListWorkflows(int? maxResults,string nextToken)

List workflows, calls the GET /workflows endpoint.

public inline objectUpdateWorkflow(string workflowId,Dictionary< string, string?> attributes)

Creates a workflow handle, calls the PATCH /workflows/{workflowId} endpoint.

public inline objectGetWorkflow(string workflowId)

Get information about a specific workflow, calls the GET /workflows/{workflow_id} endpoint.

public inline objectDeleteWorkflow(string workflowId)

Delete the workflow with the provided workflow_id, calls the DELETE /workflows/{workflowId} endpoint.

public inline objectExecuteWorkflow(string workflowId,Dictionary< string, object > content)

Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.

public inline objectListWorkflowExecutions(string workflowId,string? status,int? maxResults,string? nextToken,string? sortBy,string? order)

List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.

public inline objectListWorkflowExecutions(string workflowId,List< string >? statuses,int? maxResults,string? nextToken,string? sortBy,string? order)

List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.

public inline objectDeleteWorkflowExecution(string workflowId,string executionId)

Deletes the execution with the provided execution_id from workflow_id, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.

Members

{property} RestClientRestSharpClient

{property}Credentials`[LasCredentials`](#a00043_1aed1258913a65f014aa0ce4ef63bd6dfe)

public inlineClient(Credentialscredentials)

Client constructor.

Parameters

  • credentials Keys, endpoints and credentials needed for authorization

public inlineClient()

Client constructor with credentials read from local file.

public inline objectCreateAsset(byte [] content,Dictionary< string, string?>? attributes)

Creates an asset, calls the POST /assets endpoint.

Client client = new Client();
byte[] content = File.ReadAllBytes("myScript.js");
client.CreateAsset(content);

Parameters

  • content Asset content

  • attributes Additional attributes

Returns

Asset response from REST API

public inline objectListAssets(int? maxResults,string? nextToken)

List available assets, calls the GET /assets endpoint.

Client client = new Client();
var response = client.ListAssets();

Parameters

  • maxResults Number of items to show on a single page

  • nextToken Token to retrieve the next page

Returns

JSON object with two keys:

  • "assets" Assets response from REST API without the content of each asset

  • "nextToken" allowing for retrieving the next portion of data

public inline objectGetAsset(string assetId)

Get asset from the REST API, calls the GET /assets/{assetId} endpoint.

Client client = new Client();
var response = client.GetAsset("<asset_id>");

Parameters

  • assetId Asset ID

Returns

Asset object

public inline objectUpdateAsset(string assetId,byte? [] content,Dictionary< string, string?>? attributes)

Updates an asset, calls the PATCH /assets/{assetId} endpoint.

Client client = new Client();
byte[] newContent = File.ReadAllBytes("MyScript.js");
var response = client.UpdateAsset("<asset_id>", newContent);

Parameters

  • assetId Asset ID

  • content New content

  • attributes Additional attributes

Returns

Asset object

public inline objectCreateDocument(byte [] content,string contentType,string? consentId,string? batchId,List< Dictionary< string, string >>? groundTruth)

Creates a document handle, calls the POST /documents endpoint

Create a document handle for a jpeg image

Client client = new Client();
byte[] content = File.ReadAllBytes("MyReceipt.jpeg");
var response = client.CreateDocument(content, "image/jpeg", "bar");

Parameters

  • content Content to POST

  • contentType A mime type for the document handle

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

  • batchId Specifies the batch to which the document will be associated with

  • groundTruth A list of items {label: value}, representing the ground truth values for the document

Returns

A deserialized object that can be interpreted as a Dictionary with the fields with batchId, documentId, contentType and consentId

public inline objectListDocuments(string? batchId,string? consentId,int? maxResults,string? nextToken)

Get documents from the REST API, calls the GET /documents endpoint.

Create a document handle for a jpeg image

Client client = new Client();
var response = client.ListDocuments('<batchId>');

Parameters

  • batchId The batch id that contains the documents of interest

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

  • maxResults Number of items to show on a single page

  • nextToken Token to retrieve the next page

Returns

Documents from REST API contained in batch

public inline objectGetDocument(string documentId)

Get document from the REST API, calls the GET /documents/{documentId} endpoint.

Get information of document specified by

Client client = new Client();
var response = client.GetDocument('<documentId>');

Parameters

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

Returns

Document information from REST API

public inline objectUpdateDocument(string documentId,List< Dictionary< string, string >> groundTruth)

Update ground truth of the document, calls the POST /documents/{documentId} endpoint. This enables the API to learn from past mistakes.

Client client = new Client();
var groundTruth = new List<Dictionary<string, string>>()
{
new Dictionary<string, string>(){{"label", "total_amount"},{"value", "54.50"}},
new Dictionary<string, string>(){{"label", "purchase_date"},{"value", "2007-07-30"}}
};
var response = client.UpdateDocument('<documentId>', groundTruth);

Parameters

  • documentId Path to document to upload, Same as provided to CreateDocument

  • groundTruth A list of ground truth items

Returns

A deserialized object that can be interpreted as a Dictionary with the fields documentId, consentId, uploadUrl, contentType and ground truth.

public inline objectDeleteDocuments(string? consentId)

Delete documents with specified consentId, calls DELETE /documents endpoint.

Client client = new Client();
var response = client.DeleteConsent('<consentId>');

Parameters

  • consentId Delete documents with provided consentId

Returns

A deserialized object that can be interpreted as a Dictionary with the fields consentId and documentIds

public inline objectCreateBatch(string? name,string? description)

Create a batch handle, calls the POST /batches endpoint.

Create a new batch with the provided description. on the document specified by ''

Client client = new Client();
var response = client.CreateBatch("Data gathered from the Mars Rover Invoice Scan Mission");

Parameters

  • name Name of the batch

  • description A brief description of the purpose of the batch

Returns

A deserialized object that can be interpreted as a Dictionary with the fields batchId and description. batchId can be used as an input when posting documents to make them a part of this batch.

public inline objectCreatePrediction(string documentId,string modelId,int? maxPages,bool? autoRotate,string? imageQuality)

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

Run inference and create a prediction using the invoice model on the document specified by ''

Client client = new Client();
var response = client.CreatePrediction('<documentId>',"las:model:99cac468f7cf47ddad12e5e017540389");

Parameters

  • documentId Path to document to upload Same as provided to CreateDocument

  • modelId Id of the model to use for inference

  • maxPages Maximum number of pages to run predictions on

  • autoRotate Whether or not to let the API try different rotations on the document when running

  • extras Extra information to add to json body

Returns

A deserialized object that can be interpreted as a Dictionary with the fields documentId and predictions, the value of predictions is the output from the model.

public inline objectListPredictions(int? maxResults,string? nextToken)

List predictions available, calls the GET /predictions endpoint.

Client client = new Client();
var response = client.ListPredictions();

Parameters

  • maxResults Number of items to show on a single page

  • nextToken Token to retrieve the next page

Returns

JSON object with two keys:

  • "predictions" which contains a list of Prediction objects

  • "nextToken" allowing for retrieving the next portion of data

public inline objectListModels(int? maxResults,string? nextToken)

List models available, calls the GET /models endpoint.

Client client = new Client();
var response = client.ListModels();

Parameters

  • maxResults Number of items to show on a single page

  • nextToken Token to retrieve the next page

Returns

JSON object with two keys:

  • "models" which contains a list of Prediction objects

  • "nextToken" allowing for retrieving the next portion of data

public inline objectCreateSecret(Dictionary< string, string > data,Dictionary< string, string?>? attributes)

Creates an secret, calls the POST /secrets endpoint.

Client client = new Client();
var data = new Dictionary<string, string>{
{"key", "my_secret_value"}
}
var response = client.CreateSecret(data);

Parameters

  • data A dictionary containing values to be hidden

  • attributes Additional attributes

Returns

A Secret object

public inline objectListSecrets(int? maxResults,string? nextToken)

List secrets available, calls the GET /secrets endpoint.

Client client = new Client();
var response = client.ListSecrets();

Parameters

  • maxResults Number of items to show on a single page

  • nextToken Token to retrieve the next page

Returns

JSON object with two keys:

  • "secrets" which contains a list of Prediction objects

  • "nextToken" allowing for retrieving the next portion of data

public inline objectUpdateSecret(string secretId,Dictionary< string, string >? data,Dictionary< string, string?>? attributes)

Updates a secret, calls the PATCH /secrets/secretId endpoint.

Client client = new Client();
var data = new Dictionary<string, string>{
{"key", "my_new_secret_value"}
}
var response = client.UpdateSecret("<secretId>", data);

Parameters

  • secretId Secret ID

  • data New data

  • attributes Additional attributes

public inline objectCreateTransition(string transitionType,Dictionary< string, string >? inputJsonSchema,Dictionary< string, string >? outputJsonSchema,Dictionary< string, object?>? parameters,Dictionary< string, string?>? attributes)

Creates a transition, calls the POST /transitions endpoint.

Client client = new Client();
var inputSchema = new Dictionary<string, string>{
{"$schema", "https://json-schema.org/draft-04/schema#"},
{"title", "input"}
};
var outputSchema = new Dictionary<string, string>{
{"$schema", "https://json-schema/draft-04/schema#"},
{"title", "output"}
};
var params = new Dictionary<string, object>{
{"imageUrl", "<image_url>"},
{"credentials", new Dictionary<string, string>{
{"username", "<username>"},
{"password", "<password>"}
}
};
var response = client.CreateTransition("<transition_type>", inputSchema, outputSchema, parameters: params);

Parameters

  • transitionType Type of transition: "docker"|"manual"

  • inputJsonSchema Json-schema that defines the input to the transition

  • outputJsonSchema Json-schema that defines the output of the transition

  • parameters Parameters to the corresponding transition type

  • attributes Additional attributes

Returns

Transition response from REST API

public inline objectListTransitions(string? transitionType,int? maxResults,string? nextToken)

List transitions, calls the GET /transitions endpoint.

Client client = new Client();
var response = client.ListTransitions();

Parameters

  • transitionType Type of transitions

  • maxResults Number of items to show on a single page

  • nextToken Token to retrieve the next page

Returns

Transitions response from REST API

public inline objectGetTransition(string transitionId)

Get information about a specific transition, calls the GET /transitions/{transition_id} endpoint.

Client client = new Client();
var response = client.GetTransition("<transition_id>");

Parameters

  • transitionId Id of the transition

Returns

Transition response from REST API

public inline objectDeleteTransition(string transitionId)

Delete a transition, calls the DELETE /transitions/{transition_id} endpoint. Will fail if transition is in use by one or more workflows.

Client client = new Client();
var response = client.DeleteTransition("<transition_id>");

Parameters

  • transitionId Id of the transition

Returns

Transition response from REST API

public inline objectGetTransitionExecution(string transitionId,string executionId)

Get an execution of a transition, calls the GET /transitions/{transitionId}/executions/{executionId} endpoint

Client client = new Client();
var response = client.GetTransitionExecution("<transition_id>", "<execution_id>");

Parameters

  • transitionId Id of the transition

  • executionId Id of the execution

Returns

Transition execution response from REST API

public inline objectUpdateTransition(string transitionId,Dictionary< string, string >? inputJsonSchema,Dictionary< string, string >? outputJsonSchema,Dictionary< string, string?> attributes)

Updates an existing transition, calls the PATCH /transitions/{transitionId} endpoint.

Client client = new Client();
var response = client.UpdateTransition("<transitionId>");

Parameters

  • transitionId Id of the transition

  • inputJsonSchema Json-schema that defines the input to the transition

  • outputJsonSchema Json-schema that defines the output of the transition

  • attributes Additional attributes

Returns

Transition response from REST API

public inline objectExecuteTransition(string transitionId)

Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.

Client client = new Client();
var response = client.ExecuteTransition("<transitionId>");

Parameters

  • transitionId Id of the transition

Returns

Transition exexution response from REST API

public inline objectListTransitionExecutions(string transitionId,string? status,List< string >? executionIds,int? maxResults,string? nextToken,string? sortBy,string? order)

List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.

Client client = new Client();
var response = client.ListTransitionExecutions("<transitionId>", new [] {"succeeded", "failed"});

Parameters

  • transitionId Id of the transition

  • status Status to filter by

  • executionIds List of execution ids to filter by

  • maxResults Maximum number of results to be returned

  • nextToken A unique token used to retrieve the next page

  • sortBy The sorting variable of the execution: "endTime" | "startTime"

  • order Order of the executions: "ascending" | "descending"

Returns

Transition executions response from the REST API

public inline objectListTransitionExecutions(string transitionId,List< string >? statuses,List< string >? executionIds,int? maxResults,string? nextToken,string? sortBy,string? order)

List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.

Client client = new Client();
var response = client.ListTransitionExecutions("<transitionId>", new [] {"succeeded", "failed"});

Parameters

  • transitionId Id of the transition

  • statuses List of execution statuses to filter by

  • executionIds List of execution ids to filter by

  • maxResults Maximum number of results to be returned

  • nextToken A unique token used to retrieve the next page

  • sortBy The sorting variable of the execution: "endTime" | "startTime"

  • order Order of the executions: "ascending" | "descending"

Returns

Transition executions response from the REST API

public inline objectUpdateTransitionExecution(string transitionId,string executionId,string status,Dictionary< string, string >? output,Dictionary< string, string >? error,string? startTime)

Ends the processing of the transition execution, calls the PATCH /transitions/{transitionId}/executions/{executionId} endpoint.

Client client = new Client();
var output = new Dictionary<string, string>();
client.UpdateTransitionExecution("<transitionId>", "<executionId>, "succeeded", output: output);

Parameters

  • transitionId Id of the transition

  • executionId Id of the execution

  • status Status of the execution: "succeeded" | "failed"

  • output Output from the execution, required when status is "succeeded"

  • error Error from the execution, required when status is "failed"

  • startTime Utc start time that will replace the original start time of the execution

Returns

Transition execution response from REST API

public inline objectSendHeartbeat(string transitionId,string executionId)

Send heartbeat for a manual execution, calls the POST /transitions/{transitionId}/executions/{executionId}/heartbeats endpoint.

Client client = new Client();
var response = client.sendHeartbeat("<transitionId>", "<executionId>");

Parameters

  • transitionId Id of the transition

  • executionId Id of the execution

Returns

Transition exexution response from REST API

public inline objectCreateUser(string email,Dictionary< string, string?>? attributes)

Creates a new user, calls the POST /users endpoint.

Client client = new Client();
var response = client.CreateUser("foo@bar.com");

Parameters

  • email New user's email

  • attributes Additional attributes. Currently supported are: name, avatar

Returns

User response from REST API

public inline objectListUsers(int? maxResults,string? nextToken)

List users, calls the GET /users endpoint.

Client client = new Client();
var response = client.ListUsers();

Parameters

  • maxResults Maximum number of results to be returned

  • nextToken A unique token used to retrieve the next page

Returns

Users response from REST API

public inline objectGetUser(string userId)

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

Client client = new Client();
var response = client.GetUser("<user_id>");

Parameters

  • userId Id of the user

Returns

User response from REST API

public inline objectDeleteUser(string userId)

Delete the user with the provided user_id, calls the DELETE /users/{userId} endpoint.

Client client = new Client();
var response = client.DeleteUser("<user_id>");

Parameters

  • userId Id of the user

Returns

User response from REST API

public inline objectUpdateUser(string userId,Dictionary< string, object?> attributes)

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

Client client = new Client();
var parameters = new Dictionary<string, string>{
{"name", "User"}
};
var response = client.UpdateUser("<user_id>", parameters);

Parameters

  • userId Id of the user

  • attributes Attributes to update. Allowed attributes: name (string), avatar (base64-encoded image)

Returns

User response from REST API

public inline objectCreateWorkflow(Dictionary< string, object > spec,Dictionary< string, string >? errorConfig,Dictionary< string, string?>? attributes)

Creates a new workflow, calls the POST /workflows endpoint. Check out Lucidtech's tutorials for more info on how to create a workflow.

Client client = new Client();
var spec = new Dictionary<string, object>{
{"language", "ASL"},
{"version", "1.0.0"},
{"definition", {...}}
};
var errorConfig = new Dictionary<string, string>{
{"email", "foo@bar.com}
};
var parameters = new Dictionary<string, string>{
{"name", "Name"},
{"description", "My awesome workflow"}
};
var response = Client.CreateWorkflow(spec, errorConfig, parameters);

Parameters

  • spec Workflow specification. Currently only ASL is supported: https://states-language.net/spec.html

  • errorConfig Error handler configuration

  • attributes Additional attributes. Currently supported are: name, description.

Returns

Workflow response from REST API

public inline objectListWorkflows(int? maxResults,string nextToken)

List workflows, calls the GET /workflows endpoint.

Client client = new Client();
var response = client.ListWorkflows();

Parameters

  • maxResults Maximum number of results to be returned

  • nextToken A unique token used to retrieve the next page

Returns

Workflows response from REST API

public inline objectUpdateWorkflow(string workflowId,Dictionary< string, string?> attributes)

Creates a workflow handle, calls the PATCH /workflows/{workflowId} endpoint.

Client client = new Client();
var newParameters = new Dictionary<string, string>{
{"name", "New Name"},
{"description", "My updated awesome workflow"}
};
var response = client.UpdateWorkflow("<workflow_id>, newParameters);

Parameters

  • workflowId Id of the workflow

  • attributes Attributes to update. Currently supported are: name, description

Returns

Workflow response from REST API

public inline objectGetWorkflow(string workflowId)

Get information about a specific workflow, calls the GET /workflows/{workflow_id} endpoint.

Client client = new Client();
var response = client.GetWorkflow("<workflow_id>");

Parameters

  • workflowId Id of the workflow

Returns

Workflow response from REST API

public inline objectDeleteWorkflow(string workflowId)

Delete the workflow with the provided workflow_id, calls the DELETE /workflows/{workflowId} endpoint.

Client client = new Client();
var response = client.DeleteWorkflow("<workflow_id>");

Parameters

  • workflowId Id of the workflow

Returns

Workflow response from REST API

public inline objectExecuteWorkflow(string workflowId,Dictionary< string, object > content)

Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.

Client client = new Client();
var content = new Dictionary<string, object>();
var response = client.ExecuteWorkflow("<workflowId>, content);

Parameters

  • workflowId Id of the workflow

  • content Input to the first step of the workflow

Returns

Workflow execution response from REST API

public inline objectListWorkflowExecutions(string workflowId,string? status,int? maxResults,string? nextToken,string? sortBy,string? order)

List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.

Client client = new Client();
var statuses = new [] {"running", "succeeded"};
var response = client.ListWorkflowExecutions("<workflow_id>", statuses);

Parameters

  • workflowId Id of the workflow

  • status Workflow execution status to filter by

  • maxResults Maximum number of results to be returned

  • nextToken A unique token used to retrieve the next page

  • sortBy The sorting variable of the execution: "endTime" | "startTime"

  • order Order of the executions: "ascending" | "descending"

Returns

WorkflowExecutions response from REST API

public inline objectListWorkflowExecutions(string workflowId,List< string >? statuses,int? maxResults,string? nextToken,string? sortBy,string? order)

List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.

Client client = new Client();
var statuses = new [] {"running", "succeeded"};
var response = client.ListWorkflowExecutions("<workflow_id>", statuses);

Parameters

  • workflowId Id of the workflow

  • statuses Workflow execution statuses to filter by

  • maxResults Maximum number of results to be returned

  • nextToken A unique token used to retrieve the next page

  • sortBy The sorting variable of the execution: "endTime" | "startTime"

  • order Order of the executions: "ascending" | "descending"

Returns

WorkflowExecutions response from REST API

public inline objectDeleteWorkflowExecution(string workflowId,string executionId)

Deletes the execution with the provided execution_id from workflow_id, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.

Client client = new Client();
var response = client.DeleteWorkflowExecution("<workflow_id>", "<execution_id>");

Parameters

  • workflowId Id of the workflow

  • executionId Id of the execution

Returns

WorkflowExecution response from REST API

namespace Lucidtech::Las::Core

Summary

Members

Descriptions

classLucidtech::Las::Core::ClientException

A ClientException is raised if the client refuses to send request due to incorrect usage or bad request data.

classLucidtech::Las::Core::Credentials

Used to fetch and store credentials. One of 3 conditions must be met to successfully create credentials.

classLucidtech::Las::Core::FeedbackResponse

The structured format of the response from a send feedback request.

classLucidtech::Las::Core::InvalidCredentialsException

An InvalidCredentialsException is raised if api key, access key id or secret access key is invalid.

classLucidtech::Las::Core::LimitExceededException

A LimitExceededException is raised if you have reached the limit of total requests per month associated with your credentials.

classLucidtech::Las::Core::Prediction

A class that contains all the necessary information regarding a prediction performed by ApiClient.

classLucidtech::Las::Core::RequestException

A RequestException is raised if something went wrong with the request.

classLucidtech::Las::Core::RevokeResponse

The structured format of the response from a revoke consent request.

classLucidtech::Las::Core::TooManyRequestsException

A TooManyRequestsException is raised if you have reached the number of requests per second limit associated with your credentials.

class Lucidtech::Las::Core::ClientException

class Lucidtech::Las::Core::ClientException
: public Exception

A ClientException is raised if the client refuses to send request due to incorrect usage or bad request data.

Summary

Members

Descriptions

public inlineClientException(string s)

Members

public inlineClientException(string s)

class Lucidtech::Las::Core::Credentials

Used to fetch and store credentials. One of 3 conditions must be met to successfully create credentials.

  • ClientId, ClientSecret, ApiKey, AuthEndpoint and ApiEndpoint are provided

  • The path to the file where the credentials are stored is provided

  • Credentials are located in default path ~/.lucidtech/credentials.cfg

Get credentials by contacting hello@lucidtech.ai

Summary

Members

Descriptions

{property} stringClientId

Client ID. Provided by Lucidtech.

{property} stringClientSecret

Client Secret. Provided by Lucidtech.

{property} stringApiKey

AWS API Gateway API key. Provided by Lucidtech.

{property} stringAuthEndpoint

AWS Authorization endpoint. Provided by Lucidtech.

{property} stringApiEndpoint

AWS API Gateway API endpoint. Provided by Lucidtech.

{property} RestClientRestSharpClient

RestClient for making request to the authorization endpoint.

public inline stringGetAccessToken()

Get Access token to API endpoint.

public inlineCredentials(string clientId,string clientSecret,string apiKey,string authEndpoint,string apiEndpoint)

Credentials constructor where ClientId, ClientSecret, ApiKey, AuthEndpoint and ApiEndpoint are provided by Lucidtech.

public inlineCredentials(string credentialsPath)

Credentials constructor where the path to the credentials config is provided.

public inlineCredentials()

Credentials constructor where the credentials are located at the default path. ~/.lucidtech/credentials.cfg for linux and USERPROFILE%.lucidtech\credentials.cfg for Windows.

protectedstring

protected inline virtual voidCommonConstructor()

Members

{property} stringClientId

Client ID. Provided by Lucidtech.

{property} stringClientSecret

Client Secret. Provided by Lucidtech.

{property} stringApiKey

AWS API Gateway API key. Provided by Lucidtech.

{property} stringAuthEndpoint

AWS Authorization endpoint. Provided by Lucidtech.

{property} stringApiEndpoint

AWS API Gateway API endpoint. Provided by Lucidtech.

{property} RestClientRestSharpClient

RestClient for making request to the authorization endpoint.

public inline stringGetAccessToken()

Get Access token to API endpoint.

public inlineCredentials(string clientId,string clientSecret,string apiKey,string authEndpoint,string apiEndpoint)

Credentials constructor where ClientId, ClientSecret, ApiKey, AuthEndpoint and ApiEndpoint are provided by Lucidtech.

Parameters

  • clientId client id

  • clientSecret client secret

  • apiKey API key

  • authEndpoint Authorization endpoint

  • apiEndpoint API endpoint

Exceptions

  • ArgumentException

public inlineCredentials(string credentialsPath)

Credentials constructor where the path to the credentials config is provided.

Parameters

  • credentialsPath Path to the file where the credentials are stored

public inlineCredentials()

Credentials constructor where the credentials are located at the default path. ~/.lucidtech/credentials.cfg for linux and USERPROFILE%.lucidtech\credentials.cfg for Windows.

protectedstring

protected inline virtual voidCommonConstructor()

class Lucidtech::Las::Core::FeedbackResponse

The structured format of the response from a send feedback request.

Summary

Members

Descriptions

{property} stringDocumentId

Document id

{property} stringConsentId

Consent id

{property} stringContentType

Content type

{property} List< Dictionary< string, string > >Feedback

The same information as was uploaded as feedback.

public inlineFeedbackResponse(object response)

public inline stringToJsonString(Formatting format)

Convert an object of this class to a string ready to be interpreted as a json object.

Members

{property} stringDocumentId

Document id

{property} stringConsentId

Consent id

{property} stringContentType

Content type

{property} List< Dictionary< string, string > >Feedback

The same information as was uploaded as feedback.

public inlineFeedbackResponse(object response)

public inline stringToJsonString(Formatting format)

Convert an object of this class to a string ready to be interpreted as a json object.

Parameters

  • format The format of the string, either Formatting.None or Formatting.Indented

Returns

A string that is formatted as a json object

class Lucidtech::Las::Core::InvalidCredentialsException

class Lucidtech::Las::Core::InvalidCredentialsException
: public Lucidtech.Las.Core.ClientException

An InvalidCredentialsException is raised if api key, access key id or secret access key is invalid.

Summary

Members

Descriptions

public inlineInvalidCredentialsException(string s)

Members

public inlineInvalidCredentialsException(string s)

class Lucidtech::Las::Core::LimitExceededException

class Lucidtech::Las::Core::LimitExceededException
: public Lucidtech.Las.Core.ClientException

A LimitExceededException is raised if you have reached the limit of total requests per month associated with your credentials.

Summary

Members

Descriptions

public inlineLimitExceededException(string s)

Members

public inlineLimitExceededException(string s)

class Lucidtech::Las::Core::Prediction

A class that contains all the necessary information regarding a prediction performed by ApiClient.

Summary

Members

Descriptions

{property} stringConsentId

Consent id

{property} stringModelName

Upload url

{property} stringDocumentId

Document id

{property} List< Dictionary< string, object > >Fields

A list of the responses from a prediction

public inlinePrediction(string documentId,string consentId,string modelName,List< Dictionary< string, object >> predictionResponse)

Constructor of s Prediction object

public inline stringToJsonString(Formatting format)

Convert an object of this class to a string ready to be interpreted as a json object.

Members

{property} stringConsentId

Consent id

{property} stringModelName

Upload url

{property} stringDocumentId

Document id

{property} List< Dictionary< string, object > >Fields

A list of the responses from a prediction

public inlinePrediction(string documentId,string consentId,string modelName,List< Dictionary< string, object >> predictionResponse)

Constructor of s Prediction object

Parameters

  • documentId The id of the document used in the prediction

  • consentId The consent id

  • modelName The name of the model used

  • predictionResponse The response from prediction

public inline stringToJsonString(Formatting format)

Convert an object of this class to a string ready to be interpreted as a json object.

Parameters

  • format The format of the string, either Formatting.None or Formatting.Indented

Returns

A string that is formatted as a json object

class Lucidtech::Las::Core::RequestException

class Lucidtech::Las::Core::RequestException
: public Lucidtech.Las.Core.ClientException

A RequestException is raised if something went wrong with the request.

Summary

Members

Descriptions

{property} IRestResponseResponse

public inlineRequestException(string s)

public inlineRequestException(IRestResponse response)

Members

{property} IRestResponseResponse

public inlineRequestException(string s)

public inlineRequestException(IRestResponse response)

class Lucidtech::Las::Core::RevokeResponse

The structured format of the response from a revoke consent request.

Summary

Members

Descriptions

{property} stringConsentId

The consent Id where documents where deleted.

{property} List< string >DocumentIds

The document Ids of the deleted documents.

public inlineRevokeResponse(object deleteConsentResponse)

public inline stringToJsonString(Formatting format)

Convert an object of this class to a string ready to be interpreted as a json object.

Members

{property} stringConsentId

The consent Id where documents where deleted.

{property} List< string >DocumentIds

The document Ids of the deleted documents.

public inlineRevokeResponse(object deleteConsentResponse)

public inline stringToJsonString(Formatting format)

Convert an object of this class to a string ready to be interpreted as a json object.

Parameters

  • format The format of the string, either Formatting.None or Formatting.Indented

Returns

A string that is formatted as a json object

class Lucidtech::Las::Core::TooManyRequestsException

class Lucidtech::Las::Core::TooManyRequestsException
: public Lucidtech.Las.Core.ClientException

A TooManyRequestsException is raised if you have reached the number of requests per second limit associated with your credentials.

Summary

Members

Descriptions

public inlineTooManyRequestsException(string s)

Members

public inlineTooManyRequestsException(string s)

namespace Lucidtech::Las::Utils

Summary

Members

Descriptions

classLucidtech::Las::Utils::FileType

Help determine the type of a file, inspired by pythons imghdr.what().

classLucidtech::Las::Utils::JsonSerialPublisher

A Json publishes that allows the user to serialize and deserialize back and forth between serialized json objects and deserialized general objects and specific Dictionaries.

class Lucidtech::Las::Utils::FileType

Help determine the type of a file, inspired by pythons imghdr.what().

Summary

Members

Descriptions

Members

class Lucidtech::Las::Utils::JsonSerialPublisher

class Lucidtech::Las::Utils::JsonSerialPublisher
: public ISerializer
: public IDeserializer

A Json publishes that allows the user to serialize and deserialize back and forth between serialized json objects and deserialized general objects and specific Dictionaries.

Summary

Members

Descriptions

{property} stringContentType

public inlineJsonSerialPublisher(Newtonsoft.Json.JsonSerializer serializer)

public inline stringSerialize(object obj)

Serialize a general object.

public inline TDeserialize< T >(IRestResponse response)

Deserialize the content of an IRestResponse.

Members

{property} stringContentType

public inlineJsonSerialPublisher(Newtonsoft.Json.JsonSerializer serializer)

public inline stringSerialize(object obj)

Serialize a general object.

Parameters

  • obj A general object to be serialized

Returns

A string ready to be interpreted as a json file

public inline TDeserialize< T >(IRestResponse response)

Deserialize the content of an IRestResponse.

Parameters

  • response The response from a request performed by RestSharp.RestClient

Parameters

  • T The type of the output, e.g. Dictionary or a List of some sort

Returns

A deserialized object of type T

Generated by Moxygen