@isdk/ai-tool 0.2.2 → 0.3.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 (268) hide show
  1. package/dist/chunk-JHHFTTVE.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-DUEs7T8M.d.mts → index-BC3GQn6-.d.mts} +7 -0
  7. package/dist/{index-DUEs7T8M.d.ts → index-BC3GQn6-.d.ts} +7 -0
  8. package/dist/index.d.mts +443 -11
  9. package/dist/index.d.ts +443 -11
  10. package/dist/index.js +1 -1
  11. package/dist/index.mjs +1 -1
  12. package/dist/test/util.mjs +1 -1
  13. package/docs/classes/AbortError.md +45 -15
  14. package/docs/classes/AlreadyExistsError.md +45 -15
  15. package/docs/classes/BaseError.md +42 -16
  16. package/docs/classes/CancelableAbility.md +20 -20
  17. package/docs/classes/ClientTools.md +93 -93
  18. package/docs/classes/CommonError.md +45 -15
  19. package/docs/classes/EventClient.md +115 -115
  20. package/docs/classes/EventServer.md +117 -117
  21. package/docs/classes/EventToolFunc.md +85 -85
  22. package/docs/classes/FStringPromptTemplate.md +18 -18
  23. package/docs/classes/FewShotPromptTemplate.md +22 -22
  24. package/docs/classes/GolangPromptTemplate.md +18 -18
  25. package/docs/classes/HFEnvironment.md +9 -9
  26. package/docs/classes/HFInterpreter.md +4 -4
  27. package/docs/classes/HFTemplate.md +4 -4
  28. package/docs/classes/HfPromptTemplate.md +18 -18
  29. package/docs/classes/IntSet.md +11 -11
  30. package/docs/classes/NotFoundError.md +45 -15
  31. package/docs/classes/NotImplementationError.md +45 -15
  32. package/docs/classes/PromptExampleSelector.md +8 -8
  33. package/docs/classes/PromptTemplate.md +17 -17
  34. package/docs/classes/ReadableStreamError.md +45 -15
  35. package/docs/classes/ResClientTools.md +100 -100
  36. package/docs/classes/ResServerTools.md +101 -101
  37. package/docs/classes/SSEChannel.md +14 -14
  38. package/docs/classes/Semaphore.md +8 -8
  39. package/docs/classes/ServerTools.md +89 -89
  40. package/docs/classes/TaskAbortController.md +8 -8
  41. package/docs/classes/ToolFunc.md +82 -82
  42. package/docs/classes/YamlTypeBaseObject.md +29 -0
  43. package/docs/enumerations/AsyncFeatureBits.md +3 -3
  44. package/docs/enumerations/AsyncFeatures.md +3 -3
  45. package/docs/enumerations/ErrorCode.md +21 -21
  46. package/docs/enumerations/HashAlgorithm.md +117 -0
  47. package/docs/functions/AIArgProcessor.md +1 -1
  48. package/docs/functions/AIStream.md +1 -1
  49. package/docs/functions/ChoiceArgProcessor.md +1 -1
  50. package/docs/functions/RateLimit.md +1 -1
  51. package/docs/functions/TemplateArgProcessor.md +1 -1
  52. package/docs/functions/backendEventable.md +1 -1
  53. package/docs/functions/completeSentences.md +23 -0
  54. package/docs/functions/concatText.md +23 -0
  55. package/docs/functions/countLLMTokens.md +23 -0
  56. package/docs/functions/countRegexMatches.md +1 -1
  57. package/docs/functions/createCallbacksTransformer.md +1 -1
  58. package/docs/functions/createEmptyReadableStream.md +1 -1
  59. package/docs/functions/createEndWithRepetitionDetector.md +1 -1
  60. package/docs/functions/createError.md +1 -1
  61. package/docs/functions/createEventStreamTransformer.md +1 -1
  62. package/docs/functions/createHfValueFunc.md +1 -1
  63. package/docs/functions/createLRUCache.md +1 -1
  64. package/docs/functions/createYamlObjectTag.md +23 -0
  65. package/docs/functions/dateToText.md +1 -1
  66. package/docs/functions/decodeCharset.md +23 -0
  67. package/docs/functions/detectCharset.md +23 -0
  68. package/docs/functions/encodeLLMTokens.md +23 -0
  69. package/docs/functions/expandEnv.md +1 -1
  70. package/docs/functions/expandObjEnv.md +1 -1
  71. package/docs/functions/extNameLevel.md +1 -1
  72. package/docs/functions/fileIsExists.md +1 -1
  73. package/docs/functions/filenameReservedRegex.md +1 -1
  74. package/docs/functions/filterValidFnScope.md +1 -1
  75. package/docs/functions/findIndexNonEmptyFrom.md +23 -0
  76. package/docs/functions/findPort.md +1 -1
  77. package/docs/functions/formatTextWithSpace.md +59 -0
  78. package/docs/functions/getAllEnumKeys.md +1 -1
  79. package/docs/functions/getConfigFileNames.md +1 -1
  80. package/docs/functions/getConfigs.md +1 -1
  81. package/docs/functions/getFileMetaInfo.md +21 -0
  82. package/docs/functions/getHashAlgoBySize.md +21 -0
  83. package/docs/functions/getKeysPath.md +1 -1
  84. package/docs/functions/getLLMTokenizer.md +21 -0
  85. package/docs/functions/getMultiLevelExtname.md +1 -1
  86. package/docs/functions/getPackageDir.md +1 -1
  87. package/docs/functions/getRealFilepath.md +1 -1
  88. package/docs/functions/getResponseErrorReadableStream.md +1 -1
  89. package/docs/functions/hasDirectoryIn.md +38 -0
  90. package/docs/functions/hashFile.md +23 -0
  91. package/docs/functions/hashStream.md +23 -0
  92. package/docs/functions/hfParse.md +1 -1
  93. package/docs/functions/hfTokenize.md +1 -1
  94. package/docs/functions/interpolateEnv.md +1 -1
  95. package/docs/functions/interpolateFString.md +1 -1
  96. package/docs/functions/interpolateGolangTemplate.md +1 -1
  97. package/docs/functions/isLangUsingSpaces.md +21 -0
  98. package/docs/functions/isListItemString.md +21 -0
  99. package/docs/functions/isModelNameMatched.md +1 -1
  100. package/docs/functions/isPunctuationChar.md +36 -0
  101. package/docs/functions/isRegExp.md +21 -0
  102. package/docs/functions/isSectionString.md +23 -0
  103. package/docs/functions/isSentenceEnding.md +21 -0
  104. package/docs/functions/isSepLineString.md +21 -0
  105. package/docs/functions/isSubdirectory.md +39 -0
  106. package/docs/functions/isTitleString.md +23 -0
  107. package/docs/functions/isValidFilename.md +1 -1
  108. package/docs/functions/isValidFilepath.md +1 -1
  109. package/docs/functions/isWebStream.md +1 -1
  110. package/docs/functions/jsonFilterToWhere.md +1 -1
  111. package/docs/functions/jsonToMarkdownStr.md +1 -1
  112. package/docs/functions/loadFileFromPaths.md +1 -1
  113. package/docs/functions/loadTextFromPaths.md +1 -1
  114. package/docs/functions/lrucache.md +1 -1
  115. package/docs/functions/makeToolFuncCancelable.md +1 -1
  116. package/docs/functions/matchUrlProtocol.md +1 -1
  117. package/docs/functions/memoize.md +1 -1
  118. package/docs/functions/messagesToText.md +1 -1
  119. package/docs/functions/paramsSizeToScaleStr.md +1 -1
  120. package/docs/functions/parseCommand.md +1 -1
  121. package/docs/functions/parseFString.md +1 -1
  122. package/docs/functions/parseJsJson.md +3 -3
  123. package/docs/functions/parseJsJsonSimpleSync.md +23 -0
  124. package/docs/functions/parseObjectArgInfo.md +1 -1
  125. package/docs/functions/parseObjectArgumentInfos.md +1 -1
  126. package/docs/functions/parseObjectArguments.md +1 -1
  127. package/docs/functions/parseObjectArgumentsAsArgInfos.md +1 -1
  128. package/docs/functions/parseYaml.md +1 -1
  129. package/docs/functions/quoteStr.md +1 -1
  130. package/docs/functions/reControlCharsRegex.md +1 -1
  131. package/docs/functions/readFilenamesRecursiveSync.md +1 -1
  132. package/docs/functions/readTextFileChunks.md +51 -0
  133. package/docs/functions/readTextFileChunksEx.md +23 -0
  134. package/docs/functions/readableFromAsyncIterable.md +1 -1
  135. package/docs/functions/registerCoreTools.md +1 -1
  136. package/docs/functions/registerYamlTag.md +1 -1
  137. package/docs/functions/removeMarkdownBold.md +23 -0
  138. package/docs/functions/removeMarkdownBoldAndItalic.md +23 -0
  139. package/docs/functions/removeMarkdownItalic.md +23 -0
  140. package/docs/functions/replaceWithPlaceholder.md +41 -0
  141. package/docs/functions/restoreFromPlacehoders.md +45 -0
  142. package/docs/functions/sanitizeFilename.md +1 -1
  143. package/docs/functions/sanitizeFilepath.md +1 -1
  144. package/docs/functions/saveConfigFile.md +1 -1
  145. package/docs/functions/scaleStrToParamsSize.md +1 -1
  146. package/docs/functions/simplifyObjectArguments.md +1 -1
  147. package/docs/functions/sortedValues.md +1 -1
  148. package/docs/functions/splitChunks.md +23 -0
  149. package/docs/functions/splitParagraph.md +32 -0
  150. package/docs/functions/splitSentence.md +2 -2
  151. package/docs/functions/stringifyYaml.md +6 -34
  152. package/docs/functions/stripConsoleColor.md +21 -0
  153. package/docs/functions/textToDate.md +1 -1
  154. package/docs/functions/throwError.md +1 -1
  155. package/docs/functions/toDateTime.md +1 -1
  156. package/docs/functions/toRegExp.md +34 -0
  157. package/docs/functions/trimStartOfStreamHelper.md +1 -1
  158. package/docs/functions/truncTo.md +1 -1
  159. package/docs/functions/truncateByToken.md +23 -0
  160. package/docs/functions/truncateToTokenLimit.md +44 -0
  161. package/docs/functions/truncateToTokenLimitEx.md +23 -0
  162. package/docs/functions/uuid.md +1 -1
  163. package/docs/functions/wait.md +1 -1
  164. package/docs/functions/xxhash.md +2 -2
  165. package/docs/functions/xxhash32.md +1 -1
  166. package/docs/functions/xxhash64.md +1 -1
  167. package/docs/functions/xxhashAsStr.md +2 -2
  168. package/docs/globals.md +50 -1
  169. package/docs/interfaces/AIChatAssistantMessageParam.md +48 -6
  170. package/docs/interfaces/AIChatContentPartImage.md +2 -2
  171. package/docs/interfaces/AIChatContentPartText.md +2 -2
  172. package/docs/interfaces/AIChatMessageParamBase.md +31 -1
  173. package/docs/interfaces/AIChatMessageToolCall.md +3 -3
  174. package/docs/interfaces/AIChatSystemMessageParam.md +45 -3
  175. package/docs/interfaces/AIChatToolMessageParam.md +46 -4
  176. package/docs/interfaces/AIChatUserMessageParam.md +49 -7
  177. package/docs/interfaces/AIChoiceConfig.md +7 -7
  178. package/docs/interfaces/AIResult.md +5 -5
  179. package/docs/interfaces/AIStreamParser.md +1 -1
  180. package/docs/interfaces/AIStreamParserOptions.md +1 -1
  181. package/docs/interfaces/BaseFunc.md +9 -9
  182. package/docs/interfaces/BaseFuncItem.md +8 -8
  183. package/docs/interfaces/CancelableAbilityOptions.md +2 -2
  184. package/docs/interfaces/ClientFuncItem.md +11 -11
  185. package/docs/interfaces/DotenvExpandOptions.md +3 -3
  186. package/docs/interfaces/DotenvExpandOutput.md +2 -2
  187. package/docs/interfaces/EventClientFuncParams.md +4 -4
  188. package/docs/interfaces/EventServerFuncParams.md +5 -5
  189. package/docs/interfaces/FewShotPromptTemplateOptions.md +11 -11
  190. package/docs/interfaces/FuncItem.md +9 -9
  191. package/docs/interfaces/FuncParam.md +6 -6
  192. package/docs/interfaces/HashAlgoParams.md +37 -0
  193. package/docs/interfaces/IFileMetaInfo.md +77 -0
  194. package/docs/interfaces/IReadTextFileChunksOptions.md +157 -0
  195. package/docs/interfaces/ITruncateToTokenLimitOptions.md +111 -0
  196. package/docs/interfaces/ParseObjectArgumentOptions.md +45 -5
  197. package/docs/interfaces/PromptExampleSelectorOptions.md +2 -2
  198. package/docs/interfaces/PromptTemplateOptions.md +6 -6
  199. package/docs/interfaces/RemoteFuncItem.md +11 -11
  200. package/docs/interfaces/ReplacePlacehoderOptions.md +47 -0
  201. package/docs/interfaces/ResClientFuncParams.md +2 -2
  202. package/docs/interfaces/ResServerFuncParams.md +5 -5
  203. package/docs/interfaces/SanitizeFilenameOptions.md +2 -2
  204. package/docs/interfaces/SectionStringOptions.md +27 -0
  205. package/docs/interfaces/ServerFuncItem.md +12 -12
  206. package/docs/interfaces/ServerFuncParams.md +2 -2
  207. package/docs/interfaces/SplitSentenceOptions.md +47 -0
  208. package/docs/interfaces/StreamCallbacksAndOptions.md +4 -4
  209. package/docs/interfaces/TaskPromise.md +5 -5
  210. package/docs/interfaces/ToolFuncPackage.md +3 -3
  211. package/docs/type-aliases/AIChatContentPart.md +1 -1
  212. package/docs/type-aliases/AIChatMessageParam.md +1 -1
  213. package/docs/type-aliases/AIChatRole.md +1 -1
  214. package/docs/type-aliases/AIMessageType.md +1 -1
  215. package/docs/type-aliases/AIModelNameRule.md +1 -1
  216. package/docs/type-aliases/AIModelNameRuleFn.md +1 -1
  217. package/docs/type-aliases/AIModelNameRules.md +1 -1
  218. package/docs/type-aliases/AITextGenerationFinishReason.md +1 -1
  219. package/docs/type-aliases/ActionName.md +1 -1
  220. package/docs/type-aliases/AsyncTaskId.md +1 -1
  221. package/docs/type-aliases/EventErrorListenerFn.md +1 -1
  222. package/docs/type-aliases/EventListenerFn.md +1 -1
  223. package/docs/type-aliases/FStringPromptTemplateNode.md +1 -1
  224. package/docs/type-aliases/FuncParamType.md +1 -1
  225. package/docs/type-aliases/PromptExamples.md +1 -1
  226. package/docs/type-aliases/PromptTemplateType.md +1 -1
  227. package/docs/type-aliases/PromptType.md +1 -1
  228. package/docs/type-aliases/TFunc.md +1 -1
  229. package/docs/variables/AIChatRoles.md +1 -1
  230. package/docs/variables/AIMessageTypes.md +1 -1
  231. package/docs/variables/AITextGenerationFinishReasons.md +1 -1
  232. package/docs/variables/AbortErrorCode.md +1 -1
  233. package/docs/variables/ActionNames.md +1 -1
  234. package/docs/variables/AlreadyExistsErrorCode.md +1 -1
  235. package/docs/variables/ClientToolFuncSchema.md +1 -1
  236. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  237. package/docs/variables/EventBusName.md +1 -1
  238. package/docs/variables/EventName.md +1 -1
  239. package/docs/variables/FilenameReservedRegex.md +1 -1
  240. package/docs/variables/HFBuiltins.md +1 -1
  241. package/docs/variables/InternalErrorCode.md +1 -1
  242. package/docs/variables/LLM_TOKENIZER_NAMES.md +83 -0
  243. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +13 -0
  244. package/docs/variables/NotFoundErrorCode.md +1 -1
  245. package/docs/variables/NotImplementedErrorCode.md +1 -1
  246. package/docs/variables/PASSING_SCORE.md +1 -1
  247. package/docs/variables/PromptTemplateTypes.md +1 -1
  248. package/docs/variables/PromptTypes.md +1 -1
  249. package/docs/variables/RStreamErrCode.md +1 -1
  250. package/docs/variables/RemoteToolFuncSchema.md +1 -1
  251. package/docs/variables/ResponseRStreamErrCode.md +1 -1
  252. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
  253. package/docs/variables/ServerToolFuncSchema.md +1 -1
  254. package/docs/variables/ToolAsyncCancelableBit.md +1 -1
  255. package/docs/variables/ToolAsyncMultiTaskBit.md +1 -1
  256. package/docs/variables/ToolAsyncPriorityBit.md +1 -1
  257. package/docs/variables/ToolFuncSchema.md +1 -1
  258. package/docs/variables/WindowsReservedNameRegex.md +1 -1
  259. package/docs/variables/base32768.md +1 -1
  260. package/docs/variables/defaultTemplateFormat.md +1 -1
  261. package/docs/variables/event.md +1 -1
  262. package/docs/variables/eventClient.md +1 -1
  263. package/docs/variables/eventServer.md +1 -1
  264. package/docs/variables/lrucache.md +1 -1
  265. package/package.json +7 -3
  266. package/dist/chunk-PY6NRGZE.mjs +0 -1
  267. package/docs/enumerations/XXHashAlgorithm.md +0 -27
  268. /package/dist/{chunk-PXQPLL62.mjs → chunk-VIG2GB47.mjs} +0 -0
package/docs/interfaces/EventServerFuncParams.md CHANGED
@@ -24,7 +24,7 @@ Convention: Always pass _req, _res
24
24
 
25
25
  #### Defined in
26
26
 
27
- [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/server-tools.ts#L9)
27
+ [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L9)
28
28
 
29
29
  ***
30
30
 
@@ -38,7 +38,7 @@ Convention: Always pass _req, _res
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/server-tools.ts#L10)
41
+ [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/server-tools.ts#L10)
42
42
 
43
43
  ***
44
44
 
@@ -48,7 +48,7 @@ Convention: Always pass _req, _res
48
48
 
49
49
  #### Defined in
50
50
 
51
- [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/funcs/event-server.ts#L15)
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
52
 
53
53
  ***
54
54
 
@@ -58,7 +58,7 @@ Convention: Always pass _req, _res
58
58
 
59
59
  #### Defined in
60
60
 
61
- [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/funcs/event-server.ts#L14)
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
62
 
63
63
  ***
64
64
 
@@ -68,4 +68,4 @@ Convention: Always pass _req, _res
68
68
 
69
69
  #### Defined in
70
70
 
71
- [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/funcs/event-server.ts#L13)
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 CHANGED
@@ -26,7 +26,7 @@
26
26
 
27
27
  #### Defined in
28
28
 
29
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/prompt-template.ts#L15)
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
30
 
31
31
  ***
32
32
 
@@ -40,7 +40,7 @@
40
40
 
41
41
  #### Defined in
42
42
 
43
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/prompt-template.ts#L12)
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
44
 
45
45
  ***
46
46
 
@@ -52,7 +52,7 @@ An [PromptTemplate](../classes/PromptTemplate.md) used to format a single exampl
52
52
 
53
53
  #### Defined in
54
54
 
55
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/few-shot-prompt-template.ts#L19)
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
56
 
57
57
  ***
58
58
 
@@ -64,7 +64,7 @@ The few shot examples to use in the prompt.
64
64
 
65
65
  #### Defined in
66
66
 
67
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/few-shot-prompt-template.ts#L14)
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
68
 
69
69
  ***
70
70
 
@@ -76,7 +76,7 @@ String separator used to join the prefix, the examples, and suffix.
76
76
 
77
77
  #### Defined in
78
78
 
79
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/few-shot-prompt-template.ts#L24)
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
80
 
81
81
  ***
82
82
 
@@ -90,7 +90,7 @@ String separator used to join the prefix, the examples, and suffix.
90
90
 
91
91
  #### Defined in
92
92
 
93
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/prompt-template.ts#L16)
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
94
 
95
95
  ***
96
96
 
@@ -104,7 +104,7 @@ String separator used to join the prefix, the examples, and suffix.
104
104
 
105
105
  #### Defined in
106
106
 
107
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/prompt-template.ts#L14)
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
108
 
109
109
  ***
110
110
 
@@ -120,7 +120,7 @@ A prompt template string to put before the examples.
120
120
 
121
121
  #### Defined in
122
122
 
123
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/few-shot-prompt-template.ts#L31)
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
124
 
125
125
  ***
126
126
 
@@ -132,7 +132,7 @@ A prompt template string to put after the examples.
132
132
 
133
133
  #### Defined in
134
134
 
135
- [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/few-shot-prompt-template.ts#L36)
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
136
 
137
137
  ***
138
138
 
@@ -146,7 +146,7 @@ A prompt template string to put after the examples.
146
146
 
147
147
  #### Defined in
148
148
 
149
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/prompt-template.ts#L11)
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
150
 
151
151
  ***
152
152
 
@@ -160,4 +160,4 @@ A prompt template string to put after the examples.
160
160
 
161
161
  #### Defined in
162
162
 
163
- [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/utils/prompt/prompt-template.ts#L13)
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 CHANGED
@@ -18,7 +18,7 @@
18
18
 
19
19
  #### Defined in
20
20
 
21
- [packages/ai-tool/src/tool-func.ts:52](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L52)
21
+ [packages/ai-tool/src/tool-func.ts:52](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L52)
22
22
 
23
23
  ***
24
24
 
@@ -32,7 +32,7 @@
32
32
 
33
33
  #### Defined in
34
34
 
35
- [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L47)
35
+ [packages/ai-tool/src/tool-func.ts:47](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L47)
36
36
 
37
37
  ***
38
38
 
@@ -46,7 +46,7 @@
46
46
 
47
47
  #### Defined in
48
48
 
49
- [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L41)
49
+ [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L41)
50
50
 
51
51
  ***
52
52
 
@@ -60,7 +60,7 @@
60
60
 
61
61
  #### Defined in
62
62
 
63
- [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L42)
63
+ [packages/ai-tool/src/tool-func.ts:42](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L42)
64
64
 
65
65
  ***
66
66
 
@@ -74,7 +74,7 @@
74
74
 
75
75
  #### Defined in
76
76
 
77
- [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L43)
77
+ [packages/ai-tool/src/tool-func.ts:43](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L43)
78
78
 
79
79
  ***
80
80
 
@@ -88,7 +88,7 @@
88
88
 
89
89
  #### Defined in
90
90
 
91
- [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L44)
91
+ [packages/ai-tool/src/tool-func.ts:44](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L44)
92
92
 
93
93
  ***
94
94
 
@@ -112,7 +112,7 @@
112
112
 
113
113
  #### Defined in
114
114
 
115
- [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L46)
115
+ [packages/ai-tool/src/tool-func.ts:46](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L46)
116
116
 
117
117
  ***
118
118
 
@@ -126,7 +126,7 @@
126
126
 
127
127
  #### Defined in
128
128
 
129
- [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L48)
129
+ [packages/ai-tool/src/tool-func.ts:48](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L48)
130
130
 
131
131
  ***
132
132
 
@@ -140,4 +140,4 @@
140
140
 
141
141
  #### Defined in
142
142
 
143
- [packages/ai-tool/src/tool-func.ts:45](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L45)
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 CHANGED
@@ -14,7 +14,7 @@
14
14
 
15
15
  #### Defined in
16
16
 
17
- [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L30)
17
+ [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L30)
18
18
 
19
19
  ***
20
20
 
@@ -28,7 +28,7 @@
28
28
 
29
29
  #### Defined in
30
30
 
31
- [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L31)
31
+ [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L31)
32
32
 
33
33
  ***
34
34
 
@@ -38,7 +38,7 @@
38
38
 
39
39
  #### Defined in
40
40
 
41
- [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L29)
41
+ [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L29)
42
42
 
43
43
  ***
44
44
 
@@ -48,7 +48,7 @@
48
48
 
49
49
  #### Defined in
50
50
 
51
- [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L26)
51
+ [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L26)
52
52
 
53
53
  ***
54
54
 
@@ -58,7 +58,7 @@
58
58
 
59
59
  #### Defined in
60
60
 
61
- [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L28)
61
+ [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/tool-func.ts#L28)
62
62
 
63
63
  ***
64
64
 
@@ -68,4 +68,4 @@
68
68
 
69
69
  #### Defined in
70
70
 
71
- [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/37ada542a786fbbc770f2d61beb564f6e603941d/src/tool-func.ts#L27)
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/HashAlgoParams.md ADDED
@@ -0,0 +1,37 @@
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)
package/docs/interfaces/IFileMetaInfo.md ADDED
@@ -0,0 +1,77 @@
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / IFileMetaInfo
6
+
7
+ # Interface: IFileMetaInfo
8
+
9
+ ## Properties
10
+
11
+ ### ctime
12
+
13
+ > **ctime**: `Date`
14
+
15
+ #### Defined in
16
+
17
+ [packages/ai-tool/src/utils/load-file-from-paths.ts:213](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L213)
18
+
19
+ ***
20
+
21
+ ### hash
22
+
23
+ > **hash**: `string`
24
+
25
+ #### Defined in
26
+
27
+ [packages/ai-tool/src/utils/load-file-from-paths.ts:215](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L215)
28
+
29
+ ***
30
+
31
+ ### id
32
+
33
+ > **id**: `string`
34
+
35
+ #### Defined in
36
+
37
+ [packages/ai-tool/src/utils/load-file-from-paths.ts:217](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L217)
38
+
39
+ ***
40
+
41
+ ### mimeType
42
+
43
+ > **mimeType**: `string`
44
+
45
+ #### Defined in
46
+
47
+ [packages/ai-tool/src/utils/load-file-from-paths.ts:216](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L216)
48
+
49
+ ***
50
+
51
+ ### mtime
52
+
53
+ > **mtime**: `Date`
54
+
55
+ #### Defined in
56
+
57
+ [packages/ai-tool/src/utils/load-file-from-paths.ts:212](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L212)
58
+
59
+ ***
60
+
61
+ ### name
62
+
63
+ > **name**: `string`
64
+
65
+ #### Defined in
66
+
67
+ [packages/ai-tool/src/utils/load-file-from-paths.ts:211](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L211)
68
+
69
+ ***
70
+
71
+ ### size
72
+
73
+ > **size**: `number`
74
+
75
+ #### Defined in
76
+
77
+ [packages/ai-tool/src/utils/load-file-from-paths.ts:214](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L214)
package/docs/interfaces/IReadTextFileChunksOptions.md ADDED
@@ -0,0 +1,157 @@
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / IReadTextFileChunksOptions
6
+
7
+ # Interface: IReadTextFileChunksOptions
8
+
9
+ ## Extends
10
+
11
+ - [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md)
12
+
13
+ ## Properties
14
+
15
+ ### best?
16
+
17
+ > `optional` **best**: `boolean`
18
+
19
+ #### Inherited from
20
+
21
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`best`](ITruncateToTokenLimitOptions.md#best)
22
+
23
+ #### Defined in
24
+
25
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L8)
26
+
27
+ ***
28
+
29
+ ### bySentence?
30
+
31
+ > `optional` **bySentence**: `boolean`
32
+
33
+ #### Inherited from
34
+
35
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`bySentence`](ITruncateToTokenLimitOptions.md#bysentence)
36
+
37
+ #### Defined in
38
+
39
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:4](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L4)
40
+
41
+ ***
42
+
43
+ ### completeSentence?
44
+
45
+ > `optional` **completeSentence**: `boolean`
46
+
47
+ #### Inherited from
48
+
49
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`completeSentence`](ITruncateToTokenLimitOptions.md#completesentence)
50
+
51
+ #### Defined in
52
+
53
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L9)
54
+
55
+ ***
56
+
57
+ ### corrected?
58
+
59
+ > `optional` **corrected**: `boolean`
60
+
61
+ #### Inherited from
62
+
63
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`corrected`](ITruncateToTokenLimitOptions.md#corrected)
64
+
65
+ #### Defined in
66
+
67
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L10)
68
+
69
+ ***
70
+
71
+ ### countLLMTokens()?
72
+
73
+ > `optional` **countLLMTokens**: (`text`, `modelId`?) => `Promise`\<`number`\>
74
+
75
+ #### Parameters
76
+
77
+ • **text**: `string`
78
+
79
+ • **modelId?**: `string`
80
+
81
+ #### Returns
82
+
83
+ `Promise`\<`number`\>
84
+
85
+ #### Inherited from
86
+
87
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`countLLMTokens`](ITruncateToTokenLimitOptions.md#countllmtokens)
88
+
89
+ #### Defined in
90
+
91
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L12)
92
+
93
+ ***
94
+
95
+ ### metaInfo?
96
+
97
+ > `optional` **metaInfo**: `RequireAtLeastOne`\<`Partial`\<[`IFileMetaInfo`](IFileMetaInfo.md)\>, `"size"`\>
98
+
99
+ #### Defined in
100
+
101
+ [packages/ai-tool/src/utils/read-text-file-chunks.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/read-text-file-chunks.ts#L8)
102
+
103
+ ***
104
+
105
+ ### modelId?
106
+
107
+ > `optional` **modelId**: `string`
108
+
109
+ #### Overrides
110
+
111
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`modelId`](ITruncateToTokenLimitOptions.md#modelid)
112
+
113
+ #### Defined in
114
+
115
+ [packages/ai-tool/src/utils/read-text-file-chunks.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/read-text-file-chunks.ts#L7)
116
+
117
+ ***
118
+
119
+ ### sentences?
120
+
121
+ > `optional` **sentences**: `string`[]
122
+
123
+ #### Inherited from
124
+
125
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`sentences`](ITruncateToTokenLimitOptions.md#sentences)
126
+
127
+ #### Defined in
128
+
129
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L7)
130
+
131
+ ***
132
+
133
+ ### size?
134
+
135
+ > `optional` **size**: `number`
136
+
137
+ #### Overrides
138
+
139
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`size`](ITruncateToTokenLimitOptions.md#size)
140
+
141
+ #### Defined in
142
+
143
+ [packages/ai-tool/src/utils/read-text-file-chunks.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/read-text-file-chunks.ts#L6)
144
+
145
+ ***
146
+
147
+ ### truncLastSection?
148
+
149
+ > `optional` **truncLastSection**: `boolean`
150
+
151
+ #### Inherited from
152
+
153
+ [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`truncLastSection`](ITruncateToTokenLimitOptions.md#trunclastsection)
154
+
155
+ #### Defined in
156
+
157
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L11)
package/docs/interfaces/ITruncateToTokenLimitOptions.md ADDED
@@ -0,0 +1,111 @@
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / ITruncateToTokenLimitOptions
6
+
7
+ # Interface: ITruncateToTokenLimitOptions
8
+
9
+ ## Extended by
10
+
11
+ - [`IReadTextFileChunksOptions`](IReadTextFileChunksOptions.md)
12
+
13
+ ## Properties
14
+
15
+ ### best?
16
+
17
+ > `optional` **best**: `boolean`
18
+
19
+ #### Defined in
20
+
21
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L8)
22
+
23
+ ***
24
+
25
+ ### bySentence?
26
+
27
+ > `optional` **bySentence**: `boolean`
28
+
29
+ #### Defined in
30
+
31
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:4](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L4)
32
+
33
+ ***
34
+
35
+ ### completeSentence?
36
+
37
+ > `optional` **completeSentence**: `boolean`
38
+
39
+ #### Defined in
40
+
41
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L9)
42
+
43
+ ***
44
+
45
+ ### corrected?
46
+
47
+ > `optional` **corrected**: `boolean`
48
+
49
+ #### Defined in
50
+
51
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L10)
52
+
53
+ ***
54
+
55
+ ### countLLMTokens()?
56
+
57
+ > `optional` **countLLMTokens**: (`text`, `modelId`?) => `Promise`\<`number`\>
58
+
59
+ #### Parameters
60
+
61
+ • **text**: `string`
62
+
63
+ • **modelId?**: `string`
64
+
65
+ #### Returns
66
+
67
+ `Promise`\<`number`\>
68
+
69
+ #### Defined in
70
+
71
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L12)
72
+
73
+ ***
74
+
75
+ ### modelId?
76
+
77
+ > `optional` **modelId**: `string`
78
+
79
+ #### Defined in
80
+
81
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L6)
82
+
83
+ ***
84
+
85
+ ### sentences?
86
+
87
+ > `optional` **sentences**: `string`[]
88
+
89
+ #### Defined in
90
+
91
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L7)
92
+
93
+ ***
94
+
95
+ ### size?
96
+
97
+ > `optional` **size**: `number`
98
+
99
+ #### Defined in
100
+
101
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:5](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L5)
102
+
103
+ ***
104
+
105
+ ### truncLastSection?
106
+
107
+ > `optional` **truncLastSection**: `boolean`
108
+
109
+ #### Defined in
110
+
111
+ [packages/ai-tool/src/utils/truncate-to-token-limit.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L11)