@isdk/ai-tool 0.0.7 → 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.
Files changed (85) hide show
  1. package/README.cn.md +49 -15
  2. package/README.md +245 -2
  3. package/dist/chunk-PDXMSKQH.mjs +1 -0
  4. package/dist/funcs.d.mts +1 -1
  5. package/dist/funcs.d.ts +1 -1
  6. package/dist/funcs.js +1 -1
  7. package/dist/funcs.mjs +1 -1
  8. package/dist/{index-japi6bEq.d.mts → index-Dgo3ZXPQ.d.mts} +28 -2
  9. package/dist/{index-japi6bEq.d.ts → index-Dgo3ZXPQ.d.ts} +28 -2
  10. package/dist/index.d.mts +369 -53
  11. package/dist/index.d.ts +369 -53
  12. package/dist/index.js +1 -1
  13. package/dist/index.mjs +1 -1
  14. package/docs/README.md +245 -2
  15. package/docs/classes/AbortError.md +8 -8
  16. package/docs/classes/AlreadyExistsError.md +8 -8
  17. package/docs/classes/BaseError.md +8 -8
  18. package/docs/classes/CancelableAbility.md +431 -0
  19. package/docs/classes/ClientTools.md +101 -51
  20. package/docs/classes/CommonError.md +8 -8
  21. package/docs/classes/EventClient.md +123 -73
  22. package/docs/classes/EventServer.md +121 -71
  23. package/docs/classes/EventToolFunc.md +91 -41
  24. package/docs/classes/FStringPromptTemplate.md +18 -18
  25. package/docs/classes/FewShotPromptTemplate.md +22 -22
  26. package/docs/classes/GolangPromptTemplate.md +18 -18
  27. package/docs/classes/HFEnvironment.md +9 -9
  28. package/docs/classes/HFInterpreter.md +39 -17
  29. package/docs/classes/HFTemplate.md +4 -4
  30. package/docs/classes/HfPromptTemplate.md +18 -18
  31. package/docs/classes/IntSet.md +249 -0
  32. package/docs/classes/NotFoundError.md +8 -8
  33. package/docs/classes/NotImplementationError.md +8 -8
  34. package/docs/classes/PromptExampleSelector.md +8 -8
  35. package/docs/classes/PromptTemplate.md +17 -17
  36. package/docs/classes/ReadableStreamError.md +8 -8
  37. package/docs/classes/ResClientTools.md +107 -57
  38. package/docs/classes/ResServerTools.md +105 -55
  39. package/docs/classes/SSEChannel.md +15 -15
  40. package/docs/classes/Semaphore.md +273 -0
  41. package/docs/classes/ServerTools.md +98 -48
  42. package/docs/classes/TaskAbortController.md +157 -0
  43. package/docs/classes/ToolFunc.md +80 -38
  44. package/docs/enums/AsyncFeatureBits.md +41 -0
  45. package/docs/enums/AsyncFeatures.md +41 -0
  46. package/docs/enums/ErrorCode.md +41 -19
  47. package/docs/enums/XXHashAlgorithm.md +2 -2
  48. package/docs/interfaces/AIChatAssistantMessageParam.md +6 -6
  49. package/docs/interfaces/AIChatContentPartImage.md +2 -2
  50. package/docs/interfaces/AIChatContentPartText.md +2 -2
  51. package/docs/interfaces/AIChatMessageParamBase.md +1 -1
  52. package/docs/interfaces/AIChatMessageToolCall.md +3 -3
  53. package/docs/interfaces/AIChatSystemMessageParam.md +3 -3
  54. package/docs/interfaces/AIChatToolMessageParam.md +4 -4
  55. package/docs/interfaces/AIChatUserMessageParam.md +7 -7
  56. package/docs/interfaces/AIResult.md +16 -5
  57. package/docs/interfaces/AIStreamParser.md +1 -1
  58. package/docs/interfaces/AIStreamParserOptions.md +1 -1
  59. package/docs/interfaces/BaseFunc.md +7 -7
  60. package/docs/interfaces/BaseFuncItem.md +6 -6
  61. package/docs/interfaces/CancelableAbilityOptions.md +126 -0
  62. package/docs/interfaces/ClientFuncItem.md +10 -10
  63. package/docs/interfaces/DotenvExpandOptions.md +3 -3
  64. package/docs/interfaces/DotenvExpandOutput.md +2 -2
  65. package/docs/interfaces/EventClientFuncParams.md +4 -4
  66. package/docs/interfaces/EventServerFuncParams.md +5 -5
  67. package/docs/interfaces/FewShotPromptTemplateOptions.md +11 -11
  68. package/docs/interfaces/FuncItem.md +7 -7
  69. package/docs/interfaces/FuncParam.md +16 -5
  70. package/docs/interfaces/PromptExampleSelectorOptions.md +2 -2
  71. package/docs/interfaces/PromptTemplateOptions.md +6 -6
  72. package/docs/interfaces/RemoteFuncItem.md +10 -10
  73. package/docs/interfaces/ResClientFuncParams.md +2 -2
  74. package/docs/interfaces/ResServerFuncParams.md +5 -5
  75. package/docs/interfaces/SanitizeFilenameOptions.md +2 -2
  76. package/docs/interfaces/ServerFuncItem.md +11 -11
  77. package/docs/interfaces/ServerFuncParams.md +2 -2
  78. package/docs/interfaces/StreamCallbacksAndOptions.md +124 -0
  79. package/docs/interfaces/TaskAbortControllers.md +7 -0
  80. package/docs/interfaces/TaskPromise.md +151 -0
  81. package/docs/interfaces/ToolFuncPackage.md +63 -0
  82. package/docs/modules.md +1130 -123
  83. package/package.json +3 -2
  84. package/dist/chunk-PYM7DCYB.mjs +0 -1
  85. package/docs/interfaces/AIStreamCallbacksAndOptions.md +0 -158
package/docs/classes/CancelableAbility.md ADDED
@@ -0,0 +1,431 @@
1
+ [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / CancelableAbility
2
+
3
+ # Class: CancelableAbility
4
+
5
+ ## Indexable
6
+
7
+ ▪ [name: `string`]: `any`
8
+
9
+ ## Table of contents
10
+
11
+ ### Constructors
12
+
13
+ - [constructor](CancelableAbility.md#constructor)
14
+
15
+ ### Properties
16
+
17
+ - [\_\_task\_aborter](CancelableAbility.md#__task_aborter)
18
+ - [\_\_task\_semaphore](CancelableAbility.md#__task_semaphore)
19
+ - [\_asyncFeatures](CancelableAbility.md#_asyncfeatures)
20
+ - [\_maxTaskConcurrency](CancelableAbility.md#_maxtaskconcurrency)
21
+ - [cleanMultiTaskAborter](CancelableAbility.md#cleanmultitaskaborter)
22
+ - [generateAsyncTaskId](CancelableAbility.md#generateasynctaskid)
23
+
24
+ ### Accessors
25
+
26
+ - [maxTaskConcurrency](CancelableAbility.md#maxtaskconcurrency)
27
+ - [semaphore](CancelableAbility.md#semaphore)
28
+
29
+ ### Methods
30
+
31
+ - [$cleanMultiTaskAborter](CancelableAbility.md#$cleanmultitaskaborter)
32
+ - [$generateAsyncTaskId](CancelableAbility.md#$generateasynctaskid)
33
+ - [\_cleanMultiTaskAborter](CancelableAbility.md#_cleanmultitaskaborter)
34
+ - [\_generateAsyncTaskId](CancelableAbility.md#_generateasynctaskid)
35
+ - [abort](CancelableAbility.md#abort)
36
+ - [cleanTaskAborter](CancelableAbility.md#cleantaskaborter)
37
+ - [createAborter](CancelableAbility.md#createaborter)
38
+ - [createTaskPromise](CancelableAbility.md#createtaskpromise)
39
+ - [getRunningTask](CancelableAbility.md#getrunningtask)
40
+ - [getRunningTaskCount](CancelableAbility.md#getrunningtaskcount)
41
+ - [isAborted](CancelableAbility.md#isaborted)
42
+ - [runAsyncCancelableTask](CancelableAbility.md#runasynccancelabletask)
43
+
44
+ ## Constructors
45
+
46
+ ### constructor
47
+
48
+ • **new CancelableAbility**(): [`CancelableAbility`](CancelableAbility.md)
49
+
50
+ #### Returns
51
+
52
+ [`CancelableAbility`](CancelableAbility.md)
53
+
54
+ ## Properties
55
+
56
+ ### \_\_task\_aborter
57
+
58
+ • **\_\_task\_aborter**: `undefined` \| [`TaskAbortController`](TaskAbortController.md) \| [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)
59
+
60
+ #### Defined in
61
+
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
+
64
+ ___
65
+
66
+ ### \_\_task\_semaphore
67
+
68
+ • **\_\_task\_semaphore**: `undefined` \| [`Semaphore`](Semaphore.md)
69
+
70
+ #### Defined in
71
+
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
+
74
+ ___
75
+
76
+ ### \_asyncFeatures
77
+
78
+ • `Optional` **\_asyncFeatures**: `number`
79
+
80
+ #### Defined in
81
+
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
+
84
+ ___
85
+
86
+ ### \_maxTaskConcurrency
87
+
88
+ • **\_maxTaskConcurrency**: `undefined` \| `number`
89
+
90
+ #### Defined in
91
+
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
+
94
+ ___
95
+
96
+ ### cleanMultiTaskAborter
97
+
98
+ • **cleanMultiTaskAborter**: (`id`: [`AsyncTaskId`](../modules.md#asynctaskid), `aborters`: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)) => `void`
99
+
100
+ #### Type declaration
101
+
102
+ ▸ (`id`, `aborters`): `void`
103
+
104
+ ##### Parameters
105
+
106
+ | Name | Type |
107
+ | :------ | :------ |
108
+ | `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
109
+ | `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
110
+
111
+ ##### Returns
112
+
113
+ `void`
114
+
115
+ #### Defined in
116
+
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
+
119
+ ___
120
+
121
+ ### generateAsyncTaskId
122
+
123
+ • **generateAsyncTaskId**: (`taskId?`: [`AsyncTaskId`](../modules.md#asynctaskid), `aborters?`: [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md)) => [`AsyncTaskId`](../modules.md#asynctaskid)
124
+
125
+ #### Type declaration
126
+
127
+ ▸ (`taskId?`, `aborters?`): [`AsyncTaskId`](../modules.md#asynctaskid)
128
+
129
+ ##### Parameters
130
+
131
+ | Name | Type |
132
+ | :------ | :------ |
133
+ | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
134
+ | `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
135
+
136
+ ##### Returns
137
+
138
+ [`AsyncTaskId`](../modules.md#asynctaskid)
139
+
140
+ #### Defined in
141
+
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
+
144
+ ## Accessors
145
+
146
+ ### maxTaskConcurrency
147
+
148
+ • `get` **maxTaskConcurrency**(): `undefined` \| `number`
149
+
150
+ #### Returns
151
+
152
+ `undefined` \| `number`
153
+
154
+ #### Defined in
155
+
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
+
158
+ ___
159
+
160
+ ### semaphore
161
+
162
+ • `get` **semaphore**(): `undefined` \| [`Semaphore`](Semaphore.md)
163
+
164
+ #### Returns
165
+
166
+ `undefined` \| [`Semaphore`](Semaphore.md)
167
+
168
+ #### Defined in
169
+
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
+
172
+ ## Methods
173
+
174
+ ### $cleanMultiTaskAborter
175
+
176
+ ▸ **$cleanMultiTaskAborter**(`id`, `aborters`): `void`
177
+
178
+ #### Parameters
179
+
180
+ | Name | Type |
181
+ | :------ | :------ |
182
+ | `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
183
+ | `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
184
+
185
+ #### Returns
186
+
187
+ `void`
188
+
189
+ #### Defined in
190
+
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
+
193
+ ___
194
+
195
+ ### $generateAsyncTaskId
196
+
197
+ ▸ **$generateAsyncTaskId**(`taskId?`, `aborters?`): `undefined` \| [`AsyncTaskId`](../modules.md#asynctaskid)
198
+
199
+ #### Parameters
200
+
201
+ | Name | Type |
202
+ | :------ | :------ |
203
+ | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
204
+ | `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
205
+
206
+ #### Returns
207
+
208
+ `undefined` \| [`AsyncTaskId`](../modules.md#asynctaskid)
209
+
210
+ #### Defined in
211
+
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
+
214
+ ___
215
+
216
+ ### \_cleanMultiTaskAborter
217
+
218
+ ▸ **_cleanMultiTaskAborter**(`id`, `aborters`): `void`
219
+
220
+ #### Parameters
221
+
222
+ | Name | Type |
223
+ | :------ | :------ |
224
+ | `id` | [`AsyncTaskId`](../modules.md#asynctaskid) |
225
+ | `aborters` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
226
+
227
+ #### Returns
228
+
229
+ `void`
230
+
231
+ #### Defined in
232
+
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
+
235
+ ___
236
+
237
+ ### \_generateAsyncTaskId
238
+
239
+ ▸ **_generateAsyncTaskId**(`taskId?`, `aborters?`): [`AsyncTaskId`](../modules.md#asynctaskid)
240
+
241
+ #### Parameters
242
+
243
+ | Name | Type |
244
+ | :------ | :------ |
245
+ | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
246
+ | `aborters?` | [`TaskAbortControllers`](../interfaces/TaskAbortControllers.md) |
247
+
248
+ #### Returns
249
+
250
+ [`AsyncTaskId`](../modules.md#asynctaskid)
251
+
252
+ #### Defined in
253
+
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
+
256
+ ___
257
+
258
+ ### abort
259
+
260
+ ▸ **abort**(`reason?`, `data?`): `void`
261
+
262
+ #### Parameters
263
+
264
+ | Name | Type |
265
+ | :------ | :------ |
266
+ | `reason?` | `string` |
267
+ | `data?` | `any` |
268
+
269
+ #### Returns
270
+
271
+ `void`
272
+
273
+ #### Defined in
274
+
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
+
277
+ ___
278
+
279
+ ### cleanTaskAborter
280
+
281
+ ▸ **cleanTaskAborter**(`aborter`): `void`
282
+
283
+ #### Parameters
284
+
285
+ | Name | Type |
286
+ | :------ | :------ |
287
+ | `aborter` | [`TaskAbortController`](TaskAbortController.md) |
288
+
289
+ #### Returns
290
+
291
+ `void`
292
+
293
+ #### Defined in
294
+
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
+
297
+ ___
298
+
299
+ ### createAborter
300
+
301
+ ▸ **createAborter**(`params?`, `taskId?`, `raiseError?`): [`TaskAbortController`](TaskAbortController.md)
302
+
303
+ #### Parameters
304
+
305
+ | Name | Type | Default value |
306
+ | :------ | :------ | :------ |
307
+ | `params?` | `any` | `undefined` |
308
+ | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) | `undefined` |
309
+ | `raiseError` | `boolean` | `true` |
310
+
311
+ #### Returns
312
+
313
+ [`TaskAbortController`](TaskAbortController.md)
314
+
315
+ #### Defined in
316
+
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
+
319
+ ___
320
+
321
+ ### createTaskPromise
322
+
323
+ ▸ **createTaskPromise**\<`Output`\>(`runTask`, `params`, `options?`): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
324
+
325
+ #### Type parameters
326
+
327
+ | Name | Type |
328
+ | :------ | :------ |
329
+ | `Output` | `any` |
330
+
331
+ #### Parameters
332
+
333
+ | Name | Type |
334
+ | :------ | :------ |
335
+ | `runTask` | (`params`: `Record`\<`string`, `any`\>, `aborter`: [`TaskAbortController`](TaskAbortController.md)) => `Promise`\<`Output`\> |
336
+ | `params` | `Record`\<`string`, `any`\> |
337
+ | `options?` | `Object` |
338
+ | `options.raiseError?` | `boolean` |
339
+ | `options.taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
340
+
341
+ #### Returns
342
+
343
+ [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
344
+
345
+ #### Defined in
346
+
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
+
349
+ ___
350
+
351
+ ### getRunningTask
352
+
353
+ ▸ **getRunningTask**(`taskId?`): `undefined` \| [`TaskAbortController`](TaskAbortController.md)
354
+
355
+ #### Parameters
356
+
357
+ | Name | Type |
358
+ | :------ | :------ |
359
+ | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
360
+
361
+ #### Returns
362
+
363
+ `undefined` \| [`TaskAbortController`](TaskAbortController.md)
364
+
365
+ #### Defined in
366
+
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
+
369
+ ___
370
+
371
+ ### getRunningTaskCount
372
+
373
+ ▸ **getRunningTaskCount**(): `number`
374
+
375
+ #### Returns
376
+
377
+ `number`
378
+
379
+ #### Defined in
380
+
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
+
383
+ ___
384
+
385
+ ### isAborted
386
+
387
+ ▸ **isAborted**(`taskId?`): `boolean`
388
+
389
+ #### Parameters
390
+
391
+ | Name | Type |
392
+ | :------ | :------ |
393
+ | `taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
394
+
395
+ #### Returns
396
+
397
+ `boolean`
398
+
399
+ #### Defined in
400
+
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
+
403
+ ___
404
+
405
+ ### runAsyncCancelableTask
406
+
407
+ ▸ **runAsyncCancelableTask**\<`Output`\>(`params?`, `runTask`, `options?`): [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
408
+
409
+ #### Type parameters
410
+
411
+ | Name | Type |
412
+ | :------ | :------ |
413
+ | `Output` | `any` |
414
+
415
+ #### Parameters
416
+
417
+ | Name | Type |
418
+ | :------ | :------ |
419
+ | `params` | `Record`\<`string`, `any`\> |
420
+ | `runTask` | (`params`: `Record`\<`string`, `any`\>, `aborter`: [`TaskAbortController`](TaskAbortController.md)) => `Promise`\<`Output`\> |
421
+ | `options?` | `Object` |
422
+ | `options.raiseError?` | `boolean` |
423
+ | `options.taskId?` | [`AsyncTaskId`](../modules.md#asynctaskid) |
424
+
425
+ #### Returns
426
+
427
+ [`TaskPromise`](../interfaces/TaskPromise.md)\<`Output`\>
428
+
429
+ #### Defined in
430
+
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)