@isdk/ai-tool 0.5.3 → 0.5.4

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 (282) hide show
  1. package/docs/classes/BinarySemaphore.md +25 -25
  2. package/docs/classes/CancelableAbility.md +25 -25
  3. package/docs/classes/ClientTools.md +55 -55
  4. package/docs/classes/EnvPromptTemplate.md +19 -19
  5. package/docs/classes/EventClient.md +78 -78
  6. package/docs/classes/EventServer.md +79 -79
  7. package/docs/classes/EventToolFunc.md +47 -47
  8. package/docs/classes/FStringPromptTemplate.md +19 -19
  9. package/docs/classes/FewShotPromptTemplate.md +23 -23
  10. package/docs/classes/GolangPromptTemplate.md +19 -19
  11. package/docs/classes/HFEnvironment.md +10 -10
  12. package/docs/classes/HFInterpreter.md +5 -5
  13. package/docs/classes/HFTemplate.md +5 -5
  14. package/docs/classes/HfPromptTemplate.md +19 -19
  15. package/docs/classes/IntSet.md +12 -12
  16. package/docs/classes/PromptExampleSelector.md +9 -9
  17. package/docs/classes/PromptTemplate.md +18 -18
  18. package/docs/classes/ReadableStreamError.md +2 -2
  19. package/docs/classes/ResClientTools.md +62 -62
  20. package/docs/classes/ResServerTools.md +63 -63
  21. package/docs/classes/SSEChannel.md +16 -16
  22. package/docs/classes/Semaphore.md +26 -26
  23. package/docs/classes/ServerTools.md +51 -51
  24. package/docs/classes/SignalGate.md +9 -9
  25. package/docs/classes/TaskAbortController.md +8 -8
  26. package/docs/classes/ToolFunc.md +44 -44
  27. package/docs/classes/YamlTypeBaseObject.md +2 -2
  28. package/docs/enumerations/AsyncFeatureBits.md +4 -4
  29. package/docs/enumerations/AsyncFeatures.md +4 -4
  30. package/docs/enumerations/HashAlgorithm.md +12 -12
  31. package/docs/functions/AIArgProcessor.md +1 -1
  32. package/docs/functions/AIStream.md +1 -1
  33. package/docs/functions/ChoiceArgProcessor.md +1 -1
  34. package/docs/functions/ObjectArgsToArgsInfo.md +1 -1
  35. package/docs/functions/RateLimit.md +1 -1
  36. package/docs/functions/TemplateArgProcessor.md +1 -1
  37. package/docs/functions/assignDirs.md +1 -1
  38. package/docs/functions/backendEventable.md +1 -1
  39. package/docs/functions/beforeShutdown.md +1 -1
  40. package/docs/functions/completeSentences.md +1 -1
  41. package/docs/functions/concatText.md +1 -1
  42. package/docs/functions/countLLMTokens.md +1 -1
  43. package/docs/functions/countRegexMatches.md +1 -1
  44. package/docs/functions/createCallbacksTransformer.md +1 -1
  45. package/docs/functions/createEmptyReadableStream.md +1 -1
  46. package/docs/functions/createEndWithRepetitionDetector.md +1 -1
  47. package/docs/functions/createEventStreamTransformer.md +1 -1
  48. package/docs/functions/createHfValueFunc.md +1 -1
  49. package/docs/functions/createLRUCache.md +1 -1
  50. package/docs/functions/createYamlObjectTag.md +1 -1
  51. package/docs/functions/dateToText.md +1 -1
  52. package/docs/functions/decodeCharset.md +1 -1
  53. package/docs/functions/detectCharset.md +1 -1
  54. package/docs/functions/encodeLLMTokens.md +1 -1
  55. package/docs/functions/ensureQuoted.md +1 -1
  56. package/docs/functions/expandConfig.md +1 -1
  57. package/docs/functions/expandEnv.md +1 -1
  58. package/docs/functions/expandObjEnv.md +1 -1
  59. package/docs/functions/expandPath.md +1 -1
  60. package/docs/functions/extNameLevel.md +1 -1
  61. package/docs/functions/fileIsExists.md +1 -1
  62. package/docs/functions/filenameReservedRegex.md +1 -1
  63. package/docs/functions/filterValidFnScope.md +1 -1
  64. package/docs/functions/findIndexNonEmptyFrom.md +1 -1
  65. package/docs/functions/findPort.md +1 -1
  66. package/docs/functions/formatTextWithSpace.md +1 -1
  67. package/docs/functions/getAllEnumKeys.md +1 -1
  68. package/docs/functions/getConfigFileNames.md +1 -1
  69. package/docs/functions/getConfigs.md +1 -1
  70. package/docs/functions/getEnvVairables.md +1 -1
  71. package/docs/functions/getFileMetaInfo.md +1 -1
  72. package/docs/functions/getHashAlgoBySize.md +1 -1
  73. package/docs/functions/getKeysPath.md +1 -1
  74. package/docs/functions/getLLMTokenizer.md +1 -1
  75. package/docs/functions/getMultiLevelExtname.md +1 -1
  76. package/docs/functions/getPackageDir.md +1 -1
  77. package/docs/functions/getRealFilepath.md +1 -1
  78. package/docs/functions/getResponseErrorReadableStream.md +1 -1
  79. package/docs/functions/getXDGConfigs.md +1 -1
  80. package/docs/functions/hasDirectoryIn.md +1 -1
  81. package/docs/functions/hash.md +1 -1
  82. package/docs/functions/hashFile.md +1 -1
  83. package/docs/functions/hashStream.md +1 -1
  84. package/docs/functions/hfParse.md +1 -1
  85. package/docs/functions/hfTokenize.md +1 -1
  86. package/docs/functions/initShutdown.md +1 -1
  87. package/docs/functions/interpolateEnv.md +1 -1
  88. package/docs/functions/interpolateFString.md +1 -1
  89. package/docs/functions/interpolateGolangTemplate.md +1 -1
  90. package/docs/functions/isLangUsingSpaces.md +1 -1
  91. package/docs/functions/isListItemString.md +1 -1
  92. package/docs/functions/isModelNameMatched.md +1 -1
  93. package/docs/functions/isPunctuationChar.md +1 -1
  94. package/docs/functions/isQuoted.md +1 -1
  95. package/docs/functions/isRegExp.md +1 -1
  96. package/docs/functions/isSameString.md +1 -1
  97. package/docs/functions/isSectionString.md +1 -1
  98. package/docs/functions/isSentenceEnding.md +1 -1
  99. package/docs/functions/isSepLineString.md +1 -1
  100. package/docs/functions/isStrWrapped.md +1 -1
  101. package/docs/functions/isSubdirectory.md +1 -1
  102. package/docs/functions/isTitleString.md +1 -1
  103. package/docs/functions/isValidFilename.md +1 -1
  104. package/docs/functions/isValidFilepath.md +1 -1
  105. package/docs/functions/isWebStream.md +1 -1
  106. package/docs/functions/jsonFilterToWhere.md +1 -1
  107. package/docs/functions/jsonToMarkdownStr.md +1 -1
  108. package/docs/functions/loadAIConfig.md +1 -1
  109. package/docs/functions/loadConfig.md +1 -1
  110. package/docs/functions/loadConfigFile.md +1 -1
  111. package/docs/functions/loadFileFromPaths.md +1 -1
  112. package/docs/functions/loadTextFromPaths.md +1 -1
  113. package/docs/functions/lrucache.md +1 -1
  114. package/docs/functions/makeToolFuncCancelable.md +1 -1
  115. package/docs/functions/matchUrlProtocol.md +1 -1
  116. package/docs/functions/memoize.md +1 -1
  117. package/docs/functions/messagesToText.md +1 -1
  118. package/docs/functions/paramsSizeToScaleStr.md +1 -1
  119. package/docs/functions/parseCommand.md +1 -1
  120. package/docs/functions/parseFString.md +1 -1
  121. package/docs/functions/parseJsJson.md +1 -1
  122. package/docs/functions/parseJsJsonSimpleSync.md +1 -1
  123. package/docs/functions/parseObjectArgInfo.md +1 -1
  124. package/docs/functions/parseObjectArgumentInfos.md +1 -1
  125. package/docs/functions/parseObjectArguments.md +1 -1
  126. package/docs/functions/parseObjectArgumentsAsArgInfos.md +1 -1
  127. package/docs/functions/parseYaml.md +1 -1
  128. package/docs/functions/quoteStr.md +1 -1
  129. package/docs/functions/reControlCharsRegex.md +1 -1
  130. package/docs/functions/readFilenamesRecursiveSync.md +1 -1
  131. package/docs/functions/readTextFileChunks.md +1 -1
  132. package/docs/functions/readTextFileChunksEx.md +1 -1
  133. package/docs/functions/readableFromAsyncIterable.md +1 -1
  134. package/docs/functions/registerCoreTools.md +1 -1
  135. package/docs/functions/registerYamlTag.md +1 -1
  136. package/docs/functions/removeMarkdownBold.md +1 -1
  137. package/docs/functions/removeMarkdownBoldAndItalic.md +1 -1
  138. package/docs/functions/removeMarkdownItalic.md +1 -1
  139. package/docs/functions/replaceWithPlaceholder.md +1 -1
  140. package/docs/functions/restoreFromPlacehoders.md +1 -1
  141. package/docs/functions/sanitizeFilename.md +1 -1
  142. package/docs/functions/sanitizeFilepath.md +1 -1
  143. package/docs/functions/saveConfigFile.md +1 -1
  144. package/docs/functions/scaleStrToParamsSize.md +1 -1
  145. package/docs/functions/shutdown.md +1 -1
  146. package/docs/functions/simplifyObjectArguments.md +1 -1
  147. package/docs/functions/sortedValues.md +1 -1
  148. package/docs/functions/splitChunks.md +1 -1
  149. package/docs/functions/splitParagraph.md +1 -1
  150. package/docs/functions/splitSentence.md +1 -1
  151. package/docs/functions/stringifyYaml.md +1 -1
  152. package/docs/functions/stripConsoleColor.md +1 -1
  153. package/docs/functions/textToDate.md +1 -1
  154. package/docs/functions/toDateTime.md +1 -1
  155. package/docs/functions/trimStartOfStreamHelper.md +1 -1
  156. package/docs/functions/truncTo.md +1 -1
  157. package/docs/functions/truncateByToken.md +1 -1
  158. package/docs/functions/truncateToTokenLimit.md +1 -1
  159. package/docs/functions/truncateToTokenLimitEx.md +1 -1
  160. package/docs/functions/uuid.md +1 -1
  161. package/docs/functions/wait.md +1 -1
  162. package/docs/functions/xxhash.md +1 -1
  163. package/docs/functions/xxhash32.md +1 -1
  164. package/docs/functions/xxhash64.md +1 -1
  165. package/docs/functions/xxhashAsStr.md +1 -1
  166. package/docs/interfaces/AIChatAssistantMessageParam.md +12 -12
  167. package/docs/interfaces/AIChatContentPartImage.md +3 -3
  168. package/docs/interfaces/AIChatContentPartText.md +3 -3
  169. package/docs/interfaces/AIChatMessageParamBase.md +7 -7
  170. package/docs/interfaces/AIChatMessageToolCall.md +4 -4
  171. package/docs/interfaces/AIChatSystemMessageParam.md +9 -9
  172. package/docs/interfaces/AIChatToolChoiceFuncObject.md +3 -3
  173. package/docs/interfaces/AIChatToolChoiceObject.md +2 -2
  174. package/docs/interfaces/AIChatToolFunc.md +5 -5
  175. package/docs/interfaces/AIChatToolFuncParam.md +3 -3
  176. package/docs/interfaces/AIChatToolMessageParam.md +10 -10
  177. package/docs/interfaces/AIChatToolParam.md +2 -2
  178. package/docs/interfaces/AIChatToolTypeObject.md +2 -2
  179. package/docs/interfaces/AIChatUserMessageParam.md +13 -13
  180. package/docs/interfaces/AIChoiceConfig.md +8 -8
  181. package/docs/interfaces/AIResult.md +6 -6
  182. package/docs/interfaces/AIStreamParser.md +2 -2
  183. package/docs/interfaces/AIStreamParserOptions.md +2 -2
  184. package/docs/interfaces/BaseFunc.md +10 -10
  185. package/docs/interfaces/BaseFuncItem.md +9 -9
  186. package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
  187. package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
  188. package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
  189. package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
  190. package/docs/interfaces/CancelableAbilityOptions.md +4 -4
  191. package/docs/interfaces/ClientFuncItem.md +12 -12
  192. package/docs/interfaces/DotenvExpandOptions.md +4 -4
  193. package/docs/interfaces/DotenvExpandOutput.md +3 -3
  194. package/docs/interfaces/DotenvParseInput.md +1 -1
  195. package/docs/interfaces/DotenvParseOutput.md +1 -1
  196. package/docs/interfaces/DotenvPopulateInput.md +1 -1
  197. package/docs/interfaces/EventClientFuncParams.md +5 -5
  198. package/docs/interfaces/EventServerFuncParams.md +6 -6
  199. package/docs/interfaces/FewShotPromptTemplateOptions.md +12 -12
  200. package/docs/interfaces/FuncItem.md +10 -10
  201. package/docs/interfaces/FuncParam.md +7 -7
  202. package/docs/interfaces/FuncParams.md +1 -1
  203. package/docs/interfaces/Funcs.md +1 -1
  204. package/docs/interfaces/HashAlgoParams.md +4 -4
  205. package/docs/interfaces/IFileMetaInfo.md +8 -8
  206. package/docs/interfaces/IReadTextFileChunksOptions.md +11 -11
  207. package/docs/interfaces/ITruncateToTokenLimitOptions.md +10 -10
  208. package/docs/interfaces/JsonFilter.md +1 -1
  209. package/docs/interfaces/ParseObjectArgumentOptions.md +11 -11
  210. package/docs/interfaces/PromptExampleSelectorOptions.md +3 -3
  211. package/docs/interfaces/PromptTemplateOptions.md +7 -7
  212. package/docs/interfaces/RemoteFuncItem.md +12 -12
  213. package/docs/interfaces/ReplacePlacehoderOptions.md +5 -5
  214. package/docs/interfaces/ResClientFuncParams.md +3 -3
  215. package/docs/interfaces/ResServerFuncParams.md +6 -6
  216. package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
  217. package/docs/interfaces/SectionStringOptions.md +3 -3
  218. package/docs/interfaces/SemaphoreOptions.md +7 -7
  219. package/docs/interfaces/SemaphoreTaskItem.md +5 -5
  220. package/docs/interfaces/ServerFuncItem.md +13 -13
  221. package/docs/interfaces/ServerFuncParams.md +3 -3
  222. package/docs/interfaces/SplitSentenceOptions.md +5 -5
  223. package/docs/interfaces/StreamCallbacksAndOptions.md +5 -5
  224. package/docs/interfaces/TaskAbortControllers.md +1 -1
  225. package/docs/interfaces/TaskPromise.md +2 -2
  226. package/docs/interfaces/ToolFuncPackage.md +4 -4
  227. package/docs/type-aliases/AIChatContentPart.md +1 -1
  228. package/docs/type-aliases/AIChatMessageParam.md +1 -1
  229. package/docs/type-aliases/AIChatRole.md +1 -1
  230. package/docs/type-aliases/AIChatToolChoiceParam.md +1 -1
  231. package/docs/type-aliases/AIMessageType.md +1 -1
  232. package/docs/type-aliases/AIModelNameRule.md +1 -1
  233. package/docs/type-aliases/AIModelNameRuleFn.md +1 -1
  234. package/docs/type-aliases/AIModelNameRules.md +1 -1
  235. package/docs/type-aliases/AITextGenerationFinishReason.md +1 -1
  236. package/docs/type-aliases/ActionName.md +1 -1
  237. package/docs/type-aliases/AsyncTaskId.md +1 -1
  238. package/docs/type-aliases/BeforeShutdownListener.md +1 -1
  239. package/docs/type-aliases/EventErrorListenerFn.md +1 -1
  240. package/docs/type-aliases/EventListenerFn.md +1 -1
  241. package/docs/type-aliases/FStringPromptTemplateNode.md +1 -1
  242. package/docs/type-aliases/FuncParamType.md +1 -1
  243. package/docs/type-aliases/PromptExamples.md +1 -1
  244. package/docs/type-aliases/PromptTemplateType.md +1 -1
  245. package/docs/type-aliases/PromptType.md +1 -1
  246. package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
  247. package/docs/type-aliases/TFunc.md +1 -1
  248. package/docs/variables/AIChatRoles.md +1 -1
  249. package/docs/variables/AIMessageTypes.md +1 -1
  250. package/docs/variables/AITextGenerationFinishReasons.md +1 -1
  251. package/docs/variables/ActionNames.md +1 -1
  252. package/docs/variables/ClientToolFuncSchema.md +1 -1
  253. package/docs/variables/DEFAULT_CONFIG_NAME.md +1 -1
  254. package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
  255. package/docs/variables/EventBusName.md +1 -1
  256. package/docs/variables/EventName.md +1 -1
  257. package/docs/variables/FilenameReservedRegex.md +1 -1
  258. package/docs/variables/HFBuiltins.md +1 -1
  259. package/docs/variables/LLM_TOKENIZER_NAMES.md +1 -1
  260. package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
  261. package/docs/variables/PASSING_SCORE.md +1 -1
  262. package/docs/variables/PromptTemplateTypes.md +1 -1
  263. package/docs/variables/PromptTypes.md +1 -1
  264. package/docs/variables/RStreamErrCode.md +1 -1
  265. package/docs/variables/RemoteToolFuncSchema.md +1 -1
  266. package/docs/variables/ResponseRStreamErrCode.md +1 -1
  267. package/docs/variables/SHUTDOWN_SIGNALS.md +1 -1
  268. package/docs/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
  269. package/docs/variables/SecondaryCache.md +1 -1
  270. package/docs/variables/ServerToolFuncSchema.md +1 -1
  271. package/docs/variables/ToolAsyncCancelableBit.md +1 -1
  272. package/docs/variables/ToolAsyncMultiTaskBit.md +1 -1
  273. package/docs/variables/ToolAsyncPriorityBit.md +1 -1
  274. package/docs/variables/ToolFuncSchema.md +1 -1
  275. package/docs/variables/WindowsReservedNameRegex.md +1 -1
  276. package/docs/variables/base32768.md +1 -1
  277. package/docs/variables/defaultTemplateFormat.md +1 -1
  278. package/docs/variables/event.md +1 -1
  279. package/docs/variables/eventClient.md +1 -1
  280. package/docs/variables/eventServer.md +1 -1
  281. package/docs/variables/lrucache.md +1 -1
  282. package/package.json +1 -1
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: HfPromptTemplate
8
8
 
9
- Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:88](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/hf-prompt-template.ts#L88)
9
+ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:88](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/hf-prompt-template.ts#L88)
10
10
 
11
11
  ## Extends
12
12
 
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:88](https:/
18
18
 
19
19
  > **new HfPromptTemplate**(`template`?, `options`?): [`HfPromptTemplate`](HfPromptTemplate.md)
20
20
 
21
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L69)
21
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L69)
22
22
 
23
23
  #### Parameters
24
24
 
@@ -44,7 +44,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://gi
44
44
 
45
45
  > **compiledTemplate**: [`HFTemplate`](HFTemplate.md)
46
46
 
47
- Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:89](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/hf-prompt-template.ts#L89)
47
+ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:89](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/hf-prompt-template.ts#L89)
48
48
 
49
49
  #### Overrides
50
50
 
@@ -56,7 +56,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:89](https:/
56
56
 
57
57
  > **data**: `undefined` \| `Record`\<`string`, `any`\>
58
58
 
59
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L24)
59
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L24)
60
60
 
61
61
  #### Inherited from
62
62
 
@@ -68,7 +68,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://gi
68
68
 
69
69
  > **inputVariables**: `undefined` \| `string`[]
70
70
 
71
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L25)
71
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L25)
72
72
 
73
73
  #### Inherited from
74
74
 
@@ -80,7 +80,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://gi
80
80
 
81
81
  > **template**: `string`
82
82
 
83
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L22)
83
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L22)
84
84
 
85
85
  #### Inherited from
86
86
 
@@ -92,7 +92,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://gi
92
92
 
93
93
  > **templateFormat**: `undefined` \| `string`
94
94
 
95
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L23)
95
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L23)
96
96
 
97
97
  #### Inherited from
98
98
 
@@ -262,7 +262,7 @@ The Root Factory class
262
262
 
263
263
  > **\_format**(`data`): `string`
264
264
 
265
- Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:130](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/hf-prompt-template.ts#L130)
265
+ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:130](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/hf-prompt-template.ts#L130)
266
266
 
267
267
  #### Parameters
268
268
 
@@ -284,7 +284,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:130](https:
284
284
 
285
285
  > **\_initialize**(`options`?): `void`
286
286
 
287
- Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:121](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/hf-prompt-template.ts#L121)
287
+ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:121](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/hf-prompt-template.ts#L121)
288
288
 
289
289
  #### Parameters
290
290
 
@@ -306,7 +306,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:121](https:
306
306
 
307
307
  > **filterData**(`data`): `Record`\<`string`, `any`\>
308
308
 
309
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L62)
309
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L62)
310
310
 
311
311
  Validate/filter the data in inputVariables
312
312
 
@@ -330,7 +330,7 @@ Validate/filter the data in inputVariables
330
330
 
331
331
  > **format**(`data`?): `Promise`\<`string`\>
332
332
 
333
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L109)
333
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L109)
334
334
 
335
335
  #### Parameters
336
336
 
@@ -352,7 +352,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://g
352
352
 
353
353
  > **getVariables**(`template`): `string`[]
354
354
 
355
- Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:114](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/hf-prompt-template.ts#L114)
355
+ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:114](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/hf-prompt-template.ts#L114)
356
356
 
357
357
  #### Parameters
358
358
 
@@ -370,7 +370,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:114](https:
370
370
 
371
371
  > `abstract` **initialize**(`options`?): `void`
372
372
 
373
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L96)
373
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L96)
374
374
 
375
375
  **`Internal`**
376
376
 
@@ -396,7 +396,7 @@ initialize instance method
396
396
 
397
397
  > **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
398
398
 
399
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L139)
399
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L139)
400
400
 
401
401
  it can make sense to "partial" a prompt template - eg pass in a subset of the required values, as to create a new prompt template which expects only the remaining subset of values.
402
402
 
@@ -424,7 +424,7 @@ the new partial PromptTemplate instance
424
424
 
425
425
  > **toJSON**(`options`): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
426
426
 
427
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L147)
427
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L147)
428
428
 
429
429
  #### Parameters
430
430
 
@@ -637,7 +637,7 @@ the forEach callback function
637
637
 
638
638
  > `static` **format**(`options`): `Promise`\<`string`\>
639
639
 
640
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L31)
640
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L31)
641
641
 
642
642
  #### Parameters
643
643
 
@@ -659,7 +659,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://gi
659
659
 
660
660
  > `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
661
661
 
662
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L41)
662
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L41)
663
663
 
664
664
  If the given options.template is the template, perform formatting using that template.
665
665
 
@@ -747,7 +747,7 @@ the name to register
747
747
 
748
748
  > `static` **from**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
749
749
 
750
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L27)
750
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L27)
751
751
 
752
752
  #### Parameters
753
753
 
@@ -929,7 +929,7 @@ the unique name in the factory
929
929
 
930
930
  > `static` **isTemplate**(`templateOpt`): `boolean`
931
931
 
932
- Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:91](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/hf-prompt-template.ts#L91)
932
+ Defined in: [packages/ai-tool/src/utils/prompt/hf-prompt-template.ts:91](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/hf-prompt-template.ts#L91)
933
933
 
934
934
  #### Parameters
935
935
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: IntSet
8
8
 
9
- Defined in: [packages/ai-tool/src/utils/intset.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L6)
9
+ Defined in: [packages/ai-tool/src/utils/intset.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L6)
10
10
 
11
11
  Represents a set of integers using a bit field.
12
12
  Each bit in the bit field represents an integer starting from 0,
@@ -18,7 +18,7 @@ where the flag value 0 represents the 0th bit, 1 represents the 1st bit, and so
18
18
 
19
19
  > **new IntSet**(`bitField`): [`IntSet`](IntSet.md)
20
20
 
21
- Defined in: [packages/ai-tool/src/utils/intset.ts:21](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L21)
21
+ Defined in: [packages/ai-tool/src/utils/intset.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L21)
22
22
 
23
23
  #### Parameters
24
24
 
@@ -36,7 +36,7 @@ Defined in: [packages/ai-tool/src/utils/intset.ts:21](https://github.com/isdk/ai
36
36
 
37
37
  > **add**(`flag`): [`IntSet`](IntSet.md)
38
38
 
39
- Defined in: [packages/ai-tool/src/utils/intset.ts:29](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L29)
39
+ Defined in: [packages/ai-tool/src/utils/intset.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L29)
40
40
 
41
41
  Adds an element to the set.
42
42
 
@@ -59,7 +59,7 @@ The flag value representing the bit position to set.
59
59
 
60
60
  > **clear**(): [`IntSet`](IntSet.md)
61
61
 
62
- Defined in: [packages/ai-tool/src/utils/intset.ts:57](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L57)
62
+ Defined in: [packages/ai-tool/src/utils/intset.ts:57](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L57)
63
63
 
64
64
  Clears all elements from the set.
65
65
 
@@ -73,7 +73,7 @@ Clears all elements from the set.
73
73
 
74
74
  > **delete**(`flag`): [`IntSet`](IntSet.md)
75
75
 
76
- Defined in: [packages/ai-tool/src/utils/intset.ts:39](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L39)
76
+ Defined in: [packages/ai-tool/src/utils/intset.ts:39](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L39)
77
77
 
78
78
  Removes an element from the set.
79
79
 
@@ -95,7 +95,7 @@ The flag value representing the bit position to set. 0 represents the 0th bit
95
95
 
96
96
  > **has**(`flag`): `boolean`
97
97
 
98
- Defined in: [packages/ai-tool/src/utils/intset.ts:50](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L50)
98
+ Defined in: [packages/ai-tool/src/utils/intset.ts:50](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L50)
99
99
 
100
100
  Determines whether an element is in the set.
101
101
 
@@ -119,7 +119,7 @@ true if the element is in the set; otherwise, false.
119
119
 
120
120
  > **toJSON**(): `number`
121
121
 
122
- Defined in: [packages/ai-tool/src/utils/intset.ts:70](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L70)
122
+ Defined in: [packages/ai-tool/src/utils/intset.ts:70](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L70)
123
123
 
124
124
  #### Returns
125
125
 
@@ -131,7 +131,7 @@ Defined in: [packages/ai-tool/src/utils/intset.ts:70](https://github.com/isdk/ai
131
131
 
132
132
  > **toString**(): `string`
133
133
 
134
- Defined in: [packages/ai-tool/src/utils/intset.ts:66](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L66)
134
+ Defined in: [packages/ai-tool/src/utils/intset.ts:66](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L66)
135
135
 
136
136
  #### Returns
137
137
 
@@ -143,7 +143,7 @@ Defined in: [packages/ai-tool/src/utils/intset.ts:66](https://github.com/isdk/ai
143
143
 
144
144
  > **valueOf**(): `number`
145
145
 
146
- Defined in: [packages/ai-tool/src/utils/intset.ts:62](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L62)
146
+ Defined in: [packages/ai-tool/src/utils/intset.ts:62](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L62)
147
147
 
148
148
  #### Returns
149
149
 
@@ -155,7 +155,7 @@ Defined in: [packages/ai-tool/src/utils/intset.ts:62](https://github.com/isdk/ai
155
155
 
156
156
  > `static` **add**(`bitField`, `flag`): `number`
157
157
 
158
- Defined in: [packages/ai-tool/src/utils/intset.ts:12](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L12)
158
+ Defined in: [packages/ai-tool/src/utils/intset.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L12)
159
159
 
160
160
  #### Parameters
161
161
 
@@ -177,7 +177,7 @@ Defined in: [packages/ai-tool/src/utils/intset.ts:12](https://github.com/isdk/ai
177
177
 
178
178
  > `static` **delete**(`bitField`, `flag`): `number`
179
179
 
180
- Defined in: [packages/ai-tool/src/utils/intset.ts:16](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L16)
180
+ Defined in: [packages/ai-tool/src/utils/intset.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L16)
181
181
 
182
182
  #### Parameters
183
183
 
@@ -199,7 +199,7 @@ Defined in: [packages/ai-tool/src/utils/intset.ts:16](https://github.com/isdk/ai
199
199
 
200
200
  > `static` **has**(`bitField`, `flag`): `boolean`
201
201
 
202
- Defined in: [packages/ai-tool/src/utils/intset.ts:8](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/intset.ts#L8)
202
+ Defined in: [packages/ai-tool/src/utils/intset.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/intset.ts#L8)
203
203
 
204
204
  #### Parameters
205
205
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: PromptExampleSelector\<T\>
8
8
 
9
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:46](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L46)
9
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:46](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L46)
10
10
 
11
11
  The `PromptExampleSelector` class provides a mechanism to selectively choose examples from a given set based on
12
12
  configurable options such as maximum length and probability threshold. This class is meant to be extended and customized
@@ -46,7 +46,7 @@ The type of the prompt examples.
46
46
 
47
47
  > **new PromptExampleSelector**\<`T`\>(`examples`, `options`?): [`PromptExampleSelector`](PromptExampleSelector.md)\<`T`\>
48
48
 
49
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L62)
49
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L62)
50
50
 
51
51
  Constructs a new `PromptExampleSelector` instance with the given examples and options.
52
52
 
@@ -74,7 +74,7 @@ An optional configuration object.
74
74
 
75
75
  > **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
76
76
 
77
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L55)
77
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L55)
78
78
 
79
79
  The collection of prompt examples.
80
80
 
@@ -84,7 +84,7 @@ The collection of prompt examples.
84
84
 
85
85
  > **maxLength**: `undefined` \| `number`
86
86
 
87
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L47)
87
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L47)
88
88
 
89
89
  ***
90
90
 
@@ -92,7 +92,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](ht
92
92
 
93
93
  > **threshold**: `undefined` \| `number`
94
94
 
95
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L51)
95
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L51)
96
96
 
97
97
  The probability threshold (0-1) for selecting an example. If `undefined`, no filtering by probability occurs.
98
98
 
@@ -102,7 +102,7 @@ The probability threshold (0-1) for selecting an example. If `undefined`, no fil
102
102
 
103
103
  > **\[asyncIterator\]**(): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
104
104
 
105
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L119)
105
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L119)
106
106
 
107
107
  Returns an asynchronous iterator for the selected examples.
108
108
 
@@ -118,7 +118,7 @@ An asynchronous iterator over the selected examples.
118
118
 
119
119
  > **initialize**(`examples`, `options`?): `void`
120
120
 
121
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L71)
121
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L71)
122
122
 
123
123
  Initializes the selector with examples and options.
124
124
 
@@ -146,7 +146,7 @@ An optional configuration object.
146
146
 
147
147
  > **selectExample**(`example`, `threshold`?): `void` \| `T`
148
148
 
149
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L92)
149
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L92)
150
150
 
151
151
  Select an example. Can overwrite this in subclasses.
152
152
 
@@ -176,7 +176,7 @@ The selected example, or `undefined` if not selected.
176
176
 
177
177
  > **selectExamples**(`examples`): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
178
178
 
179
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-example-selector.ts#L103)
179
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L103)
180
180
 
181
181
  Asynchronously selects examples from the given examples, applying the configured threshold (if any).
182
182
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: PromptTemplate
8
8
 
9
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:20](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L20)
9
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:20](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L20)
10
10
 
11
11
  ## Extends
12
12
 
@@ -26,7 +26,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:20](https://gi
26
26
 
27
27
  > **new PromptTemplate**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
28
28
 
29
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L69)
29
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L69)
30
30
 
31
31
  #### Parameters
32
32
 
@@ -52,7 +52,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:69](https://gi
52
52
 
53
53
  > **compiledTemplate**: `any`
54
54
 
55
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L21)
55
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L21)
56
56
 
57
57
  ***
58
58
 
@@ -60,7 +60,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://gi
60
60
 
61
61
  > **data**: `undefined` \| `Record`\<`string`, `any`\>
62
62
 
63
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L24)
63
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L24)
64
64
 
65
65
  ***
66
66
 
@@ -68,7 +68,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:24](https://gi
68
68
 
69
69
  > **inputVariables**: `undefined` \| `string`[]
70
70
 
71
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L25)
71
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L25)
72
72
 
73
73
  ***
74
74
 
@@ -76,7 +76,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://gi
76
76
 
77
77
  > **template**: `string`
78
78
 
79
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L22)
79
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L22)
80
80
 
81
81
  ***
82
82
 
@@ -84,7 +84,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://gi
84
84
 
85
85
  > **templateFormat**: `undefined` \| `string`
86
86
 
87
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L23)
87
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L23)
88
88
 
89
89
  ***
90
90
 
@@ -250,7 +250,7 @@ The Root Factory class
250
250
 
251
251
  > **\_format**(`data`): `string` \| `Promise`\<`string`\>
252
252
 
253
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:105](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L105)
253
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:105](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L105)
254
254
 
255
255
  #### Parameters
256
256
 
@@ -268,7 +268,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:105](https://g
268
268
 
269
269
  > **\_initialize**(`options`?): `void`
270
270
 
271
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:92](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L92)
271
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:92](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L92)
272
272
 
273
273
  #### Parameters
274
274
 
@@ -286,7 +286,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:92](https://gi
286
286
 
287
287
  > **filterData**(`data`): `Record`\<`string`, `any`\>
288
288
 
289
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L62)
289
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L62)
290
290
 
291
291
  Validate/filter the data in inputVariables
292
292
 
@@ -306,7 +306,7 @@ Validate/filter the data in inputVariables
306
306
 
307
307
  > **format**(`data`?): `Promise`\<`string`\>
308
308
 
309
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L109)
309
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L109)
310
310
 
311
311
  #### Parameters
312
312
 
@@ -324,7 +324,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://g
324
324
 
325
325
  > `abstract` **initialize**(`options`?): `void`
326
326
 
327
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L96)
327
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L96)
328
328
 
329
329
  **`Internal`**
330
330
 
@@ -350,7 +350,7 @@ initialize instance method
350
350
 
351
351
  > **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
352
352
 
353
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L139)
353
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L139)
354
354
 
355
355
  it can make sense to "partial" a prompt template - eg pass in a subset of the required values, as to create a new prompt template which expects only the remaining subset of values.
356
356
 
@@ -374,7 +374,7 @@ the new partial PromptTemplate instance
374
374
 
375
375
  > **toJSON**(`options`): [`PromptTemplateOptions`](../interfaces/PromptTemplateOptions.md)
376
376
 
377
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L147)
377
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:147](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L147)
378
378
 
379
379
  #### Parameters
380
380
 
@@ -583,7 +583,7 @@ the forEach callback function
583
583
 
584
584
  > `static` **format**(`options`): `Promise`\<`string`\>
585
585
 
586
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L31)
586
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L31)
587
587
 
588
588
  #### Parameters
589
589
 
@@ -601,7 +601,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://gi
601
601
 
602
602
  > `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
603
603
 
604
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L41)
604
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L41)
605
605
 
606
606
  If the given options.template is the template, perform formatting using that template.
607
607
 
@@ -685,7 +685,7 @@ the name to register
685
685
 
686
686
  > `static` **from**(`template`?, `options`?): [`PromptTemplate`](PromptTemplate.md)
687
687
 
688
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L27)
688
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L27)
689
689
 
690
690
  #### Parameters
691
691
 
@@ -863,7 +863,7 @@ the unique name in the factory
863
863
 
864
864
  > `static` **isTemplate**(`templateOpt`): `any`
865
865
 
866
- Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/prompt/prompt-template.ts#L48)
866
+ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L48)
867
867
 
868
868
  #### Parameters
869
869
 
@@ -6,7 +6,7 @@
6
6
 
7
7
  # Class: ReadableStreamError
8
8
 
9
- Defined in: [packages/ai-tool/src/utils/stream/error-readable-stream.ts:6](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/error-readable-stream.ts#L6)
9
+ Defined in: [packages/ai-tool/src/utils/stream/error-readable-stream.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/stream/error-readable-stream.ts#L6)
10
10
 
11
11
  BaseError class that extends the Error class.
12
12
 
@@ -47,7 +47,7 @@ fromJSON - Creates a new BaseError instance from a JSON representation.
47
47
 
48
48
  > **new ReadableStreamError**(`msg`, `code`): [`ReadableStreamError`](ReadableStreamError.md)
49
49
 
50
- Defined in: [packages/ai-tool/src/utils/stream/error-readable-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/79d5773fa454dc7789b1291b1ebd73e4c1b93154/src/utils/stream/error-readable-stream.ts#L7)
50
+ Defined in: [packages/ai-tool/src/utils/stream/error-readable-stream.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/stream/error-readable-stream.ts#L7)
51
51
 
52
52
  #### Parameters
53
53