@isdk/ai-tool 0.0.7 → 0.0.8

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 (82) hide show
  1. package/dist/chunk-B7IE5ATQ.mjs +1 -0
  2. package/dist/funcs.d.mts +1 -1
  3. package/dist/funcs.d.ts +1 -1
  4. package/dist/funcs.js +1 -1
  5. package/dist/funcs.mjs +1 -1
  6. package/dist/{index-japi6bEq.d.mts → index-Dgo3ZXPQ.d.mts} +28 -2
  7. package/dist/{index-japi6bEq.d.ts → index-Dgo3ZXPQ.d.ts} +28 -2
  8. package/dist/index.d.mts +361 -52
  9. package/dist/index.d.ts +361 -52
  10. package/dist/index.js +1 -1
  11. package/dist/index.mjs +1 -1
  12. package/docs/classes/AbortError.md +8 -8
  13. package/docs/classes/AlreadyExistsError.md +8 -8
  14. package/docs/classes/BaseError.md +8 -8
  15. package/docs/classes/CancelableAbility.md +431 -0
  16. package/docs/classes/ClientTools.md +101 -51
  17. package/docs/classes/CommonError.md +8 -8
  18. package/docs/classes/EventClient.md +123 -73
  19. package/docs/classes/EventServer.md +121 -71
  20. package/docs/classes/EventToolFunc.md +91 -41
  21. package/docs/classes/FStringPromptTemplate.md +18 -18
  22. package/docs/classes/FewShotPromptTemplate.md +22 -22
  23. package/docs/classes/GolangPromptTemplate.md +18 -18
  24. package/docs/classes/HFEnvironment.md +9 -9
  25. package/docs/classes/HFInterpreter.md +17 -17
  26. package/docs/classes/HFTemplate.md +4 -4
  27. package/docs/classes/HfPromptTemplate.md +18 -18
  28. package/docs/classes/IntSet.md +249 -0
  29. package/docs/classes/NotFoundError.md +8 -8
  30. package/docs/classes/NotImplementationError.md +8 -8
  31. package/docs/classes/PromptExampleSelector.md +8 -8
  32. package/docs/classes/PromptTemplate.md +17 -17
  33. package/docs/classes/ReadableStreamError.md +8 -8
  34. package/docs/classes/ResClientTools.md +107 -57
  35. package/docs/classes/ResServerTools.md +105 -55
  36. package/docs/classes/SSEChannel.md +15 -15
  37. package/docs/classes/Semaphore.md +273 -0
  38. package/docs/classes/ServerTools.md +98 -48
  39. package/docs/classes/TaskAbortController.md +157 -0
  40. package/docs/classes/ToolFunc.md +80 -38
  41. package/docs/enums/AsyncFeatureBits.md +41 -0
  42. package/docs/enums/AsyncFeatures.md +41 -0
  43. package/docs/enums/ErrorCode.md +41 -19
  44. package/docs/enums/XXHashAlgorithm.md +2 -2
  45. package/docs/interfaces/AIChatAssistantMessageParam.md +6 -6
  46. package/docs/interfaces/AIChatContentPartImage.md +2 -2
  47. package/docs/interfaces/AIChatContentPartText.md +2 -2
  48. package/docs/interfaces/AIChatMessageParamBase.md +1 -1
  49. package/docs/interfaces/AIChatMessageToolCall.md +3 -3
  50. package/docs/interfaces/AIChatSystemMessageParam.md +3 -3
  51. package/docs/interfaces/AIChatToolMessageParam.md +4 -4
  52. package/docs/interfaces/AIChatUserMessageParam.md +7 -7
  53. package/docs/interfaces/AIResult.md +16 -5
  54. package/docs/interfaces/AIStreamParser.md +1 -1
  55. package/docs/interfaces/AIStreamParserOptions.md +1 -1
  56. package/docs/interfaces/BaseFunc.md +7 -7
  57. package/docs/interfaces/BaseFuncItem.md +6 -6
  58. package/docs/interfaces/CancelableAbilityOptions.md +126 -0
  59. package/docs/interfaces/ClientFuncItem.md +10 -10
  60. package/docs/interfaces/DotenvExpandOptions.md +3 -3
  61. package/docs/interfaces/DotenvExpandOutput.md +2 -2
  62. package/docs/interfaces/EventClientFuncParams.md +4 -4
  63. package/docs/interfaces/EventServerFuncParams.md +5 -5
  64. package/docs/interfaces/FewShotPromptTemplateOptions.md +11 -11
  65. package/docs/interfaces/FuncItem.md +7 -7
  66. package/docs/interfaces/FuncParam.md +16 -5
  67. package/docs/interfaces/PromptExampleSelectorOptions.md +2 -2
  68. package/docs/interfaces/PromptTemplateOptions.md +6 -6
  69. package/docs/interfaces/RemoteFuncItem.md +10 -10
  70. package/docs/interfaces/ResClientFuncParams.md +2 -2
  71. package/docs/interfaces/ResServerFuncParams.md +5 -5
  72. package/docs/interfaces/SanitizeFilenameOptions.md +2 -2
  73. package/docs/interfaces/ServerFuncItem.md +11 -11
  74. package/docs/interfaces/ServerFuncParams.md +2 -2
  75. package/docs/interfaces/StreamCallbacksAndOptions.md +124 -0
  76. package/docs/interfaces/TaskAbortControllers.md +7 -0
  77. package/docs/interfaces/TaskPromise.md +151 -0
  78. package/docs/interfaces/ToolFuncPackage.md +63 -0
  79. package/docs/modules.md +1124 -120
  80. package/package.json +3 -2
  81. package/dist/chunk-PYM7DCYB.mjs +0 -1
  82. package/docs/interfaces/AIStreamCallbacksAndOptions.md +0 -158
package/docs/interfaces/CancelableAbilityOptions.md ADDED
@@ -0,0 +1,126 @@
1
+ [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / CancelableAbilityOptions
2
+
3
+ # Interface: CancelableAbilityOptions
4
+
5
+ ## Hierarchy
6
+
7
+ - `AbilityOptions`
8
+
9
+ ↳ **`CancelableAbilityOptions`**
10
+
11
+ ## Table of contents
12
+
13
+ ### Properties
14
+
15
+ - [asyncFeatures](CancelableAbilityOptions.md#asyncfeatures)
16
+ - [classMethods](CancelableAbilityOptions.md#classmethods)
17
+ - [exclude](CancelableAbilityOptions.md#exclude)
18
+ - [id](CancelableAbilityOptions.md#id)
19
+ - [include](CancelableAbilityOptions.md#include)
20
+ - [maxTaskConcurrency](CancelableAbilityOptions.md#maxtaskconcurrency)
21
+ - [methods](CancelableAbilityOptions.md#methods)
22
+ - [mode](CancelableAbilityOptions.md#mode)
23
+
24
+ ## Properties
25
+
26
+ ### asyncFeatures
27
+
28
+ • `Optional` **asyncFeatures**: [`AsyncFeatures`](../enums/AsyncFeatures.md)
29
+
30
+ #### Defined in
31
+
32
+ [packages/ai-tool/src/utils/cancelable-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L11)
33
+
34
+ ___
35
+
36
+ ### classMethods
37
+
38
+ • `Optional` **classMethods**: `Record`\<`string`, `Function`\>
39
+
40
+ #### Inherited from
41
+
42
+ AbilityOptions.classMethods
43
+
44
+ #### Defined in
45
+
46
+ node_modules/.pnpm/custom-ability@2.0.0-alpha.7/node_modules/custom-ability/lib/custom-ability.d.ts:13
47
+
48
+ ___
49
+
50
+ ### exclude
51
+
52
+ • `Optional` **exclude**: `string` \| `string`[]
53
+
54
+ #### Inherited from
55
+
56
+ AbilityOptions.exclude
57
+
58
+ #### Defined in
59
+
60
+ node_modules/.pnpm/custom-ability@2.0.0-alpha.7/node_modules/custom-ability/lib/custom-ability.d.ts:11
61
+
62
+ ___
63
+
64
+ ### id
65
+
66
+ • `Optional` **id**: `string`
67
+
68
+ #### Inherited from
69
+
70
+ AbilityOptions.id
71
+
72
+ #### Defined in
73
+
74
+ node_modules/.pnpm/custom-ability@2.0.0-alpha.7/node_modules/custom-ability/lib/custom-ability.d.ts:8
75
+
76
+ ___
77
+
78
+ ### include
79
+
80
+ • `Optional` **include**: `string` \| `string`[]
81
+
82
+ #### Inherited from
83
+
84
+ AbilityOptions.include
85
+
86
+ #### Defined in
87
+
88
+ node_modules/.pnpm/custom-ability@2.0.0-alpha.7/node_modules/custom-ability/lib/custom-ability.d.ts:10
89
+
90
+ ___
91
+
92
+ ### maxTaskConcurrency
93
+
94
+ • `Optional` **maxTaskConcurrency**: `number`
95
+
96
+ #### Defined in
97
+
98
+ [packages/ai-tool/src/utils/cancelable-ability.ts:12](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/cancelable-ability.ts#L12)
99
+
100
+ ___
101
+
102
+ ### methods
103
+
104
+ • `Optional` **methods**: `Record`\<`string`, `Function`\>
105
+
106
+ #### Inherited from
107
+
108
+ AbilityOptions.methods
109
+
110
+ #### Defined in
111
+
112
+ node_modules/.pnpm/custom-ability@2.0.0-alpha.7/node_modules/custom-ability/lib/custom-ability.d.ts:12
113
+
114
+ ___
115
+
116
+ ### mode
117
+
118
+ • `Optional` **mode**: `number`
119
+
120
+ #### Inherited from
121
+
122
+ AbilityOptions.mode
123
+
124
+ #### Defined in
125
+
126
+ node_modules/.pnpm/custom-ability@2.0.0-alpha.7/node_modules/custom-ability/lib/custom-ability.d.ts:9
package/docs/interfaces/ClientFuncItem.md CHANGED
@@ -37,7 +37,7 @@
37
37
 
38
38
  #### Defined in
39
39
 
40
- [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/consts.ts#L36)
40
+ [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L36)
41
41
 
42
42
  ___
43
43
 
@@ -51,7 +51,7 @@ ___
51
51
 
52
52
  #### Defined in
53
53
 
54
- [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/consts.ts#L35)
54
+ [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L35)
55
55
 
56
56
  ___
57
57
 
@@ -65,7 +65,7 @@ ___
65
65
 
66
66
  #### Defined in
67
67
 
68
- [packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/consts.ts#L37)
68
+ [packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L37)
69
69
 
70
70
  ___
71
71
 
@@ -79,7 +79,7 @@ ___
79
79
 
80
80
  #### Defined in
81
81
 
82
- [packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L21)
82
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L41)
83
83
 
84
84
  ___
85
85
 
@@ -93,7 +93,7 @@ ___
93
93
 
94
94
  #### Defined in
95
95
 
96
- [packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L22)
96
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L42)
97
97
 
98
98
  ___
99
99
 
@@ -107,7 +107,7 @@ ___
107
107
 
108
108
  #### Defined in
109
109
 
110
- [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L23)
110
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L43)
111
111
 
112
112
  ___
113
113
 
@@ -121,7 +121,7 @@ ___
121
121
 
122
122
  #### Defined in
123
123
 
124
- [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L24)
124
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L44)
125
125
 
126
126
  ___
127
127
 
@@ -150,7 +150,7 @@ ___
150
150
 
151
151
  #### Defined in
152
152
 
153
- [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L26)
153
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L46)
154
154
 
155
155
  ___
156
156
 
@@ -164,7 +164,7 @@ ___
164
164
 
165
165
  #### Defined in
166
166
 
167
- [packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/consts.ts#L38)
167
+ [packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/consts.ts#L38)
168
168
 
169
169
  ___
170
170
 
@@ -178,4 +178,4 @@ ___
178
178
 
179
179
  #### Defined in
180
180
 
181
- [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L25)
181
+ [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L45)
package/docs/interfaces/DotenvExpandOptions.md CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/ai-tool/src/utils/prompt/template/env.ts:188](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/template/env.ts#L188)
21
+ [packages/ai-tool/src/utils/prompt/template/env.ts:188](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/template/env.ts#L188)
22
22
 
23
23
  ___
24
24
 
@@ -32,7 +32,7 @@ Object coming from dotenv's parsed result.
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/ai-tool/src/utils/prompt/template/env.ts:204](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/template/env.ts#L204)
35
+ [packages/ai-tool/src/utils/prompt/template/env.ts:204](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/template/env.ts#L204)
36
36
 
37
37
  ___
38
38
 
@@ -48,4 +48,4 @@ example: `const processEnv = {}; require('dotenv').config({ processEnv: processE
48
48
 
49
49
  #### Defined in
50
50
 
51
- [packages/ai-tool/src/utils/prompt/template/env.ts:197](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/template/env.ts#L197)
51
+ [packages/ai-tool/src/utils/prompt/template/env.ts:197](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/template/env.ts#L197)
package/docs/interfaces/DotenvExpandOutput.md CHANGED
@@ -17,7 +17,7 @@
17
17
 
18
18
  #### Defined in
19
19
 
20
- [packages/ai-tool/src/utils/prompt/template/env.ts:208](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/template/env.ts#L208)
20
+ [packages/ai-tool/src/utils/prompt/template/env.ts:208](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/template/env.ts#L208)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [packages/ai-tool/src/utils/prompt/template/env.ts:209](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/template/env.ts#L209)
30
+ [packages/ai-tool/src/utils/prompt/template/env.ts:209](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/template/env.ts#L209)
package/docs/interfaces/EventClientFuncParams.md CHANGED
@@ -19,7 +19,7 @@
19
19
 
20
20
  #### Defined in
21
21
 
22
- [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/funcs/event-client.ts#L8)
22
+ [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/funcs/event-client.ts#L8)
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/funcs/event-client.ts#L7)
32
+ [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/funcs/event-client.ts#L7)
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/funcs/event-client.ts#L6)
42
+ [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/funcs/event-client.ts#L6)
43
43
 
44
44
  ___
45
45
 
@@ -63,4 +63,4 @@ ___
63
63
 
64
64
  #### Defined in
65
65
 
66
- [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/funcs/event-client.ts#L9)
66
+ [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/funcs/event-client.ts#L9)
package/docs/interfaces/EventServerFuncParams.md CHANGED
@@ -32,7 +32,7 @@ Convention: Always pass _req, _res
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/server-tools.ts#L9)
35
+ [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/server-tools.ts#L9)
36
36
 
37
37
  ___
38
38
 
@@ -46,7 +46,7 @@ ___
46
46
 
47
47
  #### Defined in
48
48
 
49
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/server-tools.ts#L10)
49
+ [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/server-tools.ts#L10)
50
50
 
51
51
  ___
52
52
 
@@ -56,7 +56,7 @@ ___
56
56
 
57
57
  #### Defined in
58
58
 
59
- [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/funcs/event-server.ts#L15)
59
+ [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/funcs/event-server.ts#L15)
60
60
 
61
61
  ___
62
62
 
@@ -66,7 +66,7 @@ ___
66
66
 
67
67
  #### Defined in
68
68
 
69
- [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/funcs/event-server.ts#L14)
69
+ [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/funcs/event-server.ts#L14)
70
70
 
71
71
  ___
72
72
 
@@ -76,4 +76,4 @@ ___
76
76
 
77
77
  #### Defined in
78
78
 
79
- [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/funcs/event-server.ts#L13)
79
+ [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/funcs/event-server.ts#L13)
package/docs/interfaces/FewShotPromptTemplateOptions.md CHANGED
@@ -42,7 +42,7 @@
42
42
 
43
43
  #### Defined in
44
44
 
45
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L15)
45
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L15)
46
46
 
47
47
  ___
48
48
 
@@ -56,7 +56,7 @@ ___
56
56
 
57
57
  #### Defined in
58
58
 
59
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L12)
59
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L12)
60
60
 
61
61
  ___
62
62
 
@@ -68,7 +68,7 @@ An [PromptTemplate](../classes/PromptTemplate.md) used to format a single exampl
68
68
 
69
69
  #### Defined in
70
70
 
71
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/few-shot-prompt-template.ts#L19)
71
+ [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/few-shot-prompt-template.ts#L19)
72
72
 
73
73
  ___
74
74
 
@@ -80,7 +80,7 @@ String separator used to join the prefix, the examples, and suffix.
80
80
 
81
81
  #### Defined in
82
82
 
83
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/few-shot-prompt-template.ts#L24)
83
+ [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/few-shot-prompt-template.ts#L24)
84
84
 
85
85
  ___
86
86
 
@@ -92,7 +92,7 @@ The few shot examples to use in the prompt.
92
92
 
93
93
  #### Defined in
94
94
 
95
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/few-shot-prompt-template.ts#L14)
95
+ [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/few-shot-prompt-template.ts#L14)
96
96
 
97
97
  ___
98
98
 
@@ -106,7 +106,7 @@ ___
106
106
 
107
107
  #### Defined in
108
108
 
109
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L16)
109
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L16)
110
110
 
111
111
  ___
112
112
 
@@ -120,7 +120,7 @@ ___
120
120
 
121
121
  #### Defined in
122
122
 
123
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L14)
123
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L14)
124
124
 
125
125
  ___
126
126
 
@@ -136,7 +136,7 @@ A prompt template string to put before the examples.
136
136
 
137
137
  #### Defined in
138
138
 
139
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/few-shot-prompt-template.ts#L31)
139
+ [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/few-shot-prompt-template.ts#L31)
140
140
 
141
141
  ___
142
142
 
@@ -148,7 +148,7 @@ A prompt template string to put after the examples.
148
148
 
149
149
  #### Defined in
150
150
 
151
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/few-shot-prompt-template.ts#L36)
151
+ [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/few-shot-prompt-template.ts#L36)
152
152
 
153
153
  ___
154
154
 
@@ -162,7 +162,7 @@ ___
162
162
 
163
163
  #### Defined in
164
164
 
165
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L11)
165
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L11)
166
166
 
167
167
  ___
168
168
 
@@ -176,4 +176,4 @@ ___
176
176
 
177
177
  #### Defined in
178
178
 
179
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L13)
179
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L13)
package/docs/interfaces/FuncItem.md CHANGED
@@ -28,7 +28,7 @@
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L30)
31
+ [packages/ai-tool/src/tool-func.ts:50](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L50)
32
32
 
33
33
  ___
34
34
 
@@ -42,7 +42,7 @@ ___
42
42
 
43
43
  #### Defined in
44
44
 
45
- [packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L21)
45
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L41)
46
46
 
47
47
  ___
48
48
 
@@ -56,7 +56,7 @@ ___
56
56
 
57
57
  #### Defined in
58
58
 
59
- [packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L22)
59
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L42)
60
60
 
61
61
  ___
62
62
 
@@ -70,7 +70,7 @@ ___
70
70
 
71
71
  #### Defined in
72
72
 
73
- [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L23)
73
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L43)
74
74
 
75
75
  ___
76
76
 
@@ -84,7 +84,7 @@ ___
84
84
 
85
85
  #### Defined in
86
86
 
87
- [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L24)
87
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L44)
88
88
 
89
89
  ___
90
90
 
@@ -113,7 +113,7 @@ ___
113
113
 
114
114
  #### Defined in
115
115
 
116
- [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L26)
116
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L46)
117
117
 
118
118
  ___
119
119
 
@@ -127,4 +127,4 @@ ___
127
127
 
128
128
  #### Defined in
129
129
 
130
- [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L25)
130
+ [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L45)
package/docs/interfaces/FuncParam.md CHANGED
@@ -6,6 +6,7 @@
6
6
 
7
7
  ### Properties
8
8
 
9
+ - [asyncFeatures](FuncParam.md#asyncfeatures)
9
10
  - [depends](FuncParam.md#depends)
10
11
  - [description](FuncParam.md#description)
11
12
  - [name](FuncParam.md#name)
@@ -14,6 +15,16 @@
14
15
 
15
16
  ## Properties
16
17
 
18
+ ### asyncFeatures
19
+
20
+ • `Optional` **asyncFeatures**: `number`
21
+
22
+ #### Defined in
23
+
24
+ [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L30)
25
+
26
+ ___
27
+
17
28
  ### depends
18
29
 
19
30
  • `Optional` **depends**: `Object`
@@ -24,7 +35,7 @@
24
35
 
25
36
  #### Defined in
26
37
 
27
- [packages/ai-tool/src/tool-func.ts:11](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L11)
38
+ [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L31)
28
39
 
29
40
  ___
30
41
 
@@ -34,7 +45,7 @@ ___
34
45
 
35
46
  #### Defined in
36
47
 
37
- [packages/ai-tool/src/tool-func.ts:10](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L10)
48
+ [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L29)
38
49
 
39
50
  ___
40
51
 
@@ -44,7 +55,7 @@ ___
44
55
 
45
56
  #### Defined in
46
57
 
47
- [packages/ai-tool/src/tool-func.ts:7](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L7)
58
+ [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L26)
48
59
 
49
60
  ___
50
61
 
@@ -54,7 +65,7 @@ ___
54
65
 
55
66
  #### Defined in
56
67
 
57
- [packages/ai-tool/src/tool-func.ts:9](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L9)
68
+ [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L28)
58
69
 
59
70
  ___
60
71
 
@@ -64,4 +75,4 @@ ___
64
75
 
65
76
  #### Defined in
66
77
 
67
- [packages/ai-tool/src/tool-func.ts:8](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/tool-func.ts#L8)
78
+ [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/tool-func.ts#L27)
package/docs/interfaces/PromptExampleSelectorOptions.md CHANGED
@@ -23,7 +23,7 @@ The maximum count of the selected examples, or `undefined` if no limit.
23
23
 
24
24
  #### Defined in
25
25
 
26
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-example-selector.ts#L9)
26
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-example-selector.ts#L9)
27
27
 
28
28
  ___
29
29
 
@@ -36,4 +36,4 @@ If `true`, defaults to 0.5; if `false`, disable it.
36
36
 
37
37
  #### Defined in
38
38
 
39
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-example-selector.ts#L14)
39
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-example-selector.ts#L14)
package/docs/interfaces/PromptTemplateOptions.md CHANGED
@@ -31,7 +31,7 @@
31
31
 
32
32
  #### Defined in
33
33
 
34
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L15)
34
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L15)
35
35
 
36
36
  ___
37
37
 
@@ -41,7 +41,7 @@ ___
41
41
 
42
42
  #### Defined in
43
43
 
44
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L12)
44
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L12)
45
45
 
46
46
  ___
47
47
 
@@ -51,7 +51,7 @@ ___
51
51
 
52
52
  #### Defined in
53
53
 
54
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L16)
54
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L16)
55
55
 
56
56
  ___
57
57
 
@@ -61,7 +61,7 @@ ___
61
61
 
62
62
  #### Defined in
63
63
 
64
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L14)
64
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L14)
65
65
 
66
66
  ___
67
67
 
@@ -71,7 +71,7 @@ ___
71
71
 
72
72
  #### Defined in
73
73
 
74
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L11)
74
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L11)
75
75
 
76
76
  ___
77
77
 
@@ -81,4 +81,4 @@ ___
81
81
 
82
82
  #### Defined in
83
83
 
84
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/8de1e0420acc6b174e70aae08e16e1ba780f842c/src/utils/prompt/prompt-template.ts#L13)
84
+ [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/787e914a1f5dab2d24312399a6f123f0e8360403/src/utils/prompt/prompt-template.ts#L13)