Interface IGenerativeAIWorkerConnector

The generative AI worker connector interface.

interface IGenerativeAIWorkerConnector {
    close(): Promise<void>;
    getEngineType(): GenerativeAIEngineType;
    initialize(workflowId: string, models: Map<string, IGenerativeAIModel>): Promise<void>;
    processJob(parameters: IJobParametersAI, options?: IGenerativeAIWorkerOptions): Promise<IJobResultAI>;
    processJobStream(parameters: IJobParametersAI, options?: IGenerativeAIWorkerOptions): AsyncGenerator<IJobResultAI, any, unknown>;
}

Hierarchy (view full)

IJobWorkerConnector<IJobParametersAI, IJobResultAI>
- IGenerativeAIWorkerConnector

Index

Methods

close getEngineType initialize processJob processJobStream

Methods

close

close(): Promise<void>
Close the machine learning model.

Returns Promise<void>
A promise that resolves when the model has been closed.

getEngineType

getEngineType(): GenerativeAIEngineType
Get the engine type.

Returns GenerativeAIEngineType
The engine type.

initialize

initialize(workflowId, models): Promise<void>
Initialize the machine learning model.
Parameters
- workflowId: string
  The workflow ID.
- models: Map<string, IGenerativeAIModel>
  A map of model IDs and pathnames.
Returns Promise<void>
A promise that resolves when the model has been initialized.

processJob

processJob(parameters, options?): Promise<IJobResultAI>
Process a job.
Parameters
- parameters: IJobParametersAI
  The job parameters.
- Optionaloptions: IGenerativeAIWorkerOptions
  The job options.
Returns Promise<IJobResultAI>
A promise that resolves with the job result.

Overrides IJobWorkerConnector.processJob

processJobStream

processJobStream(parameters, options?): AsyncGenerator<IJobResultAI, any, unknown>
Stream a job.
Parameters
- parameters: IJobParametersAI
  The job parameters.
- Optionaloptions: IGenerativeAIWorkerOptions
  The job options.
Returns AsyncGenerator<IJobResultAI, any, unknown>
An async generator that yields the job result.

Overrides IJobWorkerConnector.processJobStream