@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
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
Name | Type |
---|---|
model | ModelInput |
Returns
Promise
<string
>
Defined in
ai/AIClient.ts:47
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
closeTranscriptionStream
▸ closeTranscriptionStream(streamId
): Promise
<void
>
Parameters
Name | Type |
---|---|
streamId | string |
Returns
Promise
<void
>
Defined in
ai/AIClient.ts:339
embed
▸ embed(modelId
, text
): Promise
<number
[]>
Parameters
Name | Type |
---|---|
modelId | string |
text | string |
Returns
Promise
<number
[]>
Defined in
ai/AIClient.ts:276
feedTranscriptionStream
▸ feedTranscriptionStream(streamId
, audio
): Promise
<void
>
Parameters
Name | Type |
---|---|
streamId | string |
audio | Float32Array |
Returns
Promise
<void
>
Defined in
ai/AIClient.ts:360
getDefaultModel
▸ getDefaultModel(modelType
): Promise
<Model
>
Parameters
Name | Type |
---|---|
modelType | ModelType |
Returns
Promise
<Model
>
Defined in
ai/AIClient.ts:95
getModels
▸ getModels(): Promise
<Model
[]>
Returns
Promise
<Model
[]>
Defined in
ai/AIClient.ts:16
modelLoadingStatus
▸ modelLoadingStatus(model
): Promise
<AIModelLoadingStatus
>
Parameters
Name | Type |
---|---|
model | string |
Returns
Promise
<AIModelLoadingStatus
>
Defined in
ai/AIClient.ts:239
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
prompt
▸ prompt(taskId
, prompt
): Promise
<string
>
Parameters
Name | Type |
---|---|
taskId | string |
prompt | string |
Returns
Promise
<string
>
Defined in
ai/AIClient.ts:260
removeModel
▸ removeModel(modelId
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
modelId | string |
Returns
Promise
<boolean
>
Defined in
ai/AIClient.ts:71
removeTask
▸ removeTask(taskId
): Promise
<AITask
>
Parameters
Name | Type |
---|---|
taskId | string |
Returns
Promise
<AITask
>
Defined in
ai/AIClient.ts:179
setDefaultModel
▸ setDefaultModel(modelType
, modelId
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
modelType | ModelType |
modelId | string |
Returns
Promise
<boolean
>
Defined in
ai/AIClient.ts:83
tasks
▸ tasks(): Promise
<AITask
[]>
Returns
Promise
<AITask
[]>
Defined in
ai/AIClient.ts:127
updateModel
▸ updateModel(modelId
, model
): Promise
<boolean
>
Parameters
Name | Type |
---|---|
modelId | string |
model | ModelInput |
Returns
Promise
<boolean
>
Defined in
ai/AIClient.ts:59
updateTask
▸ updateTask(taskId
, task
): Promise
<AITask
>
Parameters
Name | Type |
---|---|
taskId | string |
task | AITask |
Returns
Promise
<AITask
>
Defined in
ai/AIClient.ts:206