@isdk/ai-tool 0.5.2 → 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/dist/funcs.js +1 -1
- package/dist/index.js +1 -1
- package/docs/README.md +250 -0
- package/docs/_media/CONTRIBUTING.md +18 -0
- package/docs/_media/LICENSE-MIT +22 -0
- package/docs/classes/AbortError.md +366 -0
- package/docs/classes/AlreadyExistsError.md +346 -0
- package/docs/classes/BaseError.md +359 -0
- package/docs/classes/BinarySemaphore.md +418 -0
- package/docs/classes/CancelableAbility.md +467 -0
- package/docs/classes/ClientTools.md +2715 -0
- package/docs/classes/CommonError.md +377 -0
- package/docs/classes/ConfigFile.md +353 -0
- package/docs/classes/EnvPromptTemplate.md +1158 -0
- package/docs/classes/EventClient.md +3149 -0
- package/docs/classes/EventEmitter.md +299 -0
- package/docs/classes/EventServer.md +3175 -0
- package/docs/classes/EventToolFunc.md +2557 -0
- package/docs/classes/FStringPromptTemplate.md +1158 -0
- package/docs/classes/FewShotPromptTemplate.md +1180 -0
- package/docs/classes/GolangPromptTemplate.md +1158 -0
- package/docs/classes/HFEnvironment.md +184 -0
- package/docs/classes/HFInterpreter.md +77 -0
- package/docs/classes/HFTemplate.md +67 -0
- package/docs/classes/HfPromptTemplate.md +1158 -0
- package/docs/classes/IntSet.md +216 -0
- package/docs/classes/LRUCache.md +601 -0
- package/docs/classes/NotFoundError.md +346 -0
- package/docs/classes/NotImplementationError.md +346 -0
- package/docs/classes/PromptExampleSelector.md +195 -0
- package/docs/classes/PromptTemplate.md +1088 -0
- package/docs/classes/ReadableStreamError.md +366 -0
- package/docs/classes/ResClientTools.md +2431 -0
- package/docs/classes/ResServerTools.md +2407 -0
- package/docs/classes/SSEChannel.md +270 -0
- package/docs/classes/Semaphore.md +538 -0
- package/docs/classes/ServerTools.md +2623 -0
- package/docs/classes/SignalGate.md +182 -0
- package/docs/classes/TaskAbortController.md +131 -0
- package/docs/classes/ToolFunc.md +2177 -0
- package/docs/classes/YamlTypeBaseObject.md +31 -0
- package/docs/enumerations/AsyncFeatureBits.md +33 -0
- package/docs/enumerations/AsyncFeatures.md +33 -0
- package/docs/enumerations/ErrorCode.md +177 -0
- package/docs/enumerations/HashAlgorithm.md +97 -0
- package/docs/functions/AIArgProcessor.md +33 -0
- package/docs/functions/AIStream.md +52 -0
- package/docs/functions/ChoiceArgProcessor.md +33 -0
- package/docs/functions/ObjectArgsToArgsInfo.md +29 -0
- package/docs/functions/RateLimit.md +37 -0
- package/docs/functions/TemplateArgProcessor.md +33 -0
- package/docs/functions/assignDirs.md +33 -0
- package/docs/functions/backendEventable.md +29 -0
- package/docs/functions/beforeShutdown.md +29 -0
- package/docs/functions/canonicalize.md +21 -0
- package/docs/functions/completeSentences.md +25 -0
- package/docs/functions/concatText.md +25 -0
- package/docs/functions/countLLMTokens.md +25 -0
- package/docs/functions/countRegexMatches.md +35 -0
- package/docs/functions/createAbilityInjector.md +119 -0
- package/docs/functions/createCallbacksTransformer.md +49 -0
- package/docs/functions/createEmptyReadableStream.md +21 -0
- package/docs/functions/createEndWithRepetitionDetector.md +31 -0
- package/docs/functions/createError.md +39 -0
- package/docs/functions/createEventStreamTransformer.md +33 -0
- package/docs/functions/createHfValueFunc.md +31 -0
- package/docs/functions/createLRUCache.md +25 -0
- package/docs/functions/createYamlObjectTag.md +25 -0
- package/docs/functions/dateToText.md +25 -0
- package/docs/functions/decodeCharset.md +25 -0
- package/docs/functions/detectCharset.md +25 -0
- package/docs/functions/encodeLLMTokens.md +25 -0
- package/docs/functions/ensureQuoted.md +25 -0
- package/docs/functions/eventable.md +82 -0
- package/docs/functions/expandConfig.md +25 -0
- package/docs/functions/expandEnv.md +40 -0
- package/docs/functions/expandObjEnv.md +58 -0
- package/docs/functions/expandPath.md +25 -0
- package/docs/functions/extNameLevel.md +43 -0
- package/docs/functions/fileIsExists.md +34 -0
- package/docs/functions/filenameReservedRegex.md +20 -0
- package/docs/functions/filterValidFnScope.md +21 -0
- package/docs/functions/findIndexNonEmptyFrom.md +25 -0
- package/docs/functions/findPort.md +25 -0
- package/docs/functions/formatISO.md +69 -0
- package/docs/functions/formatTextWithSpace.md +63 -0
- package/docs/functions/getAllEnumKeys.md +31 -0
- package/docs/functions/getConfigFileNames.md +25 -0
- package/docs/functions/getConfigs.md +25 -0
- package/docs/functions/getEnvVairables.md +21 -0
- package/docs/functions/getFileMetaInfo.md +21 -0
- package/docs/functions/getHashAlgoBySize.md +21 -0
- package/docs/functions/getKeysPath.md +38 -0
- package/docs/functions/getLLMTokenizer.md +21 -0
- package/docs/functions/getMultiLevelExtname.md +33 -0
- package/docs/functions/getPackageDir.md +39 -0
- package/docs/functions/getRealFilepath.md +34 -0
- package/docs/functions/getResponseErrorReadableStream.md +21 -0
- package/docs/functions/getXDGConfigs.md +37 -0
- package/docs/functions/hasDirectoryIn.md +40 -0
- package/docs/functions/hash.md +25 -0
- package/docs/functions/hashFile.md +25 -0
- package/docs/functions/hashStream.md +25 -0
- package/docs/functions/hfParse.md +24 -0
- package/docs/functions/hfTokenize.md +27 -0
- package/docs/functions/initShutdown.md +15 -0
- package/docs/functions/interpolateEnv.md +29 -0
- package/docs/functions/interpolateFString.md +29 -0
- package/docs/functions/interpolateGolangTemplate.md +35 -0
- package/docs/functions/isLangUsingSpaces.md +21 -0
- package/docs/functions/isListItemString.md +21 -0
- package/docs/functions/isModelNameMatched.md +47 -0
- package/docs/functions/isPunctuationChar.md +36 -0
- package/docs/functions/isQuoted.md +21 -0
- package/docs/functions/isRegExp.md +21 -0
- package/docs/functions/isSameString.md +36 -0
- package/docs/functions/isSectionString.md +25 -0
- package/docs/functions/isSentenceEnding.md +21 -0
- package/docs/functions/isSepLineString.md +21 -0
- package/docs/functions/isStrWrapped.md +25 -0
- package/docs/functions/isSubdirectory.md +41 -0
- package/docs/functions/isTitleString.md +25 -0
- package/docs/functions/isValidFilename.md +38 -0
- package/docs/functions/isValidFilepath.md +27 -0
- package/docs/functions/isWebStream.md +21 -0
- package/docs/functions/jsonFilterToWhere.md +47 -0
- package/docs/functions/jsonToMarkdownStr.md +39 -0
- package/docs/functions/loadAIConfig.md +21 -0
- package/docs/functions/loadConfig.md +25 -0
- package/docs/functions/loadConfigFile.md +25 -0
- package/docs/functions/loadFileFromPaths.md +64 -0
- package/docs/functions/loadTextFromPaths.md +37 -0
- package/docs/functions/lrucache.md +35 -0
- package/docs/functions/makeToolFuncCancelable.md +29 -0
- package/docs/functions/matchUrlProtocol.md +48 -0
- package/docs/functions/memoize.md +29 -0
- package/docs/functions/messagesToText.md +21 -0
- package/docs/functions/paramsSizeToScaleStr.md +34 -0
- package/docs/functions/parseCommand.md +29 -0
- package/docs/functions/parseDateFormat.md +362 -0
- package/docs/functions/parseFString.md +26 -0
- package/docs/functions/parseISO.md +70 -0
- package/docs/functions/parseJsJson.md +40 -0
- package/docs/functions/parseJsJsonSimpleSync.md +25 -0
- package/docs/functions/parseObjectArgInfo.md +33 -0
- package/docs/functions/parseObjectArgumentInfos.md +29 -0
- package/docs/functions/parseObjectArguments.md +72 -0
- package/docs/functions/parseObjectArgumentsAsArgInfos.md +46 -0
- package/docs/functions/parseYaml.md +25 -0
- package/docs/functions/quoteStr.md +21 -0
- package/docs/functions/reControlCharsRegex.md +19 -0
- package/docs/functions/readFilenamesRecursiveSync.md +53 -0
- package/docs/functions/readTextFileChunks.md +53 -0
- package/docs/functions/readTextFileChunksEx.md +25 -0
- package/docs/functions/readableFromAsyncIterable.md +28 -0
- package/docs/functions/registerCoreTools.md +15 -0
- package/docs/functions/registerYamlTag.md +21 -0
- package/docs/functions/removeMarkdownBold.md +25 -0
- package/docs/functions/removeMarkdownBoldAndItalic.md +25 -0
- package/docs/functions/removeMarkdownItalic.md +25 -0
- package/docs/functions/replaceWithPlaceholder.md +43 -0
- package/docs/functions/restoreFromPlacehoders.md +49 -0
- package/docs/functions/sanitizeFilename.md +39 -0
- package/docs/functions/sanitizeFilepath.md +33 -0
- package/docs/functions/saveConfigFile.md +29 -0
- package/docs/functions/scaleStrToParamsSize.md +27 -0
- package/docs/functions/shutdown.md +33 -0
- package/docs/functions/simplifyObjectArguments.md +21 -0
- package/docs/functions/sortedValues.md +25 -0
- package/docs/functions/splitChunks.md +25 -0
- package/docs/functions/splitParagraph.md +34 -0
- package/docs/functions/splitSentence.md +39 -0
- package/docs/functions/stringifyYaml.md +25 -0
- package/docs/functions/stripConsoleColor.md +21 -0
- package/docs/functions/textToDate.md +25 -0
- package/docs/functions/throwError.md +41 -0
- package/docs/functions/toDate.md +74 -0
- package/docs/functions/toDateTime.md +21 -0
- package/docs/functions/toRegExp.md +34 -0
- package/docs/functions/trimStartOfStreamHelper.md +41 -0
- package/docs/functions/truncTo.md +51 -0
- package/docs/functions/truncateByToken.md +25 -0
- package/docs/functions/truncateToTokenLimit.md +46 -0
- package/docs/functions/truncateToTokenLimitEx.md +25 -0
- package/docs/functions/uuid.md +25 -0
- package/docs/functions/uuidParse.md +21 -0
- package/docs/functions/uuidStringify.md +25 -0
- package/docs/functions/uuidValidate.md +21 -0
- package/docs/functions/uuidVersion.md +21 -0
- package/docs/functions/uuidv1.md +55 -0
- package/docs/functions/uuidv4.md +55 -0
- package/docs/functions/uuidv5.md +63 -0
- package/docs/functions/wait.md +21 -0
- package/docs/functions/wrapEventEmitter.md +27 -0
- package/docs/functions/xxhash.md +29 -0
- package/docs/functions/xxhash32.md +25 -0
- package/docs/functions/xxhash64.md +25 -0
- package/docs/functions/xxhashAsStr.md +29 -0
- package/docs/globals.md +329 -0
- package/docs/interfaces/AIChatAssistantMessageParam.md +129 -0
- package/docs/interfaces/AIChatContentPartImage.md +29 -0
- package/docs/interfaces/AIChatContentPartText.md +25 -0
- package/docs/interfaces/AIChatMessageParamBase.md +68 -0
- package/docs/interfaces/AIChatMessageToolCall.md +41 -0
- package/docs/interfaces/AIChatSystemMessageParam.md +105 -0
- package/docs/interfaces/AIChatToolChoiceFuncObject.md +37 -0
- package/docs/interfaces/AIChatToolChoiceObject.md +25 -0
- package/docs/interfaces/AIChatToolFunc.md +41 -0
- package/docs/interfaces/AIChatToolFuncParam.md +37 -0
- package/docs/interfaces/AIChatToolMessageParam.md +113 -0
- package/docs/interfaces/AIChatToolParam.md +25 -0
- package/docs/interfaces/AIChatToolTypeObject.md +17 -0
- package/docs/interfaces/AIChatUserMessageParam.md +137 -0
- package/docs/interfaces/AIChoiceConfig.md +65 -0
- package/docs/interfaces/AIResult.md +65 -0
- package/docs/interfaces/AIStreamParser.md +43 -0
- package/docs/interfaces/AIStreamParserOptions.md +21 -0
- package/docs/interfaces/BaseFunc.md +145 -0
- package/docs/interfaces/BaseFuncItem.md +93 -0
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
- package/docs/interfaces/BinarySemaphoreOptions.md +57 -0
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
- package/docs/interfaces/CancelableAbilityOptions.md +113 -0
- package/docs/interfaces/ClientFuncItem.md +163 -0
- package/docs/interfaces/DotenvExpandOptions.md +43 -0
- package/docs/interfaces/DotenvExpandOutput.md +25 -0
- package/docs/interfaces/DotenvParseInput.md +13 -0
- package/docs/interfaces/DotenvParseOutput.md +13 -0
- package/docs/interfaces/DotenvPopulateInput.md +13 -0
- package/docs/interfaces/EventClientFuncParams.md +51 -0
- package/docs/interfaces/EventServerFuncParams.md +67 -0
- package/docs/interfaces/FewShotPromptTemplateOptions.md +147 -0
- package/docs/interfaces/FuncItem.md +131 -0
- package/docs/interfaces/FuncParam.md +61 -0
- package/docs/interfaces/FuncParams.md +13 -0
- package/docs/interfaces/Funcs.md +13 -0
- package/docs/interfaces/HashAlgoParams.md +33 -0
- package/docs/interfaces/IFileMetaInfo.md +65 -0
- package/docs/interfaces/IReadTextFileChunksOptions.md +143 -0
- package/docs/interfaces/ITruncateToTokenLimitOptions.md +99 -0
- package/docs/interfaces/JsonFilter.md +13 -0
- package/docs/interfaces/ParseObjectArgumentOptions.md +89 -0
- package/docs/interfaces/PromptExampleSelectorOptions.md +34 -0
- package/docs/interfaces/PromptTemplateOptions.md +65 -0
- package/docs/interfaces/RemoteFuncItem.md +152 -0
- package/docs/interfaces/ReplacePlacehoderOptions.md +41 -0
- package/docs/interfaces/ResClientFuncParams.md +37 -0
- package/docs/interfaces/ResServerFuncParams.md +69 -0
- package/docs/interfaces/SanitizeFilenameOptions.md +25 -0
- package/docs/interfaces/SectionStringOptions.md +25 -0
- package/docs/interfaces/SemaphoreOptions.md +89 -0
- package/docs/interfaces/SemaphoreTaskItem.md +73 -0
- package/docs/interfaces/ServerFuncItem.md +171 -0
- package/docs/interfaces/ServerFuncParams.md +35 -0
- package/docs/interfaces/SplitSentenceOptions.md +41 -0
- package/docs/interfaces/StreamCallbacksAndOptions.md +99 -0
- package/docs/interfaces/TaskAbortControllers.md +13 -0
- package/docs/interfaces/TaskPromise.md +138 -0
- package/docs/interfaces/ToolFuncPackage.md +47 -0
- package/docs/namespaces/EventStates/README.md +14 -0
- package/docs/namespaces/EventStates/variables/ABORT.md +11 -0
- package/docs/namespaces/EventStates/variables/CONTINUE.md +11 -0
- package/docs/namespaces/EventStates/variables/DONE.md +11 -0
- package/docs/namespaces/EventStates/variables/STOPPED.md +11 -0
- package/docs/namespaces/uuidv5/README.md +12 -0
- package/docs/namespaces/uuidv5/variables/DNS.md +11 -0
- package/docs/namespaces/uuidv5/variables/URL.md +11 -0
- package/docs/type-aliases/AIChatContentPart.md +11 -0
- package/docs/type-aliases/AIChatMessageParam.md +11 -0
- package/docs/type-aliases/AIChatRole.md +11 -0
- package/docs/type-aliases/AIChatToolChoiceParam.md +11 -0
- package/docs/type-aliases/AIMessageType.md +11 -0
- package/docs/type-aliases/AIModelNameRule.md +11 -0
- package/docs/type-aliases/AIModelNameRuleFn.md +21 -0
- package/docs/type-aliases/AIModelNameRules.md +11 -0
- package/docs/type-aliases/AITextGenerationFinishReason.md +11 -0
- package/docs/type-aliases/ActionName.md +11 -0
- package/docs/type-aliases/AsyncTaskId.md +11 -0
- package/docs/type-aliases/BeforeShutdownListener.md +23 -0
- package/docs/type-aliases/EventErrorListenerFn.md +33 -0
- package/docs/type-aliases/EventListenerFn.md +29 -0
- package/docs/type-aliases/FStringPromptTemplateNode.md +14 -0
- package/docs/type-aliases/FuncParamType.md +11 -0
- package/docs/type-aliases/PromptExamples.md +15 -0
- package/docs/type-aliases/PromptTemplateType.md +11 -0
- package/docs/type-aliases/PromptType.md +11 -0
- package/docs/type-aliases/SemaphoreIsReadyFuncType.md +15 -0
- package/docs/type-aliases/TFunc.md +25 -0
- package/docs/variables/AIChatRoles.md +11 -0
- package/docs/variables/AIMessageTypes.md +11 -0
- package/docs/variables/AITextGenerationFinishReasons.md +11 -0
- package/docs/variables/AbortErrorCode.md +11 -0
- package/docs/variables/ActionNames.md +11 -0
- package/docs/variables/AlreadyExistsErrorCode.md +11 -0
- package/docs/variables/ClientToolFuncSchema.md +101 -0
- package/docs/variables/DEFAULT_CONFIG_NAME.md +11 -0
- package/docs/variables/DefaultAsyncSemaphoreCapacity.md +11 -0
- package/docs/variables/EventBusName.md +11 -0
- package/docs/variables/EventName.md +11 -0
- package/docs/variables/FilenameReservedRegex.md +14 -0
- package/docs/variables/HFBuiltins.md +122 -0
- package/docs/variables/InternalErrorCode.md +11 -0
- package/docs/variables/LLM_TOKENIZER_NAMES.md +81 -0
- package/docs/variables/LLM_TOKENIZER_NAMES_MAP.md +11 -0
- package/docs/variables/NotFoundErrorCode.md +11 -0
- package/docs/variables/NotImplementedErrorCode.md +11 -0
- package/docs/variables/PASSING_SCORE.md +11 -0
- package/docs/variables/PromptTemplateTypes.md +11 -0
- package/docs/variables/PromptTypes.md +14 -0
- package/docs/variables/RStreamErrCode.md +11 -0
- package/docs/variables/RemoteToolFuncSchema.md +101 -0
- package/docs/variables/ResponseRStreamErrCode.md +11 -0
- package/docs/variables/SHUTDOWN_SIGNALS.md +17 -0
- package/docs/variables/SSEChannelAlreadyClosedErrCode.md +11 -0
- package/docs/variables/SecondaryCache.md +11 -0
- package/docs/variables/ServerToolFuncSchema.md +101 -0
- package/docs/variables/ToolAsyncCancelableBit.md +11 -0
- package/docs/variables/ToolAsyncMultiTaskBit.md +11 -0
- package/docs/variables/ToolAsyncPriorityBit.md +11 -0
- package/docs/variables/ToolFuncSchema.md +133 -0
- package/docs/variables/WindowsReservedNameRegex.md +13 -0
- package/docs/variables/base32768.md +11 -0
- package/docs/variables/defaultTemplateFormat.md +11 -0
- package/docs/variables/event.md +11 -0
- package/docs/variables/eventClient.md +11 -0
- package/docs/variables/eventServer.md +11 -0
- package/docs/variables/lrucache.md +11 -0
- package/docs/variables/mimeType.md +11 -0
- package/docs/variables/uuidNIL.md +11 -0
- package/package.json +2 -2
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / FuncParam
|
|
6
|
+
|
|
7
|
+
# Interface: FuncParam
|
|
8
|
+
|
|
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
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### asyncFeatures?
|
|
14
|
+
|
|
15
|
+
> `optional` **asyncFeatures**: `number`
|
|
16
|
+
|
|
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
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### depends?
|
|
22
|
+
|
|
23
|
+
> `optional` **depends**: `object`
|
|
24
|
+
|
|
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
|
+
|
|
27
|
+
#### Index Signature
|
|
28
|
+
|
|
29
|
+
\[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### description?
|
|
34
|
+
|
|
35
|
+
> `optional` **description**: `string`
|
|
36
|
+
|
|
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
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### name?
|
|
42
|
+
|
|
43
|
+
> `optional` **name**: `string`
|
|
44
|
+
|
|
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
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### required?
|
|
50
|
+
|
|
51
|
+
> `optional` **required**: `boolean`
|
|
52
|
+
|
|
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
|
+
|
|
55
|
+
***
|
|
56
|
+
|
|
57
|
+
### type?
|
|
58
|
+
|
|
59
|
+
> `optional` **type**: `string`
|
|
60
|
+
|
|
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)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / FuncParams
|
|
6
|
+
|
|
7
|
+
# Interface: FuncParams
|
|
8
|
+
|
|
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
|
+
|
|
11
|
+
## Indexable
|
|
12
|
+
|
|
13
|
+
\[`name`: `string`\]: `string` \| [`FuncParam`](FuncParam.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / Funcs
|
|
6
|
+
|
|
7
|
+
# Interface: Funcs
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/tool-func.ts:41](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/tool-func.ts#L41)
|
|
10
|
+
|
|
11
|
+
## Indexable
|
|
12
|
+
|
|
13
|
+
\[`name`: `string`\]: [`ToolFunc`](../classes/ToolFunc.md)
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / HashAlgoParams
|
|
6
|
+
|
|
7
|
+
# Interface: HashAlgoParams
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/hash/hash.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/hash.ts#L10)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### hashAlgo?
|
|
14
|
+
|
|
15
|
+
> `optional` **hashAlgo**: [`HashAlgorithm`](../enumerations/HashAlgorithm.md)
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/hash/hash.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/hash.ts#L11)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### outputType?
|
|
22
|
+
|
|
23
|
+
> `optional` **outputType**: `"string"` \| `"hex"` \| `"binary"`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/hash/hash.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/hash.ts#L13)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### seed?
|
|
30
|
+
|
|
31
|
+
> `optional` **seed**: `number`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/hash/hash.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/hash/hash.ts#L12)
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / IFileMetaInfo
|
|
6
|
+
|
|
7
|
+
# Interface: IFileMetaInfo
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:210](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L210)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### ctime
|
|
14
|
+
|
|
15
|
+
> **ctime**: `Date`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:213](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L213)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### hash
|
|
22
|
+
|
|
23
|
+
> **hash**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:215](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L215)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### id
|
|
30
|
+
|
|
31
|
+
> **id**: `string`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:217](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L217)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### mimeType
|
|
38
|
+
|
|
39
|
+
> **mimeType**: `string`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:216](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L216)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### mtime
|
|
46
|
+
|
|
47
|
+
> **mtime**: `Date`
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:212](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L212)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### name
|
|
54
|
+
|
|
55
|
+
> **name**: `string`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:211](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L211)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### size
|
|
62
|
+
|
|
63
|
+
> **size**: `number`
|
|
64
|
+
|
|
65
|
+
Defined in: [packages/ai-tool/src/utils/load-file-from-paths.ts:214](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/load-file-from-paths.ts#L214)
|
|
@@ -0,0 +1,143 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / IReadTextFileChunksOptions
|
|
6
|
+
|
|
7
|
+
# Interface: IReadTextFileChunksOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/read-text-file-chunks.ts#L5)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md)
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### best?
|
|
18
|
+
|
|
19
|
+
> `optional` **best**: `boolean`
|
|
20
|
+
|
|
21
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L8)
|
|
22
|
+
|
|
23
|
+
#### Inherited from
|
|
24
|
+
|
|
25
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`best`](ITruncateToTokenLimitOptions.md#best)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### bySentence?
|
|
30
|
+
|
|
31
|
+
> `optional` **bySentence**: `boolean`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:4](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L4)
|
|
34
|
+
|
|
35
|
+
#### Inherited from
|
|
36
|
+
|
|
37
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`bySentence`](ITruncateToTokenLimitOptions.md#bysentence)
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### completeSentence?
|
|
42
|
+
|
|
43
|
+
> `optional` **completeSentence**: `boolean`
|
|
44
|
+
|
|
45
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L9)
|
|
46
|
+
|
|
47
|
+
#### Inherited from
|
|
48
|
+
|
|
49
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`completeSentence`](ITruncateToTokenLimitOptions.md#completesentence)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### corrected?
|
|
54
|
+
|
|
55
|
+
> `optional` **corrected**: `boolean`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L10)
|
|
58
|
+
|
|
59
|
+
#### Inherited from
|
|
60
|
+
|
|
61
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`corrected`](ITruncateToTokenLimitOptions.md#corrected)
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
65
|
+
### countLLMTokens()?
|
|
66
|
+
|
|
67
|
+
> `optional` **countLLMTokens**: (`text`, `modelId`?) => `Promise`\<`number`\>
|
|
68
|
+
|
|
69
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L12)
|
|
70
|
+
|
|
71
|
+
#### Parameters
|
|
72
|
+
|
|
73
|
+
##### text
|
|
74
|
+
|
|
75
|
+
`string`
|
|
76
|
+
|
|
77
|
+
##### modelId?
|
|
78
|
+
|
|
79
|
+
`string`
|
|
80
|
+
|
|
81
|
+
#### Returns
|
|
82
|
+
|
|
83
|
+
`Promise`\<`number`\>
|
|
84
|
+
|
|
85
|
+
#### Inherited from
|
|
86
|
+
|
|
87
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`countLLMTokens`](ITruncateToTokenLimitOptions.md#countllmtokens)
|
|
88
|
+
|
|
89
|
+
***
|
|
90
|
+
|
|
91
|
+
### metaInfo?
|
|
92
|
+
|
|
93
|
+
> `optional` **metaInfo**: `RequireAtLeastOne`\<`Partial`\<[`IFileMetaInfo`](IFileMetaInfo.md)\>, `"size"`\>
|
|
94
|
+
|
|
95
|
+
Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/read-text-file-chunks.ts#L8)
|
|
96
|
+
|
|
97
|
+
***
|
|
98
|
+
|
|
99
|
+
### modelId?
|
|
100
|
+
|
|
101
|
+
> `optional` **modelId**: `string`
|
|
102
|
+
|
|
103
|
+
Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/read-text-file-chunks.ts#L7)
|
|
104
|
+
|
|
105
|
+
#### Overrides
|
|
106
|
+
|
|
107
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`modelId`](ITruncateToTokenLimitOptions.md#modelid-2)
|
|
108
|
+
|
|
109
|
+
***
|
|
110
|
+
|
|
111
|
+
### sentences?
|
|
112
|
+
|
|
113
|
+
> `optional` **sentences**: `string`[]
|
|
114
|
+
|
|
115
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L7)
|
|
116
|
+
|
|
117
|
+
#### Inherited from
|
|
118
|
+
|
|
119
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`sentences`](ITruncateToTokenLimitOptions.md#sentences)
|
|
120
|
+
|
|
121
|
+
***
|
|
122
|
+
|
|
123
|
+
### size?
|
|
124
|
+
|
|
125
|
+
> `optional` **size**: `number`
|
|
126
|
+
|
|
127
|
+
Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/read-text-file-chunks.ts#L6)
|
|
128
|
+
|
|
129
|
+
#### Overrides
|
|
130
|
+
|
|
131
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`size`](ITruncateToTokenLimitOptions.md#size)
|
|
132
|
+
|
|
133
|
+
***
|
|
134
|
+
|
|
135
|
+
### truncLastSection?
|
|
136
|
+
|
|
137
|
+
> `optional` **truncLastSection**: `boolean`
|
|
138
|
+
|
|
139
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L11)
|
|
140
|
+
|
|
141
|
+
#### Inherited from
|
|
142
|
+
|
|
143
|
+
[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`truncLastSection`](ITruncateToTokenLimitOptions.md#trunclastsection)
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / ITruncateToTokenLimitOptions
|
|
6
|
+
|
|
7
|
+
# Interface: ITruncateToTokenLimitOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:3](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L3)
|
|
10
|
+
|
|
11
|
+
## Extended by
|
|
12
|
+
|
|
13
|
+
- [`IReadTextFileChunksOptions`](IReadTextFileChunksOptions.md)
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### best?
|
|
18
|
+
|
|
19
|
+
> `optional` **best**: `boolean`
|
|
20
|
+
|
|
21
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:8](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L8)
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### bySentence?
|
|
26
|
+
|
|
27
|
+
> `optional` **bySentence**: `boolean`
|
|
28
|
+
|
|
29
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:4](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L4)
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### completeSentence?
|
|
34
|
+
|
|
35
|
+
> `optional` **completeSentence**: `boolean`
|
|
36
|
+
|
|
37
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L9)
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### corrected?
|
|
42
|
+
|
|
43
|
+
> `optional` **corrected**: `boolean`
|
|
44
|
+
|
|
45
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L10)
|
|
46
|
+
|
|
47
|
+
***
|
|
48
|
+
|
|
49
|
+
### countLLMTokens()?
|
|
50
|
+
|
|
51
|
+
> `optional` **countLLMTokens**: (`text`, `modelId`?) => `Promise`\<`number`\>
|
|
52
|
+
|
|
53
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L12)
|
|
54
|
+
|
|
55
|
+
#### Parameters
|
|
56
|
+
|
|
57
|
+
##### text
|
|
58
|
+
|
|
59
|
+
`string`
|
|
60
|
+
|
|
61
|
+
##### modelId?
|
|
62
|
+
|
|
63
|
+
`string`
|
|
64
|
+
|
|
65
|
+
#### Returns
|
|
66
|
+
|
|
67
|
+
`Promise`\<`number`\>
|
|
68
|
+
|
|
69
|
+
***
|
|
70
|
+
|
|
71
|
+
### modelId?
|
|
72
|
+
|
|
73
|
+
> `optional` **modelId**: `string`
|
|
74
|
+
|
|
75
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:6](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L6)
|
|
76
|
+
|
|
77
|
+
***
|
|
78
|
+
|
|
79
|
+
### sentences?
|
|
80
|
+
|
|
81
|
+
> `optional` **sentences**: `string`[]
|
|
82
|
+
|
|
83
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:7](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L7)
|
|
84
|
+
|
|
85
|
+
***
|
|
86
|
+
|
|
87
|
+
### size?
|
|
88
|
+
|
|
89
|
+
> `optional` **size**: `number`
|
|
90
|
+
|
|
91
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L5)
|
|
92
|
+
|
|
93
|
+
***
|
|
94
|
+
|
|
95
|
+
### truncLastSection?
|
|
96
|
+
|
|
97
|
+
> `optional` **truncLastSection**: `boolean`
|
|
98
|
+
|
|
99
|
+
Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L11)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / JsonFilter
|
|
6
|
+
|
|
7
|
+
# Interface: JsonFilter
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/json-filter.ts:1](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/json-filter.ts#L1)
|
|
10
|
+
|
|
11
|
+
## Indexable
|
|
12
|
+
|
|
13
|
+
\[`key`: `string`\]: `any`
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / ParseObjectArgumentOptions
|
|
6
|
+
|
|
7
|
+
# Interface: ParseObjectArgumentOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:19](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L19)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### argProcessor?
|
|
14
|
+
|
|
15
|
+
> `optional` **argProcessor**: `ArgProcessor`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:22](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L22)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### assigner?
|
|
22
|
+
|
|
23
|
+
> `optional` **assigner**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:21](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L21)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### delimiter?
|
|
30
|
+
|
|
31
|
+
> `optional` **delimiter**: `string`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:20](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L20)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### ignoreIndexNamed?
|
|
38
|
+
|
|
39
|
+
> `optional` **ignoreIndexNamed**: `boolean`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L26)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### preserveUnresolvedName?
|
|
46
|
+
|
|
47
|
+
> `optional` **preserveUnresolvedName**: `boolean`
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:27](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L27)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### raiseError?
|
|
54
|
+
|
|
55
|
+
> `optional` **raiseError**: `boolean`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:29](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L29)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### returnArrayOnly?
|
|
62
|
+
|
|
63
|
+
> `optional` **returnArrayOnly**: `boolean`
|
|
64
|
+
|
|
65
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:23](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L23)
|
|
66
|
+
|
|
67
|
+
***
|
|
68
|
+
|
|
69
|
+
### skipExpression?
|
|
70
|
+
|
|
71
|
+
> `optional` **skipExpression**: `boolean`
|
|
72
|
+
|
|
73
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:28](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L28)
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### templateData?
|
|
78
|
+
|
|
79
|
+
> `optional` **templateData**: `Record`\<`string`, `any`\>
|
|
80
|
+
|
|
81
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L25)
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### templateFormat?
|
|
86
|
+
|
|
87
|
+
> `optional` **templateFormat**: `string`
|
|
88
|
+
|
|
89
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:24](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L24)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / PromptExampleSelectorOptions
|
|
6
|
+
|
|
7
|
+
# Interface: PromptExampleSelectorOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:5](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L5)
|
|
10
|
+
|
|
11
|
+
## Indexable
|
|
12
|
+
|
|
13
|
+
\[`name`: `string`\]: `any`
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### maxLength?
|
|
18
|
+
|
|
19
|
+
> `optional` **maxLength**: `number`
|
|
20
|
+
|
|
21
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L9)
|
|
22
|
+
|
|
23
|
+
The maximum count of the selected examples, or `undefined` if no limit.
|
|
24
|
+
|
|
25
|
+
***
|
|
26
|
+
|
|
27
|
+
### threshold?
|
|
28
|
+
|
|
29
|
+
> `optional` **threshold**: `number` \| `boolean`
|
|
30
|
+
|
|
31
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-example-selector.ts#L14)
|
|
32
|
+
|
|
33
|
+
The threshold probability (0-1) at which a sample is selected.
|
|
34
|
+
If `true`, defaults to 0.5; if `false`, disable it.
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / PromptTemplateOptions
|
|
6
|
+
|
|
7
|
+
# Interface: PromptTemplateOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/prompt-template.ts#L10)
|
|
10
|
+
|
|
11
|
+
## Extended by
|
|
12
|
+
|
|
13
|
+
- [`FewShotPromptTemplateOptions`](FewShotPromptTemplateOptions.md)
|
|
14
|
+
|
|
15
|
+
## Indexable
|
|
16
|
+
|
|
17
|
+
\[`name`: `string`\]: `any`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### compiledTemplate?
|
|
22
|
+
|
|
23
|
+
> `optional` **compiledTemplate**: `any`
|
|
24
|
+
|
|
25
|
+
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)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### data?
|
|
30
|
+
|
|
31
|
+
> `optional` **data**: `Record`\<`string`, `any`\>
|
|
32
|
+
|
|
33
|
+
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)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### ignoreInitialize?
|
|
38
|
+
|
|
39
|
+
> `optional` **ignoreInitialize**: `boolean`
|
|
40
|
+
|
|
41
|
+
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)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### inputVariables?
|
|
46
|
+
|
|
47
|
+
> `optional` **inputVariables**: `string`[]
|
|
48
|
+
|
|
49
|
+
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)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### template?
|
|
54
|
+
|
|
55
|
+
> `optional` **template**: `string`
|
|
56
|
+
|
|
57
|
+
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)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### templateFormat?
|
|
62
|
+
|
|
63
|
+
> `optional` **templateFormat**: `string`
|
|
64
|
+
|
|
65
|
+
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)
|