@isdk/ai-tool 0.2.0 → 0.2.1

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