IAiExternalProcessMessenger

A messenger to provide APIs to communicate with external AI inference engine (software).

api-version: 2
user

Hierarchy

IAiProcessMessenger
- IAiExternalProcessMessenger

Properties

Readonly trainedModelsRegisteredInServer

trainedModelsRegisteredInServer: Monitorable<AiProcessModelInfo[]>

Monitorable A list of trained models which are registered in AI server. If the login is successful, it will be initialized to the data accessible to the logged-in account.

api-version: 2
user

Methods

addEventListener

addEventListener(eventName: string, listener: AiProcessEventListener, once?: boolean): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24514
Register an event listener for the {@link eventName}.

api-version
2

user
Parameters
- eventName: string
  
  Event name.
- listener: AiProcessEventListener
  
  A listener to receive callbacks when an event has been sent from AI process.
- Optional once: boolean
  
  If you set true, then the listener will be removed after receive an event. Default is false.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

addFileTransferListener

addFileTransferListener(listener: AiProcessFileTransferListener): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24478
Register a listener to transfer file.

api-version
2

user
Parameters
- listener: AiProcessFileTransferListener
  
  A listener to receive callbacks when an event has been sent from AI process.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

connect

connect(ip: FourNumArray, port: number, listener: Partial<AiProcessConnectionListener>, options?: Partial<AiProcessConnectionOptions>): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24421
Manually connect with server of AI processes.

api-version
2

user
Parameters
- ip: FourNumArray
  
  An IP of server to connect.
- port: number
  
  A port of server to connect.
- listener: Partial<AiProcessConnectionListener>
  
  A listener to receive states of the connection.
- Optional options: Partial<AiProcessConnectionOptions>
  
  (Optional)
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false.

createNewProject

createNewProject(projectName: string, options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: null | AiProcessModelProjectInfo }>

Inherited from IAiProcessMessenger.createNewProject
- Defined in src/api/dart-api.ts:24305
Request AI Server to create a new project.

api-version
2

user
Parameters
- projectName: string
  
  A name of the project to create.
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: null | AiProcessModelProjectInfo }>
Return Fulfills with AiProcessModelProjectInfo if the request has been operated successfully, otherwise false with AiProcessMessengerError.

deleteTrainedModel

deleteTrainedModel(modelId: string, options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: boolean }>

Inherited from IAiProcessMessenger.deleteTrainedModel
- Defined in src/api/dart-api.ts:24340
Request to download and update training model to AI inference module.

api-version
2

user
Parameters
- modelId: string
  
  Target model id.
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

destroy

destroy(): Promise<void>

Inherited from IAiProcessMessenger.destroy
- Defined in src/api/dart-api.ts:24227
Destroy and release the AI process handler. You cannot reuse it after destroying it.

api-version
2

user
Returns Promise<void>
Return Fulfills with void if the request has been done.

disconnect

disconnect(): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24431
Manually disconnect the connection. In that case, it will not try to reconnect.

api-version
2

user
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the handler has been disconnected successfully, otherwise false.

getInstalledTrainedModels

getInstalledTrainedModels(options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: AiProcessModelInfo[] }>

Inherited from IAiProcessMessenger.getInstalledTrainedModels
- Defined in src/api/dart-api.ts:24328
Gets the list of all installed models for the logged in account from internal AI inference module.

api-version
2

user
Parameters
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: AiProcessModelInfo[] }>
Return Fulfills with list of AiProcessModelInfo if the request has been operated successfully, otherwise false with AiProcessMessengerError.

getProjects

getProjects(options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: AiProcessModelProjectInfo[] }>

Inherited from IAiProcessMessenger.getProjects
- Defined in src/api/dart-api.ts:24293
Request a list of projects created on the logged in account to AI server.

api-version
2

user
Parameters
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: AiProcessModelProjectInfo[] }>
Return Fulfills with list of AiProcessModelProjectInfo if the request has been operated successfully, otherwise false with AiProcessMessengerError.

getTrainedModelsFromServer

getTrainedModelsFromServer(projectId: string, options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: AiProcessModelInfo[] }>

Inherited from IAiProcessMessenger.getTrainedModelsFromServer
- Defined in src/api/dart-api.ts:24317
Request a list of model data that exists in the project to AI server.

api-version
2

user
Parameters
- projectId: string
  
  A target project id.
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: AiProcessModelInfo[] }>
Return Fulfills with list of AiProcessModelInfo if the request has been operated successfully, otherwise false with AiProcessMessengerError.

installTrainedModel

installTrainedModel(modelId: string, listener: AiProcessModelInstallListener, options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24467
Request to download and install training model to AI inference module.

api-version
2

user
Parameters
- modelId: string
  
  Target model id.
- listener: AiProcessModelInstallListener
  
  A listener to be registered.
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

isConnected

isConnected(): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24441
Whether the handler has been connected or not.

api-version
2

user
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the handler has been connected, otherwise false.

isLoggedInAs

isLoggedInAs(account: string): Promise<{ error?: AiProcessMessengerError; result: boolean }>

Inherited from IAiProcessMessenger.isLoggedInAs
- Defined in src/api/dart-api.ts:24282
Whether the handler has been logged in as account or not.

api-version
2

user
Parameters
- account: string
  
  An account to check.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the handler has been log in, otherwise false.

loadTrainedModel

loadTrainedModel(modelId: string, options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: boolean }>

Inherited from IAiProcessMessenger.loadTrainedModel
- Defined in src/api/dart-api.ts:24352
Request to load a model to AI inference module.

api-version
2

user
Parameters
- modelId: string
  
  Target model id.
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

login

login(account: string, password: string, options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: boolean }>

Inherited from IAiProcessMessenger.login
- Defined in src/api/dart-api.ts:24260
Request to log in to AI process with a Dart-Store account.

api-version
2

user
Parameters
- account: string
  
  An account to use when logging in.
- password: string
  
  An password to use when logging in.
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

logout

logout(options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: boolean }>

Inherited from IAiProcessMessenger.logout
- Defined in src/api/dart-api.ts:24271
Request to log out.

api-version
2

user
Parameters
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

registerAiProcessListener

registerAiProcessListener(listener: Partial<AiProcessListener>): void

Inherited from IAiProcessMessenger.registerAiProcessListener
- Defined in src/api/dart-api.ts:24237
Register a listener to receive callback when Ai process's state has been changed.

api-version
2

user
Parameters
- listener: Partial<AiProcessListener>
  
  A listener to be registered.
Returns void

removeFileTransferListener

removeFileTransferListener(listener?: AiProcessFileTransferListener): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24489
Unregister a listener or all listeners which are registered by IAiExternalProcessMessenger.addFileTransferListener.

api-version
2

user
Parameters
- Optional listener: AiProcessFileTransferListener
  
  A listener to be unregistered. If it is not set, all listeners will be unregistered.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

removeListener

removeListener(eventName: string, listener?: AiProcessEventListener): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24526
Unregister a listener or all listeners which are registered by IAiExternalProcessMessenger.addEventListener.

api-version
2

user
Parameters
- eventName: string
  
  Event name.
- Optional listener: AiProcessEventListener
  
  A listener to be unregistered. If it is not set, all listeners will be unregistered.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

search

search(aiProcessUdpPort: number): Promise<{ error?: AiProcessMessengerError; result: ExternalAiProcessInfo[] }>

- Defined in src/api/dart-api.ts:24407
Search AI processes which are possible communicated with AI user module. The processes are collected through UDP protocol.

api-version
2

user
Parameters
- aiProcessUdpPort: number
  
  UDP port of AI process to search.
Returns Promise<{ error?: AiProcessMessengerError; result: ExternalAiProcessInfo[] }>
Return Fulfills with ExternalAiProcessInfo which are collected through UDP protocol.

sendEvent

sendEvent(eventName: string, args: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24501
Send an event to the connected AI process.

api-version
2

user
Parameters
- eventName: string
  
  Event name.
- args: Record<string, string | number | boolean>
  
  Arguments consists of key value pair for the event.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

unregisterAiProcessListener

unregisterAiProcessListener(listener?: Partial<AiProcessListener>): void

Inherited from IAiProcessMessenger.unregisterAiProcessListener
- Defined in src/api/dart-api.ts:24247
Unregister a listener or all listeners which are registered by IAiProcessMessenger.registerAiProcessListener.

api-version
2

user
Parameters
- Optional listener: Partial<AiProcessListener>
  
  A listener to be unregistered. If it is not set, all listeners will be unregistered.
Returns void

uploadCollectionData

uploadCollectionData(projectId: string, collectedDataId: string, options?: Record<string, string | number | boolean>): Promise<{ error?: AiProcessMessengerError; result: boolean }>

- Defined in src/api/dart-api.ts:24454
Request to upload collection data for model training to AI server.

api-version
2

user
Parameters
- projectId: string
  
  An id of the project where you want to upload the collection data.
- collectedDataId: string
  
  An id of collected data to upload.
- Optional options: Record<string, string | number | boolean>
  
  Additional options. It will be passed to API lib module or external AI inference engine.
Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>
Return Fulfills with true if the request has been operated successfully, otherwise false with AiProcessMessengerError.

Hierarchy

Index

Properties

Methods

Properties

Readonly trainedModelsRegisteredInServer

Methods

addEventListener

Parameters

eventName: string

listener: AiProcessEventListener

Optional once: boolean

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

addFileTransferListener

Parameters

listener: AiProcessFileTransferListener

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

connect

Parameters

ip: FourNumArray

port: number

listener: Partial<AiProcessConnectionListener>

Optional options: Partial<AiProcessConnectionOptions>

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

createNewProject

Parameters

projectName: string

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: null | AiProcessModelProjectInfo }>

deleteTrainedModel

Parameters

modelId: string

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

destroy

Returns Promise<void>

disconnect

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

getInstalledTrainedModels

Parameters

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: AiProcessModelInfo[] }>

getProjects

Parameters

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: AiProcessModelProjectInfo[] }>

getTrainedModelsFromServer

Parameters

projectId: string

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: AiProcessModelInfo[] }>

installTrainedModel

Parameters

modelId: string

listener: AiProcessModelInstallListener

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

isConnected

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

isLoggedInAs

Parameters

account: string

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

loadTrainedModel

Parameters

modelId: string

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

login

Parameters

account: string

password: string

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

logout

Parameters

Optional options: Record<string, string | number | boolean>

Returns Promise<{ error?: AiProcessMessengerError; result: boolean }>

registerAiProcessListener

Parameters