@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,105 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatSystemMessageParam
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatSystemMessageParam
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:63](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L63)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md)
|
|
14
|
+
|
|
15
|
+
## Indexable
|
|
16
|
+
|
|
17
|
+
\[`name`: `string`\]: `any`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### content
|
|
22
|
+
|
|
23
|
+
> **content**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:65](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L65)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### private?
|
|
30
|
+
|
|
31
|
+
> `optional` **private**: `boolean`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:57](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L57)
|
|
34
|
+
|
|
35
|
+
#### Inherited from
|
|
36
|
+
|
|
37
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`private`](AIChatMessageParamBase.md#private)
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### replies?
|
|
42
|
+
|
|
43
|
+
> `optional` **replies**: `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
|
|
44
|
+
|
|
45
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L56)
|
|
46
|
+
|
|
47
|
+
#### Inherited from
|
|
48
|
+
|
|
49
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`replies`](AIChatMessageParamBase.md#replies)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### role
|
|
54
|
+
|
|
55
|
+
> **role**: `"system"`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:64](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L64)
|
|
58
|
+
|
|
59
|
+
#### Overrides
|
|
60
|
+
|
|
61
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`role`](AIChatMessageParamBase.md#role)
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
65
|
+
### templateFormat?
|
|
66
|
+
|
|
67
|
+
> `optional` **templateFormat**: `string`
|
|
68
|
+
|
|
69
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:66](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L66)
|
|
70
|
+
|
|
71
|
+
***
|
|
72
|
+
|
|
73
|
+
### thinking?
|
|
74
|
+
|
|
75
|
+
> `optional` **thinking**: `string`
|
|
76
|
+
|
|
77
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:59](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L59)
|
|
78
|
+
|
|
79
|
+
#### Inherited from
|
|
80
|
+
|
|
81
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`thinking`](AIChatMessageParamBase.md#thinking)
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### tools?
|
|
86
|
+
|
|
87
|
+
> `optional` **tools**: `Record`\<`string`, `string`\>
|
|
88
|
+
|
|
89
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:58](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L58)
|
|
90
|
+
|
|
91
|
+
#### Inherited from
|
|
92
|
+
|
|
93
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`tools`](AIChatMessageParamBase.md#tools)
|
|
94
|
+
|
|
95
|
+
***
|
|
96
|
+
|
|
97
|
+
### toRole?
|
|
98
|
+
|
|
99
|
+
> `optional` **toRole**: `string` \| `string`[] \| `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
|
|
100
|
+
|
|
101
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:55](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L55)
|
|
102
|
+
|
|
103
|
+
#### Inherited from
|
|
104
|
+
|
|
105
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`toRole`](AIChatMessageParamBase.md#torole)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatToolChoiceFuncObject
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatToolChoiceFuncObject
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:148](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L148)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- [`AIChatToolChoiceObject`](AIChatToolChoiceObject.md)
|
|
14
|
+
|
|
15
|
+
## Indexable
|
|
16
|
+
|
|
17
|
+
\[`key`: `string`\]: `any`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### function
|
|
22
|
+
|
|
23
|
+
> **function**: [`AIChatToolTypeObject`](AIChatToolTypeObject.md)
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:150](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L150)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### type
|
|
30
|
+
|
|
31
|
+
> **type**: `"function"`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:149](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L149)
|
|
34
|
+
|
|
35
|
+
#### Overrides
|
|
36
|
+
|
|
37
|
+
[`AIChatToolChoiceObject`](AIChatToolChoiceObject.md).[`type`](AIChatToolChoiceObject.md#type)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatToolChoiceObject
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatToolChoiceObject
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:143](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L143)
|
|
10
|
+
|
|
11
|
+
## Extended by
|
|
12
|
+
|
|
13
|
+
- [`AIChatToolChoiceFuncObject`](AIChatToolChoiceFuncObject.md)
|
|
14
|
+
|
|
15
|
+
## Indexable
|
|
16
|
+
|
|
17
|
+
\[`key`: `string`\]: `any`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### type
|
|
22
|
+
|
|
23
|
+
> **type**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:144](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L144)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatToolFunc
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatToolFunc
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:134](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L134)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### description?
|
|
14
|
+
|
|
15
|
+
> `optional` **description**: `string`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:136](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L136)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### name
|
|
22
|
+
|
|
23
|
+
> **name**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:135](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L135)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### parameters?
|
|
30
|
+
|
|
31
|
+
> `optional` **parameters**: `any`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:137](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L137)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### strict?
|
|
38
|
+
|
|
39
|
+
> `optional` **strict**: `boolean`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:138](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L138)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatToolFuncParam
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatToolFuncParam
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:129](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L129)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- [`AIChatToolParam`](AIChatToolParam.md)
|
|
14
|
+
|
|
15
|
+
## Indexable
|
|
16
|
+
|
|
17
|
+
\[`key`: `string`\]: `any`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### function
|
|
22
|
+
|
|
23
|
+
> **function**: [`AIChatToolFunc`](AIChatToolFunc.md)
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:131](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L131)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### type
|
|
30
|
+
|
|
31
|
+
> **type**: `"function"`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:130](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L130)
|
|
34
|
+
|
|
35
|
+
#### Overrides
|
|
36
|
+
|
|
37
|
+
[`AIChatToolParam`](AIChatToolParam.md).[`type`](AIChatToolParam.md#type)
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatToolMessageParam
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatToolMessageParam
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:117](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L117)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md)
|
|
14
|
+
|
|
15
|
+
## Indexable
|
|
16
|
+
|
|
17
|
+
\[`name`: `string`\]: `any`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### content
|
|
22
|
+
|
|
23
|
+
> **content**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:119](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L119)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### private?
|
|
30
|
+
|
|
31
|
+
> `optional` **private**: `boolean`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:57](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L57)
|
|
34
|
+
|
|
35
|
+
#### Inherited from
|
|
36
|
+
|
|
37
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`private`](AIChatMessageParamBase.md#private)
|
|
38
|
+
|
|
39
|
+
***
|
|
40
|
+
|
|
41
|
+
### replies?
|
|
42
|
+
|
|
43
|
+
> `optional` **replies**: `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
|
|
44
|
+
|
|
45
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L56)
|
|
46
|
+
|
|
47
|
+
#### Inherited from
|
|
48
|
+
|
|
49
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`replies`](AIChatMessageParamBase.md#replies)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### role
|
|
54
|
+
|
|
55
|
+
> **role**: `"tool"`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:118](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L118)
|
|
58
|
+
|
|
59
|
+
#### Overrides
|
|
60
|
+
|
|
61
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`role`](AIChatMessageParamBase.md#role)
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
65
|
+
### templateFormat?
|
|
66
|
+
|
|
67
|
+
> `optional` **templateFormat**: `string`
|
|
68
|
+
|
|
69
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:121](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L121)
|
|
70
|
+
|
|
71
|
+
***
|
|
72
|
+
|
|
73
|
+
### thinking?
|
|
74
|
+
|
|
75
|
+
> `optional` **thinking**: `string`
|
|
76
|
+
|
|
77
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:59](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L59)
|
|
78
|
+
|
|
79
|
+
#### Inherited from
|
|
80
|
+
|
|
81
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`thinking`](AIChatMessageParamBase.md#thinking)
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### tool\_call\_id
|
|
86
|
+
|
|
87
|
+
> **tool\_call\_id**: `string`
|
|
88
|
+
|
|
89
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:120](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L120)
|
|
90
|
+
|
|
91
|
+
***
|
|
92
|
+
|
|
93
|
+
### tools?
|
|
94
|
+
|
|
95
|
+
> `optional` **tools**: `Record`\<`string`, `string`\>
|
|
96
|
+
|
|
97
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:58](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L58)
|
|
98
|
+
|
|
99
|
+
#### Inherited from
|
|
100
|
+
|
|
101
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`tools`](AIChatMessageParamBase.md#tools)
|
|
102
|
+
|
|
103
|
+
***
|
|
104
|
+
|
|
105
|
+
### toRole?
|
|
106
|
+
|
|
107
|
+
> `optional` **toRole**: `string` \| `string`[] \| `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
|
|
108
|
+
|
|
109
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:55](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L55)
|
|
110
|
+
|
|
111
|
+
#### Inherited from
|
|
112
|
+
|
|
113
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`toRole`](AIChatMessageParamBase.md#torole)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatToolParam
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatToolParam
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:124](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L124)
|
|
10
|
+
|
|
11
|
+
## Extended by
|
|
12
|
+
|
|
13
|
+
- [`AIChatToolFuncParam`](AIChatToolFuncParam.md)
|
|
14
|
+
|
|
15
|
+
## Indexable
|
|
16
|
+
|
|
17
|
+
\[`key`: `string`\]: `any`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### type
|
|
22
|
+
|
|
23
|
+
> **type**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:125](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L125)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatToolTypeObject
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatToolTypeObject
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:153](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L153)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### name
|
|
14
|
+
|
|
15
|
+
> **name**: `string`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:154](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L154)
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChatUserMessageParam
|
|
6
|
+
|
|
7
|
+
# Interface: AIChatUserMessageParam
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:69](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L69)
|
|
10
|
+
|
|
11
|
+
## Extends
|
|
12
|
+
|
|
13
|
+
- [`AIChatMessageParamBase`](AIChatMessageParamBase.md)
|
|
14
|
+
|
|
15
|
+
## Indexable
|
|
16
|
+
|
|
17
|
+
\[`name`: `string`\]: `any`
|
|
18
|
+
|
|
19
|
+
## Properties
|
|
20
|
+
|
|
21
|
+
### charId?
|
|
22
|
+
|
|
23
|
+
> `optional` **charId**: `string`
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:76](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L76)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### content
|
|
30
|
+
|
|
31
|
+
> **content**: `string` \| [`AIChatContentPart`](../type-aliases/AIChatContentPart.md)[]
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:71](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L71)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### createdAt?
|
|
38
|
+
|
|
39
|
+
> `optional` **createdAt**: `string` \| `Date`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:73](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L73)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### from?
|
|
46
|
+
|
|
47
|
+
> `optional` **from**: `string`
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:78](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L78)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### private?
|
|
54
|
+
|
|
55
|
+
> `optional` **private**: `boolean`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:57](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L57)
|
|
58
|
+
|
|
59
|
+
#### Inherited from
|
|
60
|
+
|
|
61
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`private`](AIChatMessageParamBase.md#private)
|
|
62
|
+
|
|
63
|
+
***
|
|
64
|
+
|
|
65
|
+
### replies?
|
|
66
|
+
|
|
67
|
+
> `optional` **replies**: `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
|
|
68
|
+
|
|
69
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:56](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L56)
|
|
70
|
+
|
|
71
|
+
#### Inherited from
|
|
72
|
+
|
|
73
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`replies`](AIChatMessageParamBase.md#replies)
|
|
74
|
+
|
|
75
|
+
***
|
|
76
|
+
|
|
77
|
+
### role
|
|
78
|
+
|
|
79
|
+
> **role**: `"user"`
|
|
80
|
+
|
|
81
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:70](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L70)
|
|
82
|
+
|
|
83
|
+
#### Overrides
|
|
84
|
+
|
|
85
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`role`](AIChatMessageParamBase.md#role)
|
|
86
|
+
|
|
87
|
+
***
|
|
88
|
+
|
|
89
|
+
### templateFormat?
|
|
90
|
+
|
|
91
|
+
> `optional` **templateFormat**: `string`
|
|
92
|
+
|
|
93
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:79](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L79)
|
|
94
|
+
|
|
95
|
+
***
|
|
96
|
+
|
|
97
|
+
### thinking?
|
|
98
|
+
|
|
99
|
+
> `optional` **thinking**: `string`
|
|
100
|
+
|
|
101
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:59](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L59)
|
|
102
|
+
|
|
103
|
+
#### Inherited from
|
|
104
|
+
|
|
105
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`thinking`](AIChatMessageParamBase.md#thinking)
|
|
106
|
+
|
|
107
|
+
***
|
|
108
|
+
|
|
109
|
+
### tools?
|
|
110
|
+
|
|
111
|
+
> `optional` **tools**: `Record`\<`string`, `string`\>
|
|
112
|
+
|
|
113
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:58](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L58)
|
|
114
|
+
|
|
115
|
+
#### Inherited from
|
|
116
|
+
|
|
117
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`tools`](AIChatMessageParamBase.md#tools)
|
|
118
|
+
|
|
119
|
+
***
|
|
120
|
+
|
|
121
|
+
### toRole?
|
|
122
|
+
|
|
123
|
+
> `optional` **toRole**: `string` \| `string`[] \| `Record`\<`string`, `Partial`\<[`AIChatMessageParam`](../type-aliases/AIChatMessageParam.md)\>\>
|
|
124
|
+
|
|
125
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:55](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L55)
|
|
126
|
+
|
|
127
|
+
#### Inherited from
|
|
128
|
+
|
|
129
|
+
[`AIChatMessageParamBase`](AIChatMessageParamBase.md).[`toRole`](AIChatMessageParamBase.md#torole)
|
|
130
|
+
|
|
131
|
+
***
|
|
132
|
+
|
|
133
|
+
### updatedAt?
|
|
134
|
+
|
|
135
|
+
> `optional` **updatedAt**: `string` \| `Date`
|
|
136
|
+
|
|
137
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:74](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L74)
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIChoiceConfig
|
|
6
|
+
|
|
7
|
+
# Interface: AIChoiceConfig
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L9)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### end?
|
|
14
|
+
|
|
15
|
+
> `optional` **end**: `string`
|
|
16
|
+
|
|
17
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L16)
|
|
18
|
+
|
|
19
|
+
***
|
|
20
|
+
|
|
21
|
+
### items?
|
|
22
|
+
|
|
23
|
+
> `optional` **items**: `string`[]
|
|
24
|
+
|
|
25
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:10](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L10)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### maxPick?
|
|
30
|
+
|
|
31
|
+
> `optional` **maxPick**: `number`
|
|
32
|
+
|
|
33
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:11](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L11)
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### minPick?
|
|
38
|
+
|
|
39
|
+
> `optional` **minPick**: `number`
|
|
40
|
+
|
|
41
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L12)
|
|
42
|
+
|
|
43
|
+
***
|
|
44
|
+
|
|
45
|
+
### prefix?
|
|
46
|
+
|
|
47
|
+
> `optional` **prefix**: `string`
|
|
48
|
+
|
|
49
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:14](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L14)
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### separator?
|
|
54
|
+
|
|
55
|
+
> `optional` **separator**: `string`
|
|
56
|
+
|
|
57
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:13](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L13)
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### type?
|
|
62
|
+
|
|
63
|
+
> `optional` **type**: `"ai"` \| `"random"`
|
|
64
|
+
|
|
65
|
+
Defined in: [packages/ai-tool/src/utils/parse-command.ts:15](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L15)
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
[**@isdk/ai-tool**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[@isdk/ai-tool](../globals.md) / AIResult
|
|
6
|
+
|
|
7
|
+
# Interface: AIResult\<TValue, TOptions\>
|
|
8
|
+
|
|
9
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:16](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L16)
|
|
10
|
+
|
|
11
|
+
## Type Parameters
|
|
12
|
+
|
|
13
|
+
• **TValue** = `any`
|
|
14
|
+
|
|
15
|
+
• **TOptions** = `any`
|
|
16
|
+
|
|
17
|
+
## Indexable
|
|
18
|
+
|
|
19
|
+
\[`name`: `string`\]: `any`
|
|
20
|
+
|
|
21
|
+
## Properties
|
|
22
|
+
|
|
23
|
+
### content?
|
|
24
|
+
|
|
25
|
+
> `optional` **content**: `TValue`
|
|
26
|
+
|
|
27
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:20](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L20)
|
|
28
|
+
|
|
29
|
+
The generated value.
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### finishReason?
|
|
34
|
+
|
|
35
|
+
> `optional` **finishReason**: `null` \| `"length"` \| `"abort"` \| `"stop"` \| `"content_filter"` \| `"tool_calls"` \| `"function_call"` \| `"error"` \| `"other"`
|
|
36
|
+
|
|
37
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L25)
|
|
38
|
+
|
|
39
|
+
The reason why the generation stopped.
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### options?
|
|
44
|
+
|
|
45
|
+
> `optional` **options**: `TOptions`
|
|
46
|
+
|
|
47
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:26](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L26)
|
|
48
|
+
|
|
49
|
+
***
|
|
50
|
+
|
|
51
|
+
### stop?
|
|
52
|
+
|
|
53
|
+
> `optional` **stop**: `boolean`
|
|
54
|
+
|
|
55
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:30](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L30)
|
|
56
|
+
|
|
57
|
+
for stream mode
|
|
58
|
+
|
|
59
|
+
***
|
|
60
|
+
|
|
61
|
+
### taskId?
|
|
62
|
+
|
|
63
|
+
> `optional` **taskId**: [`AsyncTaskId`](../type-aliases/AsyncTaskId.md)
|
|
64
|
+
|
|
65
|
+
Defined in: [packages/ai-tool/src/utils/chat.ts:31](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/chat.ts#L31)
|