@isdk/ai-tool 0.3.0 → 0.5.0

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 (296) hide show
  1. package/dist/chunk-VIG2GB47.mjs +39 -1
  2. package/dist/chunk-VJ45JQBR.mjs +7829 -0
  3. package/dist/funcs.d.mts +3 -2
  4. package/dist/funcs.d.ts +3 -2
  5. package/dist/funcs.js +5156 -1
  6. package/dist/funcs.mjs +29 -1
  7. package/dist/index-Br-4ZYgE.d.mts +892 -0
  8. package/dist/index-Br-4ZYgE.d.ts +892 -0
  9. package/dist/index.d.mts +206 -238
  10. package/dist/index.d.ts +206 -238
  11. package/dist/index.js +8132 -1
  12. package/dist/index.mjs +476 -1
  13. package/dist/test/util.js +101 -1
  14. package/dist/test/util.mjs +30 -1
  15. package/package.json +31 -31
  16. package/dist/chunk-JHHFTTVE.mjs +0 -1
  17. package/dist/index-BC3GQn6-.d.mts +0 -488
  18. package/dist/index-BC3GQn6-.d.ts +0 -488
  19. package/docs/README.md +0 -250
  20. package/docs/_media/CONTRIBUTING.md +0 -18
  21. package/docs/_media/LICENSE-MIT +0 -22
  22. package/docs/classes/AbortError.md +0 -368
  23. package/docs/classes/AlreadyExistsError.md +0 -348
  24. package/docs/classes/BaseError.md +0 -359
  25. package/docs/classes/CancelableAbility.md +0 -379
  26. package/docs/classes/ClientTools.md +0 -2691
  27. package/docs/classes/CommonError.md +0 -377
  28. package/docs/classes/ConfigFile.md +0 -333
  29. package/docs/classes/EventClient.md +0 -3119
  30. package/docs/classes/EventServer.md +0 -3149
  31. package/docs/classes/EventToolFunc.md +0 -2533
  32. package/docs/classes/FStringPromptTemplate.md +0 -1150
  33. package/docs/classes/FewShotPromptTemplate.md +0 -1186
  34. package/docs/classes/GolangPromptTemplate.md +0 -1150
  35. package/docs/classes/HFEnvironment.md +0 -186
  36. package/docs/classes/HFInterpreter.md +0 -75
  37. package/docs/classes/HFTemplate.md +0 -67
  38. package/docs/classes/HfPromptTemplate.md +0 -1150
  39. package/docs/classes/IntSet.md +0 -216
  40. package/docs/classes/NotFoundError.md +0 -348
  41. package/docs/classes/NotImplementationError.md +0 -348
  42. package/docs/classes/PromptExampleSelector.md +0 -195
  43. package/docs/classes/PromptTemplate.md +0 -1079
  44. package/docs/classes/ReadableStreamError.md +0 -368
  45. package/docs/classes/ResClientTools.md +0 -2399
  46. package/docs/classes/ResServerTools.md +0 -2385
  47. package/docs/classes/SSEChannel.md +0 -270
  48. package/docs/classes/Semaphore.md +0 -177
  49. package/docs/classes/ServerTools.md +0 -2609
  50. package/docs/classes/TaskAbortController.md +0 -137
  51. package/docs/classes/ToolFunc.md +0 -2147
  52. package/docs/classes/YamlTypeBaseObject.md +0 -29
  53. package/docs/enumerations/AsyncFeatureBits.md +0 -37
  54. package/docs/enumerations/AsyncFeatures.md +0 -37
  55. package/docs/enumerations/ErrorCode.md +0 -217
  56. package/docs/enumerations/HashAlgorithm.md +0 -117
  57. package/docs/functions/AIArgProcessor.md +0 -27
  58. package/docs/functions/AIStream.md +0 -50
  59. package/docs/functions/ChoiceArgProcessor.md +0 -27
  60. package/docs/functions/RateLimit.md +0 -33
  61. package/docs/functions/TemplateArgProcessor.md +0 -27
  62. package/docs/functions/backendEventable.md +0 -23
  63. package/docs/functions/canonicalize.md +0 -21
  64. package/docs/functions/completeSentences.md +0 -23
  65. package/docs/functions/concatText.md +0 -23
  66. package/docs/functions/countLLMTokens.md +0 -23
  67. package/docs/functions/countRegexMatches.md +0 -33
  68. package/docs/functions/createAbilityInjector.md +0 -87
  69. package/docs/functions/createCallbacksTransformer.md +0 -49
  70. package/docs/functions/createEmptyReadableStream.md +0 -23
  71. package/docs/functions/createEndWithRepetitionDetector.md +0 -29
  72. package/docs/functions/createError.md +0 -35
  73. package/docs/functions/createEventStreamTransformer.md +0 -33
  74. package/docs/functions/createHfValueFunc.md +0 -29
  75. package/docs/functions/createLRUCache.md +0 -23
  76. package/docs/functions/createYamlObjectTag.md +0 -23
  77. package/docs/functions/dateToText.md +0 -23
  78. package/docs/functions/decodeCharset.md +0 -23
  79. package/docs/functions/detectCharset.md +0 -23
  80. package/docs/functions/encodeLLMTokens.md +0 -23
  81. package/docs/functions/expandEnv.md +0 -40
  82. package/docs/functions/expandObjEnv.md +0 -54
  83. package/docs/functions/extNameLevel.md +0 -43
  84. package/docs/functions/fileIsExists.md +0 -34
  85. package/docs/functions/filenameReservedRegex.md +0 -22
  86. package/docs/functions/filterValidFnScope.md +0 -21
  87. package/docs/functions/findIndexNonEmptyFrom.md +0 -23
  88. package/docs/functions/findPort.md +0 -23
  89. package/docs/functions/formatISO.md +0 -71
  90. package/docs/functions/formatTextWithSpace.md +0 -59
  91. package/docs/functions/getAllEnumKeys.md +0 -31
  92. package/docs/functions/getConfigFileNames.md +0 -23
  93. package/docs/functions/getConfigs.md +0 -23
  94. package/docs/functions/getFileMetaInfo.md +0 -21
  95. package/docs/functions/getHashAlgoBySize.md +0 -21
  96. package/docs/functions/getKeysPath.md +0 -38
  97. package/docs/functions/getLLMTokenizer.md +0 -21
  98. package/docs/functions/getMultiLevelExtname.md +0 -31
  99. package/docs/functions/getPackageDir.md +0 -39
  100. package/docs/functions/getRealFilepath.md +0 -34
  101. package/docs/functions/getResponseErrorReadableStream.md +0 -21
  102. package/docs/functions/hasDirectoryIn.md +0 -38
  103. package/docs/functions/hashFile.md +0 -23
  104. package/docs/functions/hashStream.md +0 -23
  105. package/docs/functions/hfParse.md +0 -24
  106. package/docs/functions/hfTokenize.md +0 -25
  107. package/docs/functions/interpolateEnv.md +0 -25
  108. package/docs/functions/interpolateFString.md +0 -27
  109. package/docs/functions/interpolateGolangTemplate.md +0 -31
  110. package/docs/functions/isLangUsingSpaces.md +0 -21
  111. package/docs/functions/isListItemString.md +0 -21
  112. package/docs/functions/isModelNameMatched.md +0 -45
  113. package/docs/functions/isPunctuationChar.md +0 -36
  114. package/docs/functions/isRegExp.md +0 -21
  115. package/docs/functions/isSectionString.md +0 -23
  116. package/docs/functions/isSentenceEnding.md +0 -21
  117. package/docs/functions/isSepLineString.md +0 -21
  118. package/docs/functions/isSubdirectory.md +0 -39
  119. package/docs/functions/isTitleString.md +0 -23
  120. package/docs/functions/isValidFilename.md +0 -38
  121. package/docs/functions/isValidFilepath.md +0 -27
  122. package/docs/functions/isWebStream.md +0 -21
  123. package/docs/functions/jsonFilterToWhere.md +0 -45
  124. package/docs/functions/jsonToMarkdownStr.md +0 -31
  125. package/docs/functions/loadFileFromPaths.md +0 -54
  126. package/docs/functions/loadTextFromPaths.md +0 -29
  127. package/docs/functions/lrucache.md +0 -29
  128. package/docs/functions/makeToolFuncCancelable.md +0 -23
  129. package/docs/functions/matchUrlProtocol.md +0 -48
  130. package/docs/functions/memoize.md +0 -27
  131. package/docs/functions/messagesToText.md +0 -21
  132. package/docs/functions/paramsSizeToScaleStr.md +0 -32
  133. package/docs/functions/parseCommand.md +0 -33
  134. package/docs/functions/parseDateFormat.md +0 -360
  135. package/docs/functions/parseFString.md +0 -26
  136. package/docs/functions/parseISO.md +0 -72
  137. package/docs/functions/parseJsJson.md +0 -38
  138. package/docs/functions/parseJsJsonSimpleSync.md +0 -23
  139. package/docs/functions/parseObjectArgInfo.md +0 -27
  140. package/docs/functions/parseObjectArgumentInfos.md +0 -25
  141. package/docs/functions/parseObjectArguments.md +0 -68
  142. package/docs/functions/parseObjectArgumentsAsArgInfos.md +0 -42
  143. package/docs/functions/parseYaml.md +0 -21
  144. package/docs/functions/quoteStr.md +0 -21
  145. package/docs/functions/reControlCharsRegex.md +0 -21
  146. package/docs/functions/readFilenamesRecursiveSync.md +0 -47
  147. package/docs/functions/readTextFileChunks.md +0 -51
  148. package/docs/functions/readTextFileChunksEx.md +0 -23
  149. package/docs/functions/readableFromAsyncIterable.md +0 -28
  150. package/docs/functions/registerCoreTools.md +0 -17
  151. package/docs/functions/registerYamlTag.md +0 -21
  152. package/docs/functions/removeMarkdownBold.md +0 -23
  153. package/docs/functions/removeMarkdownBoldAndItalic.md +0 -23
  154. package/docs/functions/removeMarkdownItalic.md +0 -23
  155. package/docs/functions/replaceWithPlaceholder.md +0 -41
  156. package/docs/functions/restoreFromPlacehoders.md +0 -45
  157. package/docs/functions/sanitizeFilename.md +0 -37
  158. package/docs/functions/sanitizeFilepath.md +0 -31
  159. package/docs/functions/saveConfigFile.md +0 -25
  160. package/docs/functions/scaleStrToParamsSize.md +0 -27
  161. package/docs/functions/simplifyObjectArguments.md +0 -21
  162. package/docs/functions/sortedValues.md +0 -25
  163. package/docs/functions/splitChunks.md +0 -23
  164. package/docs/functions/splitParagraph.md +0 -32
  165. package/docs/functions/splitSentence.md +0 -37
  166. package/docs/functions/stringifyYaml.md +0 -21
  167. package/docs/functions/stripConsoleColor.md +0 -21
  168. package/docs/functions/textToDate.md +0 -23
  169. package/docs/functions/throwError.md +0 -37
  170. package/docs/functions/toDate.md +0 -76
  171. package/docs/functions/toDateTime.md +0 -21
  172. package/docs/functions/toRegExp.md +0 -34
  173. package/docs/functions/trimStartOfStreamHelper.md +0 -41
  174. package/docs/functions/truncTo.md +0 -47
  175. package/docs/functions/truncateByToken.md +0 -23
  176. package/docs/functions/truncateToTokenLimit.md +0 -44
  177. package/docs/functions/truncateToTokenLimitEx.md +0 -23
  178. package/docs/functions/uuid.md +0 -23
  179. package/docs/functions/uuidParse.md +0 -21
  180. package/docs/functions/uuidStringify.md +0 -23
  181. package/docs/functions/uuidValidate.md +0 -21
  182. package/docs/functions/uuidVersion.md +0 -21
  183. package/docs/functions/uuidv1.md +0 -47
  184. package/docs/functions/uuidv4.md +0 -47
  185. package/docs/functions/uuidv5.md +0 -51
  186. package/docs/functions/wait.md +0 -21
  187. package/docs/functions/xxhash.md +0 -25
  188. package/docs/functions/xxhash32.md +0 -23
  189. package/docs/functions/xxhash64.md +0 -23
  190. package/docs/functions/xxhashAsStr.md +0 -25
  191. package/docs/globals.md +0 -285
  192. package/docs/interfaces/AIChatAssistantMessageParam.md +0 -117
  193. package/docs/interfaces/AIChatContentPartImage.md +0 -31
  194. package/docs/interfaces/AIChatContentPartText.md +0 -27
  195. package/docs/interfaces/AIChatMessageParamBase.md +0 -58
  196. package/docs/interfaces/AIChatMessageToolCall.md +0 -45
  197. package/docs/interfaces/AIChatSystemMessageParam.md +0 -87
  198. package/docs/interfaces/AIChatToolMessageParam.md +0 -97
  199. package/docs/interfaces/AIChatUserMessageParam.md +0 -127
  200. package/docs/interfaces/AIChoiceConfig.md +0 -77
  201. package/docs/interfaces/AIResult.md +0 -73
  202. package/docs/interfaces/AIStreamParser.md +0 -39
  203. package/docs/interfaces/AIStreamParserOptions.md +0 -21
  204. package/docs/interfaces/BaseFunc.md +0 -155
  205. package/docs/interfaces/BaseFuncItem.md +0 -103
  206. package/docs/interfaces/CancelableAbilityOptions.md +0 -115
  207. package/docs/interfaces/ClientFuncItem.md +0 -179
  208. package/docs/interfaces/DotenvExpandOptions.md +0 -47
  209. package/docs/interfaces/DotenvExpandOutput.md +0 -27
  210. package/docs/interfaces/DotenvParseInput.md +0 -11
  211. package/docs/interfaces/DotenvParseOutput.md +0 -11
  212. package/docs/interfaces/DotenvPopulateInput.md +0 -11
  213. package/docs/interfaces/EventClientFuncParams.md +0 -55
  214. package/docs/interfaces/EventServerFuncParams.md +0 -71
  215. package/docs/interfaces/FewShotPromptTemplateOptions.md +0 -163
  216. package/docs/interfaces/FuncItem.md +0 -143
  217. package/docs/interfaces/FuncParam.md +0 -71
  218. package/docs/interfaces/FuncParams.md +0 -11
  219. package/docs/interfaces/Funcs.md +0 -11
  220. package/docs/interfaces/HashAlgoParams.md +0 -37
  221. package/docs/interfaces/IFileMetaInfo.md +0 -77
  222. package/docs/interfaces/IReadTextFileChunksOptions.md +0 -157
  223. package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -111
  224. package/docs/interfaces/JsonFilter.md +0 -11
  225. package/docs/interfaces/ParseObjectArgumentOptions.md +0 -97
  226. package/docs/interfaces/PromptExampleSelectorOptions.md +0 -36
  227. package/docs/interfaces/PromptTemplateOptions.md +0 -75
  228. package/docs/interfaces/RemoteFuncItem.md +0 -168
  229. package/docs/interfaces/ReplacePlacehoderOptions.md +0 -47
  230. package/docs/interfaces/ResClientFuncParams.md +0 -35
  231. package/docs/interfaces/ResServerFuncParams.md +0 -73
  232. package/docs/interfaces/SanitizeFilenameOptions.md +0 -27
  233. package/docs/interfaces/SectionStringOptions.md +0 -27
  234. package/docs/interfaces/ServerFuncItem.md +0 -189
  235. package/docs/interfaces/ServerFuncParams.md +0 -37
  236. package/docs/interfaces/SplitSentenceOptions.md +0 -47
  237. package/docs/interfaces/StreamCallbacksAndOptions.md +0 -95
  238. package/docs/interfaces/TaskAbortControllers.md +0 -11
  239. package/docs/interfaces/TaskPromise.md +0 -138
  240. package/docs/interfaces/ToolFuncPackage.md +0 -49
  241. package/docs/type-aliases/AIChatContentPart.md +0 -13
  242. package/docs/type-aliases/AIChatMessageParam.md +0 -13
  243. package/docs/type-aliases/AIChatRole.md +0 -13
  244. package/docs/type-aliases/AIMessageType.md +0 -13
  245. package/docs/type-aliases/AIModelNameRule.md +0 -13
  246. package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
  247. package/docs/type-aliases/AIModelNameRules.md +0 -13
  248. package/docs/type-aliases/AITextGenerationFinishReason.md +0 -13
  249. package/docs/type-aliases/ActionName.md +0 -13
  250. package/docs/type-aliases/AsyncTaskId.md +0 -13
  251. package/docs/type-aliases/EventErrorListenerFn.md +0 -27
  252. package/docs/type-aliases/EventListenerFn.md +0 -25
  253. package/docs/type-aliases/FStringPromptTemplateNode.md +0 -16
  254. package/docs/type-aliases/FuncParamType.md +0 -13
  255. package/docs/type-aliases/PromptExamples.md +0 -17
  256. package/docs/type-aliases/PromptTemplateType.md +0 -13
  257. package/docs/type-aliases/PromptType.md +0 -13
  258. package/docs/type-aliases/TFunc.md +0 -23
  259. package/docs/variables/AIChatRoles.md +0 -13
  260. package/docs/variables/AIMessageTypes.md +0 -13
  261. package/docs/variables/AITextGenerationFinishReasons.md +0 -13
  262. package/docs/variables/AbortErrorCode.md +0 -13
  263. package/docs/variables/ActionNames.md +0 -13
  264. package/docs/variables/AlreadyExistsErrorCode.md +0 -13
  265. package/docs/variables/ClientToolFuncSchema.md +0 -87
  266. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +0 -13
  267. package/docs/variables/EventBusName.md +0 -13
  268. package/docs/variables/EventName.md +0 -13
  269. package/docs/variables/FilenameReservedRegex.md +0 -16
  270. package/docs/variables/HFBuiltins.md +0 -92
  271. package/docs/variables/InternalErrorCode.md +0 -13
  272. package/docs/variables/LLM_TOKENIZER_NAMES.md +0 -83
  273. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +0 -13
  274. package/docs/variables/NotFoundErrorCode.md +0 -13
  275. package/docs/variables/NotImplementedErrorCode.md +0 -13
  276. package/docs/variables/PASSING_SCORE.md +0 -13
  277. package/docs/variables/PromptTemplateTypes.md +0 -13
  278. package/docs/variables/PromptTypes.md +0 -16
  279. package/docs/variables/RStreamErrCode.md +0 -13
  280. package/docs/variables/RemoteToolFuncSchema.md +0 -87
  281. package/docs/variables/ResponseRStreamErrCode.md +0 -13
  282. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +0 -13
  283. package/docs/variables/ServerToolFuncSchema.md +0 -87
  284. package/docs/variables/ToolAsyncCancelableBit.md +0 -13
  285. package/docs/variables/ToolAsyncMultiTaskBit.md +0 -13
  286. package/docs/variables/ToolAsyncPriorityBit.md +0 -13
  287. package/docs/variables/ToolFuncSchema.md +0 -125
  288. package/docs/variables/WindowsReservedNameRegex.md +0 -15
  289. package/docs/variables/base32768.md +0 -13
  290. package/docs/variables/defaultTemplateFormat.md +0 -13
  291. package/docs/variables/event.md +0 -13
  292. package/docs/variables/eventClient.md +0 -13
  293. package/docs/variables/eventServer.md +0 -13
  294. package/docs/variables/lrucache.md +0 -13
  295. package/docs/variables/mimeType.md +0 -13
  296. package/docs/variables/uuidNIL.md +0 -13
package/docs/interfaces/StreamCallbacksAndOptions.md DELETED
@@ -1,95 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / StreamCallbacksAndOptions
6
-
7
- # Interface: StreamCallbacksAndOptions\<I, O\>
8
-
9
- Configuration options and helper callback methods for stream lifecycle events.
10
-
11
- ## Type Parameters
12
-
13
- • **I** = `any`
14
-
15
- • **O** = `any`
16
-
17
- ## Properties
18
-
19
- ### onError()?
20
-
21
- > `optional` **onError**: (`error`) => `void` \| `Promise`\<`void`\>
22
-
23
- #### Parameters
24
-
25
- • **error**: `Error`
26
-
27
- #### Returns
28
-
29
- `void` \| `Promise`\<`void`\>
30
-
31
- #### Defined in
32
-
33
- [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/stream/create-callbacks-stream.ts#L12)
34
-
35
- ***
36
-
37
- ### onFinal()?
38
-
39
- > `optional` **onFinal**: (`controller`) => `void` \| `Promise`\<`void`\>
40
-
41
- `onFinal`: Called once when the stream is closed with the final completion message.
42
-
43
- #### Parameters
44
-
45
- • **controller**: `TransformStreamDefaultController`\<`any`\>
46
-
47
- #### Returns
48
-
49
- `void` \| `Promise`\<`void`\>
50
-
51
- #### Defined in
52
-
53
- [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/stream/create-callbacks-stream.ts#L11)
54
-
55
- ***
56
-
57
- ### onStart()?
58
-
59
- > `optional` **onStart**: (`controller`) => `void` \| `Promise`\<`void`\>
60
-
61
- `onStart`: Called once when the stream is initialized.
62
-
63
- #### Parameters
64
-
65
- • **controller**: `TransformStreamDefaultController`\<`any`\>
66
-
67
- #### Returns
68
-
69
- `void` \| `Promise`\<`void`\>
70
-
71
- #### Defined in
72
-
73
- [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/stream/create-callbacks-stream.ts#L7)
74
-
75
- ***
76
-
77
- ### onTransform()?
78
-
79
- > `optional` **onTransform**: (`chunk`, `controller`) => `void` \| `O` \| `Promise`\<`void` \| `O`\>
80
-
81
- `onToken`: Called for each tokenized message.
82
-
83
- #### Parameters
84
-
85
- • **chunk**: `I`
86
-
87
- • **controller**: `TransformStreamDefaultController`\<`any`\>
88
-
89
- #### Returns
90
-
91
- `void` \| `O` \| `Promise`\<`void` \| `O`\>
92
-
93
- #### Defined in
94
-
95
- [packages/ai-tool/src/utils/stream/create-callbacks-stream.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/stream/create-callbacks-stream.ts#L9)
package/docs/interfaces/TaskAbortControllers.md DELETED
@@ -1,11 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / TaskAbortControllers
6
-
7
- # Interface: TaskAbortControllers
8
-
9
- ## Indexable
10
-
11
- \[`k`: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)\]: [`TaskAbortController`](../classes/TaskAbortController.md) \| `undefined`
package/docs/interfaces/TaskPromise.md DELETED
@@ -1,138 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / TaskPromise
6
-
7
- # Interface: TaskPromise\<T\>
8
-
9
- ## Extends
10
-
11
- - `Promise`\<`T`\>
12
-
13
- ## Type Parameters
14
-
15
- • **T** = `any`
16
-
17
- ## Properties
18
-
19
- ### \[toStringTag\]
20
-
21
- > `readonly` **\[toStringTag\]**: `string`
22
-
23
- #### Inherited from
24
-
25
- `Promise.[toStringTag]`
26
-
27
- #### Defined in
28
-
29
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:176
30
-
31
- ***
32
-
33
- ### task?
34
-
35
- > `optional` **task**: [`TaskAbortController`](../classes/TaskAbortController.md)
36
-
37
- #### Defined in
38
-
39
- [packages/ai-tool/src/utils/cancelable-ability.ts:51](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/cancelable-ability.ts#L51)
40
-
41
- ## Methods
42
-
43
- ### catch()
44
-
45
- > **catch**\<`TResult`\>(`onrejected`?): `Promise`\<`T` \| `TResult`\>
46
-
47
- Attaches a callback for only the rejection of the Promise.
48
-
49
- #### Type Parameters
50
-
51
- • **TResult** = `never`
52
-
53
- #### Parameters
54
-
55
- • **onrejected?**: `null` \| (`reason`) => `TResult` \| `PromiseLike`\<`TResult`\>
56
-
57
- The callback to execute when the Promise is rejected.
58
-
59
- #### Returns
60
-
61
- `Promise`\<`T` \| `TResult`\>
62
-
63
- A Promise for the completion of the callback.
64
-
65
- #### Inherited from
66
-
67
- `Promise.catch`
68
-
69
- #### Defined in
70
-
71
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1557
72
-
73
- ***
74
-
75
- ### finally()
76
-
77
- > **finally**(`onfinally`?): `Promise`\<`T`\>
78
-
79
- Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The
80
- resolved value cannot be modified from the callback.
81
-
82
- #### Parameters
83
-
84
- • **onfinally?**: `null` \| () => `void`
85
-
86
- The callback to execute when the Promise is settled (fulfilled or rejected).
87
-
88
- #### Returns
89
-
90
- `Promise`\<`T`\>
91
-
92
- A Promise for the completion of the callback.
93
-
94
- #### Inherited from
95
-
96
- `Promise.finally`
97
-
98
- #### Defined in
99
-
100
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2018.promise.d.ts:29
101
-
102
- ***
103
-
104
- ### then()
105
-
106
- > **then**\<`TResult1`, `TResult2`\>(`onfulfilled`?, `onrejected`?): `Promise`\<`TResult1` \| `TResult2`\>
107
-
108
- Attaches callbacks for the resolution and/or rejection of the Promise.
109
-
110
- #### Type Parameters
111
-
112
- • **TResult1** = `T`
113
-
114
- • **TResult2** = `never`
115
-
116
- #### Parameters
117
-
118
- • **onfulfilled?**: `null` \| (`value`) => `TResult1` \| `PromiseLike`\<`TResult1`\>
119
-
120
- The callback to execute when the Promise is resolved.
121
-
122
- • **onrejected?**: `null` \| (`reason`) => `TResult2` \| `PromiseLike`\<`TResult2`\>
123
-
124
- The callback to execute when the Promise is rejected.
125
-
126
- #### Returns
127
-
128
- `Promise`\<`TResult1` \| `TResult2`\>
129
-
130
- A Promise for the completion of which ever callback is executed.
131
-
132
- #### Inherited from
133
-
134
- `Promise.then`
135
-
136
- #### Defined in
137
-
138
- node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1550
package/docs/interfaces/ToolFuncPackage.md DELETED
@@ -1,49 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / ToolFuncPackage
6
-
7
- # Interface: ToolFuncPackage
8
-
9
- ## Properties
10
-
11
- ### name
12
-
13
- > **name**: `string`
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/tool-func.ts:64](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L64)
18
-
19
- ***
20
-
21
- ### register()
22
-
23
- > **register**: (`data`?) => `void`
24
-
25
- #### Parameters
26
-
27
- • **data?**: `any`
28
-
29
- #### Returns
30
-
31
- `void`
32
-
33
- #### Defined in
34
-
35
- [packages/ai-tool/src/tool-func.ts:65](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L65)
36
-
37
- ***
38
-
39
- ### unregister()?
40
-
41
- > `optional` **unregister**: () => `void`
42
-
43
- #### Returns
44
-
45
- `void`
46
-
47
- #### Defined in
48
-
49
- [packages/ai-tool/src/tool-func.ts:66](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L66)
package/docs/type-aliases/AIChatContentPart.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatContentPart
6
-
7
- # Type Alias: AIChatContentPart
8
-
9
- > **AIChatContentPart**: [`AIChatContentPartText`](../interfaces/AIChatContentPartText.md) \| [`AIChatContentPartImage`](../interfaces/AIChatContentPartImage.md)
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/chat.ts:79](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/chat.ts#L79)
package/docs/type-aliases/AIChatMessageParam.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatMessageParam
6
-
7
- # Type Alias: AIChatMessageParam
8
-
9
- > **AIChatMessageParam**: [`AIChatSystemMessageParam`](../interfaces/AIChatSystemMessageParam.md) \| [`AIChatUserMessageParam`](../interfaces/AIChatUserMessageParam.md) \| [`AIChatAssistantMessageParam`](../interfaces/AIChatAssistantMessageParam.md) \| [`AIChatToolMessageParam`](../interfaces/AIChatToolMessageParam.md)
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/chat.ts:46](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/chat.ts#L46)
package/docs/type-aliases/AIChatRole.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatRole
6
-
7
- # Type Alias: AIChatRole
8
-
9
- > **AIChatRole**: *typeof* [`AIChatRoles`](../variables/AIChatRoles.md)\[`number`\] & `string`
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/chat.ts:44](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/chat.ts#L44)
package/docs/type-aliases/AIMessageType.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIMessageType
6
-
7
- # Type Alias: AIMessageType
8
-
9
- > **AIMessageType**: *typeof* [`AIMessageTypes`](../variables/AIMessageTypes.md)\[`number`\]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/chat.ts:38](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/chat.ts#L38)
package/docs/type-aliases/AIModelNameRule.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIModelNameRule
6
-
7
- # Type Alias: AIModelNameRule
8
-
9
- > **AIModelNameRule**: `string` \| `RegExp` \| [`AIModelNameRuleFn`](AIModelNameRuleFn.md)
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L10)
package/docs/type-aliases/AIModelNameRuleFn.md DELETED
@@ -1,21 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIModelNameRuleFn
6
-
7
- # Type Alias: AIModelNameRuleFn()
8
-
9
- > **AIModelNameRuleFn**: (`name`) => `string` \| `RegExpExecArray` \| `undefined`
10
-
11
- ## Parameters
12
-
13
- • **name**: `string`
14
-
15
- ## Returns
16
-
17
- `string` \| `RegExpExecArray` \| `undefined`
18
-
19
- ## Defined in
20
-
21
- [packages/ai-tool/src/utils/consts.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L8)
package/docs/type-aliases/AIModelNameRules.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIModelNameRules
6
-
7
- # Type Alias: AIModelNameRules
8
-
9
- > **AIModelNameRules**: [`AIModelNameRule`](AIModelNameRule.md) \| [`AIModelNameRule`](AIModelNameRule.md)[]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/consts.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L11)
package/docs/type-aliases/AITextGenerationFinishReason.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AITextGenerationFinishReason
6
-
7
- # Type Alias: AITextGenerationFinishReason
8
-
9
- > **AITextGenerationFinishReason**: *typeof* [`AITextGenerationFinishReasons`](../variables/AITextGenerationFinishReasons.md)\[`number`\]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/chat.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/chat.ts#L14)
package/docs/type-aliases/ActionName.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / ActionName
6
-
7
- # Type Alias: ActionName
8
-
9
- > **ActionName**: *typeof* [`ActionNames`](../variables/ActionNames.md)\[`number`\]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/consts.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L6)
package/docs/type-aliases/AsyncTaskId.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AsyncTaskId
6
-
7
- # Type Alias: AsyncTaskId
8
-
9
- > **AsyncTaskId**: `string` \| `number`
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/cancelable-ability.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/cancelable-ability.ts#L8)
package/docs/type-aliases/EventErrorListenerFn.md DELETED
@@ -1,27 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / EventErrorListenerFn
6
-
7
- # Type Alias: EventErrorListenerFn()
8
-
9
- > **EventErrorListenerFn**: (`this`, `err`, `name`, ...`args`) => `any`
10
-
11
- ## Parameters
12
-
13
- • **this**: `Event`
14
-
15
- • **err**: `Error`
16
-
17
- • **name**: `string`
18
-
19
- • ...**args**: `any`
20
-
21
- ## Returns
22
-
23
- `any`
24
-
25
- ## Defined in
26
-
27
- [packages/ai-tool/src/utils/event/event-ability.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/event-ability.ts#L9)
package/docs/type-aliases/EventListenerFn.md DELETED
@@ -1,25 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / EventListenerFn
6
-
7
- # Type Alias: EventListenerFn()
8
-
9
- > **EventListenerFn**: (`this`, `name`, ...`args`) => `any`
10
-
11
- ## Parameters
12
-
13
- • **this**: `Event`
14
-
15
- • **name**: `string`
16
-
17
- • ...**args**: `any`
18
-
19
- ## Returns
20
-
21
- `any`
22
-
23
- ## Defined in
24
-
25
- [packages/ai-tool/src/utils/event/event-ability.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/event/event-ability.ts#L8)
package/docs/type-aliases/FStringPromptTemplateNode.md DELETED
@@ -1,16 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / FStringPromptTemplateNode
6
-
7
- # Type Alias: FStringPromptTemplateNode
8
-
9
- > **FStringPromptTemplateNode**: `object` \| `object`
10
-
11
- Type that represents a node in a parsed format string. It can be either
12
- a literal text or a variable name.
13
-
14
- ## Defined in
15
-
16
- [packages/ai-tool/src/utils/prompt/template/python.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/python.ts#L6)
package/docs/type-aliases/FuncParamType.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / FuncParamType
6
-
7
- # Type Alias: FuncParamType
8
-
9
- > **FuncParamType**: `string`
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L24)
package/docs/type-aliases/PromptExamples.md DELETED
@@ -1,17 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / PromptExamples
6
-
7
- # Type Alias: PromptExamples\<T\>
8
-
9
- > **PromptExamples**\<`T`\>: `Iterable`\<`PromiseLike`\<`T`\> \| `T`\> \| `AsyncIterable`\<`T`\>
10
-
11
- ## Type Parameters
12
-
13
- • **T** = `any`
14
-
15
- ## Defined in
16
-
17
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:3](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L3)
package/docs/type-aliases/PromptTemplateType.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / PromptTemplateType
6
-
7
- # Type Alias: PromptTemplateType
8
-
9
- > **PromptTemplateType**: *typeof* [`PromptTemplateTypes`](../variables/PromptTemplateTypes.md)\[`number`\]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/prompt/consts.ts:17](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/consts.ts#L17)
package/docs/type-aliases/PromptType.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / PromptType
6
-
7
- # Type Alias: PromptType
8
-
9
- > **PromptType**: *typeof* [`PromptTypes`](../variables/PromptTypes.md)\[`number`\]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/prompt/consts.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/consts.ts#L10)
package/docs/type-aliases/TFunc.md DELETED
@@ -1,23 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / TFunc
6
-
7
- # Type Alias: TFunc()
8
-
9
- > **TFunc**: (`this`, ...`params`) => `any`
10
-
11
- ## Parameters
12
-
13
- • **this**: [`ToolFunc`](../classes/ToolFunc.md)
14
-
15
- • ...**params**: `any`[]
16
-
17
- ## Returns
18
-
19
- `any`
20
-
21
- ## Defined in
22
-
23
- [packages/ai-tool/src/tool-func.ts:38](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L38)
package/docs/variables/AIChatRoles.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIChatRoles
6
-
7
- # Variable: AIChatRoles
8
-
9
- > `const` **AIChatRoles**: readonly [`"user"`, `"assistant"`, `"system"`, `"tool"`, `"tool_calls"`]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/chat.ts:43](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/chat.ts#L43)
package/docs/variables/AIMessageTypes.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AIMessageTypes
6
-
7
- # Variable: AIMessageTypes
8
-
9
- > `const` **AIMessageTypes**: readonly [`"human"`, `"ai"`, `"generic"`, `"system"`, `"tool"`]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/chat.ts:37](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/chat.ts#L37)
package/docs/variables/AITextGenerationFinishReasons.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AITextGenerationFinishReasons
6
-
7
- # Variable: AITextGenerationFinishReasons
8
-
9
- > `const` **AITextGenerationFinishReasons**: readonly [`"stop"`, `"length"`, `"content_filter"`, `"tool_calls"`, `"function_call"`, `"abort"`, `"error"`, `"other"`, `null`]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/chat.ts:4](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/chat.ts#L4)
package/docs/variables/AbortErrorCode.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / AbortErrorCode
6
-
7
- # Variable: AbortErrorCode
8
-
9
- > `const` **AbortErrorCode**: [`Aborted`](../enumerations/ErrorCode.md#aborted) = `ErrorCode.Aborted`
10
-
11
- ## Defined in
12
-
13
- node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:31
package/docs/variables/ActionNames.md DELETED
@@ -1,13 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / ActionNames
6
-
7
- # Variable: ActionNames
8
-
9
- > `const` **ActionNames**: readonly [`"get"`, `"post"`, `"put"`, `"delete"`, `"patch"`, `"list"`, `"res"`]
10
-
11
- ## Defined in
12
-
13
- [packages/ai-tool/src/utils/consts.ts:5](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/consts.ts#L5)