@isdk/ai-tool 0.2.0 → 0.2.2

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 (248) hide show
  1. package/dist/chunk-PY6NRGZE.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-nP9lSU6E.d.mts → index-DUEs7T8M.d.mts} +2 -2
  7. package/dist/{index-nP9lSU6E.d.ts → index-DUEs7T8M.d.ts} +2 -2
  8. package/dist/index.d.mts +5 -4
  9. package/dist/index.d.ts +5 -4
  10. package/dist/index.js +1 -1
  11. package/dist/index.mjs +1 -1
  12. package/docs/README.md +5 -3
  13. package/docs/_media/CONTRIBUTING.md +18 -0
  14. package/docs/_media/LICENSE-MIT +22 -0
  15. package/docs/classes/AbortError.md +108 -129
  16. package/docs/classes/AlreadyExistsError.md +105 -126
  17. package/docs/classes/BaseError.md +112 -125
  18. package/docs/classes/CancelableAbility.md +136 -188
  19. package/docs/classes/ClientTools.md +1005 -1107
  20. package/docs/classes/CommonError.md +115 -136
  21. package/docs/classes/ConfigFile.md +150 -163
  22. package/docs/classes/EventClient.md +1128 -1282
  23. package/docs/classes/EventServer.md +1165 -1303
  24. package/docs/classes/EventToolFunc.md +958 -1028
  25. package/docs/classes/FStringPromptTemplate.md +352 -438
  26. package/docs/classes/FewShotPromptTemplate.md +364 -464
  27. package/docs/classes/GolangPromptTemplate.md +352 -438
  28. package/docs/classes/HFEnvironment.md +53 -79
  29. package/docs/classes/HFInterpreter.md +20 -377
  30. package/docs/classes/HFTemplate.md +21 -33
  31. package/docs/classes/HfPromptTemplate.md +352 -438
  32. package/docs/classes/IntSet.md +67 -100
  33. package/docs/classes/NotFoundError.md +105 -126
  34. package/docs/classes/NotImplementationError.md +105 -126
  35. package/docs/classes/PromptExampleSelector.md +58 -70
  36. package/docs/classes/PromptTemplate.md +338 -422
  37. package/docs/classes/ReadableStreamError.md +108 -129
  38. package/docs/classes/ResClientTools.md +916 -1026
  39. package/docs/classes/ResServerTools.md +919 -1026
  40. package/docs/classes/SSEChannel.md +93 -112
  41. package/docs/classes/Semaphore.md +44 -140
  42. package/docs/classes/ServerTools.md +981 -1072
  43. package/docs/classes/TaskAbortController.md +46 -66
  44. package/docs/classes/ToolFunc.md +840 -910
  45. package/docs/enumerations/AsyncFeatureBits.md +37 -0
  46. package/docs/enumerations/AsyncFeatures.md +37 -0
  47. package/docs/enumerations/ErrorCode.md +217 -0
  48. package/docs/enumerations/XXHashAlgorithm.md +27 -0
  49. package/docs/functions/AIArgProcessor.md +27 -0
  50. package/docs/functions/AIStream.md +50 -0
  51. package/docs/functions/ChoiceArgProcessor.md +27 -0
  52. package/docs/functions/RateLimit.md +33 -0
  53. package/docs/functions/TemplateArgProcessor.md +27 -0
  54. package/docs/functions/backendEventable.md +23 -0
  55. package/docs/functions/canonicalize.md +21 -0
  56. package/docs/functions/countRegexMatches.md +33 -0
  57. package/docs/functions/createAbilityInjector.md +87 -0
  58. package/docs/functions/createCallbacksTransformer.md +49 -0
  59. package/docs/functions/createEmptyReadableStream.md +23 -0
  60. package/docs/functions/createEndWithRepetitionDetector.md +29 -0
  61. package/docs/functions/createError.md +35 -0
  62. package/docs/functions/createEventStreamTransformer.md +33 -0
  63. package/docs/functions/createHfValueFunc.md +29 -0
  64. package/docs/functions/createLRUCache.md +23 -0
  65. package/docs/functions/dateToText.md +23 -0
  66. package/docs/functions/expandEnv.md +40 -0
  67. package/docs/functions/expandObjEnv.md +54 -0
  68. package/docs/functions/extNameLevel.md +43 -0
  69. package/docs/functions/fileIsExists.md +34 -0
  70. package/docs/functions/filenameReservedRegex.md +22 -0
  71. package/docs/functions/filterValidFnScope.md +21 -0
  72. package/docs/functions/findPort.md +23 -0
  73. package/docs/functions/formatISO.md +71 -0
  74. package/docs/functions/getAllEnumKeys.md +31 -0
  75. package/docs/functions/getConfigFileNames.md +23 -0
  76. package/docs/functions/getConfigs.md +23 -0
  77. package/docs/functions/getKeysPath.md +38 -0
  78. package/docs/functions/getMultiLevelExtname.md +31 -0
  79. package/docs/functions/getPackageDir.md +39 -0
  80. package/docs/functions/getRealFilepath.md +34 -0
  81. package/docs/functions/getResponseErrorReadableStream.md +21 -0
  82. package/docs/functions/hfParse.md +24 -0
  83. package/docs/functions/hfTokenize.md +25 -0
  84. package/docs/functions/interpolateEnv.md +25 -0
  85. package/docs/functions/interpolateFString.md +27 -0
  86. package/docs/functions/interpolateGolangTemplate.md +31 -0
  87. package/docs/functions/isModelNameMatched.md +45 -0
  88. package/docs/functions/isValidFilename.md +38 -0
  89. package/docs/functions/isValidFilepath.md +27 -0
  90. package/docs/functions/isWebStream.md +21 -0
  91. package/docs/functions/jsonFilterToWhere.md +45 -0
  92. package/docs/functions/jsonToMarkdownStr.md +31 -0
  93. package/docs/functions/loadFileFromPaths.md +54 -0
  94. package/docs/functions/loadTextFromPaths.md +29 -0
  95. package/docs/functions/lrucache.md +29 -0
  96. package/docs/functions/makeToolFuncCancelable.md +23 -0
  97. package/docs/functions/matchUrlProtocol.md +48 -0
  98. package/docs/functions/memoize.md +27 -0
  99. package/docs/functions/messagesToText.md +21 -0
  100. package/docs/functions/paramsSizeToScaleStr.md +32 -0
  101. package/docs/functions/parseCommand.md +33 -0
  102. package/docs/functions/parseDateFormat.md +360 -0
  103. package/docs/functions/parseFString.md +26 -0
  104. package/docs/functions/parseISO.md +72 -0
  105. package/docs/functions/parseJsJson.md +38 -0
  106. package/docs/functions/parseObjectArgInfo.md +27 -0
  107. package/docs/functions/parseObjectArgumentInfos.md +25 -0
  108. package/docs/functions/parseObjectArguments.md +68 -0
  109. package/docs/functions/parseObjectArgumentsAsArgInfos.md +42 -0
  110. package/docs/functions/parseYaml.md +21 -0
  111. package/docs/functions/quoteStr.md +21 -0
  112. package/docs/functions/reControlCharsRegex.md +21 -0
  113. package/docs/functions/readFilenamesRecursiveSync.md +47 -0
  114. package/docs/functions/readableFromAsyncIterable.md +28 -0
  115. package/docs/functions/registerCoreTools.md +17 -0
  116. package/docs/functions/registerYamlTag.md +21 -0
  117. package/docs/functions/sanitizeFilename.md +37 -0
  118. package/docs/functions/sanitizeFilepath.md +31 -0
  119. package/docs/functions/saveConfigFile.md +25 -0
  120. package/docs/functions/scaleStrToParamsSize.md +27 -0
  121. package/docs/functions/simplifyObjectArguments.md +21 -0
  122. package/docs/functions/sortedValues.md +25 -0
  123. package/docs/functions/splitSentence.md +37 -0
  124. package/docs/functions/stringifyYaml.md +49 -0
  125. package/docs/functions/textToDate.md +23 -0
  126. package/docs/functions/throwError.md +37 -0
  127. package/docs/functions/toDate.md +76 -0
  128. package/docs/functions/toDateTime.md +21 -0
  129. package/docs/functions/trimStartOfStreamHelper.md +41 -0
  130. package/docs/functions/truncTo.md +47 -0
  131. package/docs/functions/uuid.md +23 -0
  132. package/docs/functions/uuidParse.md +21 -0
  133. package/docs/functions/uuidStringify.md +23 -0
  134. package/docs/functions/uuidValidate.md +21 -0
  135. package/docs/functions/uuidVersion.md +21 -0
  136. package/docs/functions/uuidv1.md +47 -0
  137. package/docs/functions/uuidv4.md +47 -0
  138. package/docs/functions/uuidv5.md +51 -0
  139. package/docs/functions/wait.md +21 -0
  140. package/docs/functions/xxhash.md +25 -0
  141. package/docs/functions/xxhash32.md +23 -0
  142. package/docs/functions/xxhash64.md +23 -0
  143. package/docs/functions/xxhashAsStr.md +25 -0
  144. package/docs/globals.md +236 -0
  145. package/docs/interfaces/AIChatAssistantMessageParam.md +29 -38
  146. package/docs/interfaces/AIChatContentPartImage.md +11 -16
  147. package/docs/interfaces/AIChatContentPartText.md +9 -12
  148. package/docs/interfaces/AIChatMessageParamBase.md +12 -19
  149. package/docs/interfaces/AIChatMessageToolCall.md +18 -21
  150. package/docs/interfaces/AIChatSystemMessageParam.md +16 -22
  151. package/docs/interfaces/AIChatToolMessageParam.md +19 -26
  152. package/docs/interfaces/AIChatUserMessageParam.md +32 -42
  153. package/docs/interfaces/AIChoiceConfig.md +31 -39
  154. package/docs/interfaces/AIResult.md +29 -32
  155. package/docs/interfaces/AIStreamParser.md +24 -18
  156. package/docs/interfaces/AIStreamParserOptions.md +8 -10
  157. package/docs/interfaces/BaseFunc.md +55 -75
  158. package/docs/interfaces/BaseFuncItem.md +43 -61
  159. package/docs/interfaces/CancelableAbilityOptions.md +43 -54
  160. package/docs/interfaces/ClientFuncItem.md +66 -83
  161. package/docs/interfaces/DotenvExpandOptions.md +15 -19
  162. package/docs/interfaces/DotenvExpandOutput.md +11 -14
  163. package/docs/interfaces/DotenvParseInput.md +6 -2
  164. package/docs/interfaces/DotenvParseOutput.md +6 -2
  165. package/docs/interfaces/DotenvPopulateInput.md +6 -2
  166. package/docs/interfaces/EventClientFuncParams.md +22 -33
  167. package/docs/interfaces/EventServerFuncParams.md +27 -35
  168. package/docs/interfaces/FewShotPromptTemplateOptions.md +58 -74
  169. package/docs/interfaces/FuncItem.md +53 -70
  170. package/docs/interfaces/FuncParam.md +29 -36
  171. package/docs/interfaces/FuncParams.md +6 -2
  172. package/docs/interfaces/Funcs.md +6 -2
  173. package/docs/interfaces/JsonFilter.md +6 -2
  174. package/docs/interfaces/ParseObjectArgumentOptions.md +23 -29
  175. package/docs/interfaces/PromptExampleSelectorOptions.md +13 -16
  176. package/docs/interfaces/PromptTemplateOptions.md +31 -40
  177. package/docs/interfaces/RemoteFuncItem.md +64 -82
  178. package/docs/interfaces/ResClientFuncParams.md +14 -19
  179. package/docs/interfaces/ResServerFuncParams.md +28 -36
  180. package/docs/interfaces/SanitizeFilenameOptions.md +11 -14
  181. package/docs/interfaces/ServerFuncItem.md +70 -88
  182. package/docs/interfaces/ServerFuncParams.md +15 -20
  183. package/docs/interfaces/StreamCallbacksAndOptions.md +36 -65
  184. package/docs/interfaces/TaskAbortControllers.md +6 -2
  185. package/docs/interfaces/TaskPromise.md +48 -61
  186. package/docs/interfaces/ToolFuncPackage.md +18 -32
  187. package/docs/type-aliases/AIChatContentPart.md +13 -0
  188. package/docs/type-aliases/AIChatMessageParam.md +13 -0
  189. package/docs/type-aliases/AIChatRole.md +13 -0
  190. package/docs/type-aliases/AIMessageType.md +13 -0
  191. package/docs/type-aliases/AIModelNameRule.md +13 -0
  192. package/docs/type-aliases/AIModelNameRuleFn.md +21 -0
  193. package/docs/type-aliases/AIModelNameRules.md +13 -0
  194. package/docs/type-aliases/AITextGenerationFinishReason.md +13 -0
  195. package/docs/type-aliases/ActionName.md +13 -0
  196. package/docs/type-aliases/AsyncTaskId.md +13 -0
  197. package/docs/type-aliases/EventErrorListenerFn.md +27 -0
  198. package/docs/type-aliases/EventListenerFn.md +25 -0
  199. package/docs/type-aliases/FStringPromptTemplateNode.md +16 -0
  200. package/docs/type-aliases/FuncParamType.md +13 -0
  201. package/docs/type-aliases/PromptExamples.md +17 -0
  202. package/docs/type-aliases/PromptTemplateType.md +13 -0
  203. package/docs/type-aliases/PromptType.md +13 -0
  204. package/docs/type-aliases/TFunc.md +23 -0
  205. package/docs/variables/AIChatRoles.md +13 -0
  206. package/docs/variables/AIMessageTypes.md +13 -0
  207. package/docs/variables/AITextGenerationFinishReasons.md +13 -0
  208. package/docs/variables/AbortErrorCode.md +13 -0
  209. package/docs/variables/ActionNames.md +13 -0
  210. package/docs/variables/AlreadyExistsErrorCode.md +13 -0
  211. package/docs/variables/ClientToolFuncSchema.md +87 -0
  212. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +13 -0
  213. package/docs/variables/EventBusName.md +13 -0
  214. package/docs/variables/EventName.md +13 -0
  215. package/docs/variables/FilenameReservedRegex.md +16 -0
  216. package/docs/variables/HFBuiltins.md +92 -0
  217. package/docs/variables/InternalErrorCode.md +13 -0
  218. package/docs/variables/NotFoundErrorCode.md +13 -0
  219. package/docs/variables/NotImplementedErrorCode.md +13 -0
  220. package/docs/variables/PASSING_SCORE.md +13 -0
  221. package/docs/variables/PromptTemplateTypes.md +13 -0
  222. package/docs/variables/PromptTypes.md +16 -0
  223. package/docs/variables/RStreamErrCode.md +13 -0
  224. package/docs/variables/RemoteToolFuncSchema.md +87 -0
  225. package/docs/variables/ResponseRStreamErrCode.md +13 -0
  226. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +13 -0
  227. package/docs/variables/ServerToolFuncSchema.md +87 -0
  228. package/docs/variables/ToolAsyncCancelableBit.md +13 -0
  229. package/docs/variables/ToolAsyncMultiTaskBit.md +13 -0
  230. package/docs/variables/ToolAsyncPriorityBit.md +13 -0
  231. package/docs/variables/ToolFuncSchema.md +125 -0
  232. package/docs/variables/WindowsReservedNameRegex.md +15 -0
  233. package/docs/variables/base32768.md +13 -0
  234. package/docs/variables/defaultTemplateFormat.md +13 -0
  235. package/docs/variables/event.md +13 -0
  236. package/docs/variables/eventClient.md +13 -0
  237. package/docs/variables/eventServer.md +13 -0
  238. package/docs/variables/lrucache.md +13 -0
  239. package/docs/variables/mimeType.md +13 -0
  240. package/docs/variables/uuidNIL.md +13 -0
  241. package/package.json +26 -27
  242. package/dist/chunk-W2LO3HZT.mjs +0 -1
  243. package/docs/.nojekyll +0 -1
  244. package/docs/enums/AsyncFeatureBits.md +0 -41
  245. package/docs/enums/AsyncFeatures.md +0 -41
  246. package/docs/enums/ErrorCode.md +0 -239
  247. package/docs/enums/XXHashAlgorithm.md +0 -30
  248. package/docs/modules.md +0 -4062
package/docs/interfaces/BaseFunc.md CHANGED
@@ -1,170 +1,150 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / BaseFunc
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: BaseFunc
4
-
5
- ## Hierarchy
6
-
7
- - [`BaseFuncItem`](BaseFuncItem.md)
8
-
9
- ↳ **`BaseFunc`**
3
+ ***
10
4
 
11
- ↳↳ [`ToolFunc`](../classes/ToolFunc.md)
5
+ [@isdk/ai-tool](../globals.md) / BaseFunc
12
6
 
13
- ## Table of contents
7
+ # Interface: BaseFunc
14
8
 
15
- ### Properties
9
+ ## Extends
16
10
 
17
- - [isApi](BaseFunc.md#isapi)
18
- - [name](BaseFunc.md#name)
19
- - [params](BaseFunc.md#params)
20
- - [result](BaseFunc.md#result)
21
- - [scope](BaseFunc.md#scope)
22
- - [setup](BaseFunc.md#setup)
23
- - [stream](BaseFunc.md#stream)
24
- - [tags](BaseFunc.md#tags)
11
+ - [`BaseFuncItem`](BaseFuncItem.md)
25
12
 
26
- ### Methods
13
+ ## Extended by
27
14
 
28
- - [func](BaseFunc.md#func)
15
+ - [`ToolFunc`](../classes/ToolFunc.md)
29
16
 
30
17
  ## Properties
31
18
 
32
- ### isApi
19
+ ### isApi?
33
20
 
34
- • `Optional` **isApi**: `boolean`
21
+ > `optional` **isApi**: `boolean`
35
22
 
36
23
  #### Inherited from
37
24
 
38
- [BaseFuncItem](BaseFuncItem.md).[isApi](BaseFuncItem.md#isapi)
25
+ [`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
39
26
 
40
27
  #### Defined in
41
28
 
42
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L47)
29
+ [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L47)
43
30
 
44
- ___
31
+ ***
45
32
 
46
- ### name
33
+ ### name?
47
34
 
48
- • `Optional` **name**: `string`
35
+ > `optional` **name**: `string`
49
36
 
50
37
  #### Inherited from
51
38
 
52
- [BaseFuncItem](BaseFuncItem.md).[name](BaseFuncItem.md#name)
39
+ [`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
53
40
 
54
41
  #### Defined in
55
42
 
56
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L41)
43
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L41)
57
44
 
58
- ___
45
+ ***
59
46
 
60
- ### params
47
+ ### params?
61
48
 
62
- • `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
49
+ > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
63
50
 
64
51
  #### Inherited from
65
52
 
66
- [BaseFuncItem](BaseFuncItem.md).[params](BaseFuncItem.md#params)
53
+ [`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
67
54
 
68
55
  #### Defined in
69
56
 
70
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L42)
57
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L42)
71
58
 
72
- ___
59
+ ***
73
60
 
74
- ### result
61
+ ### result?
75
62
 
76
- • `Optional` **result**: `string`
63
+ > `optional` **result**: `string`
77
64
 
78
65
  #### Inherited from
79
66
 
80
- [BaseFuncItem](BaseFuncItem.md).[result](BaseFuncItem.md#result)
67
+ [`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
81
68
 
82
69
  #### Defined in
83
70
 
84
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L43)
71
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L43)
85
72
 
86
- ___
73
+ ***
87
74
 
88
- ### scope
75
+ ### scope?
89
76
 
90
- • `Optional` **scope**: `any`
77
+ > `optional` **scope**: `any`
91
78
 
92
79
  #### Inherited from
93
80
 
94
- [BaseFuncItem](BaseFuncItem.md).[scope](BaseFuncItem.md#scope)
81
+ [`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
95
82
 
96
83
  #### Defined in
97
84
 
98
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L44)
99
-
100
- ___
85
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L44)
101
86
 
102
- ### setup
87
+ ***
103
88
 
104
- • `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
89
+ ### setup()?
105
90
 
106
- #### Type declaration
91
+ > `optional` **setup**: (`this`, `options`?) => `void`
107
92
 
108
- ▸ (`this`, `options?`): `void`
93
+ #### Parameters
109
94
 
110
- ##### Parameters
95
+ • **this**: [`ToolFunc`](../classes/ToolFunc.md)
111
96
 
112
- | Name | Type |
113
- | :------ | :------ |
114
- | `this` | [`ToolFunc`](../classes/ToolFunc.md) |
115
- | `options?` | [`FuncItem`](FuncItem.md) |
97
+ • **options?**: [`FuncItem`](FuncItem.md)
116
98
 
117
- ##### Returns
99
+ #### Returns
118
100
 
119
101
  `void`
120
102
 
121
103
  #### Inherited from
122
104
 
123
- [BaseFuncItem](BaseFuncItem.md).[setup](BaseFuncItem.md#setup)
105
+ [`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
124
106
 
125
107
  #### Defined in
126
108
 
127
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L46)
109
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L46)
128
110
 
129
- ___
111
+ ***
130
112
 
131
- ### stream
113
+ ### stream?
132
114
 
133
- • `Optional` **stream**: `boolean`
115
+ > `optional` **stream**: `boolean`
134
116
 
135
117
  #### Inherited from
136
118
 
137
- [BaseFuncItem](BaseFuncItem.md).[stream](BaseFuncItem.md#stream)
119
+ [`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
138
120
 
139
121
  #### Defined in
140
122
 
141
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L48)
123
+ [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L48)
142
124
 
143
- ___
125
+ ***
144
126
 
145
- ### tags
127
+ ### tags?
146
128
 
147
- • `Optional` **tags**: `string` \| `string`[]
129
+ > `optional` **tags**: `string` \| `string`[]
148
130
 
149
131
  #### Inherited from
150
132
 
151
- [BaseFuncItem](BaseFuncItem.md).[tags](BaseFuncItem.md#tags)
133
+ [`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)
152
134
 
153
135
  #### Defined in
154
136
 
155
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L45)
137
+ [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L45)
156
138
 
157
139
  ## Methods
158
140
 
159
- ### func
141
+ ### func()
160
142
 
161
- ▸ **func**(`...params`): `any`
143
+ > **func**(...`params`): `any`
162
144
 
163
145
  #### Parameters
164
146
 
165
- | Name | Type |
166
- | :------ | :------ |
167
- | `...params` | `any` |
147
+ • ...**params**: `any`
168
148
 
169
149
  #### Returns
170
150
 
@@ -172,4 +152,4 @@ ___
172
152
 
173
153
  #### Defined in
174
154
 
175
- [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L56)
155
+ [packages/ai-tool/src/tool-func.ts:56](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L56)
package/docs/interfaces/BaseFuncItem.md CHANGED
@@ -1,121 +1,103 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / BaseFuncItem
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: BaseFuncItem
4
-
5
- ## Hierarchy
6
-
7
- - **`BaseFuncItem`**
8
-
9
- ↳ [`RemoteFuncItem`](RemoteFuncItem.md)
3
+ ***
10
4
 
11
- ↳ [`FuncItem`](FuncItem.md)
5
+ [@isdk/ai-tool](../globals.md) / BaseFuncItem
12
6
 
13
- ↳ [`BaseFunc`](BaseFunc.md)
14
-
15
- ## Table of contents
7
+ # Interface: BaseFuncItem
16
8
 
17
- ### Properties
9
+ ## Extended by
18
10
 
19
- - [isApi](BaseFuncItem.md#isapi)
20
- - [name](BaseFuncItem.md#name)
21
- - [params](BaseFuncItem.md#params)
22
- - [result](BaseFuncItem.md#result)
23
- - [scope](BaseFuncItem.md#scope)
24
- - [setup](BaseFuncItem.md#setup)
25
- - [stream](BaseFuncItem.md#stream)
26
- - [tags](BaseFuncItem.md#tags)
11
+ - [`RemoteFuncItem`](RemoteFuncItem.md)
12
+ - [`FuncItem`](FuncItem.md)
13
+ - [`BaseFunc`](BaseFunc.md)
27
14
 
28
15
  ## Properties
29
16
 
30
- ### isApi
17
+ ### isApi?
31
18
 
32
- • `Optional` **isApi**: `boolean`
19
+ > `optional` **isApi**: `boolean`
33
20
 
34
21
  #### Defined in
35
22
 
36
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L47)
23
+ [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L47)
37
24
 
38
- ___
25
+ ***
39
26
 
40
- ### name
27
+ ### name?
41
28
 
42
- • `Optional` **name**: `string`
29
+ > `optional` **name**: `string`
43
30
 
44
31
  #### Defined in
45
32
 
46
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L41)
33
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L41)
47
34
 
48
- ___
35
+ ***
49
36
 
50
- ### params
37
+ ### params?
51
38
 
52
- • `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
39
+ > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
53
40
 
54
41
  #### Defined in
55
42
 
56
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L42)
43
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L42)
57
44
 
58
- ___
45
+ ***
59
46
 
60
- ### result
47
+ ### result?
61
48
 
62
- • `Optional` **result**: `string`
49
+ > `optional` **result**: `string`
63
50
 
64
51
  #### Defined in
65
52
 
66
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L43)
53
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L43)
67
54
 
68
- ___
55
+ ***
69
56
 
70
- ### scope
57
+ ### scope?
71
58
 
72
- • `Optional` **scope**: `any`
59
+ > `optional` **scope**: `any`
73
60
 
74
61
  #### Defined in
75
62
 
76
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L44)
77
-
78
- ___
63
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L44)
79
64
 
80
- ### setup
65
+ ***
81
66
 
82
- • `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
67
+ ### setup()?
83
68
 
84
- #### Type declaration
69
+ > `optional` **setup**: (`this`, `options`?) => `void`
85
70
 
86
- ▸ (`this`, `options?`): `void`
71
+ #### Parameters
87
72
 
88
- ##### Parameters
73
+ • **this**: [`ToolFunc`](../classes/ToolFunc.md)
89
74
 
90
- | Name | Type |
91
- | :------ | :------ |
92
- | `this` | [`ToolFunc`](../classes/ToolFunc.md) |
93
- | `options?` | [`FuncItem`](FuncItem.md) |
75
+ • **options?**: [`FuncItem`](FuncItem.md)
94
76
 
95
- ##### Returns
77
+ #### Returns
96
78
 
97
79
  `void`
98
80
 
99
81
  #### Defined in
100
82
 
101
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L46)
83
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L46)
102
84
 
103
- ___
85
+ ***
104
86
 
105
- ### stream
87
+ ### stream?
106
88
 
107
- • `Optional` **stream**: `boolean`
89
+ > `optional` **stream**: `boolean`
108
90
 
109
91
  #### Defined in
110
92
 
111
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L48)
93
+ [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L48)
112
94
 
113
- ___
95
+ ***
114
96
 
115
- ### tags
97
+ ### tags?
116
98
 
117
- • `Optional` **tags**: `string` \| `string`[]
99
+ > `optional` **tags**: `string` \| `string`[]
118
100
 
119
101
  #### Defined in
120
102
 
121
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/tool-func.ts#L45)
103
+ [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L45)
package/docs/interfaces/CancelableAbilityOptions.md CHANGED
@@ -1,126 +1,115 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / CancelableAbilityOptions
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
2
 
3
- # Interface: CancelableAbilityOptions
4
-
5
- ## Hierarchy
6
-
7
- - `AbilityOptions`
3
+ ***
8
4
 
9
- ↳ **`CancelableAbilityOptions`**
5
+ [@isdk/ai-tool](../globals.md) / CancelableAbilityOptions
10
6
 
11
- ## Table of contents
7
+ # Interface: CancelableAbilityOptions
12
8
 
13
- ### Properties
9
+ ## Extends
14
10
 
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)
11
+ - `AbilityOptions`
23
12
 
24
13
  ## Properties
25
14
 
26
- ### asyncFeatures
15
+ ### asyncFeatures?
27
16
 
28
- • `Optional` **asyncFeatures**: [`AsyncFeatures`](../enums/AsyncFeatures.md)
17
+ > `optional` **asyncFeatures**: [`AsyncFeatures`](../enumerations/AsyncFeatures.md)
29
18
 
30
19
  #### Defined in
31
20
 
32
- [packages/ai-tool/src/utils/cancelable-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L11)
21
+ [packages/ai-tool/src/utils/cancelable-ability.ts:11](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L11)
33
22
 
34
- ___
23
+ ***
35
24
 
36
- ### classMethods
25
+ ### classMethods?
37
26
 
38
- • `Optional` **classMethods**: `Record`\<`string`, `Function`\>
27
+ > `optional` **classMethods**: `Record`\<`string`, `Function`\>
39
28
 
40
29
  #### Inherited from
41
30
 
42
- AbilityOptions.classMethods
31
+ `AbilityOptions.classMethods`
43
32
 
44
33
  #### Defined in
45
34
 
46
- node_modules/.pnpm/custom-ability@2.0.0/node_modules/custom-ability/lib/custom-ability.d.ts:13
35
+ node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:13
47
36
 
48
- ___
37
+ ***
49
38
 
50
- ### exclude
39
+ ### exclude?
51
40
 
52
- • `Optional` **exclude**: `string` \| `string`[]
41
+ > `optional` **exclude**: `string` \| `string`[]
53
42
 
54
43
  #### Inherited from
55
44
 
56
- AbilityOptions.exclude
45
+ `AbilityOptions.exclude`
57
46
 
58
47
  #### Defined in
59
48
 
60
- node_modules/.pnpm/custom-ability@2.0.0/node_modules/custom-ability/lib/custom-ability.d.ts:11
49
+ node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:11
61
50
 
62
- ___
51
+ ***
63
52
 
64
- ### id
53
+ ### id?
65
54
 
66
- • `Optional` **id**: `string`
55
+ > `optional` **id**: `string`
67
56
 
68
57
  #### Inherited from
69
58
 
70
- AbilityOptions.id
59
+ `AbilityOptions.id`
71
60
 
72
61
  #### Defined in
73
62
 
74
- node_modules/.pnpm/custom-ability@2.0.0/node_modules/custom-ability/lib/custom-ability.d.ts:8
63
+ node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:8
75
64
 
76
- ___
65
+ ***
77
66
 
78
- ### include
67
+ ### include?
79
68
 
80
- • `Optional` **include**: `string` \| `string`[]
69
+ > `optional` **include**: `string` \| `string`[]
81
70
 
82
71
  #### Inherited from
83
72
 
84
- AbilityOptions.include
73
+ `AbilityOptions.include`
85
74
 
86
75
  #### Defined in
87
76
 
88
- node_modules/.pnpm/custom-ability@2.0.0/node_modules/custom-ability/lib/custom-ability.d.ts:10
77
+ node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:10
89
78
 
90
- ___
79
+ ***
91
80
 
92
- ### maxTaskConcurrency
81
+ ### maxTaskConcurrency?
93
82
 
94
- • `Optional` **maxTaskConcurrency**: `number`
83
+ > `optional` **maxTaskConcurrency**: `number`
95
84
 
96
85
  #### Defined in
97
86
 
98
- [packages/ai-tool/src/utils/cancelable-ability.ts:12](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/cancelable-ability.ts#L12)
87
+ [packages/ai-tool/src/utils/cancelable-ability.ts:12](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/cancelable-ability.ts#L12)
99
88
 
100
- ___
89
+ ***
101
90
 
102
- ### methods
91
+ ### methods?
103
92
 
104
- • `Optional` **methods**: `Record`\<`string`, `Function`\>
93
+ > `optional` **methods**: `Record`\<`string`, `Function`\>
105
94
 
106
95
  #### Inherited from
107
96
 
108
- AbilityOptions.methods
97
+ `AbilityOptions.methods`
109
98
 
110
99
  #### Defined in
111
100
 
112
- node_modules/.pnpm/custom-ability@2.0.0/node_modules/custom-ability/lib/custom-ability.d.ts:12
101
+ node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:12
113
102
 
114
- ___
103
+ ***
115
104
 
116
- ### mode
105
+ ### mode?
117
106
 
118
- • `Optional` **mode**: `number`
107
+ > `optional` **mode**: `number`
119
108
 
120
109
  #### Inherited from
121
110
 
122
- AbilityOptions.mode
111
+ `AbilityOptions.mode`
123
112
 
124
113
  #### Defined in
125
114
 
126
- node_modules/.pnpm/custom-ability@2.0.0/node_modules/custom-ability/lib/custom-ability.d.ts:9
115
+ node\_modules/.pnpm/custom-ability@2.0.0/node\_modules/custom-ability/lib/custom-ability.d.ts:9