@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.
- package/docs/classes/BinarySemaphore.md +25 -25
- package/docs/classes/CancelableAbility.md +25 -25
- package/docs/classes/ClientTools.md +55 -55
- package/docs/classes/EnvPromptTemplate.md +19 -19
- package/docs/classes/EventClient.md +78 -78
- package/docs/classes/EventServer.md +79 -79
- package/docs/classes/EventToolFunc.md +47 -47
- package/docs/classes/FStringPromptTemplate.md +19 -19
- package/docs/classes/FewShotPromptTemplate.md +23 -23
- package/docs/classes/GolangPromptTemplate.md +19 -19
- package/docs/classes/HFEnvironment.md +10 -10
- package/docs/classes/HFInterpreter.md +5 -5
- package/docs/classes/HFTemplate.md +5 -5
- package/docs/classes/HfPromptTemplate.md +19 -19
- package/docs/classes/IntSet.md +12 -12
- package/docs/classes/PromptExampleSelector.md +9 -9
- package/docs/classes/PromptTemplate.md +18 -18
- package/docs/classes/ReadableStreamError.md +2 -2
- package/docs/classes/ResClientTools.md +62 -62
- package/docs/classes/ResServerTools.md +63 -63
- package/docs/classes/SSEChannel.md +16 -16
- package/docs/classes/Semaphore.md +26 -26
- package/docs/classes/ServerTools.md +51 -51
- package/docs/classes/SignalGate.md +9 -9
- package/docs/classes/TaskAbortController.md +8 -8
- package/docs/classes/ToolFunc.md +44 -44
- package/docs/classes/YamlTypeBaseObject.md +2 -2
- package/docs/enumerations/AsyncFeatureBits.md +4 -4
- package/docs/enumerations/AsyncFeatures.md +4 -4
- package/docs/enumerations/HashAlgorithm.md +12 -12
- package/docs/functions/AIArgProcessor.md +1 -1
- package/docs/functions/AIStream.md +1 -1
- package/docs/functions/ChoiceArgProcessor.md +1 -1
- package/docs/functions/ObjectArgsToArgsInfo.md +1 -1
- package/docs/functions/RateLimit.md +1 -1
- package/docs/functions/TemplateArgProcessor.md +1 -1
- package/docs/functions/assignDirs.md +1 -1
- package/docs/functions/backendEventable.md +1 -1
- package/docs/functions/beforeShutdown.md +1 -1
- package/docs/functions/completeSentences.md +1 -1
- package/docs/functions/concatText.md +1 -1
- package/docs/functions/countLLMTokens.md +1 -1
- package/docs/functions/countRegexMatches.md +1 -1
- package/docs/functions/createCallbacksTransformer.md +1 -1
- package/docs/functions/createEmptyReadableStream.md +1 -1
- package/docs/functions/createEndWithRepetitionDetector.md +1 -1
- package/docs/functions/createEventStreamTransformer.md +1 -1
- package/docs/functions/createHfValueFunc.md +1 -1
- package/docs/functions/createLRUCache.md +1 -1
- package/docs/functions/createYamlObjectTag.md +1 -1
- package/docs/functions/dateToText.md +1 -1
- package/docs/functions/decodeCharset.md +1 -1
- package/docs/functions/detectCharset.md +1 -1
- package/docs/functions/encodeLLMTokens.md +1 -1
- package/docs/functions/ensureQuoted.md +1 -1
- package/docs/functions/expandConfig.md +1 -1
- package/docs/functions/expandEnv.md +1 -1
- package/docs/functions/expandObjEnv.md +1 -1
- package/docs/functions/expandPath.md +1 -1
- package/docs/functions/extNameLevel.md +1 -1
- package/docs/functions/fileIsExists.md +1 -1
- package/docs/functions/filenameReservedRegex.md +1 -1
- package/docs/functions/filterValidFnScope.md +1 -1
- package/docs/functions/findIndexNonEmptyFrom.md +1 -1
- package/docs/functions/findPort.md +1 -1
- package/docs/functions/formatTextWithSpace.md +1 -1
- package/docs/functions/getAllEnumKeys.md +1 -1
- package/docs/functions/getConfigFileNames.md +1 -1
- package/docs/functions/getConfigs.md +1 -1
- package/docs/functions/getEnvVairables.md +1 -1
- package/docs/functions/getFileMetaInfo.md +1 -1
- package/docs/functions/getHashAlgoBySize.md +1 -1
- package/docs/functions/getKeysPath.md +1 -1
- package/docs/functions/getLLMTokenizer.md +1 -1
- package/docs/functions/getMultiLevelExtname.md +1 -1
- package/docs/functions/getPackageDir.md +1 -1
- package/docs/functions/getRealFilepath.md +1 -1
- package/docs/functions/getResponseErrorReadableStream.md +1 -1
- package/docs/functions/getXDGConfigs.md +1 -1
- package/docs/functions/hasDirectoryIn.md +1 -1
- package/docs/functions/hash.md +1 -1
- package/docs/functions/hashFile.md +1 -1
- package/docs/functions/hashStream.md +1 -1
- package/docs/functions/hfParse.md +1 -1
- package/docs/functions/hfTokenize.md +1 -1
- package/docs/functions/initShutdown.md +1 -1
- package/docs/functions/interpolateEnv.md +1 -1
- package/docs/functions/interpolateFString.md +1 -1
- package/docs/functions/interpolateGolangTemplate.md +1 -1
- package/docs/functions/isLangUsingSpaces.md +1 -1
- package/docs/functions/isListItemString.md +1 -1
- package/docs/functions/isModelNameMatched.md +1 -1
- package/docs/functions/isPunctuationChar.md +1 -1
- package/docs/functions/isQuoted.md +1 -1
- package/docs/functions/isRegExp.md +1 -1
- package/docs/functions/isSameString.md +1 -1
- package/docs/functions/isSectionString.md +1 -1
- package/docs/functions/isSentenceEnding.md +1 -1
- package/docs/functions/isSepLineString.md +1 -1
- package/docs/functions/isStrWrapped.md +1 -1
- package/docs/functions/isSubdirectory.md +1 -1
- package/docs/functions/isTitleString.md +1 -1
- package/docs/functions/isValidFilename.md +1 -1
- package/docs/functions/isValidFilepath.md +1 -1
- package/docs/functions/isWebStream.md +1 -1
- package/docs/functions/jsonFilterToWhere.md +1 -1
- package/docs/functions/jsonToMarkdownStr.md +1 -1
- package/docs/functions/loadAIConfig.md +1 -1
- package/docs/functions/loadConfig.md +1 -1
- package/docs/functions/loadConfigFile.md +1 -1
- package/docs/functions/loadFileFromPaths.md +1 -1
- package/docs/functions/loadTextFromPaths.md +1 -1
- package/docs/functions/lrucache.md +1 -1
- package/docs/functions/makeToolFuncCancelable.md +1 -1
- package/docs/functions/matchUrlProtocol.md +1 -1
- package/docs/functions/memoize.md +1 -1
- package/docs/functions/messagesToText.md +1 -1
- package/docs/functions/paramsSizeToScaleStr.md +1 -1
- package/docs/functions/parseCommand.md +1 -1
- package/docs/functions/parseFString.md +1 -1
- package/docs/functions/parseJsJson.md +1 -1
- package/docs/functions/parseJsJsonSimpleSync.md +1 -1
- package/docs/functions/parseObjectArgInfo.md +1 -1
- package/docs/functions/parseObjectArgumentInfos.md +1 -1
- package/docs/functions/parseObjectArguments.md +1 -1
- package/docs/functions/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/functions/parseYaml.md +1 -1
- package/docs/functions/quoteStr.md +1 -1
- package/docs/functions/reControlCharsRegex.md +1 -1
- package/docs/functions/readFilenamesRecursiveSync.md +1 -1
- package/docs/functions/readTextFileChunks.md +1 -1
- package/docs/functions/readTextFileChunksEx.md +1 -1
- package/docs/functions/readableFromAsyncIterable.md +1 -1
- package/docs/functions/registerCoreTools.md +1 -1
- package/docs/functions/registerYamlTag.md +1 -1
- package/docs/functions/removeMarkdownBold.md +1 -1
- package/docs/functions/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/functions/removeMarkdownItalic.md +1 -1
- package/docs/functions/replaceWithPlaceholder.md +1 -1
- package/docs/functions/restoreFromPlacehoders.md +1 -1
- package/docs/functions/sanitizeFilename.md +1 -1
- package/docs/functions/sanitizeFilepath.md +1 -1
- package/docs/functions/saveConfigFile.md +1 -1
- package/docs/functions/scaleStrToParamsSize.md +1 -1
- package/docs/functions/shutdown.md +1 -1
- package/docs/functions/simplifyObjectArguments.md +1 -1
- package/docs/functions/sortedValues.md +1 -1
- package/docs/functions/splitChunks.md +1 -1
- package/docs/functions/splitParagraph.md +1 -1
- package/docs/functions/splitSentence.md +1 -1
- package/docs/functions/stringifyYaml.md +1 -1
- package/docs/functions/stripConsoleColor.md +1 -1
- package/docs/functions/textToDate.md +1 -1
- package/docs/functions/toDateTime.md +1 -1
- package/docs/functions/trimStartOfStreamHelper.md +1 -1
- package/docs/functions/truncTo.md +1 -1
- package/docs/functions/truncateByToken.md +1 -1
- package/docs/functions/truncateToTokenLimit.md +1 -1
- package/docs/functions/truncateToTokenLimitEx.md +1 -1
- package/docs/functions/uuid.md +1 -1
- package/docs/functions/wait.md +1 -1
- package/docs/functions/xxhash.md +1 -1
- package/docs/functions/xxhash32.md +1 -1
- package/docs/functions/xxhash64.md +1 -1
- package/docs/functions/xxhashAsStr.md +1 -1
- package/docs/interfaces/AIChatAssistantMessageParam.md +12 -12
- package/docs/interfaces/AIChatContentPartImage.md +3 -3
- package/docs/interfaces/AIChatContentPartText.md +3 -3
- package/docs/interfaces/AIChatMessageParamBase.md +7 -7
- package/docs/interfaces/AIChatMessageToolCall.md +4 -4
- package/docs/interfaces/AIChatSystemMessageParam.md +9 -9
- package/docs/interfaces/AIChatToolChoiceFuncObject.md +3 -3
- package/docs/interfaces/AIChatToolChoiceObject.md +2 -2
- package/docs/interfaces/AIChatToolFunc.md +5 -5
- package/docs/interfaces/AIChatToolFuncParam.md +3 -3
- package/docs/interfaces/AIChatToolMessageParam.md +10 -10
- package/docs/interfaces/AIChatToolParam.md +2 -2
- package/docs/interfaces/AIChatToolTypeObject.md +2 -2
- package/docs/interfaces/AIChatUserMessageParam.md +13 -13
- package/docs/interfaces/AIChoiceConfig.md +8 -8
- package/docs/interfaces/AIResult.md +6 -6
- package/docs/interfaces/AIStreamParser.md +2 -2
- package/docs/interfaces/AIStreamParserOptions.md +2 -2
- package/docs/interfaces/BaseFunc.md +10 -10
- package/docs/interfaces/BaseFuncItem.md +9 -9
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreOptions.md +5 -5
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +2 -2
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +3 -3
- package/docs/interfaces/CancelableAbilityOptions.md +4 -4
- package/docs/interfaces/ClientFuncItem.md +12 -12
- package/docs/interfaces/DotenvExpandOptions.md +4 -4
- package/docs/interfaces/DotenvExpandOutput.md +3 -3
- package/docs/interfaces/DotenvParseInput.md +1 -1
- package/docs/interfaces/DotenvParseOutput.md +1 -1
- package/docs/interfaces/DotenvPopulateInput.md +1 -1
- package/docs/interfaces/EventClientFuncParams.md +5 -5
- package/docs/interfaces/EventServerFuncParams.md +6 -6
- package/docs/interfaces/FewShotPromptTemplateOptions.md +12 -12
- package/docs/interfaces/FuncItem.md +10 -10
- package/docs/interfaces/FuncParam.md +7 -7
- package/docs/interfaces/FuncParams.md +1 -1
- package/docs/interfaces/Funcs.md +1 -1
- package/docs/interfaces/HashAlgoParams.md +4 -4
- package/docs/interfaces/IFileMetaInfo.md +8 -8
- package/docs/interfaces/IReadTextFileChunksOptions.md +11 -11
- package/docs/interfaces/ITruncateToTokenLimitOptions.md +10 -10
- package/docs/interfaces/JsonFilter.md +1 -1
- package/docs/interfaces/ParseObjectArgumentOptions.md +11 -11
- package/docs/interfaces/PromptExampleSelectorOptions.md +3 -3
- package/docs/interfaces/PromptTemplateOptions.md +7 -7
- package/docs/interfaces/RemoteFuncItem.md +12 -12
- package/docs/interfaces/ReplacePlacehoderOptions.md +5 -5
- package/docs/interfaces/ResClientFuncParams.md +3 -3
- package/docs/interfaces/ResServerFuncParams.md +6 -6
- package/docs/interfaces/SanitizeFilenameOptions.md +3 -3
- package/docs/interfaces/SectionStringOptions.md +3 -3
- package/docs/interfaces/SemaphoreOptions.md +7 -7
- package/docs/interfaces/SemaphoreTaskItem.md +5 -5
- package/docs/interfaces/ServerFuncItem.md +13 -13
- package/docs/interfaces/ServerFuncParams.md +3 -3
- package/docs/interfaces/SplitSentenceOptions.md +5 -5
- package/docs/interfaces/StreamCallbacksAndOptions.md +5 -5
- package/docs/interfaces/TaskAbortControllers.md +1 -1
- package/docs/interfaces/TaskPromise.md +2 -2
- package/docs/interfaces/ToolFuncPackage.md +4 -4
- package/docs/type-aliases/AIChatContentPart.md +1 -1
- package/docs/type-aliases/AIChatMessageParam.md +1 -1
- package/docs/type-aliases/AIChatRole.md +1 -1
- package/docs/type-aliases/AIChatToolChoiceParam.md +1 -1
- package/docs/type-aliases/AIMessageType.md +1 -1
- package/docs/type-aliases/AIModelNameRule.md +1 -1
- package/docs/type-aliases/AIModelNameRuleFn.md +1 -1
- package/docs/type-aliases/AIModelNameRules.md +1 -1
- package/docs/type-aliases/AITextGenerationFinishReason.md +1 -1
- package/docs/type-aliases/ActionName.md +1 -1
- package/docs/type-aliases/AsyncTaskId.md +1 -1
- package/docs/type-aliases/BeforeShutdownListener.md +1 -1
- package/docs/type-aliases/EventErrorListenerFn.md +1 -1
- package/docs/type-aliases/EventListenerFn.md +1 -1
- package/docs/type-aliases/FStringPromptTemplateNode.md +1 -1
- package/docs/type-aliases/FuncParamType.md +1 -1
- package/docs/type-aliases/PromptExamples.md +1 -1
- package/docs/type-aliases/PromptTemplateType.md +1 -1
- package/docs/type-aliases/PromptType.md +1 -1
- package/docs/type-aliases/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/type-aliases/TFunc.md +1 -1
- package/docs/variables/AIChatRoles.md +1 -1
- package/docs/variables/AIMessageTypes.md +1 -1
- package/docs/variables/AITextGenerationFinishReasons.md +1 -1
- package/docs/variables/ActionNames.md +1 -1
- package/docs/variables/ClientToolFuncSchema.md +1 -1
- package/docs/variables/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/variables/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/variables/EventBusName.md +1 -1
- package/docs/variables/EventName.md +1 -1
- package/docs/variables/FilenameReservedRegex.md +1 -1
- package/docs/variables/HFBuiltins.md +1 -1
- package/docs/variables/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/variables/PASSING_SCORE.md +1 -1
- package/docs/variables/PromptTemplateTypes.md +1 -1
- package/docs/variables/PromptTypes.md +1 -1
- package/docs/variables/RStreamErrCode.md +1 -1
- package/docs/variables/RemoteToolFuncSchema.md +1 -1
- package/docs/variables/ResponseRStreamErrCode.md +1 -1
- package/docs/variables/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/variables/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/variables/SecondaryCache.md +1 -1
- package/docs/variables/ServerToolFuncSchema.md +1 -1
- package/docs/variables/ToolAsyncCancelableBit.md +1 -1
- package/docs/variables/ToolAsyncMultiTaskBit.md +1 -1
- package/docs/variables/ToolAsyncPriorityBit.md +1 -1
- package/docs/variables/ToolFuncSchema.md +1 -1
- package/docs/variables/WindowsReservedNameRegex.md +1 -1
- package/docs/variables/base32768.md +1 -1
- package/docs/variables/defaultTemplateFormat.md +1 -1
- package/docs/variables/event.md +1 -1
- package/docs/variables/eventClient.md +1 -1
- package/docs/variables/eventServer.md +1 -1
- package/docs/variables/lrucache.md +1 -1
- 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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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
|
|
package/docs/classes/IntSet.md
CHANGED
|
@@ -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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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/
|
|
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
|
|