IAiProcessMessenger | Dart-API Doc V3

A common interface for IAiInternalProcessMessenger and IAiExternalProcessMessenger.

api-version: 2
user

Hierarchy

IAiProcessMessenger
- IAiInternalProcessMessenger
- IAiExternalProcessMessenger

Index

Properties

trainedModelsRegisteredInServer

Methods

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

createNewProject

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

- 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 }>

- 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>

- 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.

getInstalledTrainedModels

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

- 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[] }>

- 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[] }>

- 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.

isLoggedInAs

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

- 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 }>

- 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 }>

- 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 }>

- 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

- 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

unregisterAiProcessListener

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

- 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

Hierarchy

Index

Properties

Methods

Properties

Readonly trainedModelsRegisteredInServer

Methods

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>

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[] }>

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

listener: Partial<AiProcessListener>

Returns void

unregisterAiProcessListener

Parameters

Optional listener: Partial<AiProcessListener>

Returns void