@isdk/ai-tool 0.0.8 → 0.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.cn.md +49 -15
- package/README.md +245 -2
- package/dist/chunk-PDXMSKQH.mjs +1 -0
- package/dist/funcs.js +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/index.d.mts +9 -2
- package/dist/index.d.ts +9 -2
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/docs/README.md +245 -2
- package/docs/classes/AbortError.md +8 -8
- package/docs/classes/AlreadyExistsError.md +8 -8
- package/docs/classes/BaseError.md +8 -8
- package/docs/classes/CancelableAbility.md +20 -20
- package/docs/classes/ClientTools.md +53 -53
- package/docs/classes/CommonError.md +8 -8
- package/docs/classes/EventClient.md +75 -75
- package/docs/classes/EventServer.md +73 -73
- package/docs/classes/EventToolFunc.md +43 -43
- package/docs/classes/FStringPromptTemplate.md +18 -18
- package/docs/classes/FewShotPromptTemplate.md +22 -22
- package/docs/classes/GolangPromptTemplate.md +18 -18
- package/docs/classes/HFEnvironment.md +9 -9
- package/docs/classes/HFInterpreter.md +39 -17
- package/docs/classes/HFTemplate.md +4 -4
- package/docs/classes/HfPromptTemplate.md +18 -18
- package/docs/classes/IntSet.md +12 -12
- package/docs/classes/NotFoundError.md +8 -8
- package/docs/classes/NotImplementationError.md +8 -8
- package/docs/classes/PromptExampleSelector.md +8 -8
- package/docs/classes/PromptTemplate.md +17 -17
- package/docs/classes/ReadableStreamError.md +8 -8
- package/docs/classes/ResClientTools.md +59 -59
- package/docs/classes/ResServerTools.md +57 -57
- package/docs/classes/SSEChannel.md +15 -15
- package/docs/classes/Semaphore.md +14 -14
- package/docs/classes/ServerTools.md +50 -50
- package/docs/classes/TaskAbortController.md +7 -7
- package/docs/classes/ToolFunc.md +40 -40
- package/docs/enums/AsyncFeatureBits.md +3 -3
- package/docs/enums/AsyncFeatures.md +3 -3
- package/docs/enums/ErrorCode.md +21 -21
- package/docs/enums/XXHashAlgorithm.md +2 -2
- package/docs/interfaces/AIChatAssistantMessageParam.md +6 -6
- package/docs/interfaces/AIChatContentPartImage.md +2 -2
- package/docs/interfaces/AIChatContentPartText.md +2 -2
- package/docs/interfaces/AIChatMessageParamBase.md +1 -1
- package/docs/interfaces/AIChatMessageToolCall.md +3 -3
- package/docs/interfaces/AIChatSystemMessageParam.md +3 -3
- package/docs/interfaces/AIChatToolMessageParam.md +4 -4
- package/docs/interfaces/AIChatUserMessageParam.md +7 -7
- package/docs/interfaces/AIResult.md +5 -5
- package/docs/interfaces/AIStreamParser.md +1 -1
- package/docs/interfaces/AIStreamParserOptions.md +1 -1
- package/docs/interfaces/BaseFunc.md +7 -7
- package/docs/interfaces/BaseFuncItem.md +6 -6
- package/docs/interfaces/CancelableAbilityOptions.md +2 -2
- package/docs/interfaces/ClientFuncItem.md +10 -10
- package/docs/interfaces/DotenvExpandOptions.md +3 -3
- package/docs/interfaces/DotenvExpandOutput.md +2 -2
- package/docs/interfaces/EventClientFuncParams.md +4 -4
- package/docs/interfaces/EventServerFuncParams.md +5 -5
- package/docs/interfaces/FewShotPromptTemplateOptions.md +11 -11
- package/docs/interfaces/FuncItem.md +7 -7
- package/docs/interfaces/FuncParam.md +6 -6
- package/docs/interfaces/PromptExampleSelectorOptions.md +2 -2
- package/docs/interfaces/PromptTemplateOptions.md +6 -6
- package/docs/interfaces/RemoteFuncItem.md +10 -10
- package/docs/interfaces/ResClientFuncParams.md +2 -2
- package/docs/interfaces/ResServerFuncParams.md +5 -5
- package/docs/interfaces/SanitizeFilenameOptions.md +2 -2
- package/docs/interfaces/ServerFuncItem.md +11 -11
- package/docs/interfaces/ServerFuncParams.md +2 -2
- package/docs/interfaces/StreamCallbacksAndOptions.md +4 -4
- package/docs/interfaces/TaskPromise.md +1 -1
- package/docs/interfaces/ToolFuncPackage.md +3 -3
- package/docs/modules.md +127 -124
- package/package.json +1 -1
- package/dist/chunk-B7IE5ATQ.mjs +0 -1
package/docs/README.md
CHANGED
|
@@ -1,5 +1,248 @@
|
|
|
1
1
|
@isdk/ai-tool / [Exports](modules.md)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
# @isdk/ai-tool
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
A library for abstracting AI utility functions (`ToolFunc`), providing a series of convenient helper functions.
|
|
6
|
+
|
|
7
|
+
**Note:** All `ToolFunc` parameters are object-based, not positional.
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
1. Install the package:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @isdk/ai-tool
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
## ToolFunc
|
|
20
|
+
|
|
21
|
+
Register ordinary functions as `ToolFunc`.
|
|
22
|
+
|
|
23
|
+
### Example
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import { ToolFunc } from '@isdk/ai-tool';
|
|
27
|
+
|
|
28
|
+
// Register a function directly
|
|
29
|
+
ToolFunc.register({
|
|
30
|
+
name: 'add',
|
|
31
|
+
description: 'Return the sum of a and b',
|
|
32
|
+
params: { a: { type: 'number' }, b: { type: 'number' } },
|
|
33
|
+
result: 'number',
|
|
34
|
+
func: ({ a, b }: { a: number; b: number }) => a + b,
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
console.log('Result:', ToolFunc.runSync('add', { a: 1, b: 2 }));
|
|
38
|
+
// Result: 3
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Properties
|
|
42
|
+
|
|
43
|
+
* `func`: The main body of the tool function.
|
|
44
|
+
* `name`: Name of the tool function.
|
|
45
|
+
* `params`: Parameter schema for the tool function.
|
|
46
|
+
* `result`: Return type of the tool function.
|
|
47
|
+
* `scope`: Scope of the function.
|
|
48
|
+
* `description`: Description of the tool function.
|
|
49
|
+
* `setup`: Executed during the construction of the ToolFunc instance.
|
|
50
|
+
* `depends`: Dependencies on other ToolFunc instances.
|
|
51
|
+
|
|
52
|
+
### ServerTools (extends ToolFunc)
|
|
53
|
+
|
|
54
|
+
Server-side AI tool functions.
|
|
55
|
+
|
|
56
|
+
**Features**
|
|
57
|
+
|
|
58
|
+
* Allows exporting the function body as a string for local execution.
|
|
59
|
+
* Provides a static `toJSON()` method to export all service API definitions.
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
interface ServerFuncItem extends FuncItem {
|
|
63
|
+
apiRoot?: string
|
|
64
|
+
/**
|
|
65
|
+
* API request method, can be 'get' or 'post'
|
|
66
|
+
*/
|
|
67
|
+
action?: 'get'|'post'
|
|
68
|
+
// Options for the Node.js fetch function
|
|
69
|
+
fetchOptions?: any
|
|
70
|
+
// Whether to allow exporting the func body itself, default to false
|
|
71
|
+
allowExportFunc?: boolean
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Usage: Parameters are sent via query string for GET requests and in the body for POST requests.
|
|
76
|
+
|
|
77
|
+
### ClientTools (extends ToolFunc)
|
|
78
|
+
|
|
79
|
+
Used to call remote AI tool functions (ServerTools).
|
|
80
|
+
|
|
81
|
+
**Features**
|
|
82
|
+
|
|
83
|
+
* Supports loading all remote calls with static loadFromSync(items) and static async loadFrom().
|
|
84
|
+
* Prioritizes local execution over remote calls.
|
|
85
|
+
|
|
86
|
+
```ts
|
|
87
|
+
interface ClientFuncItem extends FuncItem {
|
|
88
|
+
apiRoot?: string
|
|
89
|
+
action?: 'get'|'post'
|
|
90
|
+
fetchOptions?: any
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### ResServerTools
|
|
95
|
+
|
|
96
|
+
Resource-based server tools, where resources are named ToolFunc.
|
|
97
|
+
|
|
98
|
+
#### Methods
|
|
99
|
+
|
|
100
|
+
* `GET /api/res/:id`: Get resource.
|
|
101
|
+
* `GET /api/res`: List resources.
|
|
102
|
+
* `POST /api/res`: Create resource.
|
|
103
|
+
* `PUT /api/res/:id`: Update resource.
|
|
104
|
+
* `DELETE /api/res/:id`: Delete resource.
|
|
105
|
+
|
|
106
|
+
#### Custom Methods
|
|
107
|
+
|
|
108
|
+
Methods prefixed with `$` are custom resource methods, accessible via `POST`.
|
|
109
|
+
|
|
110
|
+
Example
|
|
111
|
+
|
|
112
|
+
```ts
|
|
113
|
+
class TestResTool extends ResServerTools {
|
|
114
|
+
items: any = {}
|
|
115
|
+
params: FuncParams = {
|
|
116
|
+
'id': {type: 'number'},
|
|
117
|
+
'val': {type: 'any'},
|
|
118
|
+
}
|
|
119
|
+
$customMethod({id}: ResServerFuncParams) {
|
|
120
|
+
if (id) {
|
|
121
|
+
const item = this.items[id]
|
|
122
|
+
if (!item) {
|
|
123
|
+
throw new NotFoundError(id, 'res')
|
|
124
|
+
}
|
|
125
|
+
return {name: 'customMethod', id, item}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
get({id}: ResServerFuncParams) {
|
|
129
|
+
if (id) {
|
|
130
|
+
const item = this.items[id]
|
|
131
|
+
if (!item) {
|
|
132
|
+
throw new NotFoundError(id, 'res')
|
|
133
|
+
}
|
|
134
|
+
return item
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
post({id, val}: ResServerFuncParams) {
|
|
138
|
+
if (id !== undefined && val !== undefined) {
|
|
139
|
+
this.items[id] = val
|
|
140
|
+
return {id}
|
|
141
|
+
} else {
|
|
142
|
+
throwError('id or val is undefined')
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
list() {
|
|
146
|
+
return Object.keys(this.items)
|
|
147
|
+
}
|
|
148
|
+
delete({id}: ResServerFuncParams) {
|
|
149
|
+
if (id) {
|
|
150
|
+
const item = this.items[id]
|
|
151
|
+
if (item === undefined) {
|
|
152
|
+
throw new NotFoundError(id, 'res')
|
|
153
|
+
}
|
|
154
|
+
delete this.items[id]
|
|
155
|
+
return {id}
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
ResServerTools.apiRoot = apiRoot
|
|
160
|
+
const res = new TestResTool('res')
|
|
161
|
+
res.register()
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
### ResClientTools
|
|
165
|
+
|
|
166
|
+
Resource-based client tools that generate methods based on ServerTools agreements.
|
|
167
|
+
|
|
168
|
+
Example
|
|
169
|
+
|
|
170
|
+
```ts
|
|
171
|
+
ResClientTools.apiRoot = apiRoot
|
|
172
|
+
await ResClientTools.loadFrom()
|
|
173
|
+
|
|
174
|
+
const resFunc = ResClientTools.getFunc(funcName)
|
|
175
|
+
if (resFunc) {
|
|
176
|
+
let result = await res.post({id: '...', val: '...'})
|
|
177
|
+
result = await res.put({id: '...', val: '...'})
|
|
178
|
+
result = await res.get({id: '...'})
|
|
179
|
+
result = await res.customMethod({id: '...'})
|
|
180
|
+
}
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
### SSE (Server-Sent Events)
|
|
184
|
+
|
|
185
|
+
Endpoints
|
|
186
|
+
|
|
187
|
+
* `GET /api/event`: List server event channel (stream).
|
|
188
|
+
* `POST /api/event`: Subscribe to server events.
|
|
189
|
+
* `DELETE /api/event`: Unsubscribe from server events.
|
|
190
|
+
* `PUT /api/event`: Publish messages to server events.
|
|
191
|
+
|
|
192
|
+
### EventClient
|
|
193
|
+
|
|
194
|
+
The `EventClient` component facilitates communication between the client and server through Server-Sent Events (SSE). Its primary responsibilities include subscribing to server events and publishing messages to the server.
|
|
195
|
+
|
|
196
|
+
#### Key Features
|
|
197
|
+
|
|
198
|
+
- **Subscription**: Subscribes to server events and forwards them to the local client's event bus.
|
|
199
|
+
- **Publication**: Publishes messages to the server.
|
|
200
|
+
|
|
201
|
+
#### EventClient Methods
|
|
202
|
+
|
|
203
|
+
- `initEventSource(events)`: Specifies which events to receive from the server. If `events` is not provided, all events are received.
|
|
204
|
+
- `subscribe(events)`: Subscribes to specified server events and forwards them to the local event bus.
|
|
205
|
+
- Note: It's important to distinguish between local and server-originated messages. Server messages that were previously forwarded from local events should not be re-forwarded to avoid infinite loops.
|
|
206
|
+
- `unsubscribe(events)`: Cancels subscriptions to specified server events.
|
|
207
|
+
- `forwardEvent(events)`: Forwards specific local events to the server.
|
|
208
|
+
- `unforwardEvent(events)`: Stops forwarding specific local events to the server.
|
|
209
|
+
|
|
210
|
+
#### Considerations
|
|
211
|
+
|
|
212
|
+
- Local events that need to be forwarded to the server can be managed independently through the `forwardEvent` method.
|
|
213
|
+
- Event handling logic should be decoupled from the core functionality of `ToolFunc` to maintain flexibility and separation of concerns.
|
|
214
|
+
|
|
215
|
+
### EventServer
|
|
216
|
+
|
|
217
|
+
The `EventServer` component manages server-side event processing, including publishing and subscribing to events.
|
|
218
|
+
|
|
219
|
+
**Key Features**
|
|
220
|
+
|
|
221
|
+
- **Publishing**: Publishes events to clients via SSE.
|
|
222
|
+
- **Subscribing**: Manages subscriptions to events on the server side.
|
|
223
|
+
|
|
224
|
+
**Actions**
|
|
225
|
+
|
|
226
|
+
- `pub`: Publishes an SSE event.
|
|
227
|
+
- `sub`: Subscribes to server events.
|
|
228
|
+
- `unsub`: Unsubscribes from server events.
|
|
229
|
+
|
|
230
|
+
**Usage**
|
|
231
|
+
|
|
232
|
+
- Functions without an `act` or with only `events` specified are used for server-side event handling.
|
|
233
|
+
- Functions with an `act` define specific actions such as publishing, subscribing, or unsubscribing from events.
|
|
234
|
+
|
|
235
|
+
## Contribution
|
|
236
|
+
|
|
237
|
+
If you would like to contribute to the project, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) file for guidelines on how to get started.
|
|
238
|
+
|
|
239
|
+
## License
|
|
240
|
+
|
|
241
|
+
The project is licensed under the MIT License. See the [LICENSE-MIT](./LICENSE-MIT) file for more details.
|
|
242
|
+
|
|
243
|
+
## Credit
|
|
244
|
+
|
|
245
|
+
* [@huggingface/jinja](https://github.com/huggingface/huggingface.js)
|
|
246
|
+
* [eventsource-parser](https://github.com/rexxars/eventsource-parser)
|
|
247
|
+
* [async-sema](https://github.com/vercel/async-sema)
|
|
248
|
+
* [modelfusion](https://github.com/vercel/modelfusion)
|
|
@@ -86,7 +86,7 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
|
|
|
86
86
|
|
|
87
87
|
#### Defined in
|
|
88
88
|
|
|
89
|
-
[packages/ai-tool/src/utils/base-error.ts:204](https://github.com/isdk/ai-tool.js/blob/
|
|
89
|
+
[packages/ai-tool/src/utils/base-error.ts:204](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L204)
|
|
90
90
|
|
|
91
91
|
## Properties
|
|
92
92
|
|
|
@@ -102,7 +102,7 @@ The name of the function that threw the error.
|
|
|
102
102
|
|
|
103
103
|
#### Defined in
|
|
104
104
|
|
|
105
|
-
[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/
|
|
105
|
+
[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L66)
|
|
106
106
|
|
|
107
107
|
___
|
|
108
108
|
|
|
@@ -130,7 +130,7 @@ ___
|
|
|
130
130
|
|
|
131
131
|
#### Defined in
|
|
132
132
|
|
|
133
|
-
[packages/ai-tool/src/utils/base-error.ts:67](https://github.com/isdk/ai-tool.js/blob/
|
|
133
|
+
[packages/ai-tool/src/utils/base-error.ts:67](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L67)
|
|
134
134
|
|
|
135
135
|
___
|
|
136
136
|
|
|
@@ -146,7 +146,7 @@ Additional data associated with the error.
|
|
|
146
146
|
|
|
147
147
|
#### Defined in
|
|
148
148
|
|
|
149
|
-
[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
149
|
+
[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L68)
|
|
150
150
|
|
|
151
151
|
___
|
|
152
152
|
|
|
@@ -204,7 +204,7 @@ The error code associated with the error.
|
|
|
204
204
|
|
|
205
205
|
#### Defined in
|
|
206
206
|
|
|
207
|
-
[packages/ai-tool/src/utils/base-error.ts:203](https://github.com/isdk/ai-tool.js/blob/
|
|
207
|
+
[packages/ai-tool/src/utils/base-error.ts:203](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L203)
|
|
208
208
|
|
|
209
209
|
___
|
|
210
210
|
|
|
@@ -281,7 +281,7 @@ A new BaseError instance.
|
|
|
281
281
|
|
|
282
282
|
#### Defined in
|
|
283
283
|
|
|
284
|
-
[packages/ai-tool/src/utils/base-error.ts:131](https://github.com/isdk/ai-tool.js/blob/
|
|
284
|
+
[packages/ai-tool/src/utils/base-error.ts:131](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L131)
|
|
285
285
|
|
|
286
286
|
___
|
|
287
287
|
|
|
@@ -303,7 +303,7 @@ A JSON representation of the error.
|
|
|
303
303
|
|
|
304
304
|
#### Defined in
|
|
305
305
|
|
|
306
|
-
[packages/ai-tool/src/utils/base-error.ts:111](https://github.com/isdk/ai-tool.js/blob/
|
|
306
|
+
[packages/ai-tool/src/utils/base-error.ts:111](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L111)
|
|
307
307
|
|
|
308
308
|
___
|
|
309
309
|
|
|
@@ -356,4 +356,4 @@ typeof [`BaseError`](BaseError.md)
|
|
|
356
356
|
|
|
357
357
|
#### Defined in
|
|
358
358
|
|
|
359
|
-
[packages/ai-tool/src/utils/base-error.ts:70](https://github.com/isdk/ai-tool.js/blob/
|
|
359
|
+
[packages/ai-tool/src/utils/base-error.ts:70](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L70)
|
|
@@ -66,7 +66,7 @@ throw new AlreadyExistsError('user', { id: 123 })
|
|
|
66
66
|
|
|
67
67
|
#### Defined in
|
|
68
68
|
|
|
69
|
-
[packages/ai-tool/src/utils/base-error.ts:195](https://github.com/isdk/ai-tool.js/blob/
|
|
69
|
+
[packages/ai-tool/src/utils/base-error.ts:195](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L195)
|
|
70
70
|
|
|
71
71
|
## Properties
|
|
72
72
|
|
|
@@ -82,7 +82,7 @@ The name of the function that threw the error.
|
|
|
82
82
|
|
|
83
83
|
#### Defined in
|
|
84
84
|
|
|
85
|
-
[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/
|
|
85
|
+
[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L66)
|
|
86
86
|
|
|
87
87
|
___
|
|
88
88
|
|
|
@@ -110,7 +110,7 @@ ___
|
|
|
110
110
|
|
|
111
111
|
#### Defined in
|
|
112
112
|
|
|
113
|
-
[packages/ai-tool/src/utils/base-error.ts:67](https://github.com/isdk/ai-tool.js/blob/
|
|
113
|
+
[packages/ai-tool/src/utils/base-error.ts:67](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L67)
|
|
114
114
|
|
|
115
115
|
___
|
|
116
116
|
|
|
@@ -126,7 +126,7 @@ Additional data associated with the error.
|
|
|
126
126
|
|
|
127
127
|
#### Defined in
|
|
128
128
|
|
|
129
|
-
[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
129
|
+
[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L68)
|
|
130
130
|
|
|
131
131
|
___
|
|
132
132
|
|
|
@@ -184,7 +184,7 @@ The error code associated with the error.
|
|
|
184
184
|
|
|
185
185
|
#### Defined in
|
|
186
186
|
|
|
187
|
-
[packages/ai-tool/src/utils/base-error.ts:194](https://github.com/isdk/ai-tool.js/blob/
|
|
187
|
+
[packages/ai-tool/src/utils/base-error.ts:194](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L194)
|
|
188
188
|
|
|
189
189
|
___
|
|
190
190
|
|
|
@@ -261,7 +261,7 @@ A new BaseError instance.
|
|
|
261
261
|
|
|
262
262
|
#### Defined in
|
|
263
263
|
|
|
264
|
-
[packages/ai-tool/src/utils/base-error.ts:131](https://github.com/isdk/ai-tool.js/blob/
|
|
264
|
+
[packages/ai-tool/src/utils/base-error.ts:131](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L131)
|
|
265
265
|
|
|
266
266
|
___
|
|
267
267
|
|
|
@@ -283,7 +283,7 @@ A JSON representation of the error.
|
|
|
283
283
|
|
|
284
284
|
#### Defined in
|
|
285
285
|
|
|
286
|
-
[packages/ai-tool/src/utils/base-error.ts:111](https://github.com/isdk/ai-tool.js/blob/
|
|
286
|
+
[packages/ai-tool/src/utils/base-error.ts:111](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L111)
|
|
287
287
|
|
|
288
288
|
___
|
|
289
289
|
|
|
@@ -336,4 +336,4 @@ typeof [`BaseError`](BaseError.md)
|
|
|
336
336
|
|
|
337
337
|
#### Defined in
|
|
338
338
|
|
|
339
|
-
[packages/ai-tool/src/utils/base-error.ts:70](https://github.com/isdk/ai-tool.js/blob/
|
|
339
|
+
[packages/ai-tool/src/utils/base-error.ts:70](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L70)
|
|
@@ -93,7 +93,7 @@ AbstractError.constructor
|
|
|
93
93
|
|
|
94
94
|
#### Defined in
|
|
95
95
|
|
|
96
|
-
[packages/ai-tool/src/utils/base-error.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
96
|
+
[packages/ai-tool/src/utils/base-error.ts:81](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L81)
|
|
97
97
|
|
|
98
98
|
## Properties
|
|
99
99
|
|
|
@@ -105,7 +105,7 @@ The name of the function that threw the error.
|
|
|
105
105
|
|
|
106
106
|
#### Defined in
|
|
107
107
|
|
|
108
|
-
[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/
|
|
108
|
+
[packages/ai-tool/src/utils/base-error.ts:66](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L66)
|
|
109
109
|
|
|
110
110
|
___
|
|
111
111
|
|
|
@@ -133,7 +133,7 @@ AbstractError.code
|
|
|
133
133
|
|
|
134
134
|
#### Defined in
|
|
135
135
|
|
|
136
|
-
[packages/ai-tool/src/utils/base-error.ts:67](https://github.com/isdk/ai-tool.js/blob/
|
|
136
|
+
[packages/ai-tool/src/utils/base-error.ts:67](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L67)
|
|
137
137
|
|
|
138
138
|
___
|
|
139
139
|
|
|
@@ -145,7 +145,7 @@ Additional data associated with the error.
|
|
|
145
145
|
|
|
146
146
|
#### Defined in
|
|
147
147
|
|
|
148
|
-
[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
148
|
+
[packages/ai-tool/src/utils/base-error.ts:68](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L68)
|
|
149
149
|
|
|
150
150
|
___
|
|
151
151
|
|
|
@@ -199,7 +199,7 @@ The error code associated with the error.
|
|
|
199
199
|
|
|
200
200
|
#### Defined in
|
|
201
201
|
|
|
202
|
-
[packages/ai-tool/src/utils/base-error.ts:65](https://github.com/isdk/ai-tool.js/blob/
|
|
202
|
+
[packages/ai-tool/src/utils/base-error.ts:65](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L65)
|
|
203
203
|
|
|
204
204
|
___
|
|
205
205
|
|
|
@@ -272,7 +272,7 @@ A new BaseError instance.
|
|
|
272
272
|
|
|
273
273
|
#### Defined in
|
|
274
274
|
|
|
275
|
-
[packages/ai-tool/src/utils/base-error.ts:131](https://github.com/isdk/ai-tool.js/blob/
|
|
275
|
+
[packages/ai-tool/src/utils/base-error.ts:131](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L131)
|
|
276
276
|
|
|
277
277
|
___
|
|
278
278
|
|
|
@@ -290,7 +290,7 @@ A JSON representation of the error.
|
|
|
290
290
|
|
|
291
291
|
#### Defined in
|
|
292
292
|
|
|
293
|
-
[packages/ai-tool/src/utils/base-error.ts:111](https://github.com/isdk/ai-tool.js/blob/
|
|
293
|
+
[packages/ai-tool/src/utils/base-error.ts:111](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L111)
|
|
294
294
|
|
|
295
295
|
___
|
|
296
296
|
|
|
@@ -343,4 +343,4 @@ AbstractError.createErrorClass
|
|
|
343
343
|
|
|
344
344
|
#### Defined in
|
|
345
345
|
|
|
346
|
-
[packages/ai-tool/src/utils/base-error.ts:70](https://github.com/isdk/ai-tool.js/blob/
|
|
346
|
+
[packages/ai-tool/src/utils/base-error.ts:70](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/base-error.ts#L70)
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
|
|
60
60
|
#### Defined in
|
|
61
61
|
|
|
62
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:65](https://github.com/isdk/ai-tool.js/blob/
|
|
62
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:65](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L65)
|
|
63
63
|
|
|
64
64
|
___
|
|
65
65
|
|
|
@@ -69,7 +69,7 @@ ___
|
|
|
69
69
|
|
|
70
70
|
#### Defined in
|
|
71
71
|
|
|
72
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:66](https://github.com/isdk/ai-tool.js/blob/
|
|
72
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:66](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L66)
|
|
73
73
|
|
|
74
74
|
___
|
|
75
75
|
|
|
@@ -79,7 +79,7 @@ ___
|
|
|
79
79
|
|
|
80
80
|
#### Defined in
|
|
81
81
|
|
|
82
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/
|
|
82
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:55](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L55)
|
|
83
83
|
|
|
84
84
|
___
|
|
85
85
|
|
|
@@ -89,7 +89,7 @@ ___
|
|
|
89
89
|
|
|
90
90
|
#### Defined in
|
|
91
91
|
|
|
92
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:56](https://github.com/isdk/ai-tool.js/blob/
|
|
92
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:56](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L56)
|
|
93
93
|
|
|
94
94
|
___
|
|
95
95
|
|
|
@@ -114,7 +114,7 @@ ___
|
|
|
114
114
|
|
|
115
115
|
#### Defined in
|
|
116
116
|
|
|
117
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:63](https://github.com/isdk/ai-tool.js/blob/
|
|
117
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:63](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L63)
|
|
118
118
|
|
|
119
119
|
___
|
|
120
120
|
|
|
@@ -139,7 +139,7 @@ ___
|
|
|
139
139
|
|
|
140
140
|
#### Defined in
|
|
141
141
|
|
|
142
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:62](https://github.com/isdk/ai-tool.js/blob/
|
|
142
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:62](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L62)
|
|
143
143
|
|
|
144
144
|
## Accessors
|
|
145
145
|
|
|
@@ -153,7 +153,7 @@ ___
|
|
|
153
153
|
|
|
154
154
|
#### Defined in
|
|
155
155
|
|
|
156
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:68](https://github.com/isdk/ai-tool.js/blob/
|
|
156
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:68](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L68)
|
|
157
157
|
|
|
158
158
|
___
|
|
159
159
|
|
|
@@ -167,7 +167,7 @@ ___
|
|
|
167
167
|
|
|
168
168
|
#### Defined in
|
|
169
169
|
|
|
170
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:72](https://github.com/isdk/ai-tool.js/blob/
|
|
170
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:72](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L72)
|
|
171
171
|
|
|
172
172
|
## Methods
|
|
173
173
|
|
|
@@ -188,7 +188,7 @@ ___
|
|
|
188
188
|
|
|
189
189
|
#### Defined in
|
|
190
190
|
|
|
191
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:214](https://github.com/isdk/ai-tool.js/blob/
|
|
191
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:214](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L214)
|
|
192
192
|
|
|
193
193
|
___
|
|
194
194
|
|
|
@@ -209,7 +209,7 @@ ___
|
|
|
209
209
|
|
|
210
210
|
#### Defined in
|
|
211
211
|
|
|
212
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:147](https://github.com/isdk/ai-tool.js/blob/
|
|
212
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:147](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L147)
|
|
213
213
|
|
|
214
214
|
___
|
|
215
215
|
|
|
@@ -230,7 +230,7 @@ ___
|
|
|
230
230
|
|
|
231
231
|
#### Defined in
|
|
232
232
|
|
|
233
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:234](https://github.com/isdk/ai-tool.js/blob/
|
|
233
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:234](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L234)
|
|
234
234
|
|
|
235
235
|
___
|
|
236
236
|
|
|
@@ -251,7 +251,7 @@ ___
|
|
|
251
251
|
|
|
252
252
|
#### Defined in
|
|
253
253
|
|
|
254
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:134](https://github.com/isdk/ai-tool.js/blob/
|
|
254
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:134](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L134)
|
|
255
255
|
|
|
256
256
|
___
|
|
257
257
|
|
|
@@ -272,7 +272,7 @@ ___
|
|
|
272
272
|
|
|
273
273
|
#### Defined in
|
|
274
274
|
|
|
275
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:291](https://github.com/isdk/ai-tool.js/blob/
|
|
275
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:291](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L291)
|
|
276
276
|
|
|
277
277
|
___
|
|
278
278
|
|
|
@@ -292,7 +292,7 @@ ___
|
|
|
292
292
|
|
|
293
293
|
#### Defined in
|
|
294
294
|
|
|
295
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:224](https://github.com/isdk/ai-tool.js/blob/
|
|
295
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:224](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L224)
|
|
296
296
|
|
|
297
297
|
___
|
|
298
298
|
|
|
@@ -314,7 +314,7 @@ ___
|
|
|
314
314
|
|
|
315
315
|
#### Defined in
|
|
316
316
|
|
|
317
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/
|
|
317
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:158](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L158)
|
|
318
318
|
|
|
319
319
|
___
|
|
320
320
|
|
|
@@ -344,7 +344,7 @@ ___
|
|
|
344
344
|
|
|
345
345
|
#### Defined in
|
|
346
346
|
|
|
347
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:238](https://github.com/isdk/ai-tool.js/blob/
|
|
347
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:238](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L238)
|
|
348
348
|
|
|
349
349
|
___
|
|
350
350
|
|
|
@@ -364,7 +364,7 @@ ___
|
|
|
364
364
|
|
|
365
365
|
#### Defined in
|
|
366
366
|
|
|
367
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
367
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:96](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L96)
|
|
368
368
|
|
|
369
369
|
___
|
|
370
370
|
|
|
@@ -378,7 +378,7 @@ ___
|
|
|
378
378
|
|
|
379
379
|
#### Defined in
|
|
380
380
|
|
|
381
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:119](https://github.com/isdk/ai-tool.js/blob/
|
|
381
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:119](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L119)
|
|
382
382
|
|
|
383
383
|
___
|
|
384
384
|
|
|
@@ -398,7 +398,7 @@ ___
|
|
|
398
398
|
|
|
399
399
|
#### Defined in
|
|
400
400
|
|
|
401
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:81](https://github.com/isdk/ai-tool.js/blob/
|
|
401
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:81](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L81)
|
|
402
402
|
|
|
403
403
|
___
|
|
404
404
|
|
|
@@ -428,4 +428,4 @@ ___
|
|
|
428
428
|
|
|
429
429
|
#### Defined in
|
|
430
430
|
|
|
431
|
-
[packages/ai-tool/src/utils/cancelable-ability.ts:276](https://github.com/isdk/ai-tool.js/blob/
|
|
431
|
+
[packages/ai-tool/src/utils/cancelable-ability.ts:276](https://github.com/isdk/ai-tool.js/blob/43e2dd311b252f4a811e695a7944005766712a72/src/utils/cancelable-ability.ts#L276)
|