@coasys/ad4m / Exports / AIClient
Class: AIClient
Table of contents
Constructors
Properties
Methods
- addModel
- addTask
- closeTranscriptionStream
- embed
- feedTranscriptionStream
- getDefaultModel
- getModels
- modelLoadingStatus
- openTranscriptionStream
- prompt
- removeModel
- removeTask
- setDefaultModel
- tasks
- updateModel
- updateTask
Constructors
constructor
• new AIClient(apolloClient, subscribe?)
Parameters
| Name | Type | Default value |
|---|---|---|
apolloClient | ApolloClient<any> | undefined |
subscribe | boolean | true |
Defined in
ai/AIClient.ts:12 (opens in a new tab)
Properties
#apolloClient
• Private #apolloClient: ApolloClient<any>
Defined in
ai/AIClient.ts:9 (opens in a new tab)
#transcriptionSubscriptions
• Private #transcriptionSubscriptions: Map<string, any>
Defined in
ai/AIClient.ts:10 (opens in a new tab)
Methods
addModel
▸ addModel(model): Promise<string>
Parameters
| Name | Type |
|---|---|
model | ModelInput |
Returns
Promise<string>
Defined in
ai/AIClient.ts:47 (opens in a new tab)
addTask
▸ addTask(name, modelId, systemPrompt, promptExamples, metaData?): Promise<AITask>
Parameters
| Name | Type |
|---|---|
name | string |
modelId | string |
systemPrompt | string |
promptExamples | { input: string ; output: string }[] |
metaData? | string |
Returns
Promise<AITask>
Defined in
ai/AIClient.ts:151 (opens in a new tab)
closeTranscriptionStream
▸ closeTranscriptionStream(streamId): Promise<void>
Parameters
| Name | Type |
|---|---|
streamId | string |
Returns
Promise<void>
Defined in
ai/AIClient.ts:339 (opens in a new tab)
embed
▸ embed(modelId, text): Promise<number[]>
Parameters
| Name | Type |
|---|---|
modelId | string |
text | string |
Returns
Promise<number[]>
Defined in
ai/AIClient.ts:276 (opens in a new tab)
feedTranscriptionStream
▸ feedTranscriptionStream(streamIds, audio): Promise<void>
Parameters
| Name | Type |
|---|---|
streamIds | string | string[] |
audio | Float32Array |
Returns
Promise<void>
Defined in
ai/AIClient.ts:360 (opens in a new tab)
getDefaultModel
▸ getDefaultModel(modelType): Promise<Model>
Parameters
| Name | Type |
|---|---|
modelType | ModelType |
Returns
Promise<Model>
Defined in
ai/AIClient.ts:95 (opens in a new tab)
getModels
▸ getModels(): Promise<Model[]>
Returns
Promise<Model[]>
Defined in
ai/AIClient.ts:16 (opens in a new tab)
modelLoadingStatus
▸ modelLoadingStatus(model): Promise<AIModelLoadingStatus>
Parameters
| Name | Type |
|---|---|
model | string |
Returns
Promise<AIModelLoadingStatus>
Defined in
ai/AIClient.ts:239 (opens in a new tab)
openTranscriptionStream
▸ openTranscriptionStream(modelId, streamCallback, params?): Promise<string>
Parameters
| Name | Type |
|---|---|
modelId | string |
streamCallback | (text: string) => void |
params? | Object |
params.endThreshold? | number |
params.endWindow? | number |
params.startThreshold? | number |
params.startWindow? | number |
params.timeBeforeSpeech? | number |
Returns
Promise<string>
Defined in
ai/AIClient.ts:296 (opens in a new tab)
prompt
▸ prompt(taskId, prompt): Promise<string>
Parameters
| Name | Type |
|---|---|
taskId | string |
prompt | string |
Returns
Promise<string>
Defined in
ai/AIClient.ts:260 (opens in a new tab)
removeModel
▸ removeModel(modelId): Promise<boolean>
Parameters
| Name | Type |
|---|---|
modelId | string |
Returns
Promise<boolean>
Defined in
ai/AIClient.ts:71 (opens in a new tab)
removeTask
▸ removeTask(taskId): Promise<AITask>
Parameters
| Name | Type |
|---|---|
taskId | string |
Returns
Promise<AITask>
Defined in
ai/AIClient.ts:179 (opens in a new tab)
setDefaultModel
▸ setDefaultModel(modelType, modelId): Promise<boolean>
Parameters
| Name | Type |
|---|---|
modelType | ModelType |
modelId | string |
Returns
Promise<boolean>
Defined in
ai/AIClient.ts:83 (opens in a new tab)
tasks
▸ tasks(): Promise<AITask[]>
Returns
Promise<AITask[]>
Defined in
ai/AIClient.ts:127 (opens in a new tab)
updateModel
▸ updateModel(modelId, model): Promise<boolean>
Parameters
| Name | Type |
|---|---|
modelId | string |
model | ModelInput |
Returns
Promise<boolean>
Defined in
ai/AIClient.ts:59 (opens in a new tab)
updateTask
▸ updateTask(taskId, task): Promise<AITask>
Parameters
| Name | Type |
|---|---|
taskId | string |
task | AITask |
Returns
Promise<AITask>