@isdk/ai-tool 0.3.0 → 0.5.0

package/docs/interfaces/IFileMetaInfo.md

@@ -1,77 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / IFileMetaInfo
-
-# Interface: IFileMetaInfo
-
-## Properties
-
-### ctime
-
-> **ctime**: `Date`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:213](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L213)
-
-***
-
-### hash
-
-> **hash**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:215](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L215)
-
-***
-
-### id
-
-> **id**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:217](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L217)
-
-***
-
-### mimeType
-
-> **mimeType**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:216](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L216)
-
-***
-
-### mtime
-
-> **mtime**: `Date`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:212](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L212)
-
-***
-
-### name
-
-> **name**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:211](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L211)
-
-***
-
-### size
-
-> **size**: `number`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:214](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L214)

package/docs/interfaces/IReadTextFileChunksOptions.md

@@ -1,157 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / IReadTextFileChunksOptions
-
-# Interface: IReadTextFileChunksOptions
-
-## Extends
-
-- [`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md)
-
-## Properties
-
-### best?
-
-> `optional` **best**: `boolean`
-
-#### Inherited from
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`best`](ITruncateToTokenLimitOptions.md#best)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L8)
-
-***
-
-### bySentence?
-
-> `optional` **bySentence**: `boolean`
-
-#### Inherited from
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`bySentence`](ITruncateToTokenLimitOptions.md#bysentence)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:4](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L4)
-
-***
-
-### completeSentence?
-
-> `optional` **completeSentence**: `boolean`
-
-#### Inherited from
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`completeSentence`](ITruncateToTokenLimitOptions.md#completesentence)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L9)
-
-***
-
-### corrected?
-
-> `optional` **corrected**: `boolean`
-
-#### Inherited from
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`corrected`](ITruncateToTokenLimitOptions.md#corrected)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L10)
-
-***
-
-### countLLMTokens()?
-
-> `optional` **countLLMTokens**: (`text`, `modelId`?) => `Promise`\<`number`\>
-
-#### Parameters
-
-• **text**: `string`
-
-• **modelId?**: `string`
-
-#### Returns
-
-`Promise`\<`number`\>
-
-#### Inherited from
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`countLLMTokens`](ITruncateToTokenLimitOptions.md#countllmtokens)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L12)
-
-***
-
-### metaInfo?
-
-> `optional` **metaInfo**: `RequireAtLeastOne`\<`Partial`\<[`IFileMetaInfo`](IFileMetaInfo.md)\>, `"size"`\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/read-text-file-chunks.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/read-text-file-chunks.ts#L8)
-
-***
-
-### modelId?
-
-> `optional` **modelId**: `string`
-
-#### Overrides
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`modelId`](ITruncateToTokenLimitOptions.md#modelid)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/read-text-file-chunks.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/read-text-file-chunks.ts#L7)
-
-***
-
-### sentences?
-
-> `optional` **sentences**: `string`[]
-
-#### Inherited from
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`sentences`](ITruncateToTokenLimitOptions.md#sentences)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L7)
-
-***
-
-### size?
-
-> `optional` **size**: `number`
-
-#### Overrides
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`size`](ITruncateToTokenLimitOptions.md#size)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/read-text-file-chunks.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/read-text-file-chunks.ts#L6)
-
-***
-
-### truncLastSection?
-
-> `optional` **truncLastSection**: `boolean`
-
-#### Inherited from
-
-[`ITruncateToTokenLimitOptions`](ITruncateToTokenLimitOptions.md).[`truncLastSection`](ITruncateToTokenLimitOptions.md#trunclastsection)
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L11)

package/docs/interfaces/ITruncateToTokenLimitOptions.md

@@ -1,111 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / ITruncateToTokenLimitOptions
-
-# Interface: ITruncateToTokenLimitOptions
-
-## Extended by
-
-- [`IReadTextFileChunksOptions`](IReadTextFileChunksOptions.md)
-
-## Properties
-
-### best?
-
-> `optional` **best**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:8](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L8)
-
-***
-
-### bySentence?
-
-> `optional` **bySentence**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:4](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L4)
-
-***
-
-### completeSentence?
-
-> `optional` **completeSentence**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L9)
-
-***
-
-### corrected?
-
-> `optional` **corrected**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:10](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L10)
-
-***
-
-### countLLMTokens()?
-
-> `optional` **countLLMTokens**: (`text`, `modelId`?) => `Promise`\<`number`\>
-
-#### Parameters
-
-• **text**: `string`
-
-• **modelId?**: `string`
-
-#### Returns
-
-`Promise`\<`number`\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L12)
-
-***
-
-### modelId?
-
-> `optional` **modelId**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L6)
-
-***
-
-### sentences?
-
-> `optional` **sentences**: `string`[]
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:7](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L7)
-
-***
-
-### size?
-
-> `optional` **size**: `number`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:5](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L5)
-
-***
-
-### truncLastSection?
-
-> `optional` **truncLastSection**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/truncate-to-token-limit.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/truncate-to-token-limit.ts#L11)

package/docs/interfaces/JsonFilter.md

@@ -1,11 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / JsonFilter
-
-# Interface: JsonFilter
-
-## Indexable
-
- \[`key`: `string`\]: `any`

package/docs/interfaces/ParseObjectArgumentOptions.md

@@ -1,97 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / ParseObjectArgumentOptions
-
-# Interface: ParseObjectArgumentOptions
-
-## Properties
-
-### argProcessor?
-
-> `optional` **argProcessor**: `ArgProcessor`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:22](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L22)
-
-***
-
-### assigner?
-
-> `optional` **assigner**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:21](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L21)
-
-***
-
-### delimiter?
-
-> `optional` **delimiter**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:20](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L20)
-
-***
-
-### ignoreIndexNamed?
-
-> `optional` **ignoreIndexNamed**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:26](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L26)
-
-***
-
-### preserveUnresolvedName?
-
-> `optional` **preserveUnresolvedName**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:27](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L27)
-
-***
-
-### returnArrayOnly?
-
-> `optional` **returnArrayOnly**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:23](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L23)
-
-***
-
-### skipExpression?
-
-> `optional` **skipExpression**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:28](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L28)
-
-***
-
-### templateData?
-
-> `optional` **templateData**: `Record`\<`string`, `any`\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:25](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L25)
-
-***
-
-### templateFormat?
-
-> `optional` **templateFormat**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/parse-command.ts:24](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/parse-command.ts#L24)

package/docs/interfaces/PromptExampleSelectorOptions.md

@@ -1,36 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / PromptExampleSelectorOptions
-
-# Interface: PromptExampleSelectorOptions
-
-## Indexable
-
- \[`name`: `string`\]: `any`
-
-## Properties
-
-### maxLength?
-
-> `optional` **maxLength**: `number`
-
-The maximum count of the selected examples, or `undefined` if no limit.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:9](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L9)
-
-***
-
-### threshold?
-
-> `optional` **threshold**: `number` \| `boolean`
-
-The threshold probability (0-1) at which a sample is selected.
-If `true`, defaults to 0.5; if `false`, disable it.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L14)

package/docs/interfaces/PromptTemplateOptions.md

@@ -1,75 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / PromptTemplateOptions
-
-# Interface: PromptTemplateOptions
-
-## Extended by
-
-- [`FewShotPromptTemplateOptions`](FewShotPromptTemplateOptions.md)
-
-## Indexable
-
- \[`name`: `string`\]: `any`
-
-## Properties
-
-### compiledTemplate?
-
-> `optional` **compiledTemplate**: `any`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:15](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L15)
-
-***
-
-### data?
-
-> `optional` **data**: `Record`\<`string`, `any`\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:12](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L12)
-
-***
-
-### ignoreInitialize?
-
-> `optional` **ignoreInitialize**: `boolean`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:16](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L16)
-
-***
-
-### inputVariables?
-
-> `optional` **inputVariables**: `string`[]
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:14](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L14)
-
-***
-
-### template?
-
-> `optional` **template**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:11](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L11)
-
-***
-
-### templateFormat?
-
-> `optional` **templateFormat**: `string`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-template.ts:13](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-template.ts#L13)