API Reference
classes
Aiclient

@coasys/ad4m / Exports / AIClient

Class: AIClient

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new AIClient(apolloClient, subscribe?)

Parameters

NameTypeDefault value
apolloClientApolloClient<any>undefined
subscribebooleantrue

Defined in

ai/AIClient.ts:12

Properties

#apolloClient

Private #apolloClient: ApolloClient<any>

Defined in

ai/AIClient.ts:9


#transcriptionSubscriptions

Private #transcriptionSubscriptions: Map<string, any>

Defined in

ai/AIClient.ts:10

Methods

addModel

addModel(model): Promise<string>

Parameters

NameType
modelModelInput

Returns

Promise<string>

Defined in

ai/AIClient.ts:42


addTask

addTask(name, modelId, systemPrompt, promptExamples, metaData?): Promise<AITask>

Parameters

NameType
namestring
modelIdstring
systemPromptstring
promptExamples{ input: string ; output: string }[]
metaData?string

Returns

Promise<AITask>

Defined in

ai/AIClient.ts:141


closeTranscriptionStream

closeTranscriptionStream(streamId): Promise<void>

Parameters

NameType
streamIdstring

Returns

Promise<void>

Defined in

ai/AIClient.ts:318


embed

embed(modelId, text): Promise<number[]>

Parameters

NameType
modelIdstring
textstring

Returns

Promise<number[]>

Defined in

ai/AIClient.ts:266


feedTranscriptionStream

feedTranscriptionStream(streamId, audio): Promise<void>

Parameters

NameType
streamIdstring
audioFloat32Array

Returns

Promise<void>

Defined in

ai/AIClient.ts:339


getDefaultModel

getDefaultModel(modelType): Promise<Model>

Parameters

NameType
modelTypeModelType

Returns

Promise<Model>

Defined in

ai/AIClient.ts:90


getModels

getModels(): Promise<Model[]>

Returns

Promise<Model[]>

Defined in

ai/AIClient.ts:16


modelLoadingStatus

modelLoadingStatus(model): Promise<AIModelLoadingStatus>

Parameters

NameType
modelstring

Returns

Promise<AIModelLoadingStatus>

Defined in

ai/AIClient.ts:229


openTranscriptionStream

openTranscriptionStream(modelId, streamCallback): Promise<string>

Parameters

NameType
modelIdstring
streamCallback(text: string) => void

Returns

Promise<string>

Defined in

ai/AIClient.ts:286


prompt

prompt(taskId, prompt): Promise<string>

Parameters

NameType
taskIdstring
promptstring

Returns

Promise<string>

Defined in

ai/AIClient.ts:250


removeModel

removeModel(modelId): Promise<boolean>

Parameters

NameType
modelIdstring

Returns

Promise<boolean>

Defined in

ai/AIClient.ts:66


removeTask

removeTask(taskId): Promise<AITask>

Parameters

NameType
taskIdstring

Returns

Promise<AITask>

Defined in

ai/AIClient.ts:169


setDefaultModel

setDefaultModel(modelType, modelId): Promise<boolean>

Parameters

NameType
modelTypeModelType
modelIdstring

Returns

Promise<boolean>

Defined in

ai/AIClient.ts:78


tasks

tasks(): Promise<AITask[]>

Returns

Promise<AITask[]>

Defined in

ai/AIClient.ts:117


updateModel

updateModel(modelId, model): Promise<boolean>

Parameters

NameType
modelIdstring
modelModelInput

Returns

Promise<boolean>

Defined in

ai/AIClient.ts:54


updateTask

updateTask(taskId, task): Promise<AITask>

Parameters

NameType
taskIdstring
taskAITask

Returns

Promise<AITask>

Defined in

ai/AIClient.ts:196