@lucidtech/las-sdk-core / Exports
$ yarn add @lucidtech/las-sdk-browser
$ npm install @lucidtech/las-sdk-browser
$ yarn add @lucidtech/las-sdk-node
$ npm install @lucidtech/las-sdk-node
import { Client } from '@lucidtech/las-sdk-core';
import { ClientCredentials } from '@lucidtech/las-sdk-node';
const credentials = new ClientCredentials('<apiEndpoint>', '<apiKey>', '<clientId>', '<clientSecret>', '<authEndpoint>');
const client = new Client(credentials);
const content = '<read image content>'
client.createDocument(content, 'image/jpeg').then(documentResponse => {
console.log(documentResponse);
}).catch(error => {
console.log(error);
})Install dependencies
$ npm install && npm run upgrade-lucidtech
Build
$ npm run build
Run tests
$ npm run test test
@lucidtech/las-sdk-core / Exports / client / Client
client.Client
A high-level http client for communicating with the Lucidtech REST API
- createAsset
- createBatch
- createDocument
- createPrediction
- createSecret
- createTransition
- createUser
- createWorkflow
- deleteDocuments
- deleteTransition
- deleteUser
- deleteWorkflow
- deleteWorkflowExecution
- executeTransition
- executeWorkflow
- getAsset
- getDocument
- getLog
- getTransition
- getUser
- getWorkflow
- listAssets
- listDocuments
- listModels
- listPredictions
- listSecrets
- listTransitionExecutions
- listTransitions
- listUsers
- listWorkflowExecutions
- listWorkflows
- makeDeleteRequest
- makeGetRequest
- makePatchRequest
- makePostRequest
- updateAsset
- updateDocument
- updateSecret
- updateTransition
- updateTransitionExecution
- updateUser
- updateWorkflow
+ new Client(credentials: Credentials): Client
credentials Credentials
Returns: Client
• credentials: Credentials
▸ createAsset(content: string): Promise<Asset>
Creates an asset handle, calls the POST /assets endpoint.
content string Content to POST (base64-encoded string | Buffer)
Returns: Promise<Asset>
Asset response from REST API
▸ createBatch(options: CreateBatchOptions): Promise<Batch>
Creates a batch, calls the POST /batches endpoint.
options CreateBatchOptions
Returns: Promise<Batch>
Batch response from REST API
▸ createDocument(content: string | Buffer, contentType: ContentType, options?: CreateDocumentOptions): Promise<LasDocument>
Creates a document handle, calls the POST /documents endpoint.
content string | Buffer Content to POST (base64 string | Buffer)
contentType ContentType MIME type for the document handle
options? CreateDocumentOptions -
Returns: Promise<LasDocument>
Document response from REST API
▸ createPrediction(documentId: string, modelId: string, options?: CreatePredictionsOptions): Promise<PredictionResponse>
Create a prediction on a document using specified model, calls the POST /predictions endpoint.
documentId string Id of the document to run inference and create a prediction on
modelId string Id of the model to use for inference
options? CreatePredictionsOptions -
Returns: Promise<PredictionResponse>
Predicion response from REST API
▸ createSecret(data: Record<any, any>, options?: CreateSecretOptions): Promise<Secret>
Creates an secret handle, calls the POST /secrets endpoint.
data Record<any, any> Object containing the data you want to keep secret
options? CreateSecretOptions -
Returns: Promise<Secret>
Secret response from REST API
▸ createTransition(transitionType: TransitionType, options?: CreateTransitionOptions): Promise<Transition>
Creates a transition handle, calls the POST /transitions endpoint.
transitionType TransitionType Type of transition "docker"|"manual"
options? CreateTransitionOptions -
Returns: Promise<Transition>
Transition response from REST API
▸ createUser(email: string, data?: CreateUserOptions): Promise<User>
Creates a new user, calls the POST /users endpoint.
email string Email to the new user
data? CreateUserOptions -
Returns: Promise<User>
User response from REST API
▸ createWorkflow(name: string, specification: WorkflowSpecification, options?: CreateWorkflowOptions): Promise<Workflow>
Creates a new workflow, calls the POST /workflows endpoint.
name string Name of the workflow
specification WorkflowSpecification Specification of the workflow
options? CreateWorkflowOptions -
Returns: Promise<Workflow>
Workflow response from REST API
▸ deleteDocuments(options?: DeleteDocumentOptions): Promise<LasDocumentList>
Delete documents with the provided consentId, calls the DELETE /documents endpoint. Will delete all documents when no consentId is provided.
options? DeleteDocumentOptions
Returns: Promise<LasDocumentList>
Documents response from REST API
▸ deleteTransition(transitionId: string): Promise<Transition>
Delete the transition with the provided transitionId, calls the DELETE /transitions/{transitionId} endpoint. Will fail if transition is in use by one or more workflows.
transitionId string Id of the transition
Returns: Promise<Transition>
Transition response from REST API
▸ deleteUser(userId: string): Promise<User>
Delete the user with the provided user_id, calls the DELETE /users/{userId} endpoint.
userId string Id of the user
Returns: Promise<User>
User response from REST API
▸ deleteWorkflow(workflowId: string): Promise<Workflow>
Delete the workflow with the provided workflowId, calls the DELETE /workflows/{workflowId} endpoint.
workflowId string Id of the workflow
Returns: Promise<Workflow>
Workflow response from REST API
▸ deleteWorkflowExecution(workflowId: string, executionId: string): Promise<WorkflowExecution>
Deletes the execution with the provided execution_id from workflow_id, calls the DELETE /workflows/{workflowId}/executions/{executionId} endpoint.
workflowId string Id of the workflow
executionId string Id of the execution
Returns: Promise<WorkflowExecution>
WorkflowExecution response from REST API
▸ executeTransition(transitionId: string): Promise<TransitionExecution>
Start executing a manual transition, calls the POST /transitions/{transitionId}/executions endpoint.
transitionId string Id of the transition
Returns: Promise<TransitionExecution>
Transition execution response from REST API
▸ executeWorkflow(workflowId: string, input: object): Promise<WorkflowExecution>
Start a workflow execution, calls the POST /workflows/{workflowId}/executions endpoint.
workflowId string Id of the workflow
input object Input to the first step of the workflow
Returns: Promise<WorkflowExecution>
Workflow execution response from REST API
▸ getAsset(assetId: string): Promise<Asset>
Get asset from the REST API, calls the GET /assets/{assetId} endpoint.
assetId string Id of the asset
Returns: Promise<Asset>
Asset response from REST API
▸ getDocument(documentId: string): Promise<LasDocument>
Get document from the REST API, calls the GET /documents/{documentId} endpoint.
documentId string Id of the document
Returns: Promise<LasDocument>
Document response from REST API
▸ getLog(logId: string): Promise<Log>
Get log, calls the GET /logs/{logId} endpoint.
logId string Id of the log
Returns: Promise<Log>
Log response from REST API
▸ getTransition(transitionId: string): Promise<Transition>
Get the transition with the provided transitionId, calls the GET /transitions/{transitionId} endpoint.
transitionId string Id of the transition
Returns: Promise<Transition>
Transition response from REST API
▸ getUser(userId: string): Promise<User>
Get information about a specific user, calls the GET /users/{user_id} endpoint.
userId string Id of the user
Returns: Promise<User>
User response from REST API
▸ getWorkflow(workflowId: string): Promise<Workflow>
Get the workflow with the provided workflowId, calls the GET /workflows/{workflowId} endpoint.
workflowId string Id of the workflow
Returns: Promise<Workflow>
Workflow response from REST API
▸ listAssets(options?: PaginationOptions): Promise<AssetList>
List assets available, calls the GET /assets endpoint.
options? PaginationOptions
Returns: Promise<AssetList>
Assets response from REST API without the content of each asset
▸ listDocuments(options?: ListDocumentsOptions): Promise<LasDocumentList>
List documents available for inference, calls the GET /documents endpoint.
options? ListDocumentsOptions
Returns: Promise<LasDocumentList>
Documents response from REST API
▸ listModels(options?: PaginationOptions): Promise<ModelList>
List models available, calls the GET /models endpoint.
options? PaginationOptions
Returns: Promise<ModelList>
Models response from the REST API
▸ listPredictions(options?: PaginationOptions): Promise<PredictionList>
options? PaginationOptions
Returns: Promise<PredictionList>
▸ listSecrets(options?: PaginationOptions): Promise<SecretList>
List secrets available, calls the GET /secrets endpoint.
options? PaginationOptions
Returns: Promise<SecretList>
Secrets response from REST API without the username of each secret
▸ listTransitionExecutions(transitionId: string, options?: TransitionExecutionListOptions): Promise<TransitionExecutionList>
List executions in a transition, calls the GET /transitions/{transitionId}/executions endpoint.
transitionId string Id of the transition
options? TransitionExecutionListOptions -
Returns: Promise<TransitionExecutionList>
Transition executions responses from REST API
▸ listTransitions(options?: ListTransitionOptions): Promise<TransitionList>
List transitions, calls the GET /transitions endpoint.
options? ListTransitionOptions
Returns: Promise<TransitionList>
Transitions response from REST API
▸ listUsers(options?: PaginationOptions): Promise<UserList>
List users, calls the GET /users endpoint.
options? PaginationOptions
Returns: Promise<UserList>
User response from REST API
▸ listWorkflowExecutions(workflowId: string, options?: ListWorkflowExecutionsOptions): Promise<WorkflowExecutionList>
List executions in a workflow, calls the GET /workflows/{workflowId}/executions endpoint.
workflowId string Id of the workflow
options? ListWorkflowExecutionsOptions -
Returns: Promise<WorkflowExecutionList>
Workflow executions responses from REST API
▸ listWorkflows(options?: PaginationOptions): Promise<WorkflowList>
List workflows, calls the GET /workflows endpoint.
options? PaginationOptions
Returns: Promise<WorkflowList>
Workflows response from REST API
▸ makeDeleteRequest<T>(path: string, query?: any): Promise<T>
T
path string
query? any
Returns: Promise<T>
▸ makeGetRequest<T>(path: string, query?: any): Promise<T>
T
path string
query? any
Returns: Promise<T>
▸ makePatchRequest<T>(path: string, body: any): Promise<T>
T
path string
body any
Returns: Promise<T>
▸ makePostRequest<T>(path: string, body: any): Promise<T>
T
path string
body any
Returns: Promise<T>
▸ updateAsset(assetId: string, data: UpdateAssetOptions): Promise<Asset>
Updates an asset, calls the PATCH /assets/assetId endpoint.
assetId string Id of the asset
data UpdateAssetOptions -
Returns: Promise<Asset>
Asset response from REST API with content
▸ updateDocument(documentId: string, data: UpdateDocumentOptions): Promise<LasDocument>
Post ground truth to the REST API, calls the PATCH /documents/{documentId} endpoint. Posting ground truth means posting the ground truth data for the particular document. This enables the API to learn from past mistakes.
documentId string Id of the document
data UpdateDocumentOptions -
Returns: Promise<LasDocument>
Document response from REST API
▸ updateSecret(secretId: string, data: UpdateSecretOptions): Promise<Secret>
Updates a secret, calls the PATCH /secrets/secretId endpoint.
secretId string Id of the secret
data UpdateSecretOptions -
Returns: Promise<Secret>
▸ updateTransition(transitionId: string, data: UpdateTransitionOptions): Promise<Transition>
Updates a transition, calls the PATCH /transitions/transitionId endpoint.
transitionId string Id of the transition
data UpdateTransitionOptions Transition fields to PATCH
Returns: Promise<Transition>
Transition response from REST API
▸ updateTransitionExecution(transitionId: string, executionId: string, data: UpdateTransitionExecution): Promise<TransitionExecution>
Ends the processing of the transition execution, calls the PATCH /transitions/{transition_id}/executions/{execution_id} endpoint.
transitionId string Id of the transition that performs the execution
executionId string Id of the execution to update
data UpdateTransitionExecution -
Returns: Promise<TransitionExecution>
Transition execution response from REST API
▸ updateUser(userId: string, data: UpdateUserOptions): Promise<User>
Updates a user, calls the PATCH /users/{userId} endpoint.
userId string Id of the user
data UpdateUserOptions -
Returns: Promise<User>
User response from REST API
▸ updateWorkflow(workflowId: string, data: UpdateWorkflowOptions): Promise<Workflow>
Updates a workflow, calls the PATCH /workflows/workflowId endpoint.
workflowId string Id of the workflow
data UpdateWorkflowOptions Workflow fields to PATCH
Returns: Promise<Workflow>
Workflow response from REST API
@lucidtech/las-sdk-core / Exports / credentials / Credentials
credentials.Credentials
Use to fetch and store credentials and to generate/cache an access token
• Readonly apiEndpoint: string
• Readonly apiKey: string
▸ getAccessToken(): Promise<string>
Method used to get and cache an access token. Algorithm used:
- Look for a valid token in memory.
- Look for a valid token in the storage (if provided);
- Fetch a new token from server and cache it (both in memory and in storage).
Returns: Promise<string>
@lucidtech/las-sdk-core / Exports / credentials / Token
credentials.Token
Wrapper class for an AWS Cognito token
+ new Token(accessToken: string, expiration: number, refreshToken?: string): Token
accessToken string
expiration number
refreshToken? string
Returns: Token
• Readonly accessToken: string
• Readonly expiration: number
• Optional Readonly refreshToken: undefined | string
▸ isValid(): boolean
Checks if current timestamp is larger than token expiration time
Returns: boolean
@lucidtech/las-sdk-core / Exports / index / CreateDocumentOptions
index.CreateDocumentOptions
• Optional batchId: undefined | string
• Optional consentId: undefined | string
• Optional groundTruth: undefined | GroundTruth[]
@lucidtech/las-sdk-core / Exports / index / CreatePredictionsOptions
index.CreatePredictionsOptions
• Optional autoRotate: undefined | boolean
• Optional maxPages: undefined | number
@lucidtech/las-sdk-core / Exports / index / CreateSecretOptions
index.CreateSecretOptions
• Optional description: undefined | string
@lucidtech/las-sdk-core / Exports / index / CreateTransitionOptions
index.CreateTransitionOptions
• Optional description: undefined | null | string
• Optional inputJsonSchema: undefined | Record<any, any>
• Optional name: undefined | null | string
• Optional outputJsonSchema: undefined | Record<any, any>
• Optional parameters: undefined | CreateTransitionDockerParams | CreateTransitionManualParams
@lucidtech/las-sdk-core / Exports / index / DeleteDocumentOptions
index.DeleteDocumentOptions
• Optional consentId: undefined | string | string[]
@lucidtech/las-sdk-core / Exports / index / PaginationOptions
index.PaginationOptions
• Optional maxResults: undefined | number
• Optional nextToken: undefined | string
@lucidtech/las-sdk-core / Exports / index / UpdateAssetOptions
index.UpdateAssetOptions
• Optional content: undefined | string | Buffer
@lucidtech/las-sdk-core / Exports / index / UpdateDocumentOptions
index.UpdateDocumentOptions
• Optional groundTruth: undefined | GroundTruth[]
@lucidtech/las-sdk-core / Exports / index / UpdateSecretOptions
index.UpdateSecretOptions
• Optional data: undefined | Record<any, any>
• Optional description: undefined | null | string
• Optional name: undefined | null | string
@lucidtech/las-sdk-core / Exports / index / UpdateTransitionExecution
index.UpdateTransitionExecution
• Optional error: undefined | { message: string }
• Optional output: undefined | Record<any, any>
• status: succeeded | failed | retry | rejected
@lucidtech/las-sdk-core / Exports / index / UpdateWorkflowOptions
index.UpdateWorkflowOptions
• Optional description: undefined | string
• Optional name: undefined | string
@lucidtech/las-sdk-core / Exports / storage / TokenStorage
storage.TokenStorage
T Token
• getPersistentToken: () => null | T
▸ (): null | T
Returns: null | T
• setPersistentToken: (value: T) => void
▸ (value: T): void
value T
Returns: void
@lucidtech/las-sdk-core / Exports / types / CreateDocumentOptions
types.CreateDocumentOptions
• Optional batchId: undefined | string
• Optional consentId: undefined | string
• Optional groundTruth: undefined | GroundTruth[]
@lucidtech/las-sdk-core / Exports / types / CreatePredictionsOptions
types.CreatePredictionsOptions
• Optional autoRotate: undefined | boolean
• Optional maxPages: undefined | number
@lucidtech/las-sdk-core / Exports / types / CreateSecretOptions
types.CreateSecretOptions
• Optional description: undefined | string
@lucidtech/las-sdk-core / Exports / types / CreateTransitionOptions
types.CreateTransitionOptions
• Optional description: undefined | null | string
• Optional inputJsonSchema: undefined | Record<any, any>
• Optional name: undefined | null | string
• Optional outputJsonSchema: undefined | Record<any, any>
• Optional parameters: undefined | CreateTransitionDockerParams | CreateTransitionManualParams
@lucidtech/las-sdk-core / Exports / types / DeleteDocumentOptions
types.DeleteDocumentOptions
• Optional consentId: undefined | string | string[]
@lucidtech/las-sdk-core / Exports / types / PaginationOptions
types.PaginationOptions
• Optional maxResults: undefined | number
• Optional nextToken: undefined | string
@lucidtech/las-sdk-core / Exports / types / UpdateAssetOptions
types.UpdateAssetOptions
• Optional content: undefined | string | Buffer
@lucidtech/las-sdk-core / Exports / types / UpdateDocumentOptions
types.UpdateDocumentOptions
• Optional groundTruth: undefined | GroundTruth[]
@lucidtech/las-sdk-core / Exports / types / UpdateSecretOptions
types.UpdateSecretOptions
• Optional data: undefined | Record<any, any>
• Optional description: undefined | null | string
• Optional name: undefined | null | string
@lucidtech/las-sdk-core / Exports / types / UpdateTransitionExecution
types.UpdateTransitionExecution
• Optional error: undefined | { message: string }
• Optional output: undefined | Record<any, any>
• status: succeeded | failed | retry | rejected
@lucidtech/las-sdk-core / Exports / types / UpdateWorkflowOptions
types.UpdateWorkflowOptions
• Optional description: undefined | string
• Optional name: undefined | string
@lucidtech/las-sdk-core / Exports
@lucidtech/las-sdk-core / Exports / client
Renames and exports: Client
@lucidtech/las-sdk-core / Exports / credentials
@lucidtech/las-sdk-core / Exports / index
- CreateDocumentOptions
- CreatePredictionsOptions
- CreateSecretOptions
- CreateTransitionOptions
- DeleteDocumentOptions
- PaginationOptions
- UpdateAssetOptions
- UpdateDocumentOptions
- UpdateSecretOptions
- UpdateTransitionExecution
- UpdateWorkflowOptions
- Asset
- AssetList
- AssetWithoutContent
- AuthorizationHeaders
- AxiosFn
- Batch
- ContentType
- CreateBatchOptions
- CreateTransitionDockerParams
- CreateTransitionManualParams
- CreateTransitionParams
- CreateUserOptions
- CreateWorkflowOptions
- GroundTruth
- LasDocument
- LasDocumentList
- ListAssetsOptions
- ListDocumentsOptions
- ListModelsOptions
- ListPredictionsOptions
- ListSecretsOptions
- ListTransitionOptions
- ListUsersOptions
- ListWorkflowExecutionsOptions
- ListWorkflowOptions
- Log
- Model
- ModelList
- PostPredictions
- Prediction
- PredictionList
- PredictionResponse
- Secret
- SecretList
- Transition
- TransitionExecution
- TransitionExecutionList
- TransitionExecutionListOptions
- TransitionList
- TransitionType
- UpdateTransitionOptions
- UpdateUserOptions
- User
- UserList
- Workflow
- WorkflowExecution
- WorkflowExecutionList
- WorkflowList
- WorkflowSpecification
Re-exports: Client
Re-exports: Credentials
Re-exports: Token
Re-exports: TokenStorage
Ƭ Asset: object
assetId string
content string
Ƭ AssetList: object
assets AssetWithoutContent[]
nextToken string | null
Ƭ AssetWithoutContent: object
assetId string
Ƭ AuthorizationHeaders: object
Authorization string
X-Api-Key string
Ƭ AxiosFn: <T, R>(url: string, body?: any, config?: AxiosRequestConfig) => Promise<R>
▸ <T, R>(url: string, body?: any, config?: AxiosRequestConfig): Promise<R>
T any
R AxiosResponse<T>
url string
body? any
config? AxiosRequestConfig
Returns: Promise<R>
Ƭ Batch: object
batchId string
description string
name string
Ƭ ContentType: application/pdf | image/jpeg
Ƭ CreateBatchOptions: object
description? string
name? string
Ƭ CreateTransitionDockerParams: object
cpu? 256
credentials? object
credentials.password string
credentials.username string
environment? object
imageUrl string
memory? 512 | 1024 | 2048
Ƭ CreateTransitionManualParams: object
assets? { jsRemoteComponent?: string } & Record<string, string>
Ƭ CreateTransitionParams: CreateTransitionDockerParams | CreateTransitionManualParams
Ƭ CreateUserOptions: object
avatar? string | null
name? string | null
Ƭ CreateWorkflowOptions: object
description? string
errorConfig? object
errorConfig.email string
Ƭ GroundTruth: object
label string maxLength: 36, minLength: 1, pattern: ^[0-9A-Za-z_]+$
value string | boolean | null maxLength: 64, minLength: 1
Ƭ LasDocument: object
batchId? string pattern: ^las:batch:[a-f0-9]{32}$
consentId? string pattern: ^las:consent:[a-f0-9]{32}$
content? string minimum: 1
contentType ContentType -
documentId string pattern: ^las:document:[a-f0-9]{32}$
groundTruth? GroundTruth[] -
inferenceTime? number minimum: 0
predictions? Prediction[] -
updated? number minimum: 1
Ƭ LasDocumentList: object
batchId? string
consentId? string
documents LasDocument[]
nextToken? string
Ƭ ListAssetsOptions: PaginationOptions
Ƭ ListDocumentsOptions: PaginationOptions & { batchId?: string | string[] ; consentId?: string | string[] }
Ƭ ListModelsOptions: PaginationOptions
Ƭ ListPredictionsOptions: PaginationOptions
Ƭ ListSecretsOptions: PaginationOptions
Ƭ ListTransitionOptions: PaginationOptions & { transitionType?: string | string[] }
Ƭ ListUsersOptions: PaginationOptions
Ƭ ListWorkflowExecutionsOptions: PaginationOptions & { order?: ascending | descending ; sortBy?: startTime | endTime ; status?: string | string[] }
Ƭ ListWorkflowOptions: PaginationOptions
Ƭ Log: object
events Record<any, any>[]
logId string
transitionId? string | null
Ƭ Model: object
description string | null
height number
modelId string
name string | null
width number
Ƭ ModelList: object
models Model[]
nextToken string | null
Ƭ PostPredictions: CreatePredictionsOptions & { documentId: string ; modelId: string }
Ƭ Prediction: GroundTruth & { confidence: number }
Ƭ PredictionList: object
nextToken string | null
predictions PredictionResponse[]
Ƭ PredictionResponse: object
documentId string
inferenceTime number
modelId string
predictionId string
predictions Prediction[]
timestamp number
Ƭ Secret: object
description string | null
name string | null
secredId string
Ƭ SecretList: object
nextToken? string | null
secrets Secret[]
Ƭ Transition: object
assets? Record<string, string>
description string
inputJsonSchema unknown
name string
outputJsonSchema? unknown
transitionId string
transitionType TransitionType
Ƭ TransitionExecution: object
completedBy string | null
endTime string | null
executionId string
input Record<any, any>
startTime string | null
status succeeded | failed | retry | running | rejected
transitionId string
Ƭ TransitionExecutionList: object
executions TransitionExecution[]
nextToken string | null
transitionId string
Ƭ TransitionExecutionListOptions: PaginationOptions & { executionId?: string | string[] ; order?: ascending | descending ; sortBy?: startTime | endTime ; status?: succeeded | failed | retry | running | rejected }
Ƭ TransitionList: object
nextToken? string
transitions Transition[]
Ƭ TransitionType: docker | manual
Ƭ UpdateTransitionOptions: object
description? string
inputJsonSchema? Record<any, any>
name? string
outputJsonSchema? Record<any, any>
Ƭ UpdateUserOptions: object
avatar? string | null
name? string | null
Ƭ User: object
avatar string | null
email string
name string | null
userId string
Ƭ UserList: object
nextToken? string
users User[]
Ƭ Workflow: object
description? string
name string
workflowId string
Ƭ WorkflowExecution: object
completedBy string[]
endTime string | null
executionId string
input Record<any, any>
output Record<any, any>
startTime string | null
status? succeeded | failed | running | rejected
transitionExecutions Record<string, string[]> | null
workflowId string
Ƭ WorkflowExecutionList: object
executions Required<WorkflowExecution>[]
nextToken? string
status? succeeded | failed | running | rejected
workflowId string
Ƭ WorkflowList: object
workflows Workflow[]
Ƭ WorkflowSpecification: object
definition object
language? ASL
version? 1.0.0
@lucidtech/las-sdk-core / Exports / storage
@lucidtech/las-sdk-core / Exports / types
- CreateDocumentOptions
- CreatePredictionsOptions
- CreateSecretOptions
- CreateTransitionOptions
- DeleteDocumentOptions
- PaginationOptions
- UpdateAssetOptions
- UpdateDocumentOptions
- UpdateSecretOptions
- UpdateTransitionExecution
- UpdateWorkflowOptions
- Asset
- AssetList
- AssetWithoutContent
- AuthorizationHeaders
- AxiosFn
- Batch
- ContentType
- CreateBatchOptions
- CreateTransitionDockerParams
- CreateTransitionManualParams
- CreateTransitionParams
- CreateUserOptions
- CreateWorkflowOptions
- GroundTruth
- LasDocument
- LasDocumentList
- ListAssetsOptions
- ListDocumentsOptions
- ListModelsOptions
- ListPredictionsOptions
- ListSecretsOptions
- ListTransitionOptions
- ListUsersOptions
- ListWorkflowExecutionsOptions
- ListWorkflowOptions
- Log
- Model
- ModelList
- PostPredictions
- Prediction
- PredictionList
- PredictionResponse
- Secret
- SecretList
- Transition
- TransitionExecution
- TransitionExecutionList
- TransitionExecutionListOptions
- TransitionList
- TransitionType
- UpdateTransitionOptions
- UpdateUserOptions
- User
- UserList
- Workflow
- WorkflowExecution
- WorkflowExecutionList
- WorkflowList
- WorkflowSpecification
Ƭ Asset: object
assetId string
content string
Ƭ AssetList: object
assets AssetWithoutContent[]
nextToken string | null
Ƭ AssetWithoutContent: object
assetId string
Ƭ AuthorizationHeaders: object
Authorization string
X-Api-Key string
Ƭ AxiosFn: <T, R>(url: string, body?: any, config?: AxiosRequestConfig) => Promise<R>
▸ <T, R>(url: string, body?: any, config?: AxiosRequestConfig): Promise<R>
T any
R AxiosResponse<T>
url string
body? any
config? AxiosRequestConfig
Returns: Promise<R>
Ƭ Batch: object
batchId string
description string
name string
Ƭ ContentType: application/pdf | image/jpeg
Ƭ CreateBatchOptions: object
description? string
name? string
Ƭ CreateTransitionDockerParams: object
cpu? 256
credentials? object
credentials.password string
credentials.username string
environment? object
imageUrl string
memory? 512 | 1024 | 2048
Ƭ CreateTransitionManualParams: object
assets? { jsRemoteComponent?: string } & Record<string, string>
Ƭ CreateTransitionParams: CreateTransitionDockerParams | CreateTransitionManualParams
Ƭ CreateUserOptions: object
avatar? string | null
name? string | null
Ƭ CreateWorkflowOptions: object
description? string
errorConfig? object
errorConfig.email string
Ƭ GroundTruth: object
label string maxLength: 36, minLength: 1, pattern: ^[0-9A-Za-z_]+$
value string | boolean | null maxLength: 64, minLength: 1
Ƭ LasDocument: object
batchId? string pattern: ^las:batch:[a-f0-9]{32}$
consentId? string pattern: ^las:consent:[a-f0-9]{32}$
content? string minimum: 1
contentType ContentType -
documentId string pattern: ^las:document:[a-f0-9]{32}$
groundTruth? GroundTruth[] -
inferenceTime? number minimum: 0
predictions? Prediction[] -
updated? number minimum: 1
Ƭ LasDocumentList: object
batchId? string
consentId? string
documents LasDocument[]
nextToken? string
Ƭ ListAssetsOptions: PaginationOptions
Ƭ ListDocumentsOptions: PaginationOptions & { batchId?: string | string[] ; consentId?: string | string[] }
Ƭ ListModelsOptions: PaginationOptions
Ƭ ListPredictionsOptions: PaginationOptions
Ƭ ListSecretsOptions: PaginationOptions
Ƭ ListTransitionOptions: PaginationOptions & { transitionType?: string | string[] }
Ƭ ListUsersOptions: PaginationOptions
Ƭ ListWorkflowExecutionsOptions: PaginationOptions & { order?: ascending | descending ; sortBy?: startTime | endTime ; status?: string | string[] }
Ƭ ListWorkflowOptions: PaginationOptions
Ƭ Log: object
events Record<any, any>[]
logId string
transitionId? string | null
Ƭ Model: object
description string | null
height number
modelId string
name string | null
width number
Ƭ ModelList: object
models Model[]
nextToken string | null
Ƭ PostPredictions: CreatePredictionsOptions & { documentId: string ; modelId: string }
Ƭ Prediction: GroundTruth & { confidence: number }
Ƭ PredictionList: object
nextToken string | null
predictions PredictionResponse[]
Ƭ PredictionResponse: object
documentId string
inferenceTime number
modelId string
predictionId string
predictions Prediction[]
timestamp number
Ƭ Secret: object
description string | null
name string | null
secredId string
Ƭ SecretList: object
nextToken? string | null
secrets Secret[]
Ƭ Transition: objects
assets? Record<string, string>
description string
inputJsonSchema unknown
name string
outputJsonSchema? unknown
transitionId string
transitionType TransitionType
Ƭ TransitionExecution: object
completedBy string | null
endTime string | null
executionId string
input Record<any, any>
startTime string | null
status succeeded | failed | retry | running | rejected
transitionId string
Ƭ TransitionExecutionList: object
executions TransitionExecution[]
nextToken string | null
transitionId string
Ƭ TransitionExecutionListOptions: PaginationOptions & { executionId?: string | string[] ; order?: ascending | descending ; sortBy?: startTime | endTime ; status?: succeeded | failed | retry | running | rejected }
Ƭ TransitionList: object
nextToken? string
transitions Transition[]
Ƭ TransitionType: docker | manual
Ƭ UpdateTransitionOptions: object
description? string
inputJsonSchema? Record<any, any>
name? string
outputJsonSchema? Record<any, any>
Ƭ UpdateUserOptions: object
avatar? string | null
name? string | null
Ƭ User: object
avatar string | null
email string
name string | null
userId string
Ƭ UserList: object
nextToken? string
users User[]
Ƭ Workflow: object
description? string
name string
workflowId string
Ƭ WorkflowExecution: object
completedBy string[]
endTime string | null
executionId string
input Record<any, any>
output Record<any, any>
startTime string | null
status? succeeded | failed | running | rejected
transitionExecutions Record<string, string[]> | null
workflowId string
Ƭ WorkflowExecutionList: object
executions Required<WorkflowExecution>[]
nextToken? string
status? succeeded | failed | running | rejected
workflowId string
Ƭ WorkflowList: object
workflows Workflow[]
Ƭ WorkflowSpecification: object
definition object
language? ASL
version? 1.0.0