@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/classes/NotImplementationError.md CHANGED
@@ -1,60 +1,35 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / NotImplementationError
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / NotImplementationError
2
6
 
3
7
  # Class: NotImplementationError
4
8
 
5
9
  Represents an error when a function or method is not implemented.
6
10
  Inherits from BaseError.
7
11
 
8
- **`Example`**
12
+ ## Example
9
13
 
10
14
  ```ts
11
15
  throw new NotImplementationError()
12
16
  ```
13
17
 
14
- ## Hierarchy
18
+ ## Extends
15
19
 
16
20
  - [`CommonError`](CommonError.md)
17
21
 
18
- ↳ **`NotImplementationError`**
19
-
20
- ## Table of contents
21
-
22
- ### Constructors
23
-
24
- - [constructor](NotImplementationError.md#constructor)
25
-
26
- ### Properties
27
-
28
- - [caller](NotImplementationError.md#caller)
29
- - [cause](NotImplementationError.md#cause)
30
- - [code](NotImplementationError.md#code)
31
- - [data](NotImplementationError.md#data)
32
- - [message](NotImplementationError.md#message)
33
- - [name](NotImplementationError.md#name)
34
- - [stack](NotImplementationError.md#stack)
35
- - [code](NotImplementationError.md#code-1)
36
- - [prepareStackTrace](NotImplementationError.md#preparestacktrace)
37
- - [stackTraceLimit](NotImplementationError.md#stacktracelimit)
38
-
39
- ### Methods
40
-
41
- - [fromJSON](NotImplementationError.md#fromjson)
42
- - [toJSON](NotImplementationError.md#tojson)
43
- - [captureStackTrace](NotImplementationError.md#capturestacktrace)
44
- - [createErrorClass](NotImplementationError.md#createerrorclass)
45
-
46
22
  ## Constructors
47
23
 
48
- ### constructor
24
+ ### new NotImplementationError()
49
25
 
50
- • **new NotImplementationError**(`msg?`, `name?`): [`NotImplementationError`](NotImplementationError.md)
26
+ > **new NotImplementationError**(`msg`?, `name`?): [`NotImplementationError`](NotImplementationError.md)
51
27
 
52
28
  #### Parameters
53
29
 
54
- | Name | Type |
55
- | :------ | :------ |
56
- | `msg?` | `string` |
57
- | `name?` | `string` \| `Record`\<`string`, `any`\> |
30
+ • **msg?**: `string`
31
+
32
+ • **name?**: `string` \| `Record`\<`string`, `any`\>
58
33
 
59
34
  #### Returns
60
35
 
@@ -62,192 +37,189 @@ throw new NotImplementationError()
62
37
 
63
38
  #### Overrides
64
39
 
65
- [CommonError](CommonError.md).[constructor](CommonError.md#constructor)
40
+ [`CommonError`](CommonError.md).[`constructor`](CommonError.md#constructors)
66
41
 
67
42
  #### Defined in
68
43
 
69
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:102
44
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:102
70
45
 
71
46
  ## Properties
72
47
 
73
48
  ### caller
74
49
 
75
- • **caller**: `string`
50
+ > **caller**: `string`
76
51
 
77
52
  The name of the function that threw the error.
78
53
 
79
54
  #### Inherited from
80
55
 
81
- [CommonError](CommonError.md).[caller](CommonError.md#caller)
56
+ [`CommonError`](CommonError.md).[`caller`](CommonError.md#caller)
82
57
 
83
58
  #### Defined in
84
59
 
85
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:63
60
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:63
86
61
 
87
- ___
62
+ ***
88
63
 
89
- ### cause
64
+ ### cause?
90
65
 
91
- • `Optional` **cause**: `unknown`
66
+ > `optional` **cause**: `unknown`
92
67
 
93
68
  #### Inherited from
94
69
 
95
- [CommonError](CommonError.md).[cause](CommonError.md#cause)
70
+ [`CommonError`](CommonError.md).[`cause`](CommonError.md#cause)
96
71
 
97
72
  #### Defined in
98
73
 
99
- node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es2022.error.d.ts:24
74
+ node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
100
75
 
101
- ___
76
+ ***
102
77
 
103
78
  ### code
104
79
 
105
- • **code**: `ErrorCodeType`
80
+ > **code**: `ErrorCodeType`
81
+
82
+ the error code
106
83
 
107
84
  #### Inherited from
108
85
 
109
- [CommonError](CommonError.md).[code](CommonError.md#code)
86
+ [`CommonError`](CommonError.md).[`code`](CommonError.md#code)
110
87
 
111
88
  #### Defined in
112
89
 
113
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:64
90
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:64
114
91
 
115
- ___
92
+ ***
116
93
 
117
- ### data
94
+ ### data?
118
95
 
119
- • `Optional` **data**: `any`
96
+ > `optional` **data**: `any`
120
97
 
121
98
  Additional data associated with the error.
122
99
 
123
100
  #### Inherited from
124
101
 
125
- [CommonError](CommonError.md).[data](CommonError.md#data)
102
+ [`CommonError`](CommonError.md).[`data`](CommonError.md#data)
126
103
 
127
104
  #### Defined in
128
105
 
129
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:65
106
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:65
130
107
 
131
- ___
108
+ ***
132
109
 
133
110
  ### message
134
111
 
135
- • **message**: `string`
112
+ > **message**: `string`
136
113
 
137
114
  #### Inherited from
138
115
 
139
- [CommonError](CommonError.md).[message](CommonError.md#message)
116
+ [`CommonError`](CommonError.md).[`message`](CommonError.md#message)
140
117
 
141
118
  #### Defined in
142
119
 
143
- node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1077
120
+ node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1077
144
121
 
145
- ___
122
+ ***
146
123
 
147
124
  ### name
148
125
 
149
- • **name**: `string`
126
+ > **name**: `string`
150
127
 
151
128
  #### Inherited from
152
129
 
153
- [CommonError](CommonError.md).[name](CommonError.md#name)
130
+ [`CommonError`](CommonError.md).[`name`](CommonError.md#name)
154
131
 
155
132
  #### Defined in
156
133
 
157
- node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1076
134
+ node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1076
158
135
 
159
- ___
136
+ ***
160
137
 
161
- ### stack
138
+ ### stack?
162
139
 
163
- • `Optional` **stack**: `string`
140
+ > `optional` **stack**: `string`
164
141
 
165
142
  #### Inherited from
166
143
 
167
- [CommonError](CommonError.md).[stack](CommonError.md#stack)
144
+ [`CommonError`](CommonError.md).[`stack`](CommonError.md#stack)
168
145
 
169
146
  #### Defined in
170
147
 
171
- node_modules/.pnpm/typescript@5.4.5/node_modules/typescript/lib/lib.es5.d.ts:1078
148
+ node\_modules/.pnpm/typescript@5.6.2/node\_modules/typescript/lib/lib.es5.d.ts:1078
172
149
 
173
- ___
150
+ ***
174
151
 
175
152
  ### code
176
153
 
177
- ▪ `Static` **code**: `ErrorCodeType`
154
+ > `static` **code**: `ErrorCodeType`
178
155
 
179
156
  The error code associated with the error.
180
157
 
181
158
  #### Inherited from
182
159
 
183
- [CommonError](CommonError.md).[code](CommonError.md#code-1)
160
+ [`CommonError`](CommonError.md).[`code`](CommonError.md#code-1)
184
161
 
185
162
  #### Defined in
186
163
 
187
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:62
164
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:62
188
165
 
189
- ___
166
+ ***
190
167
 
191
- ### prepareStackTrace
168
+ ### prepareStackTrace()?
192
169
 
193
- ▪ `Static` `Optional` **prepareStackTrace**: (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any`
170
+ > `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
194
171
 
195
172
  Optional override for formatting stack traces
196
173
 
197
- **`See`**
198
-
199
- https://v8.dev/docs/stack-trace-api#customizing-stack-traces
174
+ #### Parameters
200
175
 
201
- #### Type declaration
176
+ • **err**: `Error`
202
177
 
203
- ▸ (`err`, `stackTraces`): `any`
178
+ • **stackTraces**: `CallSite`[]
204
179
 
205
- ##### Parameters
180
+ #### Returns
206
181
 
207
- | Name | Type |
208
- | :------ | :------ |
209
- | `err` | `Error` |
210
- | `stackTraces` | `CallSite`[] |
182
+ `any`
211
183
 
212
- ##### Returns
184
+ #### See
213
185
 
214
- `any`
186
+ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
215
187
 
216
188
  #### Inherited from
217
189
 
218
- [CommonError](CommonError.md).[prepareStackTrace](CommonError.md#preparestacktrace)
190
+ [`CommonError`](CommonError.md).[`prepareStackTrace`](CommonError.md#preparestacktrace)
219
191
 
220
192
  #### Defined in
221
193
 
222
- node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:28
194
+ node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:143
223
195
 
224
- ___
196
+ ***
225
197
 
226
198
  ### stackTraceLimit
227
199
 
228
- ▪ `Static` **stackTraceLimit**: `number`
200
+ > `static` **stackTraceLimit**: `number`
229
201
 
230
202
  #### Inherited from
231
203
 
232
- [CommonError](CommonError.md).[stackTraceLimit](CommonError.md#stacktracelimit)
204
+ [`CommonError`](CommonError.md).[`stackTraceLimit`](CommonError.md#stacktracelimit)
233
205
 
234
206
  #### Defined in
235
207
 
236
- node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:30
208
+ node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:145
237
209
 
238
210
  ## Methods
239
211
 
240
- ### fromJSON
212
+ ### fromJSON()
241
213
 
242
- ▸ **fromJSON**(`json`): [`BaseError`](BaseError.md)
214
+ > **fromJSON**(`json`): [`BaseError`](BaseError.md)
243
215
 
244
216
  Creates a new BaseError instance from a JSON representation.
245
217
 
246
218
  #### Parameters
247
219
 
248
- | Name | Type | Description |
249
- | :------ | :------ | :------ |
250
- | `json` | `any` | A JSON representation of the error. |
220
+ • **json**: `any`
221
+
222
+ A JSON representation of the error.
251
223
 
252
224
  #### Returns
253
225
 
@@ -257,17 +229,17 @@ A new BaseError instance.
257
229
 
258
230
  #### Inherited from
259
231
 
260
- [CommonError](CommonError.md).[fromJSON](CommonError.md#fromjson)
232
+ [`CommonError`](CommonError.md).[`fromJSON`](CommonError.md#fromjson)
261
233
 
262
234
  #### Defined in
263
235
 
264
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:87
236
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:87
265
237
 
266
- ___
238
+ ***
267
239
 
268
- ### toJSON
240
+ ### toJSON()
269
241
 
270
- ▸ **toJSON**(): `any`
242
+ > **toJSON**(): `any`
271
243
 
272
244
  Returns a JSON representation of the error.
273
245
 
@@ -279,26 +251,25 @@ A JSON representation of the error.
279
251
 
280
252
  #### Inherited from
281
253
 
282
- [CommonError](CommonError.md).[toJSON](CommonError.md#tojson)
254
+ [`CommonError`](CommonError.md).[`toJSON`](CommonError.md#tojson)
283
255
 
284
256
  #### Defined in
285
257
 
286
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:80
258
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:80
287
259
 
288
- ___
260
+ ***
289
261
 
290
- ### captureStackTrace
262
+ ### captureStackTrace()
291
263
 
292
- ▸ **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
264
+ > `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
293
265
 
294
266
  Create .stack property on a target object
295
267
 
296
268
  #### Parameters
297
269
 
298
- | Name | Type |
299
- | :------ | :------ |
300
- | `targetObject` | `object` |
301
- | `constructorOpt?` | `Function` |
270
+ • **targetObject**: `object`
271
+
272
+ • **constructorOpt?**: `Function`
302
273
 
303
274
  #### Returns
304
275
 
@@ -306,34 +277,42 @@ Create .stack property on a target object
306
277
 
307
278
  #### Inherited from
308
279
 
309
- [CommonError](CommonError.md).[captureStackTrace](CommonError.md#capturestacktrace)
280
+ [`CommonError`](CommonError.md).[`captureStackTrace`](CommonError.md#capturestacktrace)
310
281
 
311
282
  #### Defined in
312
283
 
313
- node_modules/.pnpm/@types+node@20.14.2/node_modules/@types/node/globals.d.ts:21
284
+ node\_modules/.pnpm/@types+node@22.5.5/node\_modules/@types/node/globals.d.ts:136
285
+
286
+ ***
314
287
 
315
- ___
288
+ ### createErrorClass()
316
289
 
317
- ### createErrorClass
290
+ > `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`BaseError`](BaseError.md)
318
291
 
319
- ▸ **createErrorClass**(`aType`, `aErrorCode?`, `ParentErrorClass?`): typeof [`BaseError`](BaseError.md)
292
+ Create an Error Class
320
293
 
321
294
  #### Parameters
322
295
 
323
- | Name | Type |
324
- | :------ | :------ |
325
- | `aType` | `string` |
326
- | `aErrorCode?` | `string` \| `number` \| typeof `AbstractError` |
327
- | `ParentErrorClass?` | typeof [`BaseError`](BaseError.md) |
296
+ • **aType**: `string`
297
+
298
+ the error type(class) name
299
+
300
+ • **aErrorCode?**: `string` \| `number` \| *typeof* `AbstractError`
301
+
302
+ • **ParentErrorClass?**: *typeof* [`BaseError`](BaseError.md)
303
+
304
+ the parent error class. defaults to AbstractError
328
305
 
329
306
  #### Returns
330
307
 
331
- typeof [`BaseError`](BaseError.md)
308
+ *typeof* [`BaseError`](BaseError.md)
309
+
310
+ the new Error Class
332
311
 
333
312
  #### Inherited from
334
313
 
335
- [CommonError](CommonError.md).[createErrorClass](CommonError.md#createerrorclass)
314
+ [`CommonError`](CommonError.md).[`createErrorClass`](CommonError.md#createerrorclass)
336
315
 
337
316
  #### Defined in
338
317
 
339
- node_modules/.pnpm/@isdk+common-error@0.1.1/node_modules/@isdk/common-error/dist/index.d.ts:66
318
+ node\_modules/.pnpm/@isdk+common-error@0.1.1/node\_modules/@isdk/common-error/dist/index.d.ts:66
package/docs/classes/PromptExampleSelector.md CHANGED
@@ -1,4 +1,8 @@
1
- [@isdk/ai-tool](../README.md) / [Exports](../modules.md) / PromptExampleSelector
1
+ [**@isdk/ai-tool**](../README.md) • **Docs**
2
+
3
+ ***
4
+
5
+ [@isdk/ai-tool](../globals.md) / PromptExampleSelector
2
6
 
3
7
  # Class: PromptExampleSelector\<T\>
4
8
 
@@ -6,7 +10,7 @@ The `PromptExampleSelector` class provides a mechanism to selectively choose exa
6
10
  configurable options such as maximum length and probability threshold. This class is meant to be extended and customized
7
11
  with an implementation of the `selectExample` method.
8
12
 
9
- **`Example`**
13
+ ## Example
10
14
 
11
15
  ```ts
12
16
  // Custom selector that selects examples based on a custom condition
@@ -28,51 +32,29 @@ for await (const selectedExample of selector) {
28
32
  }
29
33
  ```
30
34
 
31
- ## Type parameters
32
-
33
- | Name | Type | Description |
34
- | :------ | :------ | :------ |
35
- | `T` | `any` | The type of the prompt examples. |
36
-
37
- ## Table of contents
38
-
39
- ### Constructors
35
+ ## Type Parameters
40
36
 
41
- - [constructor](PromptExampleSelector.md#constructor)
37
+ • **T** = `any`
42
38
 
43
- ### Properties
44
-
45
- - [examples](PromptExampleSelector.md#examples)
46
- - [maxLength](PromptExampleSelector.md#maxlength)
47
- - [threshold](PromptExampleSelector.md#threshold)
48
-
49
- ### Methods
50
-
51
- - [[asyncIterator]](PromptExampleSelector.md#[asynciterator])
52
- - [initialize](PromptExampleSelector.md#initialize)
53
- - [selectExample](PromptExampleSelector.md#selectexample)
54
- - [selectExamples](PromptExampleSelector.md#selectexamples)
39
+ The type of the prompt examples.
55
40
 
56
41
  ## Constructors
57
42
 
58
- ### constructor
43
+ ### new PromptExampleSelector()
59
44
 
60
- • **new PromptExampleSelector**\<`T`\>(`examples`, `options?`): [`PromptExampleSelector`](PromptExampleSelector.md)\<`T`\>
45
+ > **new PromptExampleSelector**\<`T`\>(`examples`, `options`?): [`PromptExampleSelector`](PromptExampleSelector.md)\<`T`\>
61
46
 
62
47
  Constructs a new `PromptExampleSelector` instance with the given examples and options.
63
48
 
64
- #### Type parameters
49
+ #### Parameters
50
+
51
+ • **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
65
52
 
66
- | Name | Type |
67
- | :------ | :------ |
68
- | `T` | `any` |
53
+ The prompt examples to select from.
69
54
 
70
- #### Parameters
55
+ • **options?**: [`PromptExampleSelectorOptions`](../interfaces/PromptExampleSelectorOptions.md)
71
56
 
72
- | Name | Type | Description |
73
- | :------ | :------ | :------ |
74
- | `examples` | [`PromptExamples`](../modules.md#promptexamples)\<`T`\> | The prompt examples to select from. |
75
- | `options?` | [`PromptExampleSelectorOptions`](../interfaces/PromptExampleSelectorOptions.md) | An optional configuration object. |
57
+ An optional configuration object.
76
58
 
77
59
  #### Returns
78
60
 
@@ -80,47 +62,47 @@ Constructs a new `PromptExampleSelector` instance with the given examples and op
80
62
 
81
63
  #### Defined in
82
64
 
83
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-example-selector.ts#L62)
65
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-example-selector.ts#L62)
84
66
 
85
67
  ## Properties
86
68
 
87
69
  ### examples
88
70
 
89
- • **examples**: [`PromptExamples`](../modules.md#promptexamples)\<`T`\>
71
+ > **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
90
72
 
91
73
  The collection of prompt examples.
92
74
 
93
75
  #### Defined in
94
76
 
95
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-example-selector.ts#L55)
77
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-example-selector.ts#L55)
96
78
 
97
- ___
79
+ ***
98
80
 
99
81
  ### maxLength
100
82
 
101
- • **maxLength**: `undefined` \| `number`
83
+ > **maxLength**: `undefined` \| `number`
102
84
 
103
85
  #### Defined in
104
86
 
105
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-example-selector.ts#L47)
87
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-example-selector.ts#L47)
106
88
 
107
- ___
89
+ ***
108
90
 
109
91
  ### threshold
110
92
 
111
- • **threshold**: `undefined` \| `number`
93
+ > **threshold**: `undefined` \| `number`
112
94
 
113
95
  The probability threshold (0-1) for selecting an example. If `undefined`, no filtering by probability occurs.
114
96
 
115
97
  #### Defined in
116
98
 
117
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-example-selector.ts#L51)
99
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-example-selector.ts#L51)
118
100
 
119
101
  ## Methods
120
102
 
121
- ### [asyncIterator]
103
+ ### \[asyncIterator\]()
122
104
 
123
- ▸ **[asyncIterator]**(): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
105
+ > **\[asyncIterator\]**(): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
124
106
 
125
107
  Returns an asynchronous iterator for the selected examples.
126
108
 
@@ -132,22 +114,25 @@ An asynchronous iterator over the selected examples.
132
114
 
133
115
  #### Defined in
134
116
 
135
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-example-selector.ts#L119)
117
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-example-selector.ts#L119)
136
118
 
137
- ___
119
+ ***
138
120
 
139
- ### initialize
121
+ ### initialize()
140
122
 
141
- ▸ **initialize**(`examples`, `options?`): `void`
123
+ > **initialize**(`examples`, `options`?): `void`
142
124
 
143
125
  Initializes the selector with examples and options.
144
126
 
145
127
  #### Parameters
146
128
 
147
- | Name | Type | Description |
148
- | :------ | :------ | :------ |
149
- | `examples` | [`PromptExamples`](../modules.md#promptexamples)\<`T`\> | The prompt examples to select from. |
150
- | `options?` | [`PromptExampleSelectorOptions`](../interfaces/PromptExampleSelectorOptions.md) | An optional configuration object. |
129
+ • **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
130
+
131
+ The prompt examples to select from.
132
+
133
+ • **options?**: [`PromptExampleSelectorOptions`](../interfaces/PromptExampleSelectorOptions.md)
134
+
135
+ An optional configuration object.
151
136
 
152
137
  #### Returns
153
138
 
@@ -155,22 +140,25 @@ Initializes the selector with examples and options.
155
140
 
156
141
  #### Defined in
157
142
 
158
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-example-selector.ts#L71)
143
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-example-selector.ts#L71)
159
144
 
160
- ___
145
+ ***
161
146
 
162
- ### selectExample
147
+ ### selectExample()
163
148
 
164
- ▸ **selectExample**(`example`, `threshold?`): `void` \| `T`
149
+ > **selectExample**(`example`, `threshold`?): `void` \| `T`
165
150
 
166
151
  Select an example. Can overwrite this in subclasses.
167
152
 
168
153
  #### Parameters
169
154
 
170
- | Name | Type | Description |
171
- | :------ | :------ | :------ |
172
- | `example` | `T` | The example to potentially select. |
173
- | `threshold?` | `number` | report the current probability [0-1) for the selecting example. |
155
+ • **example**: `T`
156
+
157
+ The example to potentially select.
158
+
159
+ • **threshold?**: `number`
160
+
161
+ report the current probability [0-1) for the selecting example.
174
162
 
175
163
  #### Returns
176
164
 
@@ -180,21 +168,21 @@ The selected example, or `undefined` if not selected.
180
168
 
181
169
  #### Defined in
182
170
 
183
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-example-selector.ts#L92)
171
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-example-selector.ts#L92)
184
172
 
185
- ___
173
+ ***
186
174
 
187
- ### selectExamples
175
+ ### selectExamples()
188
176
 
189
- ▸ **selectExamples**(`examples?`): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
177
+ > **selectExamples**(`examples`): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
190
178
 
191
179
  Asynchronously selects examples from the given examples, applying the configured threshold (if any).
192
180
 
193
181
  #### Parameters
194
182
 
195
- | Name | Type | Description |
196
- | :------ | :------ | :------ |
197
- | `examples` | [`PromptExamples`](../modules.md#promptexamples)\<`T`\> | The examples to select from. Defaults to the selector's examples if not provided. |
183
+ • **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\> = `...`
184
+
185
+ The examples to select from. Defaults to the selector's examples if not provided.
198
186
 
199
187
  #### Returns
200
188
 
@@ -204,4 +192,4 @@ An asynchronous iterator yielding selected examples.
204
192
 
205
193
  #### Defined in
206
194
 
207
- [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/c5e620338f3b80d6ef09148577c5087098896d8b/src/utils/prompt/prompt-example-selector.ts#L103)
195
+ [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/5f9f0083c734722103ff5468e424b48c212a55f0/src/utils/prompt/prompt-example-selector.ts#L103)