@isdk/ai-tool 0.2.0 → 0.2.2

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