@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: FewShotPromptTemplate\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:39](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:39](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L39)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:39](h
|
|
|
22
22
|
|
|
23
23
|
> **new FewShotPromptTemplate**\<`T`\>(`options`): [`FewShotPromptTemplate`](FewShotPromptTemplate.md)\<`T`\>
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L50)
|
|
26
26
|
|
|
27
27
|
#### Parameters
|
|
28
28
|
|
|
@@ -44,7 +44,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:50](h
|
|
|
44
44
|
|
|
45
45
|
> **compiledTemplate**: `any`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
47
|
+
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)
|
|
48
48
|
|
|
49
49
|
#### Inherited from
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://gi
|
|
|
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
|
> **examplePrompt**: `undefined` \| [`PromptTemplate`](PromptTemplate.md)
|
|
70
70
|
|
|
71
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
71
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L41)
|
|
72
72
|
|
|
73
73
|
***
|
|
74
74
|
|
|
@@ -76,7 +76,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:41](h
|
|
|
76
76
|
|
|
77
77
|
> **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
|
|
78
78
|
|
|
79
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](https://github.com/isdk/ai-tool.js/blob/
|
|
79
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L40)
|
|
80
80
|
|
|
81
81
|
***
|
|
82
82
|
|
|
@@ -84,7 +84,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:40](h
|
|
|
84
84
|
|
|
85
85
|
> **exampleSeparator**: `string`
|
|
86
86
|
|
|
87
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/
|
|
87
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L43)
|
|
88
88
|
|
|
89
89
|
***
|
|
90
90
|
|
|
@@ -92,7 +92,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:43](h
|
|
|
92
92
|
|
|
93
93
|
> **inputVariables**: `undefined` \| `string`[]
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
95
|
+
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)
|
|
96
96
|
|
|
97
97
|
#### Inherited from
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:25](https://gi
|
|
|
104
104
|
|
|
105
105
|
> **prefix**: `string`
|
|
106
106
|
|
|
107
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](https://github.com/isdk/ai-tool.js/blob/
|
|
107
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L44)
|
|
108
108
|
|
|
109
109
|
***
|
|
110
110
|
|
|
@@ -112,7 +112,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:44](h
|
|
|
112
112
|
|
|
113
113
|
> **suffix**: `string`
|
|
114
114
|
|
|
115
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](https://github.com/isdk/ai-tool.js/blob/
|
|
115
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L42)
|
|
116
116
|
|
|
117
117
|
***
|
|
118
118
|
|
|
@@ -120,7 +120,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:42](h
|
|
|
120
120
|
|
|
121
121
|
> **template**: `string`
|
|
122
122
|
|
|
123
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
123
|
+
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)
|
|
124
124
|
|
|
125
125
|
#### Inherited from
|
|
126
126
|
|
|
@@ -132,7 +132,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:22](https://gi
|
|
|
132
132
|
|
|
133
133
|
> **templateFormat**: `undefined` \| `string`
|
|
134
134
|
|
|
135
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
135
|
+
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)
|
|
136
136
|
|
|
137
137
|
#### Inherited from
|
|
138
138
|
|
|
@@ -302,7 +302,7 @@ The Root Factory class
|
|
|
302
302
|
|
|
303
303
|
> **\_format**(`data`): `Promise`\<`string`\>
|
|
304
304
|
|
|
305
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/
|
|
305
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L69)
|
|
306
306
|
|
|
307
307
|
#### Parameters
|
|
308
308
|
|
|
@@ -324,7 +324,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:69](h
|
|
|
324
324
|
|
|
325
325
|
> **\_initialize**(`options`?): `void`
|
|
326
326
|
|
|
327
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](https://github.com/isdk/ai-tool.js/blob/
|
|
327
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L54)
|
|
328
328
|
|
|
329
329
|
#### Parameters
|
|
330
330
|
|
|
@@ -346,7 +346,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:54](h
|
|
|
346
346
|
|
|
347
347
|
> **filterData**(`data`): `Record`\<`string`, `any`\>
|
|
348
348
|
|
|
349
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:62](https://github.com/isdk/ai-tool.js/blob/
|
|
349
|
+
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)
|
|
350
350
|
|
|
351
351
|
Validate/filter the data in inputVariables
|
|
352
352
|
|
|
@@ -370,7 +370,7 @@ Validate/filter the data in inputVariables
|
|
|
370
370
|
|
|
371
371
|
> **format**(`data`?): `Promise`\<`string`\>
|
|
372
372
|
|
|
373
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://github.com/isdk/ai-tool.js/blob/
|
|
373
|
+
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)
|
|
374
374
|
|
|
375
375
|
#### Parameters
|
|
376
376
|
|
|
@@ -392,7 +392,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:109](https://g
|
|
|
392
392
|
|
|
393
393
|
> `abstract` **initialize**(`options`?): `void`
|
|
394
394
|
|
|
395
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:96](https://github.com/isdk/ai-tool.js/blob/
|
|
395
|
+
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)
|
|
396
396
|
|
|
397
397
|
**`Internal`**
|
|
398
398
|
|
|
@@ -418,7 +418,7 @@ initialize instance method
|
|
|
418
418
|
|
|
419
419
|
> **partial**(`data`): [`PromptTemplate`](PromptTemplate.md)
|
|
420
420
|
|
|
421
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:139](https://github.com/isdk/ai-tool.js/blob/
|
|
421
|
+
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)
|
|
422
422
|
|
|
423
423
|
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.
|
|
424
424
|
|
|
@@ -446,7 +446,7 @@ the new partial PromptTemplate instance
|
|
|
446
446
|
|
|
447
447
|
> **toJSON**(`options`): [`FewShotPromptTemplateOptions`](../interfaces/FewShotPromptTemplateOptions.md)\<`T`\>
|
|
448
448
|
|
|
449
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](https://github.com/isdk/ai-tool.js/blob/
|
|
449
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:94](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L94)
|
|
450
450
|
|
|
451
451
|
#### Parameters
|
|
452
452
|
|
|
@@ -659,7 +659,7 @@ the forEach callback function
|
|
|
659
659
|
|
|
660
660
|
> `static` **format**(`options`): `Promise`\<`string`\>
|
|
661
661
|
|
|
662
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/
|
|
662
|
+
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)
|
|
663
663
|
|
|
664
664
|
#### Parameters
|
|
665
665
|
|
|
@@ -681,7 +681,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:31](https://gi
|
|
|
681
681
|
|
|
682
682
|
> `static` **formatIf**(`options`): `Promise`\<`undefined` \| `string`\>
|
|
683
683
|
|
|
684
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:41](https://github.com/isdk/ai-tool.js/blob/
|
|
684
|
+
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)
|
|
685
685
|
|
|
686
686
|
If the given options.template is the template, perform formatting using that template.
|
|
687
687
|
|
|
@@ -769,7 +769,7 @@ the name to register
|
|
|
769
769
|
|
|
770
770
|
> `static` **from**\<`T`\>(`options`): [`FewShotPromptTemplate`](FewShotPromptTemplate.md)\<`T`\>
|
|
771
771
|
|
|
772
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](https://github.com/isdk/ai-tool.js/blob/
|
|
772
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:46](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L46)
|
|
773
773
|
|
|
774
774
|
#### Type Parameters
|
|
775
775
|
|
|
@@ -951,7 +951,7 @@ the unique name in the factory
|
|
|
951
951
|
|
|
952
952
|
> `static` **isTemplate**(`templateOpt`): `any`
|
|
953
953
|
|
|
954
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:48](https://github.com/isdk/ai-tool.js/blob/
|
|
954
|
+
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)
|
|
955
955
|
|
|
956
956
|
#### Parameters
|
|
957
957
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: GolangPromptTemplate
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/golang-prompt-template.ts#L5)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:5](http
|
|
|
18
18
|
|
|
19
19
|
> **new GolangPromptTemplate**(`template`?, `options`?): [`GolangPromptTemplate`](GolangPromptTemplate.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**: `any`
|
|
46
46
|
|
|
47
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
47
|
+
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)
|
|
48
48
|
|
|
49
49
|
#### Inherited from
|
|
50
50
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:21](https://gi
|
|
|
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/golang-prompt-template.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
265
|
+
Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/golang-prompt-template.ts#L26)
|
|
266
266
|
|
|
267
267
|
#### Parameters
|
|
268
268
|
|
|
@@ -284,7 +284,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:26](htt
|
|
|
284
284
|
|
|
285
285
|
> **\_initialize**(`options`?): `void`
|
|
286
286
|
|
|
287
|
-
Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:18](https://github.com/isdk/ai-tool.js/blob/
|
|
287
|
+
Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:18](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/golang-prompt-template.ts#L18)
|
|
288
288
|
|
|
289
289
|
#### Parameters
|
|
290
290
|
|
|
@@ -306,7 +306,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:18](htt
|
|
|
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/golang-prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
355
|
+
Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/golang-prompt-template.ts#L12)
|
|
356
356
|
|
|
357
357
|
#### Parameters
|
|
358
358
|
|
|
@@ -370,7 +370,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:12](htt
|
|
|
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`): `undefined` \| `boolean`
|
|
931
931
|
|
|
932
|
-
Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:7](https://github.com/isdk/ai-tool.js/blob/
|
|
932
|
+
Defined in: [packages/ai-tool/src/utils/prompt/golang-prompt-template.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/golang-prompt-template.ts#L7)
|
|
933
933
|
|
|
934
934
|
#### Parameters
|
|
935
935
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: HFEnvironment
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:21](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L21)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:21](h
|
|
|
18
18
|
|
|
19
19
|
> **new HFEnvironment**(`parent`?): [`HFEnvironment`](HFEnvironment.md)
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
21
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L22)
|
|
22
22
|
|
|
23
23
|
#### Parameters
|
|
24
24
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:22](h
|
|
|
40
40
|
|
|
41
41
|
> `optional` **parent**: [`HFEnvironment`](HFEnvironment.md)
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:22](https://github.com/isdk/ai-tool.js/blob/
|
|
43
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L22)
|
|
44
44
|
|
|
45
45
|
#### Inherited from
|
|
46
46
|
|
|
@@ -52,7 +52,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:22](h
|
|
|
52
52
|
|
|
53
53
|
> **tests**: `Map`\<`string`, (...`value`) => `boolean`\>
|
|
54
54
|
|
|
55
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:319](https://github.com/isdk/ai-tool.js/blob/
|
|
55
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:319](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L319)
|
|
56
56
|
|
|
57
57
|
The tests available in this environment.
|
|
58
58
|
|
|
@@ -66,7 +66,7 @@ The tests available in this environment.
|
|
|
66
66
|
|
|
67
67
|
> **variables**: `Map`\<`string`, `AnyRuntimeValue`\>
|
|
68
68
|
|
|
69
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:301](https://github.com/isdk/ai-tool.js/blob/
|
|
69
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:301](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L301)
|
|
70
70
|
|
|
71
71
|
The variables declared in this environment.
|
|
72
72
|
|
|
@@ -80,7 +80,7 @@ The variables declared in this environment.
|
|
|
80
80
|
|
|
81
81
|
> **assign**(`items`): `void`
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
83
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L26)
|
|
84
84
|
|
|
85
85
|
#### Parameters
|
|
86
86
|
|
|
@@ -98,7 +98,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:26](h
|
|
|
98
98
|
|
|
99
99
|
> **clear**(): `void`
|
|
100
100
|
|
|
101
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:32](https://github.com/isdk/ai-tool.js/blob/
|
|
101
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:32](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L32)
|
|
102
102
|
|
|
103
103
|
#### Returns
|
|
104
104
|
|
|
@@ -110,7 +110,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:32](h
|
|
|
110
110
|
|
|
111
111
|
> **lookupVariable**(`name`): `AnyRuntimeValue`
|
|
112
112
|
|
|
113
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:417](https://github.com/isdk/ai-tool.js/blob/
|
|
113
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:417](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L417)
|
|
114
114
|
|
|
115
115
|
#### Parameters
|
|
116
116
|
|
|
@@ -132,7 +132,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:417
|
|
|
132
132
|
|
|
133
133
|
> **set**(`name`, `value`): `AnyRuntimeValue`
|
|
134
134
|
|
|
135
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:372](https://github.com/isdk/ai-tool.js/blob/
|
|
135
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:372](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L372)
|
|
136
136
|
|
|
137
137
|
Set the value of a variable in the current environment.
|
|
138
138
|
|
|
@@ -160,7 +160,7 @@ Set the value of a variable in the current environment.
|
|
|
160
160
|
|
|
161
161
|
> **setVariable**(`name`, `value`): `AnyRuntimeValue`
|
|
162
162
|
|
|
163
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:394](https://github.com/isdk/ai-tool.js/blob/
|
|
163
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:394](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L394)
|
|
164
164
|
|
|
165
165
|
Set variable in the current scope.
|
|
166
166
|
See https://jinja.palletsprojects.com/en/3.0.x/templates/#assignments for more information.
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: HFInterpreter
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:426](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:426](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L426)
|
|
10
10
|
|
|
11
11
|
## Constructors
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:426
|
|
|
14
14
|
|
|
15
15
|
> **new HFInterpreter**(`env`?): [`HFInterpreter`](HFInterpreter.md)
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:429](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:429](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L429)
|
|
18
18
|
|
|
19
19
|
#### Parameters
|
|
20
20
|
|
|
@@ -32,7 +32,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:429
|
|
|
32
32
|
|
|
33
33
|
> **global**: `Environment`
|
|
34
34
|
|
|
35
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:427](https://github.com/isdk/ai-tool.js/blob/
|
|
35
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:427](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L427)
|
|
36
36
|
|
|
37
37
|
## Methods
|
|
38
38
|
|
|
@@ -40,7 +40,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:427
|
|
|
40
40
|
|
|
41
41
|
> **evaluate**(`statement`, `environment`): `AnyRuntimeValue`
|
|
42
42
|
|
|
43
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:1109](https://github.com/isdk/ai-tool.js/blob/
|
|
43
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:1109](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L1109)
|
|
44
44
|
|
|
45
45
|
#### Parameters
|
|
46
46
|
|
|
@@ -62,7 +62,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:110
|
|
|
62
62
|
|
|
63
63
|
> **run**(`program`): `AnyRuntimeValue`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:436](https://github.com/isdk/ai-tool.js/blob/
|
|
65
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/runtime.ts:436](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/runtime.ts#L436)
|
|
66
66
|
|
|
67
67
|
Run the program.
|
|
68
68
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Class: HFTemplate
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:37](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:37](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L37)
|
|
10
10
|
|
|
11
11
|
## Constructors
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:37](h
|
|
|
14
14
|
|
|
15
15
|
> **new HFTemplate**(`template`, `options`): [`HFTemplate`](HFTemplate.md)
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:45](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:45](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L45)
|
|
18
18
|
|
|
19
19
|
#### Parameters
|
|
20
20
|
|
|
@@ -38,7 +38,7 @@ The template string
|
|
|
38
38
|
|
|
39
39
|
> **parsed**: `Program`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:38](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L38)
|
|
42
42
|
|
|
43
43
|
***
|
|
44
44
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:38](h
|
|
|
46
46
|
|
|
47
47
|
> `static` **global**: [`HFEnvironment`](HFEnvironment.md)
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:40](https://github.com/isdk/ai-tool.js/blob/
|
|
49
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:40](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L40)
|
|
50
50
|
|
|
51
51
|
## Methods
|
|
52
52
|
|
|
@@ -54,7 +54,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:40](h
|
|
|
54
54
|
|
|
55
55
|
> **render**(`items`?): `string`
|
|
56
56
|
|
|
57
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:55](https://github.com/isdk/ai-tool.js/blob/
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/jinja/src/index.ts:55](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/jinja/src/index.ts#L55)
|
|
58
58
|
|
|
59
59
|
#### Parameters
|
|
60
60
|
|