@isdk/ai-tool 0.3.0 → 0.5.0

package/docs/functions/interpolateFString.md

@@ -1,27 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateFString
-
-# Function: interpolateFString()
-
-> **interpolateFString**(`nodes`, `values`): `string`
-
-Type that represents a function that takes a template string and a set
-of input values, and returns a string where all variables in the
-template have been replaced with their corresponding values.
-
-## Parameters
-
-• **nodes**: [`FStringPromptTemplateNode`](../type-aliases/FStringPromptTemplateNode.md)[]
-
-• **values**: `Record`\<`string`, `any`\>
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/template/python.ts:71](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/python.ts#L71)

package/docs/functions/interpolateGolangTemplate.md

@@ -1,31 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / interpolateGolangTemplate
-
-# Function: interpolateGolangTemplate()
-
-> **interpolateGolangTemplate**(`str`, `variables`, `initVars`?): `string`
-
-Parse and interpolate template
-
-## Parameters
-
-• **str**: `string`
-
-golang style template
-
-• **variables**: `Record`\<`string`, `any`\>
-
-object of variables to insert
-
-• **initVars?**: `boolean`
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/prompt/template/golang.ts:269](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/template/golang.ts#L269)

package/docs/functions/isLangUsingSpaces.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isLangUsingSpaces
-
-# Function: isLangUsingSpaces()
-
-> **isLangUsingSpaces**(`isoCode`): `boolean`
-
-## Parameters
-
-• **isoCode**: `string`
-
-## Returns
-
-`boolean`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:260](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L260)

package/docs/functions/isListItemString.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isListItemString
-
-# Function: isListItemString()
-
-> **isListItemString**(`text`): `null` \| `RegExpExecArray`
-
-## Parameters
-
-• **text**: `string`
-
-## Returns
-
-`null` \| `RegExpExecArray`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:223](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L223)

package/docs/functions/isModelNameMatched.md

@@ -1,45 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isModelNameMatched
-
-# Function: isModelNameMatched()
-
-> **isModelNameMatched**(`modelName`, `rule`?): `undefined` \| `string` \| `RegExpExecArray`
-
-Checks if the provided model name matches the given rule.
-
-## Parameters
-
-• **modelName**: `string`
-
-The name of the model to check.
-
-• **rule?**: [`AIModelNameRules`](../type-aliases/AIModelNameRules.md)
-
-An optional rule that can be a string, an array of strings, a regular expression, or a function.
-
-## Returns
-
-`undefined` \| `string` \| `RegExpExecArray`
-
-matched result if the model name matches the rule, undefined otherwise.
-
-## Example
-
-```ts
-IsModelNameMatched("gpt-3", "gpt-3") // returns true
-IsModelNameMatched("GPT-3", "gpt-3") // returns true
-IsModelNameMatched("GPT-3", ["gpt-3", "gpt-4"]) // returns true
-IsModelNameMatched("gpt-3", /^gpt-\d+$/) // returns true
-IsModelNameMatched("gpt-3", (modelName) => modelName.startsWith("gpt-")) // returns true
-IsModelNameMatched("gpt-2", "gpt-3") // returns false
-IsModelNameMatched("gpt-2", ["gpt-3", "gpt-4"]) // returns false
-IsModelNameMatched("gpt-2", /^gpt-\d+$/) // returns false
-IsModelNameMatched("gpt-2", (modelName) => modelName.startsWith("gpt-")) // returns false
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/is-model-name-matched.ts:21](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/is-model-name-matched.ts#L21)

package/docs/functions/isPunctuationChar.md

@@ -1,36 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isPunctuationChar
-
-# Function: isPunctuationChar()
-
-> **isPunctuationChar**(`char`): `boolean`
-
-Checks if the given character is a punctuation mark.
-This function supports both Chinese and English punctuation marks.
-
-## Parameters
-
-• **char**: `string`
-
-The character to check.
-
-## Returns
-
-`boolean`
-
-`true` if the character is a punctuation mark, otherwise `false`.
-
-## Example
-
-```typescript
-isPunctuationChar('。'); // returns true
-isPunctuationChar('!');  // returns true
-isPunctuationChar('a');  // returns false
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:245](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L245)

package/docs/functions/isRegExp.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isRegExp
-
-# Function: isRegExp()
-
-> **isRegExp**(`value`): `boolean`
-
-## Parameters
-
-• **value**: `any`
-
-## Returns
-
-`boolean`
-
-## Defined in
-
-[packages/ai-tool/src/utils/isRegExp.ts:3](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/isRegExp.ts#L3)

package/docs/functions/isSectionString.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isSectionString
-
-# Function: isSectionString()
-
-> **isSectionString**(`text`, `options`?): `null` \| `RegExpExecArray`
-
-## Parameters
-
-• **text**: `string`
-
-• **options?**: [`SectionStringOptions`](../interfaces/SectionStringOptions.md)
-
-## Returns
-
-`null` \| `RegExpExecArray`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:197](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L197)

package/docs/functions/isSentenceEnding.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isSentenceEnding
-
-# Function: isSentenceEnding()
-
-> **isSentenceEnding**(`text`): `boolean`
-
-## Parameters
-
-• **text**: `string`
-
-## Returns
-
-`boolean`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:187](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L187)

package/docs/functions/isSepLineString.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isSepLineString
-
-# Function: isSepLineString()
-
-> **isSepLineString**(`text`): `null` \| `RegExpExecArray`
-
-## Parameters
-
-• **text**: `string`
-
-## Returns
-
-`null` \| `RegExpExecArray`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:227](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L227)

package/docs/functions/isSubdirectory.md

@@ -1,39 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isSubdirectory
-
-# Function: isSubdirectory()
-
-> **isSubdirectory**(`parentDir`, `childDir`): `boolean`
-
-Determines whether the `childDir` is a subdirectory of `parentDir`.
-
-## Parameters
-
-• **parentDir**: `string`
-
-The directory to check as the potential parent.
-
-• **childDir**: `string`
-
-The directory to check as the potential child.
-
-## Returns
-
-`boolean`
-
-true if `childDir` is a subdirectory of `parentDir`, otherwise false.
-
-## Example
-
-```typescript
-const parentDir = '/usr/local';
-const childDir = '/usr/local/include';
-const result = isSubdirectory(parentDir, childDir); // true
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/has-directory-in.ts:17](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/has-directory-in.ts#L17)

package/docs/functions/isTitleString.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isTitleString
-
-# Function: isTitleString()
-
-> **isTitleString**(`text`, `options`?): `null` \| `RegExpExecArray`
-
-## Parameters
-
-• **text**: `string`
-
-• **options?**: [`SectionStringOptions`](../interfaces/SectionStringOptions.md)
-
-## Returns
-
-`null` \| `RegExpExecArray`
-
-## Defined in
-
-[packages/ai-tool/src/utils/split-sentence.ts:204](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/split-sentence.ts#L204)

package/docs/functions/isValidFilename.md

@@ -1,38 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isValidFilename
-
-# Function: isValidFilename()
-
-> **isValidFilename**(`filename`): `boolean` \| `""`
-
-Validates if a given string is a valid filename.
-
-## Parameters
-
-• **filename**: `string`
-
-The filename to be validated.
-
-## Returns
-
-`boolean` \| `""`
-
-True if the filename is valid, false otherwise.
-
-## Throws
-
-If the input is not a string.
-
-## Example
-
-```ts
-isValidFilename('myFile.txt'); // Returns true
-isValidFilename('my<file.txt'); // Returns false
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:63](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/filename.ts#L63)

package/docs/functions/isValidFilepath.md

@@ -1,27 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isValidFilepath
-
-# Function: isValidFilepath()
-
-> **isValidFilepath**(`filepath`): `boolean`
-
-Validates whether the given filepath is valid.
-
-## Parameters
-
-• **filepath**: `string`
-
-The filepath to be checked, represented as a string.
-
-## Returns
-
-`boolean`
-
-A boolean indicating whether the filepath is valid. Returns true if valid; false otherwise.
-
-## Defined in
-
-[packages/ai-tool/src/utils/filename.ts:72](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/filename.ts#L72)

package/docs/functions/isWebStream.md

@@ -1,21 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / isWebStream
-
-# Function: isWebStream()
-
-> **isWebStream**(`val`): val is ReadableStream\<any\> \| WritableStream\<any\>
-
-## Parameters
-
-• **val**: `any`
-
-## Returns
-
-val is ReadableStream\<any\> \| WritableStream\<any\>
-
-## Defined in
-
-[packages/ai-tool/src/utils/stream/is-web-stream.ts:1](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/stream/is-web-stream.ts#L1)

package/docs/functions/jsonFilterToWhere.md

@@ -1,45 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / jsonFilterToWhere
-
-# Function: jsonFilterToWhere()
-
-> **jsonFilterToWhere**(`filter`, `wrapKey`?): `string`
-
-Converts a filter object to a SQLite WHERE clause.
-
-## Parameters
-
-• **filter**: [`JsonFilter`](../interfaces/JsonFilter.md) \| [`JsonFilter`](../interfaces/JsonFilter.md)[]
-
-The filter object to convert.
-
-• **wrapKey?**
-
-## Returns
-
-`string`
-
-The generated WHERE clause.
-
-## Example
-
-```ts
-const jsonFilter: Filter = {
-  $and: [
-    { age: { $gt: 18, $lt: 30 } },
-    { name: { $like: 'John%', $nlike: 'Doe%' } },
-    { hobbies: { $in: ['reading', 'writing'] } },
-    { $or: [{ gender: 'male' }, { country: 'USA' }] },
-    { $and: [{ status: 'active' }, { registered: new Date('2020-01-01') }] },
-  ],
-};
-
-console.log(jsonFilterToWhere(jsonFilter)); // Outputs a WHERE clause based on the given filter
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/json-filter.ts:123](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/json-filter.ts#L123)

package/docs/functions/jsonToMarkdownStr.md

@@ -1,31 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / jsonToMarkdownStr
-
-# Function: jsonToMarkdownStr()
-
-> **jsonToMarkdownStr**(`mem`, `options`?): `string`
-
-## Parameters
-
-• **mem**: `any`
-
-• **options?**
-
-• **options.arrayTag?**: `string`
-
-• **options.level?**: `number`
-
-• **options.objectTag?**: `string`
-
-• **options.visiting?**: `Set`\<`any`\>
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/json-to-markdown-str.ts:2](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/json-to-markdown-str.ts#L2)

package/docs/functions/loadFileFromPaths.md

@@ -1,54 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / loadFileFromPaths
-
-# Function: loadFileFromPaths()
-
-> **loadFileFromPaths**(`filename`, `searchPaths`?, `extNames`?, `options`?): `Buffer`
-
-Loads a file from given paths, optionally searching for specific extensions.
-
-## Parameters
-
-• **filename**: `string`
-
-The base filename to search for, without any file extension.
-
-• **searchPaths?**: `string`[]
-
-An array of directories to search for the file. Defaults to the current directory (`"."`) if not provided.
-
-• **extNames?**: `string`[]
-
-An array of file extensions to try, in order of preference. If not provided, the file will be searched for
-                  without any extension.
-
-• **options?**
-
-• **options.exclude?**: `string` \| `string`[]
-
-• **options.filepath?**: `string`
-
-• **options.signal?**: `AbortSignal`
-
-## Returns
-
-`Buffer`
-
-The contents of the found file as a Buffer.
-
-## Throws
-
-If the file is not found in any of the search paths.
-
-## Example
-
-```typescript
-const content = loadFileFromPaths('config', ['/etc', '/usr/local/etc'], ['.json', '.yaml']);
-```
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:44](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L44)

package/docs/functions/loadTextFromPaths.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / loadTextFromPaths
-
-# Function: loadTextFromPaths()
-
-> **loadTextFromPaths**(`filename`, `searchPaths`?, `extNames`?, `options`?, `exclude`?): `string`
-
-## Parameters
-
-• **filename**: `string`
-
-• **searchPaths?**: `string`[]
-
-• **extNames?**: `string`[]
-
-• **options?**: `BufferEncoding` \| `object`
-
-• **exclude?**: `string` \| `string`[]
-
-## Returns
-
-`string`
-
-## Defined in
-
-[packages/ai-tool/src/utils/load-file-from-paths.ts:101](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/load-file-from-paths.ts#L101)

package/docs/functions/lrucache.md

@@ -1,29 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / \_lrucache
-
-# Function: \_lrucache()
-
-> **\_lrucache**(`this`, `__namedParameters`): `_Cache`
-
-## Parameters
-
-• **this**: [`ToolFunc`](../classes/ToolFunc.md)
-
-• **\_\_namedParameters** = `{}`
-
-• **\_\_namedParameters.key?**: `string`
-
-• **\_\_namedParameters.options?**: `number` \| `ICacheOptions`
-
-• **\_\_namedParameters.value?**: `any`
-
-## Returns
-
-`_Cache`
-
-## Defined in
-
-[packages/ai-tool/src/funcs/lrucache.ts:6](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/funcs/lrucache.ts#L6)

package/docs/functions/makeToolFuncCancelable.md

@@ -1,23 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / makeToolFuncCancelable
-
-# Function: makeToolFuncCancelable()
-
-> **makeToolFuncCancelable**(`Tool`, `options`?): *typeof* [`ToolFunc`](../classes/ToolFunc.md)
-
-## Parameters
-
-• **Tool**: *typeof* [`ToolFunc`](../classes/ToolFunc.md)
-
-• **options?**: [`CancelableAbilityOptions`](../interfaces/CancelableAbilityOptions.md)
-
-## Returns
-
-*typeof* [`ToolFunc`](../classes/ToolFunc.md)
-
-## Defined in
-
-[packages/ai-tool/src/utils/cancelable-ability.ts:340](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/cancelable-ability.ts#L340)