@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
|
# Interface: BinarySemaphoreReleaserFunc()
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:38](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:38](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L38)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:38](https://github.co
|
|
|
14
14
|
|
|
15
15
|
> **BinarySemaphoreReleaserFunc**(): `void`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:39](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:39](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L39)
|
|
18
18
|
|
|
19
19
|
## Returns
|
|
20
20
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:39](https://github.co
|
|
|
30
30
|
|
|
31
31
|
> `optional` **token**: `any`
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/async-semaphore.ts:34](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/async-semaphore.ts#L34)
|
|
34
34
|
|
|
35
35
|
#### Inherited from
|
|
36
36
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: CancelableAbilityOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L29)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github
|
|
|
22
22
|
|
|
23
23
|
> `optional` **asyncFeatures**: [`AsyncFeatures`](../enumerations/AsyncFeatures.md)
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L30)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -78,7 +78,7 @@ Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-abilit
|
|
|
78
78
|
|
|
79
79
|
> `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
|
|
80
80
|
|
|
81
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github.com/isdk/ai-tool.js/blob/
|
|
81
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L32)
|
|
82
82
|
|
|
83
83
|
***
|
|
84
84
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github
|
|
|
86
86
|
|
|
87
87
|
> `optional` **maxTaskConcurrency**: `number`
|
|
88
88
|
|
|
89
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:31](https://github.com/isdk/ai-tool.js/blob/
|
|
89
|
+
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:31](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/cancelable-ability.ts#L31)
|
|
90
90
|
|
|
91
91
|
***
|
|
92
92
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: ClientFuncItem
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/client-tools.ts#L5)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/client-tools.ts:5](https://github.com/isdk/ai-
|
|
|
22
22
|
|
|
23
23
|
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L35)
|
|
26
26
|
|
|
27
27
|
#### Inherited from
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai
|
|
|
34
34
|
|
|
35
35
|
> `optional` **apiRoot**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/
|
|
37
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L34)
|
|
38
38
|
|
|
39
39
|
#### Inherited from
|
|
40
40
|
|
|
@@ -46,7 +46,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai
|
|
|
46
46
|
|
|
47
47
|
> `optional` **fetchOptions**: `any`
|
|
48
48
|
|
|
49
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
49
|
+
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/consts.ts#L36)
|
|
50
50
|
|
|
51
51
|
#### Inherited from
|
|
52
52
|
|
|
@@ -58,7 +58,7 @@ Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai
|
|
|
58
58
|
|
|
59
59
|
> `optional` **isApi**: `boolean`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
61
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L29)
|
|
62
62
|
|
|
63
63
|
#### Inherited from
|
|
64
64
|
|
|
@@ -70,7 +70,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
70
70
|
|
|
71
71
|
> `optional` **name**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
73
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L23)
|
|
74
74
|
|
|
75
75
|
#### Inherited from
|
|
76
76
|
|
|
@@ -82,7 +82,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-to
|
|
|
82
82
|
|
|
83
83
|
> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
|
|
84
84
|
|
|
85
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
85
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L24)
|
|
86
86
|
|
|
87
87
|
#### Inherited from
|
|
88
88
|
|
|
@@ -94,7 +94,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
94
94
|
|
|
95
95
|
> `optional` **result**: `string`
|
|
96
96
|
|
|
97
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
97
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L25)
|
|
98
98
|
|
|
99
99
|
#### Inherited from
|
|
100
100
|
|
|
@@ -106,7 +106,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
106
106
|
|
|
107
107
|
> `optional` **scope**: `any`
|
|
108
108
|
|
|
109
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
109
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L26)
|
|
110
110
|
|
|
111
111
|
#### Inherited from
|
|
112
112
|
|
|
@@ -118,7 +118,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
118
118
|
|
|
119
119
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
121
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L28)
|
|
122
122
|
|
|
123
123
|
#### Parameters
|
|
124
124
|
|
|
@@ -144,7 +144,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
144
144
|
|
|
145
145
|
> `optional` **stream**: `boolean`
|
|
146
146
|
|
|
147
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
147
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L30)
|
|
148
148
|
|
|
149
149
|
#### Inherited from
|
|
150
150
|
|
|
@@ -156,7 +156,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
156
156
|
|
|
157
157
|
> `optional` **tags**: `string` \| `string`[]
|
|
158
158
|
|
|
159
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
159
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L27)
|
|
160
160
|
|
|
161
161
|
#### Inherited from
|
|
162
162
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DotenvExpandOptions
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:202](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:202](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L202)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:202](https://gith
|
|
|
14
14
|
|
|
15
15
|
> `optional` **error**: `Error`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:203](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:203](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L203)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:203](https://gith
|
|
|
22
22
|
|
|
23
23
|
> `optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:219](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:219](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L219)
|
|
26
26
|
|
|
27
27
|
Default: `object`
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Object coming from dotenv's parsed result.
|
|
|
34
34
|
|
|
35
35
|
> `optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:212](https://github.com/isdk/ai-tool.js/blob/
|
|
37
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:212](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L212)
|
|
38
38
|
|
|
39
39
|
Default: `process.env`
|
|
40
40
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DotenvExpandOutput
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:222](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:222](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L222)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:222](https://gith
|
|
|
14
14
|
|
|
15
15
|
> `optional` **error**: `Error`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:223](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:223](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L223)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,4 +22,4 @@ Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:223](https://gith
|
|
|
22
22
|
|
|
23
23
|
> `optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:224](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:224](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L224)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DotenvParseInput
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:194](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:194](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L194)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DotenvParseOutput
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:198](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:198](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L198)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: DotenvPopulateInput
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:190](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:190](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/template/env.ts#L190)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: EventClientFuncParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:5](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/funcs/event-client.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-client.ts#L5)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/funcs/event-client.ts:5](https://github.com/is
|
|
|
14
14
|
|
|
15
15
|
> `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"` \| `"init"`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-client.ts#L8)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/is
|
|
|
22
22
|
|
|
23
23
|
> `optional` **data**: `any`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-client.ts#L7)
|
|
26
26
|
|
|
27
27
|
***
|
|
28
28
|
|
|
@@ -30,7 +30,7 @@ Defined in: [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/is
|
|
|
30
30
|
|
|
31
31
|
> `optional` **event**: `string` \| `string`[]
|
|
32
32
|
|
|
33
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/
|
|
33
|
+
Defined in: [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-client.ts#L6)
|
|
34
34
|
|
|
35
35
|
***
|
|
36
36
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/is
|
|
|
38
38
|
|
|
39
39
|
> `optional` **listener**: (...`args`) => `void`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
41
|
+
Defined in: [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-client.ts#L9)
|
|
42
42
|
|
|
43
43
|
#### Parameters
|
|
44
44
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: EventServerFuncParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/funcs/event-server.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-server.ts#L12)
|
|
10
10
|
|
|
11
11
|
Convention: Always pass _req, _res
|
|
12
12
|
|
|
@@ -24,7 +24,7 @@ Convention: Always pass _req, _res
|
|
|
24
24
|
|
|
25
25
|
> `optional` **\_req**: `IncomingMessage`
|
|
26
26
|
|
|
27
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
27
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L9)
|
|
28
28
|
|
|
29
29
|
#### Inherited from
|
|
30
30
|
|
|
@@ -36,7 +36,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-
|
|
|
36
36
|
|
|
37
37
|
> `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
|
|
38
38
|
|
|
39
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
39
|
+
Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/server-tools.ts#L10)
|
|
40
40
|
|
|
41
41
|
#### Inherited from
|
|
42
42
|
|
|
@@ -48,7 +48,7 @@ Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai
|
|
|
48
48
|
|
|
49
49
|
> `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/
|
|
51
|
+
Defined in: [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-server.ts#L15)
|
|
52
52
|
|
|
53
53
|
***
|
|
54
54
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/i
|
|
|
56
56
|
|
|
57
57
|
> `optional` **data**: `any`
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
59
|
+
Defined in: [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-server.ts#L14)
|
|
60
60
|
|
|
61
61
|
***
|
|
62
62
|
|
|
@@ -64,4 +64,4 @@ Defined in: [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/i
|
|
|
64
64
|
|
|
65
65
|
> `optional` **event**: `string` \| `string`[]
|
|
66
66
|
|
|
67
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
67
|
+
Defined in: [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/funcs/event-server.ts#L13)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FewShotPromptTemplateOptions\<T\>
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L10)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:10](h
|
|
|
26
26
|
|
|
27
27
|
> `optional` **compiledTemplate**: `any`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/
|
|
29
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L15)
|
|
30
30
|
|
|
31
31
|
#### Inherited from
|
|
32
32
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://gi
|
|
|
38
38
|
|
|
39
39
|
> `optional` **data**: `Record`\<`string`, `any`\>
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L12)
|
|
42
42
|
|
|
43
43
|
#### Inherited from
|
|
44
44
|
|
|
@@ -50,7 +50,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://gi
|
|
|
50
50
|
|
|
51
51
|
> **examplePrompt**: [`PromptTemplateOptions`](PromptTemplateOptions.md) \| [`PromptTemplate`](../classes/PromptTemplate.md)
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/
|
|
53
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L19)
|
|
54
54
|
|
|
55
55
|
An [PromptTemplate](../classes/PromptTemplate.md) used to format a single example.
|
|
56
56
|
|
|
@@ -60,7 +60,7 @@ An [PromptTemplate](../classes/PromptTemplate.md) used to format a single exampl
|
|
|
60
60
|
|
|
61
61
|
> **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
|
|
62
62
|
|
|
63
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
63
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L14)
|
|
64
64
|
|
|
65
65
|
The few shot examples to use in the prompt.
|
|
66
66
|
|
|
@@ -70,7 +70,7 @@ The few shot examples to use in the prompt.
|
|
|
70
70
|
|
|
71
71
|
> `optional` **exampleSeparator**: `string`
|
|
72
72
|
|
|
73
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
73
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L24)
|
|
74
74
|
|
|
75
75
|
String separator used to join the prefix, the examples, and suffix.
|
|
76
76
|
|
|
@@ -80,7 +80,7 @@ String separator used to join the prefix, the examples, and suffix.
|
|
|
80
80
|
|
|
81
81
|
> `optional` **ignoreInitialize**: `boolean`
|
|
82
82
|
|
|
83
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
83
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L16)
|
|
84
84
|
|
|
85
85
|
#### Inherited from
|
|
86
86
|
|
|
@@ -92,7 +92,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://gi
|
|
|
92
92
|
|
|
93
93
|
> `optional` **inputVariables**: `string`[]
|
|
94
94
|
|
|
95
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/
|
|
95
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L14)
|
|
96
96
|
|
|
97
97
|
#### Inherited from
|
|
98
98
|
|
|
@@ -104,7 +104,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://gi
|
|
|
104
104
|
|
|
105
105
|
> `optional` **prefix**: `string`
|
|
106
106
|
|
|
107
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/
|
|
107
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L31)
|
|
108
108
|
|
|
109
109
|
A prompt template string to put before the examples.
|
|
110
110
|
|
|
@@ -118,7 +118,7 @@ A prompt template string to put before the examples.
|
|
|
118
118
|
|
|
119
119
|
> `optional` **suffix**: `string`
|
|
120
120
|
|
|
121
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/
|
|
121
|
+
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L36)
|
|
122
122
|
|
|
123
123
|
A prompt template string to put after the examples.
|
|
124
124
|
|
|
@@ -128,7 +128,7 @@ A prompt template string to put after the examples.
|
|
|
128
128
|
|
|
129
129
|
> `optional` **template**: `string`
|
|
130
130
|
|
|
131
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
131
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L11)
|
|
132
132
|
|
|
133
133
|
#### Inherited from
|
|
134
134
|
|
|
@@ -140,7 +140,7 @@ Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://gi
|
|
|
140
140
|
|
|
141
141
|
> `optional` **templateFormat**: `string`
|
|
142
142
|
|
|
143
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
143
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L13)
|
|
144
144
|
|
|
145
145
|
#### Inherited from
|
|
146
146
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FuncItem
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:33](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:33](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L33)
|
|
10
10
|
|
|
11
11
|
## Extends
|
|
12
12
|
|
|
@@ -18,7 +18,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:33](https://github.com/isdk/ai-to
|
|
|
18
18
|
|
|
19
19
|
> `optional` **func**: [`TFunc`](../type-aliases/TFunc.md)
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:34](https://github.com/isdk/ai-tool.js/blob/
|
|
21
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:34](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L34)
|
|
22
22
|
|
|
23
23
|
***
|
|
24
24
|
|
|
@@ -26,7 +26,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:34](https://github.com/isdk/ai-to
|
|
|
26
26
|
|
|
27
27
|
> `optional` **isApi**: `boolean`
|
|
28
28
|
|
|
29
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/
|
|
29
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L29)
|
|
30
30
|
|
|
31
31
|
#### Inherited from
|
|
32
32
|
|
|
@@ -38,7 +38,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-to
|
|
|
38
38
|
|
|
39
39
|
> `optional` **name**: `string`
|
|
40
40
|
|
|
41
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/
|
|
41
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L23)
|
|
42
42
|
|
|
43
43
|
#### Inherited from
|
|
44
44
|
|
|
@@ -50,7 +50,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-to
|
|
|
50
50
|
|
|
51
51
|
> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/
|
|
53
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L24)
|
|
54
54
|
|
|
55
55
|
#### Inherited from
|
|
56
56
|
|
|
@@ -62,7 +62,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-to
|
|
|
62
62
|
|
|
63
63
|
> `optional` **result**: `string`
|
|
64
64
|
|
|
65
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/
|
|
65
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L25)
|
|
66
66
|
|
|
67
67
|
#### Inherited from
|
|
68
68
|
|
|
@@ -74,7 +74,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-to
|
|
|
74
74
|
|
|
75
75
|
> `optional` **scope**: `any`
|
|
76
76
|
|
|
77
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/
|
|
77
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L26)
|
|
78
78
|
|
|
79
79
|
#### Inherited from
|
|
80
80
|
|
|
@@ -86,7 +86,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-to
|
|
|
86
86
|
|
|
87
87
|
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
88
88
|
|
|
89
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/
|
|
89
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L28)
|
|
90
90
|
|
|
91
91
|
#### Parameters
|
|
92
92
|
|
|
@@ -112,7 +112,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-to
|
|
|
112
112
|
|
|
113
113
|
> `optional` **stream**: `boolean`
|
|
114
114
|
|
|
115
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/
|
|
115
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L30)
|
|
116
116
|
|
|
117
117
|
#### Inherited from
|
|
118
118
|
|
|
@@ -124,7 +124,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-to
|
|
|
124
124
|
|
|
125
125
|
> `optional` **tags**: `string` \| `string`[]
|
|
126
126
|
|
|
127
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/
|
|
127
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L27)
|
|
128
128
|
|
|
129
129
|
#### Inherited from
|
|
130
130
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FuncParam
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:7](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L7)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -14,7 +14,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:7](https://github.com/isdk/ai-too
|
|
|
14
14
|
|
|
15
15
|
> `optional` **asyncFeatures**: `number`
|
|
16
16
|
|
|
17
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:12](https://github.com/isdk/ai-tool.js/blob/
|
|
17
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L12)
|
|
18
18
|
|
|
19
19
|
***
|
|
20
20
|
|
|
@@ -22,7 +22,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:12](https://github.com/isdk/ai-to
|
|
|
22
22
|
|
|
23
23
|
> `optional` **depends**: `object`
|
|
24
24
|
|
|
25
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:13](https://github.com/isdk/ai-tool.js/blob/
|
|
25
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L13)
|
|
26
26
|
|
|
27
27
|
#### Index Signature
|
|
28
28
|
|
|
@@ -34,7 +34,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:13](https://github.com/isdk/ai-to
|
|
|
34
34
|
|
|
35
35
|
> `optional` **description**: `string`
|
|
36
36
|
|
|
37
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:11](https://github.com/isdk/ai-tool.js/blob/
|
|
37
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L11)
|
|
38
38
|
|
|
39
39
|
***
|
|
40
40
|
|
|
@@ -42,7 +42,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:11](https://github.com/isdk/ai-to
|
|
|
42
42
|
|
|
43
43
|
> `optional` **name**: `string`
|
|
44
44
|
|
|
45
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:8](https://github.com/isdk/ai-tool.js/blob/
|
|
45
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L8)
|
|
46
46
|
|
|
47
47
|
***
|
|
48
48
|
|
|
@@ -50,7 +50,7 @@ Defined in: [packages/ai-tool/src/tool-func.ts:8](https://github.com/isdk/ai-too
|
|
|
50
50
|
|
|
51
51
|
> `optional` **required**: `boolean`
|
|
52
52
|
|
|
53
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:10](https://github.com/isdk/ai-tool.js/blob/
|
|
53
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L10)
|
|
54
54
|
|
|
55
55
|
***
|
|
56
56
|
|
|
@@ -58,4 +58,4 @@ Defined in: [packages/ai-tool/src/tool-func.ts:10](https://github.com/isdk/ai-to
|
|
|
58
58
|
|
|
59
59
|
> `optional` **type**: `string`
|
|
60
60
|
|
|
61
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:9](https://github.com/isdk/ai-tool.js/blob/
|
|
61
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L9)
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Interface: FuncParams
|
|
8
8
|
|
|
9
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:16](https://github.com/isdk/ai-tool.js/blob/
|
|
9
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L16)
|
|
10
10
|
|
|
11
11
|
## Indexable
|
|
12
12
|
|