@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/DotenvExpandOptions.md DELETED
@@ -1,47 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / DotenvExpandOptions
6
-
7
- # Interface: DotenvExpandOptions
8
-
9
- ## Properties
10
-
11
- ### error?
12
-
13
- > `optional` **error**: `Error`
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/prompt/template/env.ts:188](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/env.ts#L188)
18
-
19
- ***
20
-
21
- ### parsed?
22
-
23
- > `optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
24
-
25
- Default: `object`
26
-
27
- Object coming from dotenv's parsed result.
28
-
29
- #### Defined in
30
-
31
- [packages/ai-tool/src/utils/prompt/template/env.ts:204](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/env.ts#L204)
32
-
33
- ***
34
-
35
- ### processEnv?
36
-
37
- > `optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
38
-
39
- Default: `process.env`
40
-
41
- Specify an object to write your secrets to. Defaults to process.env environment variables.
42
-
43
- example: `const processEnv = {}; require('dotenv').config({ processEnv: processEnv })`
44
-
45
- #### Defined in
46
-
47
- [packages/ai-tool/src/utils/prompt/template/env.ts:197](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/env.ts#L197)
package/docs/interfaces/DotenvExpandOutput.md DELETED
@@ -1,27 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / DotenvExpandOutput
6
-
7
- # Interface: DotenvExpandOutput
8
-
9
- ## Properties
10
-
11
- ### error?
12
-
13
- > `optional` **error**: `Error`
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/prompt/template/env.ts:208](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/env.ts#L208)
18
-
19
- ***
20
-
21
- ### parsed?
22
-
23
- > `optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/utils/prompt/template/env.ts:209](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/env.ts#L209)
package/docs/interfaces/DotenvParseInput.md DELETED
@@ -1,11 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / DotenvParseInput
6
-
7
- # Interface: DotenvParseInput
8
-
9
- ## Indexable
10
-
11
- \[`name`: `string`\]: `string` \| `undefined`
package/docs/interfaces/DotenvParseOutput.md DELETED
@@ -1,11 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / DotenvParseOutput
6
-
7
- # Interface: DotenvParseOutput
8
-
9
- ## Indexable
10
-
11
- \[`name`: `string`\]: `string` \| `undefined`
package/docs/interfaces/DotenvPopulateInput.md DELETED
@@ -1,11 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / DotenvPopulateInput
6
-
7
- # Interface: DotenvPopulateInput
8
-
9
- ## Indexable
10
-
11
- \[`name`: `string`\]: `string` \| `undefined`
package/docs/interfaces/EventClientFuncParams.md DELETED
@@ -1,55 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / EventClientFuncParams
6
-
7
- # Interface: EventClientFuncParams
8
-
9
- ## Properties
10
-
11
- ### act?
12
-
13
- > `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"` \| `"init"`
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L8)
18
-
19
- ***
20
-
21
- ### data?
22
-
23
- > `optional` **data**: `any`
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L7)
28
-
29
- ***
30
-
31
- ### event?
32
-
33
- > `optional` **event**: `string` \| `string`[]
34
-
35
- #### Defined in
36
-
37
- [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L6)
38
-
39
- ***
40
-
41
- ### listener()?
42
-
43
- > `optional` **listener**: (...`args`) => `void`
44
-
45
- #### Parameters
46
-
47
- • ...**args**: `any`[]
48
-
49
- #### Returns
50
-
51
- `void`
52
-
53
- #### Defined in
54
-
55
- [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-client.ts#L9)
package/docs/interfaces/EventServerFuncParams.md DELETED
@@ -1,71 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / EventServerFuncParams
6
-
7
- # Interface: EventServerFuncParams
8
-
9
- Convention: Always pass _req, _res
10
-
11
- ## Extends
12
-
13
- - [`ServerFuncParams`](ServerFuncParams.md)
14
-
15
- ## Properties
16
-
17
- ### \_req?
18
-
19
- > `optional` **\_req**: `IncomingMessage`
20
-
21
- #### Inherited from
22
-
23
- [`ServerFuncParams`](ServerFuncParams.md).[`_req`](ServerFuncParams.md#_req)
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L9)
28
-
29
- ***
30
-
31
- ### \_res?
32
-
33
- > `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
34
-
35
- #### Inherited from
36
-
37
- [`ServerFuncParams`](ServerFuncParams.md).[`_res`](ServerFuncParams.md#_res)
38
-
39
- #### Defined in
40
-
41
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L10)
42
-
43
- ***
44
-
45
- ### act?
46
-
47
- > `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"`
48
-
49
- #### Defined in
50
-
51
- [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-server.ts#L15)
52
-
53
- ***
54
-
55
- ### data?
56
-
57
- > `optional` **data**: `any`
58
-
59
- #### Defined in
60
-
61
- [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-server.ts#L14)
62
-
63
- ***
64
-
65
- ### event?
66
-
67
- > `optional` **event**: `string` \| `string`[]
68
-
69
- #### Defined in
70
-
71
- [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/event-server.ts#L13)
package/docs/interfaces/FewShotPromptTemplateOptions.md DELETED
@@ -1,163 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / FewShotPromptTemplateOptions
6
-
7
- # Interface: FewShotPromptTemplateOptions\<T\>
8
-
9
- ## Extends
10
-
11
- - [`PromptTemplateOptions`](PromptTemplateOptions.md)
12
-
13
- ## Type Parameters
14
-
15
- • **T** = `any`
16
-
17
- ## Properties
18
-
19
- ### compiledTemplate?
20
-
21
- > `optional` **compiledTemplate**: `any`
22
-
23
- #### Inherited from
24
-
25
- [`PromptTemplateOptions`](PromptTemplateOptions.md).[`compiledTemplate`](PromptTemplateOptions.md#compiledtemplate)
26
-
27
- #### Defined in
28
-
29
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L15)
30
-
31
- ***
32
-
33
- ### data?
34
-
35
- > `optional` **data**: `Record`\<`string`, `any`\>
36
-
37
- #### Inherited from
38
-
39
- [`PromptTemplateOptions`](PromptTemplateOptions.md).[`data`](PromptTemplateOptions.md#data)
40
-
41
- #### Defined in
42
-
43
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L12)
44
-
45
- ***
46
-
47
- ### examplePrompt
48
-
49
- > **examplePrompt**: [`PromptTemplateOptions`](PromptTemplateOptions.md) \| [`PromptTemplate`](../classes/PromptTemplate.md)
50
-
51
- An [PromptTemplate](../classes/PromptTemplate.md) used to format a single example.
52
-
53
- #### Defined in
54
-
55
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/few-shot-prompt-template.ts#L19)
56
-
57
- ***
58
-
59
- ### examples
60
-
61
- > **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
62
-
63
- The few shot examples to use in the prompt.
64
-
65
- #### Defined in
66
-
67
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/few-shot-prompt-template.ts#L14)
68
-
69
- ***
70
-
71
- ### exampleSeparator?
72
-
73
- > `optional` **exampleSeparator**: `string`
74
-
75
- String separator used to join the prefix, the examples, and suffix.
76
-
77
- #### Defined in
78
-
79
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/few-shot-prompt-template.ts#L24)
80
-
81
- ***
82
-
83
- ### ignoreInitialize?
84
-
85
- > `optional` **ignoreInitialize**: `boolean`
86
-
87
- #### Inherited from
88
-
89
- [`PromptTemplateOptions`](PromptTemplateOptions.md).[`ignoreInitialize`](PromptTemplateOptions.md#ignoreinitialize)
90
-
91
- #### Defined in
92
-
93
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L16)
94
-
95
- ***
96
-
97
- ### inputVariables?
98
-
99
- > `optional` **inputVariables**: `string`[]
100
-
101
- #### Inherited from
102
-
103
- [`PromptTemplateOptions`](PromptTemplateOptions.md).[`inputVariables`](PromptTemplateOptions.md#inputvariables)
104
-
105
- #### Defined in
106
-
107
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L14)
108
-
109
- ***
110
-
111
- ### prefix?
112
-
113
- > `optional` **prefix**: `string`
114
-
115
- A prompt template string to put before the examples.
116
-
117
- #### Default Value
118
-
119
- `""`
120
-
121
- #### Defined in
122
-
123
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/few-shot-prompt-template.ts#L31)
124
-
125
- ***
126
-
127
- ### suffix?
128
-
129
- > `optional` **suffix**: `string`
130
-
131
- A prompt template string to put after the examples.
132
-
133
- #### Defined in
134
-
135
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/few-shot-prompt-template.ts#L36)
136
-
137
- ***
138
-
139
- ### template?
140
-
141
- > `optional` **template**: `string`
142
-
143
- #### Inherited from
144
-
145
- [`PromptTemplateOptions`](PromptTemplateOptions.md).[`template`](PromptTemplateOptions.md#template)
146
-
147
- #### Defined in
148
-
149
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L11)
150
-
151
- ***
152
-
153
- ### templateFormat?
154
-
155
- > `optional` **templateFormat**: `string`
156
-
157
- #### Inherited from
158
-
159
- [`PromptTemplateOptions`](PromptTemplateOptions.md).[`templateFormat`](PromptTemplateOptions.md#templateformat)
160
-
161
- #### Defined in
162
-
163
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L13)
package/docs/interfaces/FuncItem.md DELETED
@@ -1,143 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / FuncItem
6
-
7
- # Interface: FuncItem
8
-
9
- ## Extends
10
-
11
- - [`BaseFuncItem`](BaseFuncItem.md)
12
-
13
- ## Properties
14
-
15
- ### func?
16
-
17
- > `optional` **func**: [`TFunc`](../type-aliases/TFunc.md)
18
-
19
- #### Defined in
20
-
21
- [packages/ai-tool/src/tool-func.ts:52](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L52)
22
-
23
- ***
24
-
25
- ### isApi?
26
-
27
- > `optional` **isApi**: `boolean`
28
-
29
- #### Inherited from
30
-
31
- [`BaseFuncItem`](BaseFuncItem.md).[`isApi`](BaseFuncItem.md#isapi)
32
-
33
- #### Defined in
34
-
35
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L47)
36
-
37
- ***
38
-
39
- ### name?
40
-
41
- > `optional` **name**: `string`
42
-
43
- #### Inherited from
44
-
45
- [`BaseFuncItem`](BaseFuncItem.md).[`name`](BaseFuncItem.md#name)
46
-
47
- #### Defined in
48
-
49
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L41)
50
-
51
- ***
52
-
53
- ### params?
54
-
55
- > `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
56
-
57
- #### Inherited from
58
-
59
- [`BaseFuncItem`](BaseFuncItem.md).[`params`](BaseFuncItem.md#params)
60
-
61
- #### Defined in
62
-
63
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L42)
64
-
65
- ***
66
-
67
- ### result?
68
-
69
- > `optional` **result**: `string`
70
-
71
- #### Inherited from
72
-
73
- [`BaseFuncItem`](BaseFuncItem.md).[`result`](BaseFuncItem.md#result)
74
-
75
- #### Defined in
76
-
77
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L43)
78
-
79
- ***
80
-
81
- ### scope?
82
-
83
- > `optional` **scope**: `any`
84
-
85
- #### Inherited from
86
-
87
- [`BaseFuncItem`](BaseFuncItem.md).[`scope`](BaseFuncItem.md#scope)
88
-
89
- #### Defined in
90
-
91
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L44)
92
-
93
- ***
94
-
95
- ### setup()?
96
-
97
- > `optional` **setup**: (`this`, `options`?) => `void`
98
-
99
- #### Parameters
100
-
101
- • **this**: [`ToolFunc`](../classes/ToolFunc.md)
102
-
103
- • **options?**: [`FuncItem`](FuncItem.md)
104
-
105
- #### Returns
106
-
107
- `void`
108
-
109
- #### Inherited from
110
-
111
- [`BaseFuncItem`](BaseFuncItem.md).[`setup`](BaseFuncItem.md#setup)
112
-
113
- #### Defined in
114
-
115
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L46)
116
-
117
- ***
118
-
119
- ### stream?
120
-
121
- > `optional` **stream**: `boolean`
122
-
123
- #### Inherited from
124
-
125
- [`BaseFuncItem`](BaseFuncItem.md).[`stream`](BaseFuncItem.md#stream)
126
-
127
- #### Defined in
128
-
129
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L48)
130
-
131
- ***
132
-
133
- ### tags?
134
-
135
- > `optional` **tags**: `string` \| `string`[]
136
-
137
- #### Inherited from
138
-
139
- [`BaseFuncItem`](BaseFuncItem.md).[`tags`](BaseFuncItem.md#tags)
140
-
141
- #### Defined in
142
-
143
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L45)
package/docs/interfaces/FuncParam.md DELETED
@@ -1,71 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / FuncParam
6
-
7
- # Interface: FuncParam
8
-
9
- ## Properties
10
-
11
- ### asyncFeatures?
12
-
13
- > `optional` **asyncFeatures**: `number`
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L30)
18
-
19
- ***
20
-
21
- ### depends?
22
-
23
- > `optional` **depends**: `object`
24
-
25
- #### Index Signature
26
-
27
- \[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
28
-
29
- #### Defined in
30
-
31
- [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L31)
32
-
33
- ***
34
-
35
- ### description?
36
-
37
- > `optional` **description**: `string`
38
-
39
- #### Defined in
40
-
41
- [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L29)
42
-
43
- ***
44
-
45
- ### name?
46
-
47
- > `optional` **name**: `string`
48
-
49
- #### Defined in
50
-
51
- [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L26)
52
-
53
- ***
54
-
55
- ### required?
56
-
57
- > `optional` **required**: `boolean`
58
-
59
- #### Defined in
60
-
61
- [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L28)
62
-
63
- ***
64
-
65
- ### type?
66
-
67
- > `optional` **type**: `string`
68
-
69
- #### Defined in
70
-
71
- [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L27)
package/docs/interfaces/FuncParams.md DELETED
@@ -1,11 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / FuncParams
6
-
7
- # Interface: FuncParams
8
-
9
- ## Indexable
10
-
11
- \[`name`: `string`\]: [`FuncParam`](FuncParam.md) \| [`FuncParamType`](../type-aliases/FuncParamType.md)
package/docs/interfaces/Funcs.md DELETED
@@ -1,11 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / Funcs
6
-
7
- # Interface: Funcs
8
-
9
- ## Indexable
10
-
11
- \[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
package/docs/interfaces/HashAlgoParams.md DELETED
@@ -1,37 +0,0 @@
1
- [**@isdk/ai-tool**](../README.md) • **Docs**
2
-
3
- ***
4
-
5
- [@isdk/ai-tool](../globals.md) / HashAlgoParams
6
-
7
- # Interface: HashAlgoParams
8
-
9
- ## Properties
10
-
11
- ### hashAlgo?
12
-
13
- > `optional` **hashAlgo**: [`HashAlgorithm`](../enumerations/HashAlgorithm.md)
14
-
15
- #### Defined in
16
-
17
- [packages/ai-tool/src/utils/hash/xxhash.ts:76](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L76)
18
-
19
- ***
20
-
21
- ### outputType?
22
-
23
- > `optional` **outputType**: `"string"` \| `"hex"` \| `"binary"`
24
-
25
- #### Defined in
26
-
27
- [packages/ai-tool/src/utils/hash/xxhash.ts:78](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L78)
28
-
29
- ***
30
-
31
- ### seed?
32
-
33
- > `optional` **seed**: `number`
34
-
35
- #### Defined in
36
-
37
- [packages/ai-tool/src/utils/hash/xxhash.ts:77](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/hash/xxhash.ts#L77)