@isdk/ai-tool 0.5.8 → 0.7.0
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/README.cn.md +103 -237
- package/README.md +101 -186
- package/dist/chunk-LNTIQQNN.mjs +1 -0
- package/dist/chunk-VIG2GB47.mjs +1 -1
- package/dist/funcs.d.mts +1 -1
- package/dist/funcs.d.ts +1 -1
- package/dist/funcs.js +1 -1
- package/dist/funcs.mjs +1 -1
- package/dist/index-BCco-g_I.d.mts +1781 -0
- package/dist/index-BCco-g_I.d.ts +1781 -0
- package/dist/index.d.mts +1083 -650
- package/dist/index.d.ts +1083 -650
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/test/util.js +1 -1
- package/docs/api/README.md +165 -0
- package/docs/{_media → api/_media}/CONTRIBUTING.md +3 -3
- package/docs/api/_media/pubsub.md +326 -0
- package/docs/api/_media/server_client_tools.md +88 -0
- package/docs/api/_media/toolFunc.md +183 -0
- package/docs/api/_media/transport.md +137 -0
- package/docs/{classes → api/classes}/AbortError.md +139 -54
- package/docs/api/classes/AlreadyExistsError.md +431 -0
- package/docs/api/classes/BaseError.md +440 -0
- package/docs/{classes → api/classes}/BinarySemaphore.md +25 -25
- package/docs/{classes → api/classes}/CancelableAbility.md +25 -25
- package/docs/api/classes/ClientToolTransport.md +310 -0
- package/docs/{classes → api/classes}/ClientTools.md +642 -180
- package/docs/{classes → api/classes}/CommonError.md +139 -54
- package/docs/api/classes/ConfigFile.md +218 -0
- package/docs/{classes → api/classes}/EnvPromptTemplate.md +308 -65
- package/docs/{classes → api/classes}/EventClient.md +725 -232
- package/docs/{classes → api/classes}/EventEmitter.md +12 -12
- package/docs/{classes → api/classes}/EventServer.md +658 -205
- package/docs/{classes → api/classes}/EventToolFunc.md +561 -109
- package/docs/{classes → api/classes}/FStringPromptTemplate.md +309 -66
- package/docs/{classes → api/classes}/FewShotPromptTemplate.md +290 -63
- package/docs/{classes → api/classes}/GolangPromptTemplate.md +308 -65
- package/docs/api/classes/HttpClientToolTransport.md +324 -0
- package/docs/api/classes/HttpServerToolTransport.md +324 -0
- package/docs/{classes → api/classes}/IntSet.md +12 -12
- package/docs/{classes → api/classes}/LRUCache.md +26 -26
- package/docs/api/classes/NotFoundError.md +431 -0
- package/docs/api/classes/NotImplementationError.md +431 -0
- package/docs/{classes → api/classes}/PromptExampleSelector.md +9 -9
- package/docs/{classes → api/classes}/PromptTemplate.md +303 -63
- package/docs/api/classes/ReadableStreamError.md +451 -0
- package/docs/api/classes/ResClientTools.md +2878 -0
- package/docs/api/classes/ResServerTools.md +2856 -0
- package/docs/api/classes/SSEChannel.md +272 -0
- package/docs/{classes → api/classes}/Semaphore.md +26 -26
- package/docs/api/classes/ServerToolTransport.md +323 -0
- package/docs/{classes → api/classes}/ServerTools.md +579 -120
- package/docs/{classes → api/classes}/SignalGate.md +9 -9
- package/docs/api/classes/SseClientPubSubTransport.md +92 -0
- package/docs/api/classes/SseServerPubSubTransport.md +234 -0
- package/docs/{classes → api/classes}/TaskAbortController.md +9 -9
- package/docs/api/classes/ToolFunc.md +2665 -0
- package/docs/api/classes/ToolTransport.md +143 -0
- package/docs/api/classes/YamlTypeBaseObject.md +31 -0
- package/docs/api/enumerations/AsyncFeatureBits.md +33 -0
- package/docs/api/enumerations/AsyncFeatures.md +33 -0
- package/docs/api/enumerations/ErrorCode.md +177 -0
- package/docs/api/enumerations/HashAlgorithm.md +97 -0
- package/docs/{functions → api/functions}/AIArgProcessor.md +1 -1
- package/docs/{functions → api/functions}/AIStream.md +1 -1
- package/docs/{functions → api/functions}/ChoiceArgProcessor.md +1 -1
- package/docs/api/functions/DefaultDateFormat.md +21 -0
- package/docs/{functions → api/functions}/ObjectArgsToArgsInfo.md +1 -1
- package/docs/{functions → api/functions}/RateLimit.md +1 -1
- package/docs/{functions → api/functions}/TemplateArgProcessor.md +1 -1
- package/docs/api/functions/addDate.md +71 -0
- package/docs/{functions → api/functions}/assignDirs.md +1 -1
- package/docs/{functions → api/functions}/backendEventable.md +1 -1
- package/docs/{functions → api/functions}/beforeShutdown.md +1 -1
- package/docs/api/functions/calcPerplexity.md +60 -0
- package/docs/api/functions/calcPerplexitySimple.md +42 -0
- package/docs/api/functions/canonicalize.md +33 -0
- package/docs/{functions → api/functions}/completeSentences.md +1 -1
- package/docs/{functions → api/functions}/concatText.md +1 -1
- package/docs/{functions → api/functions}/countLLMTokens.md +1 -1
- package/docs/{functions → api/functions}/countRegexMatches.md +1 -1
- package/docs/{functions → api/functions}/createAbilityInjector.md +4 -4
- package/docs/{functions → api/functions}/createCallbacksTransformer.md +1 -1
- package/docs/{functions → api/functions}/createEmptyReadableStream.md +1 -1
- package/docs/{functions → api/functions}/createEndWithRepetitionDetector.md +1 -1
- package/docs/{functions → api/functions}/createError.md +1 -1
- package/docs/{functions → api/functions}/createEventStreamTransformer.md +1 -1
- package/docs/{functions → api/functions}/createHfValueFunc.md +1 -1
- package/docs/{functions → api/functions}/createLRUCache.md +1 -1
- package/docs/{functions → api/functions}/createYamlObjectTag.md +1 -1
- package/docs/{functions → api/functions}/dateToText.md +1 -1
- package/docs/{functions → api/functions}/decodeCharset.md +1 -1
- package/docs/api/functions/defaultsWithConcat.md +74 -0
- package/docs/{functions → api/functions}/detectCharset.md +1 -1
- package/docs/{functions → api/functions}/encodeLLMTokens.md +1 -1
- package/docs/{functions → api/functions}/ensureQuoted.md +1 -1
- package/docs/{functions → api/functions}/eventable.md +1 -1
- package/docs/api/functions/expandConfig.md +25 -0
- package/docs/{functions → api/functions}/expandEnv.md +4 -4
- package/docs/{functions → api/functions}/expandObjEnv.md +4 -4
- package/docs/{functions → api/functions}/expandPath.md +1 -1
- package/docs/api/functions/expandPathInObject.md +29 -0
- package/docs/api/functions/expandPaths.md +25 -0
- package/docs/{functions → api/functions}/extNameLevel.md +1 -1
- package/docs/{functions → api/functions}/fileIsExists.md +1 -1
- package/docs/{functions → api/functions}/filterValidFnScope.md +1 -1
- package/docs/{functions → api/functions}/findIndexNonEmptyFrom.md +1 -1
- package/docs/{functions → api/functions}/findPort.md +1 -1
- package/docs/{functions → api/functions}/formatISO.md +1 -1
- package/docs/{functions → api/functions}/formatTextWithSpace.md +1 -1
- package/docs/api/functions/funcGetMeta.md +27 -0
- package/docs/api/functions/funcWithMeta.md +41 -0
- package/docs/api/functions/genUrlParamsStr.md +27 -0
- package/docs/{functions → api/functions}/getAllEnumKeys.md +1 -1
- package/docs/{functions → api/functions}/getConfigFileNames.md +1 -1
- package/docs/{functions → api/functions}/getConfigs.md +1 -1
- package/docs/{functions → api/functions}/getEnvVairables.md +1 -1
- package/docs/{functions → api/functions}/getFileMetaInfo.md +1 -1
- package/docs/{functions → api/functions}/getHashAlgoBySize.md +1 -1
- package/docs/{functions → api/functions}/getKeysPath.md +1 -1
- package/docs/{functions → api/functions}/getLLMTokenizer.md +1 -1
- package/docs/{functions → api/functions}/getMultiLevelExtname.md +4 -4
- package/docs/{functions → api/functions}/getPackageDir.md +1 -1
- package/docs/{functions → api/functions}/getRealFilepath.md +1 -1
- package/docs/{functions → api/functions}/getResponseErrorReadableStream.md +1 -1
- package/docs/{functions → api/functions}/getXDGConfigs.md +1 -1
- package/docs/{functions → api/functions}/hasDirectoryIn.md +1 -1
- package/docs/{functions → api/functions}/hash.md +1 -1
- package/docs/{functions → api/functions}/hashFile.md +1 -1
- package/docs/api/functions/hashObject.md +25 -0
- package/docs/{functions → api/functions}/hashStream.md +1 -1
- package/docs/api/functions/initShutdown.md +15 -0
- package/docs/{functions → api/functions}/isLangUsingSpaces.md +1 -1
- package/docs/{functions → api/functions}/isListItemString.md +1 -1
- package/docs/{functions → api/functions}/isModelNameMatched.md +1 -1
- package/docs/{functions → api/functions}/isPunctuationChar.md +1 -1
- package/docs/{functions → api/functions}/isQuoted.md +1 -1
- package/docs/{functions → api/functions}/isRegExp.md +1 -1
- package/docs/{functions → api/functions}/isSameString.md +1 -1
- package/docs/{functions → api/functions}/isSectionString.md +1 -1
- package/docs/{functions → api/functions}/isSentenceEnding.md +1 -1
- package/docs/{functions → api/functions}/isSepLineString.md +1 -1
- package/docs/{functions → api/functions}/isStrWrapped.md +1 -1
- package/docs/{functions → api/functions}/isSubdirectory.md +2 -2
- package/docs/{functions → api/functions}/isTitleString.md +1 -1
- package/docs/{functions → api/functions}/isValidFilename.md +1 -1
- package/docs/{functions → api/functions}/isValidFilepath.md +1 -1
- package/docs/{functions → api/functions}/isWebStream.md +1 -1
- package/docs/api/functions/joinSplitWords.md +46 -0
- package/docs/{functions → api/functions}/jsonFilterToWhere.md +1 -1
- package/docs/{functions → api/functions}/jsonToMarkdownStr.md +9 -1
- package/docs/{functions → api/functions}/loadAIConfig.md +1 -1
- package/docs/{functions → api/functions}/loadConfig.md +1 -1
- package/docs/{functions → api/functions}/loadConfigFile.md +1 -1
- package/docs/{functions → api/functions}/loadFileFromPaths.md +1 -1
- package/docs/{functions → api/functions}/loadTextFromPaths.md +1 -1
- package/docs/{functions → api/functions}/lrucache.md +1 -1
- package/docs/{functions → api/functions}/makeToolFuncCancelable.md +1 -1
- package/docs/{functions → api/functions}/matchUrlProtocol.md +1 -1
- package/docs/{functions → api/functions}/memoize.md +1 -1
- package/docs/api/functions/mergeArray.md +57 -0
- package/docs/{functions → api/functions}/messagesToText.md +1 -1
- package/docs/api/functions/normalizePath.md +21 -0
- package/docs/{functions → api/functions}/paramsSizeToScaleStr.md +1 -1
- package/docs/{functions → api/functions}/parseCommand.md +1 -1
- package/docs/{functions → api/functions}/parseDateFormat.md +1 -1
- package/docs/{functions → api/functions}/parseISO.md +1 -1
- package/docs/{functions → api/functions}/parseJsJson.md +1 -1
- package/docs/{functions → api/functions}/parseJsJsonSimpleSync.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgInfo.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgumentInfos.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArguments.md +1 -1
- package/docs/{functions → api/functions}/parseObjectArgumentsAsArgInfos.md +1 -1
- package/docs/api/functions/parseYaml.md +45 -0
- package/docs/api/functions/pruneSubdirectories.md +35 -0
- package/docs/api/functions/pruneSubdirectoriesInPlace.md +38 -0
- package/docs/{functions → api/functions}/quoteStr.md +1 -1
- package/docs/{functions → api/functions}/readFilenamesRecursiveSync.md +7 -1
- package/docs/{functions → api/functions}/readTextFileChunks.md +1 -1
- package/docs/{functions → api/functions}/readTextFileChunksEx.md +1 -1
- package/docs/{functions → api/functions}/readableFromAsyncIterable.md +1 -1
- package/docs/{functions → api/functions}/registerCoreTools.md +1 -1
- package/docs/api/functions/registerYamlTag.md +37 -0
- package/docs/{functions → api/functions}/removeMarkdownBold.md +1 -1
- package/docs/{functions → api/functions}/removeMarkdownBoldAndItalic.md +1 -1
- package/docs/{functions → api/functions}/removeMarkdownItalic.md +1 -1
- package/docs/{functions → api/functions}/replaceWithPlaceholder.md +1 -1
- package/docs/{functions → api/functions}/restoreFromPlacehoders.md +1 -1
- package/docs/{functions → api/functions}/sanitizeFilename.md +4 -4
- package/docs/{functions → api/functions}/sanitizeFilepath.md +4 -4
- package/docs/{functions → api/functions}/saveConfigFile.md +1 -1
- package/docs/{functions → api/functions}/scaleStrToParamsSize.md +1 -1
- package/docs/{functions → api/functions}/shutdown.md +1 -1
- package/docs/{functions → api/functions}/simplifyObjectArguments.md +1 -1
- package/docs/api/functions/sleep.md +36 -0
- package/docs/{functions → api/functions}/sortedValues.md +1 -1
- package/docs/{functions → api/functions}/splitChunks.md +1 -1
- package/docs/{functions → api/functions}/splitParagraph.md +1 -1
- package/docs/{functions → api/functions}/splitSentence.md +1 -1
- package/docs/api/functions/splitWords.md +42 -0
- package/docs/api/functions/stringifyYaml.md +45 -0
- package/docs/{functions → api/functions}/stripConsoleColor.md +1 -1
- package/docs/{functions → api/functions}/textToDate.md +1 -1
- package/docs/{functions → api/functions}/throwError.md +3 -3
- package/docs/{functions → api/functions}/toDate.md +1 -1
- package/docs/{functions → api/functions}/toDateTime.md +1 -1
- package/docs/{functions → api/functions}/toRegExp.md +1 -1
- package/docs/{functions → api/functions}/trimStartOfStreamHelper.md +1 -1
- package/docs/{functions → api/functions}/truncTo.md +1 -1
- package/docs/{functions → api/functions}/truncateByToken.md +1 -1
- package/docs/{functions → api/functions}/truncateToTokenLimit.md +1 -1
- package/docs/{functions → api/functions}/truncateToTokenLimitEx.md +1 -1
- package/docs/{functions → api/functions}/uuid.md +1 -1
- package/docs/{functions → api/functions}/uuidParse.md +1 -1
- package/docs/{functions → api/functions}/uuidStringify.md +1 -1
- package/docs/{functions → api/functions}/uuidValidate.md +1 -1
- package/docs/{functions → api/functions}/uuidVersion.md +1 -1
- package/docs/{functions → api/functions}/uuidv1.md +9 -5
- package/docs/{functions → api/functions}/uuidv4.md +9 -5
- package/docs/{functions → api/functions}/uuidv5.md +9 -5
- package/docs/api/functions/wait.md +45 -0
- package/docs/{functions → api/functions}/wrapEventEmitter.md +1 -1
- package/docs/{functions → api/functions}/xxhash.md +1 -1
- package/docs/{functions → api/functions}/xxhash32.md +1 -1
- package/docs/{functions → api/functions}/xxhash64.md +1 -1
- package/docs/{functions → api/functions}/xxhashAsStr.md +1 -1
- package/docs/api/functions/yieldExec.md +27 -0
- package/docs/{globals.md → api/globals.md} +44 -24
- package/docs/api/interfaces/AIChatAssistantMessageParam.md +129 -0
- package/docs/api/interfaces/AIChatContentPartImage.md +29 -0
- package/docs/api/interfaces/AIChatContentPartText.md +25 -0
- package/docs/api/interfaces/AIChatMessageParamBase.md +68 -0
- package/docs/api/interfaces/AIChatMessageToolCall.md +41 -0
- package/docs/{interfaces → api/interfaces}/AIChatSystemMessageParam.md +9 -9
- package/docs/api/interfaces/AIChatToolChoiceFuncObject.md +37 -0
- package/docs/api/interfaces/AIChatToolChoiceObject.md +25 -0
- package/docs/api/interfaces/AIChatToolFunc.md +41 -0
- package/docs/api/interfaces/AIChatToolFuncParam.md +37 -0
- package/docs/api/interfaces/AIChatToolMessageParam.md +113 -0
- package/docs/api/interfaces/AIChatToolParam.md +25 -0
- package/docs/api/interfaces/AIChatToolTypeObject.md +17 -0
- package/docs/api/interfaces/AIChatUserMessageParam.md +137 -0
- package/docs/api/interfaces/AIChoiceConfig.md +65 -0
- package/docs/api/interfaces/AIResult.md +65 -0
- package/docs/{interfaces → api/interfaces}/AIStreamParser.md +2 -2
- package/docs/api/interfaces/AIStreamParserOptions.md +21 -0
- package/docs/api/interfaces/BaseFunc.md +299 -0
- package/docs/api/interfaces/BaseFuncItem.md +221 -0
- package/docs/api/interfaces/BinarySemaphoreAcquireOptions.md +25 -0
- package/docs/api/interfaces/BinarySemaphoreOptions.md +57 -0
- package/docs/api/interfaces/BinarySemaphoreReleaseOptions.md +25 -0
- package/docs/api/interfaces/BinarySemaphoreReleaserFunc.md +37 -0
- package/docs/api/interfaces/CancelableAbilityOptions.md +113 -0
- package/docs/api/interfaces/ClientFuncItem.md +326 -0
- package/docs/api/interfaces/EventClientFuncParams.md +51 -0
- package/docs/api/interfaces/EventServerFuncParams.md +73 -0
- package/docs/api/interfaces/FewShotPromptTemplateOptions.md +159 -0
- package/docs/api/interfaces/FuncItem.md +281 -0
- package/docs/api/interfaces/FuncParam.md +51 -0
- package/docs/api/interfaces/FuncParams.md +28 -0
- package/docs/api/interfaces/Funcs.md +15 -0
- package/docs/api/interfaces/HashAlgoParams.md +33 -0
- package/docs/api/interfaces/IClientToolTransport.md +155 -0
- package/docs/api/interfaces/IFileMetaInfo.md +65 -0
- package/docs/api/interfaces/IPubSubClientTransport.md +70 -0
- package/docs/api/interfaces/IPubSubServerTransport.md +241 -0
- package/docs/{interfaces → api/interfaces}/IReadTextFileChunksOptions.md +12 -12
- package/docs/api/interfaces/IServerToolTransport.md +159 -0
- package/docs/api/interfaces/IToolTransport.md +73 -0
- package/docs/api/interfaces/ITruncateToTokenLimitOptions.md +99 -0
- package/docs/api/interfaces/JsonFilter.md +13 -0
- package/docs/api/interfaces/ParseObjectArgumentOptions.md +89 -0
- package/docs/api/interfaces/ProbabilityItem.md +41 -0
- package/docs/api/interfaces/PromptExampleSelectorOptions.md +34 -0
- package/docs/api/interfaces/PromptTemplateOptions.md +73 -0
- package/docs/api/interfaces/PubSubClient.md +27 -0
- package/docs/api/interfaces/PubSubClientStream.md +196 -0
- package/docs/api/interfaces/PubSubServerSession.md +103 -0
- package/docs/api/interfaces/RemoteFuncItem.md +316 -0
- package/docs/api/interfaces/ReplacePlacehoderOptions.md +41 -0
- package/docs/api/interfaces/ResClientFuncParams.md +37 -0
- package/docs/api/interfaces/ResServerFuncParams.md +73 -0
- package/docs/api/interfaces/SanitizeFilenameOptions.md +25 -0
- package/docs/api/interfaces/SectionStringOptions.md +25 -0
- package/docs/api/interfaces/SemaphoreOptions.md +89 -0
- package/docs/api/interfaces/SemaphoreTaskItem.md +73 -0
- package/docs/api/interfaces/ServerFuncItem.md +339 -0
- package/docs/api/interfaces/ServerFuncParams.md +41 -0
- package/docs/api/interfaces/SplitSentenceOptions.md +41 -0
- package/docs/{interfaces → api/interfaces}/StreamCallbacksAndOptions.md +5 -5
- package/docs/{interfaces → api/interfaces}/TaskAbortControllers.md +1 -1
- package/docs/{interfaces → api/interfaces}/TaskPromise.md +6 -6
- package/docs/api/interfaces/ToolFuncPackage.md +57 -0
- package/docs/{namespaces → api/namespaces}/EventStates/variables/ABORT.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/CONTINUE.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/DONE.md +1 -1
- package/docs/{namespaces → api/namespaces}/EventStates/variables/STOPPED.md +1 -1
- package/docs/{namespaces → api/namespaces}/uuidv5/variables/DNS.md +1 -1
- package/docs/{namespaces → api/namespaces}/uuidv5/variables/URL.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatContentPart.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatMessageParam.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatRole.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIChatToolChoiceParam.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/AIMessageType.md +1 -1
- package/docs/api/type-aliases/AIModelNameRule.md +14 -0
- package/docs/api/type-aliases/AIModelNameRuleFn.md +28 -0
- package/docs/api/type-aliases/AIModelNameRules.md +13 -0
- package/docs/{type-aliases → api/type-aliases}/AITextGenerationFinishReason.md +1 -1
- package/docs/api/type-aliases/ActionName.md +13 -0
- package/docs/api/type-aliases/ArrayMergeWay.md +11 -0
- package/docs/api/type-aliases/AsyncTaskId.md +11 -0
- package/docs/{type-aliases → api/type-aliases}/BeforeShutdownListener.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/EventErrorListenerFn.md +1 -1
- package/docs/{type-aliases → api/type-aliases}/EventListenerFn.md +1 -1
- package/docs/api/type-aliases/FuncParamType.md +13 -0
- package/docs/{type-aliases → api/type-aliases}/PromptExamples.md +1 -1
- package/docs/api/type-aliases/PubSubClientId.md +14 -0
- package/docs/api/type-aliases/PubSubCtx.md +37 -0
- package/docs/api/type-aliases/RpcMethodHandler.md +34 -0
- package/docs/{type-aliases → api/type-aliases}/SemaphoreIsReadyFuncType.md +1 -1
- package/docs/api/type-aliases/TFunc.md +33 -0
- package/docs/{variables → api/variables}/AIChatRoles.md +1 -1
- package/docs/{variables → api/variables}/AIMessageTypes.md +1 -1
- package/docs/{variables → api/variables}/AITextGenerationFinishReasons.md +1 -1
- package/docs/{variables → api/variables}/AbortErrorCode.md +1 -1
- package/docs/api/variables/ActionNames.md +13 -0
- package/docs/{variables → api/variables}/AlreadyExistsErrorCode.md +1 -1
- package/docs/api/variables/ArrayMergeWay.md +25 -0
- package/docs/api/variables/ArrayMergeWaySymbol.md +11 -0
- package/docs/api/variables/ClientToolFuncSchema.md +83 -0
- package/docs/{variables → api/variables}/DEFAULT_CONFIG_NAME.md +1 -1
- package/docs/{variables → api/variables}/DefaultAsyncSemaphoreCapacity.md +1 -1
- package/docs/api/variables/EventBusName.md +11 -0
- package/docs/api/variables/EventName.md +11 -0
- package/docs/{variables → api/variables}/FilenameReservedRegex.md +1 -1
- package/docs/api/variables/FuncMetaSymbol.md +15 -0
- package/docs/{variables → api/variables}/InternalErrorCode.md +1 -1
- package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES.md +1 -1
- package/docs/{variables → api/variables}/LLM_TOKENIZER_NAMES_MAP.md +1 -1
- package/docs/{variables → api/variables}/NotFoundErrorCode.md +1 -1
- package/docs/{variables → api/variables}/NotImplementedErrorCode.md +1 -1
- package/docs/api/variables/PASSING_SCORE.md +13 -0
- package/docs/api/variables/RStreamErrCode.md +11 -0
- package/docs/api/variables/RemoteToolFuncSchema.md +84 -0
- package/docs/api/variables/ResponseRStreamErrCode.md +11 -0
- package/docs/{variables → api/variables}/SHUTDOWN_SIGNALS.md +1 -1
- package/docs/{variables → api/variables}/SSEChannelAlreadyClosedErrCode.md +1 -1
- package/docs/api/variables/SecondaryCache.md +11 -0
- package/docs/api/variables/ServerToolFuncSchema.md +83 -0
- package/docs/api/variables/StrangeHumanName.md +11 -0
- package/docs/api/variables/ToolAsyncCancelableBit.md +11 -0
- package/docs/api/variables/ToolAsyncMultiTaskBit.md +11 -0
- package/docs/api/variables/ToolAsyncPriorityBit.md +11 -0
- package/docs/{variables → api/variables}/ToolFuncSchema.md +14 -1
- package/docs/{variables → api/variables}/WindowsReservedNameRegex.md +1 -1
- package/docs/api/variables/base32768.md +11 -0
- package/docs/api/variables/defaultTemplateFormat.md +11 -0
- package/docs/api/variables/event.md +11 -0
- package/docs/api/variables/eventClient.md +11 -0
- package/docs/api/variables/eventServer.md +11 -0
- package/docs/api/variables/lrucache.md +11 -0
- package/docs/{variables → api/variables}/mimeType.md +1 -1
- package/docs/{variables → api/variables}/uuidNIL.md +1 -1
- package/docs/pubsub.md +326 -0
- package/docs/server_client_tools.md +88 -0
- package/docs/toolFunc.md +183 -0
- package/docs/transport.md +137 -0
- package/package.json +38 -38
- package/dist/chunk-YVFGQB4L.mjs +0 -1
- package/dist/index-BkwhCK1q.d.mts +0 -899
- package/dist/index-BkwhCK1q.d.ts +0 -899
- package/docs/README.md +0 -250
- package/docs/classes/AlreadyExistsError.md +0 -346
- package/docs/classes/BaseError.md +0 -359
- package/docs/classes/ConfigFile.md +0 -353
- package/docs/classes/HFEnvironment.md +0 -184
- package/docs/classes/HFInterpreter.md +0 -77
- package/docs/classes/HFTemplate.md +0 -67
- package/docs/classes/HfPromptTemplate.md +0 -1158
- package/docs/classes/NotFoundError.md +0 -346
- package/docs/classes/NotImplementationError.md +0 -346
- package/docs/classes/ReadableStreamError.md +0 -366
- package/docs/classes/ResClientTools.md +0 -2451
- package/docs/classes/ResServerTools.md +0 -2427
- package/docs/classes/SSEChannel.md +0 -270
- package/docs/classes/ToolFunc.md +0 -2201
- package/docs/classes/YamlTypeBaseObject.md +0 -31
- package/docs/enumerations/AsyncFeatureBits.md +0 -33
- package/docs/enumerations/AsyncFeatures.md +0 -33
- package/docs/enumerations/ErrorCode.md +0 -177
- package/docs/enumerations/HashAlgorithm.md +0 -97
- package/docs/functions/canonicalize.md +0 -21
- package/docs/functions/expandConfig.md +0 -25
- package/docs/functions/filenameReservedRegex.md +0 -20
- package/docs/functions/hfParse.md +0 -24
- package/docs/functions/hfTokenize.md +0 -27
- package/docs/functions/initShutdown.md +0 -15
- package/docs/functions/interpolateEnv.md +0 -29
- package/docs/functions/interpolateFString.md +0 -29
- package/docs/functions/interpolateGolangTemplate.md +0 -35
- package/docs/functions/parseFString.md +0 -26
- package/docs/functions/parseYaml.md +0 -25
- package/docs/functions/reControlCharsRegex.md +0 -19
- package/docs/functions/registerYamlTag.md +0 -21
- package/docs/functions/stringifyYaml.md +0 -25
- package/docs/functions/wait.md +0 -21
- package/docs/interfaces/AIChatAssistantMessageParam.md +0 -129
- package/docs/interfaces/AIChatContentPartImage.md +0 -29
- package/docs/interfaces/AIChatContentPartText.md +0 -25
- package/docs/interfaces/AIChatMessageParamBase.md +0 -68
- package/docs/interfaces/AIChatMessageToolCall.md +0 -41
- package/docs/interfaces/AIChatToolChoiceFuncObject.md +0 -37
- package/docs/interfaces/AIChatToolChoiceObject.md +0 -25
- package/docs/interfaces/AIChatToolFunc.md +0 -41
- package/docs/interfaces/AIChatToolFuncParam.md +0 -37
- package/docs/interfaces/AIChatToolMessageParam.md +0 -113
- package/docs/interfaces/AIChatToolParam.md +0 -25
- package/docs/interfaces/AIChatToolTypeObject.md +0 -17
- package/docs/interfaces/AIChatUserMessageParam.md +0 -137
- package/docs/interfaces/AIChoiceConfig.md +0 -65
- package/docs/interfaces/AIResult.md +0 -65
- package/docs/interfaces/AIStreamParserOptions.md +0 -21
- package/docs/interfaces/BaseFunc.md +0 -157
- package/docs/interfaces/BaseFuncItem.md +0 -101
- package/docs/interfaces/BinarySemaphoreAcquireOptions.md +0 -25
- package/docs/interfaces/BinarySemaphoreOptions.md +0 -57
- package/docs/interfaces/BinarySemaphoreReleaseOptions.md +0 -25
- package/docs/interfaces/BinarySemaphoreReleaserFunc.md +0 -37
- package/docs/interfaces/CancelableAbilityOptions.md +0 -113
- package/docs/interfaces/ClientFuncItem.md +0 -175
- package/docs/interfaces/DotenvExpandOptions.md +0 -43
- package/docs/interfaces/DotenvExpandOutput.md +0 -25
- package/docs/interfaces/DotenvParseInput.md +0 -13
- package/docs/interfaces/DotenvParseOutput.md +0 -13
- package/docs/interfaces/DotenvPopulateInput.md +0 -13
- package/docs/interfaces/EventClientFuncParams.md +0 -51
- package/docs/interfaces/EventServerFuncParams.md +0 -67
- package/docs/interfaces/FewShotPromptTemplateOptions.md +0 -147
- package/docs/interfaces/FuncItem.md +0 -143
- package/docs/interfaces/FuncParam.md +0 -61
- package/docs/interfaces/FuncParams.md +0 -13
- package/docs/interfaces/Funcs.md +0 -13
- package/docs/interfaces/HashAlgoParams.md +0 -33
- package/docs/interfaces/IFileMetaInfo.md +0 -65
- package/docs/interfaces/ITruncateToTokenLimitOptions.md +0 -99
- package/docs/interfaces/JsonFilter.md +0 -13
- package/docs/interfaces/ParseObjectArgumentOptions.md +0 -89
- package/docs/interfaces/PromptExampleSelectorOptions.md +0 -34
- package/docs/interfaces/PromptTemplateOptions.md +0 -65
- package/docs/interfaces/RemoteFuncItem.md +0 -164
- package/docs/interfaces/ReplacePlacehoderOptions.md +0 -41
- package/docs/interfaces/ResClientFuncParams.md +0 -37
- package/docs/interfaces/ResServerFuncParams.md +0 -69
- package/docs/interfaces/SanitizeFilenameOptions.md +0 -25
- package/docs/interfaces/SectionStringOptions.md +0 -25
- package/docs/interfaces/SemaphoreOptions.md +0 -89
- package/docs/interfaces/SemaphoreTaskItem.md +0 -73
- package/docs/interfaces/ServerFuncItem.md +0 -183
- package/docs/interfaces/ServerFuncParams.md +0 -35
- package/docs/interfaces/SplitSentenceOptions.md +0 -41
- package/docs/interfaces/ToolFuncPackage.md +0 -47
- package/docs/type-aliases/AIModelNameRule.md +0 -11
- package/docs/type-aliases/AIModelNameRuleFn.md +0 -21
- package/docs/type-aliases/AIModelNameRules.md +0 -11
- package/docs/type-aliases/ActionName.md +0 -11
- package/docs/type-aliases/AsyncTaskId.md +0 -11
- package/docs/type-aliases/FStringPromptTemplateNode.md +0 -14
- package/docs/type-aliases/FuncParamType.md +0 -11
- package/docs/type-aliases/PromptTemplateType.md +0 -11
- package/docs/type-aliases/PromptType.md +0 -11
- package/docs/type-aliases/TFunc.md +0 -25
- package/docs/variables/ActionNames.md +0 -11
- package/docs/variables/ClientToolFuncSchema.md +0 -101
- package/docs/variables/EventBusName.md +0 -11
- package/docs/variables/EventName.md +0 -11
- package/docs/variables/HFBuiltins.md +0 -122
- package/docs/variables/PASSING_SCORE.md +0 -11
- package/docs/variables/PromptTemplateTypes.md +0 -11
- package/docs/variables/PromptTypes.md +0 -14
- package/docs/variables/RStreamErrCode.md +0 -11
- package/docs/variables/RemoteToolFuncSchema.md +0 -101
- package/docs/variables/ResponseRStreamErrCode.md +0 -11
- package/docs/variables/SecondaryCache.md +0 -11
- package/docs/variables/ServerToolFuncSchema.md +0 -101
- package/docs/variables/ToolAsyncCancelableBit.md +0 -11
- package/docs/variables/ToolAsyncMultiTaskBit.md +0 -11
- package/docs/variables/ToolAsyncPriorityBit.md +0 -11
- package/docs/variables/base32768.md +0 -11
- package/docs/variables/defaultTemplateFormat.md +0 -11
- package/docs/variables/event.md +0 -11
- package/docs/variables/eventClient.md +0 -11
- package/docs/variables/eventServer.md +0 -11
- package/docs/variables/lrucache.md +0 -11
- /package/docs/{_media → api/_media}/LICENSE-MIT +0 -0
- /package/docs/{namespaces → api/namespaces}/EventStates/README.md +0 -0
- /package/docs/{namespaces → api/namespaces}/uuidv5/README.md +0 -0
|
@@ -1,113 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / CancelableAbilityOptions
|
|
6
|
-
|
|
7
|
-
# Interface: CancelableAbilityOptions
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:29](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/cancelable-ability.ts#L29)
|
|
10
|
-
|
|
11
|
-
## Extends
|
|
12
|
-
|
|
13
|
-
- `AbilityOptions`
|
|
14
|
-
|
|
15
|
-
## Indexable
|
|
16
|
-
|
|
17
|
-
\[`name`: `string`\]: `any`
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### asyncFeatures?
|
|
22
|
-
|
|
23
|
-
> `optional` **asyncFeatures**: [`AsyncFeatures`](../enumerations/AsyncFeatures.md)
|
|
24
|
-
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:30](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/cancelable-ability.ts#L30)
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### classMethods?
|
|
30
|
-
|
|
31
|
-
> `optional` **classMethods**: `Record`\<`string`, `Function`\>
|
|
32
|
-
|
|
33
|
-
Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:13
|
|
34
|
-
|
|
35
|
-
#### Inherited from
|
|
36
|
-
|
|
37
|
-
`AbilityOptions.classMethods`
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### exclude?
|
|
42
|
-
|
|
43
|
-
> `optional` **exclude**: `string` \| `string`[]
|
|
44
|
-
|
|
45
|
-
Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:11
|
|
46
|
-
|
|
47
|
-
#### Inherited from
|
|
48
|
-
|
|
49
|
-
`AbilityOptions.exclude`
|
|
50
|
-
|
|
51
|
-
***
|
|
52
|
-
|
|
53
|
-
### id?
|
|
54
|
-
|
|
55
|
-
> `optional` **id**: `string`
|
|
56
|
-
|
|
57
|
-
Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:8
|
|
58
|
-
|
|
59
|
-
#### Inherited from
|
|
60
|
-
|
|
61
|
-
`AbilityOptions.id`
|
|
62
|
-
|
|
63
|
-
***
|
|
64
|
-
|
|
65
|
-
### include?
|
|
66
|
-
|
|
67
|
-
> `optional` **include**: `string` \| `string`[]
|
|
68
|
-
|
|
69
|
-
Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:10
|
|
70
|
-
|
|
71
|
-
#### Inherited from
|
|
72
|
-
|
|
73
|
-
`AbilityOptions.include`
|
|
74
|
-
|
|
75
|
-
***
|
|
76
|
-
|
|
77
|
-
### isReadyFn?
|
|
78
|
-
|
|
79
|
-
> `optional` **isReadyFn**: [`SemaphoreIsReadyFuncType`](../type-aliases/SemaphoreIsReadyFuncType.md)
|
|
80
|
-
|
|
81
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:32](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/cancelable-ability.ts#L32)
|
|
82
|
-
|
|
83
|
-
***
|
|
84
|
-
|
|
85
|
-
### maxTaskConcurrency?
|
|
86
|
-
|
|
87
|
-
> `optional` **maxTaskConcurrency**: `number`
|
|
88
|
-
|
|
89
|
-
Defined in: [packages/ai-tool/src/utils/cancelable-ability.ts:31](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/cancelable-ability.ts#L31)
|
|
90
|
-
|
|
91
|
-
***
|
|
92
|
-
|
|
93
|
-
### methods?
|
|
94
|
-
|
|
95
|
-
> `optional` **methods**: `Record`\<`string`, `Function`\>
|
|
96
|
-
|
|
97
|
-
Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:12
|
|
98
|
-
|
|
99
|
-
#### Inherited from
|
|
100
|
-
|
|
101
|
-
`AbilityOptions.methods`
|
|
102
|
-
|
|
103
|
-
***
|
|
104
|
-
|
|
105
|
-
### mode?
|
|
106
|
-
|
|
107
|
-
> `optional` **mode**: `number`
|
|
108
|
-
|
|
109
|
-
Defined in: node\_modules/.pnpm/custom-ability@2.0.1/node\_modules/custom-ability/lib/custom-ability.d.ts:9
|
|
110
|
-
|
|
111
|
-
#### Inherited from
|
|
112
|
-
|
|
113
|
-
`AbilityOptions.mode`
|
|
@@ -1,175 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / ClientFuncItem
|
|
6
|
-
|
|
7
|
-
# Interface: ClientFuncItem
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/client-tools.ts:5](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/client-tools.ts#L5)
|
|
10
|
-
|
|
11
|
-
## Extends
|
|
12
|
-
|
|
13
|
-
- [`RemoteFuncItem`](RemoteFuncItem.md)
|
|
14
|
-
|
|
15
|
-
## Extended by
|
|
16
|
-
|
|
17
|
-
- [`ClientTools`](../classes/ClientTools.md)
|
|
18
|
-
|
|
19
|
-
## Properties
|
|
20
|
-
|
|
21
|
-
### action?
|
|
22
|
-
|
|
23
|
-
> `optional` **action**: `"get"` \| `"post"` \| `"put"` \| `"delete"` \| `"patch"` \| `"list"` \| `"res"`
|
|
24
|
-
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/consts.ts#L35)
|
|
26
|
-
|
|
27
|
-
#### Inherited from
|
|
28
|
-
|
|
29
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`action`](RemoteFuncItem.md#action)
|
|
30
|
-
|
|
31
|
-
***
|
|
32
|
-
|
|
33
|
-
### alias?
|
|
34
|
-
|
|
35
|
-
> `optional` **alias**: `string` \| `string`[]
|
|
36
|
-
|
|
37
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:31](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L31)
|
|
38
|
-
|
|
39
|
-
#### Inherited from
|
|
40
|
-
|
|
41
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`alias`](RemoteFuncItem.md#alias)
|
|
42
|
-
|
|
43
|
-
***
|
|
44
|
-
|
|
45
|
-
### apiRoot?
|
|
46
|
-
|
|
47
|
-
> `optional` **apiRoot**: `string`
|
|
48
|
-
|
|
49
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:34](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/consts.ts#L34)
|
|
50
|
-
|
|
51
|
-
#### Inherited from
|
|
52
|
-
|
|
53
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`apiRoot`](RemoteFuncItem.md#apiroot)
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### fetchOptions?
|
|
58
|
-
|
|
59
|
-
> `optional` **fetchOptions**: `any`
|
|
60
|
-
|
|
61
|
-
Defined in: [packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/consts.ts#L36)
|
|
62
|
-
|
|
63
|
-
#### Inherited from
|
|
64
|
-
|
|
65
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`fetchOptions`](RemoteFuncItem.md#fetchoptions)
|
|
66
|
-
|
|
67
|
-
***
|
|
68
|
-
|
|
69
|
-
### isApi?
|
|
70
|
-
|
|
71
|
-
> `optional` **isApi**: `boolean`
|
|
72
|
-
|
|
73
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:29](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L29)
|
|
74
|
-
|
|
75
|
-
#### Inherited from
|
|
76
|
-
|
|
77
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`isApi`](RemoteFuncItem.md#isapi)
|
|
78
|
-
|
|
79
|
-
***
|
|
80
|
-
|
|
81
|
-
### name?
|
|
82
|
-
|
|
83
|
-
> `optional` **name**: `string`
|
|
84
|
-
|
|
85
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L23)
|
|
86
|
-
|
|
87
|
-
#### Inherited from
|
|
88
|
-
|
|
89
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`name`](RemoteFuncItem.md#name)
|
|
90
|
-
|
|
91
|
-
***
|
|
92
|
-
|
|
93
|
-
### params?
|
|
94
|
-
|
|
95
|
-
> `optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
|
|
96
|
-
|
|
97
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L24)
|
|
98
|
-
|
|
99
|
-
#### Inherited from
|
|
100
|
-
|
|
101
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`params`](RemoteFuncItem.md#params)
|
|
102
|
-
|
|
103
|
-
***
|
|
104
|
-
|
|
105
|
-
### result?
|
|
106
|
-
|
|
107
|
-
> `optional` **result**: `string`
|
|
108
|
-
|
|
109
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L25)
|
|
110
|
-
|
|
111
|
-
#### Inherited from
|
|
112
|
-
|
|
113
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`result`](RemoteFuncItem.md#result)
|
|
114
|
-
|
|
115
|
-
***
|
|
116
|
-
|
|
117
|
-
### scope?
|
|
118
|
-
|
|
119
|
-
> `optional` **scope**: `any`
|
|
120
|
-
|
|
121
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L26)
|
|
122
|
-
|
|
123
|
-
#### Inherited from
|
|
124
|
-
|
|
125
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`scope`](RemoteFuncItem.md#scope)
|
|
126
|
-
|
|
127
|
-
***
|
|
128
|
-
|
|
129
|
-
### setup()?
|
|
130
|
-
|
|
131
|
-
> `optional` **setup**: (`this`, `options`?) => `void`
|
|
132
|
-
|
|
133
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:28](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L28)
|
|
134
|
-
|
|
135
|
-
#### Parameters
|
|
136
|
-
|
|
137
|
-
##### this
|
|
138
|
-
|
|
139
|
-
[`ToolFunc`](../classes/ToolFunc.md)
|
|
140
|
-
|
|
141
|
-
##### options?
|
|
142
|
-
|
|
143
|
-
[`FuncItem`](FuncItem.md)
|
|
144
|
-
|
|
145
|
-
#### Returns
|
|
146
|
-
|
|
147
|
-
`void`
|
|
148
|
-
|
|
149
|
-
#### Inherited from
|
|
150
|
-
|
|
151
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`setup`](RemoteFuncItem.md#setup)
|
|
152
|
-
|
|
153
|
-
***
|
|
154
|
-
|
|
155
|
-
### stream?
|
|
156
|
-
|
|
157
|
-
> `optional` **stream**: `boolean`
|
|
158
|
-
|
|
159
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:30](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L30)
|
|
160
|
-
|
|
161
|
-
#### Inherited from
|
|
162
|
-
|
|
163
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`stream`](RemoteFuncItem.md#stream)
|
|
164
|
-
|
|
165
|
-
***
|
|
166
|
-
|
|
167
|
-
### tags?
|
|
168
|
-
|
|
169
|
-
> `optional` **tags**: `string` \| `string`[]
|
|
170
|
-
|
|
171
|
-
Defined in: [packages/ai-tool/src/tool-func.ts:27](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/tool-func.ts#L27)
|
|
172
|
-
|
|
173
|
-
#### Inherited from
|
|
174
|
-
|
|
175
|
-
[`RemoteFuncItem`](RemoteFuncItem.md).[`tags`](RemoteFuncItem.md#tags)
|
|
@@ -1,43 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / DotenvExpandOptions
|
|
6
|
-
|
|
7
|
-
# Interface: DotenvExpandOptions
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:203](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L203)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### error?
|
|
14
|
-
|
|
15
|
-
> `optional` **error**: `Error`
|
|
16
|
-
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:204](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L204)
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### parsed?
|
|
22
|
-
|
|
23
|
-
> `optional` **parsed**: [`DotenvParseInput`](DotenvParseInput.md)
|
|
24
|
-
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:220](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L220)
|
|
26
|
-
|
|
27
|
-
Default: `object`
|
|
28
|
-
|
|
29
|
-
Object coming from dotenv's parsed result.
|
|
30
|
-
|
|
31
|
-
***
|
|
32
|
-
|
|
33
|
-
### processEnv?
|
|
34
|
-
|
|
35
|
-
> `optional` **processEnv**: [`DotenvPopulateInput`](DotenvPopulateInput.md)
|
|
36
|
-
|
|
37
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:213](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L213)
|
|
38
|
-
|
|
39
|
-
Default: `process.env`
|
|
40
|
-
|
|
41
|
-
Specify an object to write your secrets to. Defaults to process.env environment variables.
|
|
42
|
-
|
|
43
|
-
example: `const processEnv = {}; require('dotenv').config({ processEnv: processEnv })`
|
|
@@ -1,25 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / DotenvExpandOutput
|
|
6
|
-
|
|
7
|
-
# Interface: DotenvExpandOutput
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:223](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L223)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### error?
|
|
14
|
-
|
|
15
|
-
> `optional` **error**: `Error`
|
|
16
|
-
|
|
17
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:224](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L224)
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### parsed?
|
|
22
|
-
|
|
23
|
-
> `optional` **parsed**: [`DotenvParseOutput`](DotenvParseOutput.md)
|
|
24
|
-
|
|
25
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:225](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L225)
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / DotenvParseInput
|
|
6
|
-
|
|
7
|
-
# Interface: DotenvParseInput
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:195](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L195)
|
|
10
|
-
|
|
11
|
-
## Indexable
|
|
12
|
-
|
|
13
|
-
\[`name`: `string`\]: `undefined` \| `string`
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / DotenvParseOutput
|
|
6
|
-
|
|
7
|
-
# Interface: DotenvParseOutput
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:199](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L199)
|
|
10
|
-
|
|
11
|
-
## Indexable
|
|
12
|
-
|
|
13
|
-
\[`name`: `string`\]: `undefined` \| `string`
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / DotenvPopulateInput
|
|
6
|
-
|
|
7
|
-
# Interface: DotenvPopulateInput
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/template/env.ts:191](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/template/env.ts#L191)
|
|
10
|
-
|
|
11
|
-
## Indexable
|
|
12
|
-
|
|
13
|
-
\[`name`: `string`\]: `undefined` \| `string`
|
|
@@ -1,51 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / EventClientFuncParams
|
|
6
|
-
|
|
7
|
-
# Interface: EventClientFuncParams
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:5](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-client.ts#L5)
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
### act?
|
|
14
|
-
|
|
15
|
-
> `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"` \| `"init"`
|
|
16
|
-
|
|
17
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:8](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-client.ts#L8)
|
|
18
|
-
|
|
19
|
-
***
|
|
20
|
-
|
|
21
|
-
### data?
|
|
22
|
-
|
|
23
|
-
> `optional` **data**: `any`
|
|
24
|
-
|
|
25
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:7](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-client.ts#L7)
|
|
26
|
-
|
|
27
|
-
***
|
|
28
|
-
|
|
29
|
-
### event?
|
|
30
|
-
|
|
31
|
-
> `optional` **event**: `string` \| `string`[]
|
|
32
|
-
|
|
33
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:6](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-client.ts#L6)
|
|
34
|
-
|
|
35
|
-
***
|
|
36
|
-
|
|
37
|
-
### listener()?
|
|
38
|
-
|
|
39
|
-
> `optional` **listener**: (...`args`) => `void`
|
|
40
|
-
|
|
41
|
-
Defined in: [packages/ai-tool/src/funcs/event-client.ts:9](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-client.ts#L9)
|
|
42
|
-
|
|
43
|
-
#### Parameters
|
|
44
|
-
|
|
45
|
-
##### args
|
|
46
|
-
|
|
47
|
-
...`any`[]
|
|
48
|
-
|
|
49
|
-
#### Returns
|
|
50
|
-
|
|
51
|
-
`void`
|
|
@@ -1,67 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / EventServerFuncParams
|
|
6
|
-
|
|
7
|
-
# Interface: EventServerFuncParams
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:12](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-server.ts#L12)
|
|
10
|
-
|
|
11
|
-
Convention: Always pass _req, _res
|
|
12
|
-
|
|
13
|
-
## Extends
|
|
14
|
-
|
|
15
|
-
- [`ServerFuncParams`](ServerFuncParams.md)
|
|
16
|
-
|
|
17
|
-
## Indexable
|
|
18
|
-
|
|
19
|
-
\[`name`: `string`\]: `any`
|
|
20
|
-
|
|
21
|
-
## Properties
|
|
22
|
-
|
|
23
|
-
### \_req?
|
|
24
|
-
|
|
25
|
-
> `optional` **\_req**: `IncomingMessage`
|
|
26
|
-
|
|
27
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:9](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/server-tools.ts#L9)
|
|
28
|
-
|
|
29
|
-
#### Inherited from
|
|
30
|
-
|
|
31
|
-
[`ServerFuncParams`](ServerFuncParams.md).[`_req`](ServerFuncParams.md#_req)
|
|
32
|
-
|
|
33
|
-
***
|
|
34
|
-
|
|
35
|
-
### \_res?
|
|
36
|
-
|
|
37
|
-
> `optional` **\_res**: `ServerResponse`\<`IncomingMessage`\>
|
|
38
|
-
|
|
39
|
-
Defined in: [packages/ai-tool/src/server-tools.ts:10](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/server-tools.ts#L10)
|
|
40
|
-
|
|
41
|
-
#### Inherited from
|
|
42
|
-
|
|
43
|
-
[`ServerFuncParams`](ServerFuncParams.md).[`_res`](ServerFuncParams.md#_res)
|
|
44
|
-
|
|
45
|
-
***
|
|
46
|
-
|
|
47
|
-
### act?
|
|
48
|
-
|
|
49
|
-
> `optional` **act**: `"sub"` \| `"pub"` \| `"unsub"`
|
|
50
|
-
|
|
51
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:15](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-server.ts#L15)
|
|
52
|
-
|
|
53
|
-
***
|
|
54
|
-
|
|
55
|
-
### data?
|
|
56
|
-
|
|
57
|
-
> `optional` **data**: `any`
|
|
58
|
-
|
|
59
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:14](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-server.ts#L14)
|
|
60
|
-
|
|
61
|
-
***
|
|
62
|
-
|
|
63
|
-
### event?
|
|
64
|
-
|
|
65
|
-
> `optional` **event**: `string` \| `string`[]
|
|
66
|
-
|
|
67
|
-
Defined in: [packages/ai-tool/src/funcs/event-server.ts:13](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/funcs/event-server.ts#L13)
|
|
@@ -1,147 +0,0 @@
|
|
|
1
|
-
[**@isdk/ai-tool**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@isdk/ai-tool](../globals.md) / FewShotPromptTemplateOptions
|
|
6
|
-
|
|
7
|
-
# Interface: FewShotPromptTemplateOptions\<T\>
|
|
8
|
-
|
|
9
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:10](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L10)
|
|
10
|
-
|
|
11
|
-
## Extends
|
|
12
|
-
|
|
13
|
-
- [`PromptTemplateOptions`](PromptTemplateOptions.md)
|
|
14
|
-
|
|
15
|
-
## Type Parameters
|
|
16
|
-
|
|
17
|
-
• **T** = `any`
|
|
18
|
-
|
|
19
|
-
## Indexable
|
|
20
|
-
|
|
21
|
-
\[`name`: `string`\]: `any`
|
|
22
|
-
|
|
23
|
-
## Properties
|
|
24
|
-
|
|
25
|
-
### compiledTemplate?
|
|
26
|
-
|
|
27
|
-
> `optional` **compiledTemplate**: `any`
|
|
28
|
-
|
|
29
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L15)
|
|
30
|
-
|
|
31
|
-
#### Inherited from
|
|
32
|
-
|
|
33
|
-
[`PromptTemplateOptions`](PromptTemplateOptions.md).[`compiledTemplate`](PromptTemplateOptions.md#compiledtemplate)
|
|
34
|
-
|
|
35
|
-
***
|
|
36
|
-
|
|
37
|
-
### data?
|
|
38
|
-
|
|
39
|
-
> `optional` **data**: `Record`\<`string`, `any`\>
|
|
40
|
-
|
|
41
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L12)
|
|
42
|
-
|
|
43
|
-
#### Inherited from
|
|
44
|
-
|
|
45
|
-
[`PromptTemplateOptions`](PromptTemplateOptions.md).[`data`](PromptTemplateOptions.md#data)
|
|
46
|
-
|
|
47
|
-
***
|
|
48
|
-
|
|
49
|
-
### examplePrompt
|
|
50
|
-
|
|
51
|
-
> **examplePrompt**: [`PromptTemplateOptions`](PromptTemplateOptions.md) \| [`PromptTemplate`](../classes/PromptTemplate.md)
|
|
52
|
-
|
|
53
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:19](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L19)
|
|
54
|
-
|
|
55
|
-
An [PromptTemplate](../classes/PromptTemplate.md) used to format a single example.
|
|
56
|
-
|
|
57
|
-
***
|
|
58
|
-
|
|
59
|
-
### examples
|
|
60
|
-
|
|
61
|
-
> **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
|
|
62
|
-
|
|
63
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L14)
|
|
64
|
-
|
|
65
|
-
The few shot examples to use in the prompt.
|
|
66
|
-
|
|
67
|
-
***
|
|
68
|
-
|
|
69
|
-
### exampleSeparator?
|
|
70
|
-
|
|
71
|
-
> `optional` **exampleSeparator**: `string`
|
|
72
|
-
|
|
73
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:24](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L24)
|
|
74
|
-
|
|
75
|
-
String separator used to join the prefix, the examples, and suffix.
|
|
76
|
-
|
|
77
|
-
***
|
|
78
|
-
|
|
79
|
-
### ignoreInitialize?
|
|
80
|
-
|
|
81
|
-
> `optional` **ignoreInitialize**: `boolean`
|
|
82
|
-
|
|
83
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L16)
|
|
84
|
-
|
|
85
|
-
#### Inherited from
|
|
86
|
-
|
|
87
|
-
[`PromptTemplateOptions`](PromptTemplateOptions.md).[`ignoreInitialize`](PromptTemplateOptions.md#ignoreinitialize)
|
|
88
|
-
|
|
89
|
-
***
|
|
90
|
-
|
|
91
|
-
### inputVariables?
|
|
92
|
-
|
|
93
|
-
> `optional` **inputVariables**: `string`[]
|
|
94
|
-
|
|
95
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L14)
|
|
96
|
-
|
|
97
|
-
#### Inherited from
|
|
98
|
-
|
|
99
|
-
[`PromptTemplateOptions`](PromptTemplateOptions.md).[`inputVariables`](PromptTemplateOptions.md#inputvariables)
|
|
100
|
-
|
|
101
|
-
***
|
|
102
|
-
|
|
103
|
-
### prefix?
|
|
104
|
-
|
|
105
|
-
> `optional` **prefix**: `string`
|
|
106
|
-
|
|
107
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:31](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L31)
|
|
108
|
-
|
|
109
|
-
A prompt template string to put before the examples.
|
|
110
|
-
|
|
111
|
-
#### Default Value
|
|
112
|
-
|
|
113
|
-
`""`
|
|
114
|
-
|
|
115
|
-
***
|
|
116
|
-
|
|
117
|
-
### suffix?
|
|
118
|
-
|
|
119
|
-
> `optional` **suffix**: `string`
|
|
120
|
-
|
|
121
|
-
Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:36](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/few-shot-prompt-template.ts#L36)
|
|
122
|
-
|
|
123
|
-
A prompt template string to put after the examples.
|
|
124
|
-
|
|
125
|
-
***
|
|
126
|
-
|
|
127
|
-
### template?
|
|
128
|
-
|
|
129
|
-
> `optional` **template**: `string`
|
|
130
|
-
|
|
131
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L11)
|
|
132
|
-
|
|
133
|
-
#### Inherited from
|
|
134
|
-
|
|
135
|
-
[`PromptTemplateOptions`](PromptTemplateOptions.md).[`template`](PromptTemplateOptions.md#template)
|
|
136
|
-
|
|
137
|
-
***
|
|
138
|
-
|
|
139
|
-
### templateFormat?
|
|
140
|
-
|
|
141
|
-
> `optional` **templateFormat**: `string`
|
|
142
|
-
|
|
143
|
-
Defined in: [packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/c084189f913fb955b91b492de68bd07ce78f8c82/src/utils/prompt/prompt-template.ts#L13)
|
|
144
|
-
|
|
145
|
-
#### Inherited from
|
|
146
|
-
|
|
147
|
-
[`PromptTemplateOptions`](PromptTemplateOptions.md).[`templateFormat`](PromptTemplateOptions.md#templateformat)
|