@isdk/ai-tool 0.5.2 → 0.5.4

package/docs/functions/saveConfigFile.md

@@ -0,0 +1,29 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / saveConfigFile
+
+# Function: saveConfigFile()
+
+> **saveConfigFile**(`filename`, `config`, `extLevel`): `string`
+
+Defined in: [packages/ai-tool/src/utils/config.ts:114](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/config.ts#L114)
+
+## Parameters
+
+### filename
+
+`string`
+
+### config
+
+`any`
+
+### extLevel
+
+`number` = `1`
+
+## Returns
+
+`string`

package/docs/functions/scaleStrToParamsSize.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / scaleStrToParamsSize
+
+# Function: scaleStrToParamsSize()
+
+> **scaleStrToParamsSize**(`scale`): `number`
+
+Defined in: [packages/ai-tool/src/utils/convert-params-size.ts:44](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/convert-params-size.ts#L44)
+
+Converts a formatted parameters size string (with units T, B, M, or K) back to its byte value.
+
+## Parameters
+
+### scale
+
+`string`
+
+The formatted parameter size string (e.g., "1.23B", "456M", "789K", or "123").
+
+## Returns
+
+`number`
+
+The parameter size in bytes.

package/docs/functions/shutdown.md

@@ -0,0 +1,33 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / shutdown
+
+# Function: shutdown()
+
+> **shutdown**(`signalOrEvent`, `exitCode`): `Promise`\<`undefined`\>
+
+Defined in: [packages/ai-tool/src/utils/node/before-shutdown.ts:64](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/node/before-shutdown.ts#L64)
+
+Main process shutdown handler. Will invoke every previously registered async shutdown listener
+in the queue and exit with a code of `0`. Any `Promise` rejections from any listener will
+be logged out as a warning, but won't prevent other callbacks from executing.
+
+## Parameters
+
+### signalOrEvent
+
+The exit signal or event name received on the process, defaults to shutdown.
+
+`string` | `number`
+
+### exitCode
+
+The optional exit code, defaults to 0.
+
+`null` | `string` | `number`
+
+## Returns
+
+`Promise`\<`undefined`\>

package/docs/functions/simplifyObjectArguments.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / simplifyObjectArguments
+
+# Function: simplifyObjectArguments()
+
+> **simplifyObjectArguments**(`args`): `any`
+
+Defined in: [packages/ai-tool/src/utils/parse-command.ts:121](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/parse-command.ts#L121)
+
+## Parameters
+
+### args
+
+`any`
+
+## Returns
+
+`any`

package/docs/functions/sortedValues.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / sortedValues
+
+# Function: sortedValues()
+
+> **sortedValues**\<`T`\>(`values`): `T`[]
+
+Defined in: [packages/ai-tool/src/utils/prompt/few-shot-prompt-template.ts:4](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/prompt/few-shot-prompt-template.ts#L4)
+
+## Type Parameters
+
+• **T**
+
+## Parameters
+
+### values
+
+`Record`\<`string`, `T`\>
+
+## Returns
+
+`T`[]

package/docs/functions/splitChunks.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / splitChunks
+
+# Function: splitChunks()
+
+> **splitChunks**(`content`, `options`?): `Promise`\<`string`[][]\>
+
+Defined in: [packages/ai-tool/src/utils/read-text-file-chunks.ts:182](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/read-text-file-chunks.ts#L182)
+
+## Parameters
+
+### content
+
+`string`
+
+### options?
+
+[`IReadTextFileChunksOptions`](../interfaces/IReadTextFileChunksOptions.md)
+
+## Returns
+
+`Promise`\<`string`[][]\>

package/docs/functions/splitParagraph.md

@@ -0,0 +1,34 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / splitParagraph
+
+# Function: splitParagraph()
+
+> **splitParagraph**(`value`, `options`?): `string`[][]
+
+Defined in: [packages/ai-tool/src/utils/split-paragraph.ts:12](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/split-paragraph.ts#L12)
+
+Splits the input string into paragraphs based on empty lines and title lines.
+Each paragraph is represented as an array of strings, where each string is a line in the paragraph.
+
+## Parameters
+
+### value
+
+`string`
+
+The input string to be split into paragraphs.
+
+### options?
+
+[`SplitSentenceOptions`](../interfaces/SplitSentenceOptions.md)
+
+Optional configuration options for splitting the string.
+
+## Returns
+
+`string`[][]
+
+A two-dimensional array where each sub-array represents a paragraph.

package/docs/functions/splitSentence.md

@@ -0,0 +1,39 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / splitSentence
+
+# Function: splitSentence()
+
+> **splitSentence**(`text`, `best`): `string`[]
+
+Defined in: [packages/ai-tool/src/utils/split-sentence.ts:44](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/split-sentence.ts#L44)
+
+Splits a text into sentences.
+This function is used to split a text into separate sentences, based on punctuation marks such as '.', '?', or '!' and other rules.
+
+## Parameters
+
+### text
+
+`string`
+
+The input string that needs to be split into sentences.
+
+### best
+
+[`SplitSentenceOptions`](../interfaces/SplitSentenceOptions.md) = `{}`
+
+A boolean flag indicating if the function should use the best possible sentence splitting method (default is true).
+If set to false, it will not perform any additional processing and simply split on newline characters ('\n').
+
+## Returns
+
+`string`[]
+
+An array of strings where each string represents a sentence in the input text.
+
+Example:
+const text = "Hello world! How are you today? I am fine.";
+console.log(splitSentence(text));  // returns ['Hello world!', 'How are you today?', 'I am fine.']

package/docs/functions/stringifyYaml.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / stringifyYaml
+
+# Function: stringifyYaml()
+
+> **stringifyYaml**(`content`, `options`?): `string`
+
+Defined in: [packages/ai-tool/src/utils/config.ts:42](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/config.ts#L42)
+
+## Parameters
+
+### content
+
+`any`
+
+### options?
+
+`DocumentOptions` & `SchemaOptions` & `ParseOptions` & `CreateNodeOptions` & `ToStringOptions`
+
+## Returns
+
+`string`

package/docs/functions/stripConsoleColor.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / stripConsoleColor
+
+# Function: stripConsoleColor()
+
+> **stripConsoleColor**(`str`): `any`
+
+Defined in: [packages/ai-tool/src/utils/strip-console-color.ts:1](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/strip-console-color.ts#L1)
+
+## Parameters
+
+### str
+
+`any`
+
+## Returns
+
+`any`

package/docs/functions/textToDate.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / textToDate
+
+# Function: textToDate()
+
+> **textToDate**(`date`, `format`): `Date`
+
+Defined in: [packages/ai-tool/src/utils/to-datetime.ts:25](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/to-datetime.ts#L25)
+
+## Parameters
+
+### date
+
+`string`
+
+### format
+
+`string` = `FormatDateStr`
+
+## Returns
+
+`Date`

package/docs/functions/throwError.md

@@ -0,0 +1,41 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / throwError
+
+# Function: throwError()
+
+> **throwError**(`message`, `name`?, `status`?): `void`
+
+Defined in: node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:161
+
+Throw an error
+
+## Parameters
+
+### message
+
+`string`
+
+Error message
+
+### name?
+
+Error name, optional
+
+`string` | `Record`\<`string`, `any`\>
+
+### status?
+
+Error status code, default to 500
+
+`string` | `number`
+
+## Returns
+
+`void`
+
+## Throws
+
+Throws a BaseError object

package/docs/functions/toDate.md

@@ -0,0 +1,74 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / toDate
+
+# Function: toDate()
+
+> **toDate**\<`DateType`, `ResultDate`\>(`argument`, `context`?): `ResultDate`
+
+Defined in: node\_modules/.pnpm/date-fns@4.1.0/node\_modules/date-fns/toDate.d.ts:40
+
+## Type Parameters
+
+• **DateType** *extends* `Date` \| `ConstructableDate`
+
+The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
+
+• **ResultDate** *extends* `Date` = `DateType`
+
+The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
+
+## Parameters
+
+### argument
+
+`DateArg`\<`DateType`\>
+
+The value to convert
+
+### context?
+
+`ContextFn`\<`ResultDate`\>
+
+## Returns
+
+`ResultDate`
+
+The parsed date in the local time zone
+
+## Name
+
+toDate
+
+## Description
+
+Convert the given argument to an instance of Date.
+
+If the argument is an instance of Date, the function returns its clone.
+
+If the argument is a number, it is treated as a timestamp.
+
+If the argument is none of the above, the function returns Invalid Date.
+
+Starting from v3.7.0, it clones a date using `[Symbol.for("constructDateFrom")]`
+enabling to transfer extra properties from the reference date to the new date.
+It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
+that accept a time zone as a constructor argument.
+
+**Note**: *all* Date arguments passed to any *date-fns* function is processed by `toDate`.
+
+## Examples
+
+```ts
+// Clone the date:
+const result = toDate(new Date(2014, 1, 11, 11, 30, 30))
+//=> Tue Feb 11 2014 11:30:30
+```
+
+```ts
+// Convert the timestamp to date:
+const result = toDate(1392098430000)
+//=> Tue Feb 11 2014 11:30:30
+```

package/docs/functions/toDateTime.md

@@ -0,0 +1,21 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / toDateTime
+
+# Function: toDateTime()
+
+> **toDateTime**(`date`): `undefined` \| `Date`
+
+Defined in: [packages/ai-tool/src/utils/to-datetime.ts:9](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/to-datetime.ts#L9)
+
+## Parameters
+
+### date
+
+`string` | `number` | `Date`
+
+## Returns
+
+`undefined` \| `Date`

package/docs/functions/toRegExp.md

@@ -0,0 +1,34 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / toRegExp
+
+# Function: toRegExp()
+
+> **toRegExp**(`value`): `RegExp`
+
+Defined in: node\_modules/.pnpm/util-ex@2.2.1/node\_modules/util-ex/lib/to-regexp.d.ts:9
+
+create or clone RegExp
+
+## Parameters
+
+### value
+
+create a new RegExp from.
+
+`string` | `RegExp`
+
+## Returns
+
+`RegExp`
+
+- new RegExp instance.
+
+## Example
+
+```ts
+toRegExp('/[a-z]/g') // new RegExp(/[a-z]/g)
+toRegExp(/[a-z]/g)  // new RegExp(/[a-z]/g)
+```

package/docs/functions/trimStartOfStreamHelper.md

@@ -0,0 +1,41 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / trimStartOfStreamHelper
+
+# Function: trimStartOfStreamHelper()
+
+> **trimStartOfStreamHelper**(): (`text`) => `string`
+
+Defined in: [packages/ai-tool/src/utils/stream/ai-stream.ts:90](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/stream/ai-stream.ts#L90)
+
+Returns a stateful function that, when invoked, trims leading whitespace
+from the input text. The trimming only occurs on the first invocation, ensuring that
+subsequent calls do not alter the input text. This is particularly useful in scenarios
+where a text stream is being processed and only the initial whitespace should be removed.
+
+## Returns
+
+`Function`
+
+A function that takes a string as input and returns a string
+with leading whitespace removed if it is the first invocation; otherwise, it returns the input unchanged.
+
+### Parameters
+
+#### text
+
+`string`
+
+### Returns
+
+`string`
+
+## Example
+
+```ts
+const trimStart = trimStartOfStreamHelper();
+const output1 = trimStart("   text"); // "text"
+const output2 = trimStart("   text"); // "   text"
+```

package/docs/functions/truncTo.md

@@ -0,0 +1,51 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / truncTo
+
+# Function: truncTo()
+
+> **truncTo**(`n`, `dec`, `up`): `number`
+
+Defined in: [packages/ai-tool/src/utils/trunc-to.ts:19](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/trunc-to.ts#L19)
+
+Truncates(Round) a number to a specified number of decimal places.
+
+## Parameters
+
+### n
+
+`number`
+
+The number to truncate.
+
+### dec
+
+`number` = `2`
+
+The number of decimal places to truncate to (default is 2).
+
+### up
+
+`number` = `0.5`
+
+The amount to round up by before truncating (default is 0.5).
+
+## Returns
+
+`number`
+
+The truncated number.
+
+## Examples
+
+```ts
+// returns 1.235
+truncTo(1.2345, 3)
+```
+
+```ts
+// returns 1.24
+truncTo(1.2345, 2, 0.6)
+```

package/docs/functions/truncateByToken.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / truncateByToken
+
+# Function: truncateByToken()
+
+> **truncateByToken**(`content`, `options`?): `Promise`\<`void`\>
+
+Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:164](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L164)
+
+## Parameters
+
+### content
+
+`string`
+
+### options?
+
+[`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/functions/truncateToTokenLimit.md

@@ -0,0 +1,46 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / truncateToTokenLimit
+
+# Function: truncateToTokenLimit()
+
+> **truncateToTokenLimit**(`content`, `options`?): `Promise`\<`string`\>
+
+Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:31](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L31)
+
+Truncates the given content to fit within a specified token limit by removing sentences from the end.
+This function is suitable for text content with multiple sentences.
+
+## Parameters
+
+### content
+
+`string`
+
+The original text content to be processed.
+
+### options?
+
+[`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
+
+Optional configuration including model ID and size limit.
+
+## Returns
+
+`Promise`\<`string`\>
+
+The truncated text content.
+
+## Example
+
+```typescript
+const text = "This is an example text that will be truncated to fit within the token limit. It contains multiple sentences. Each sentence will be removed until the content fits within the specified token limit. This is the fourth sentence. This is the fifth sentence.";
+const truncatedText = await truncateToTokenLimit(text, { modelId: "exampleModel", size: 50 });
+console.log(truncatedText); // Output may be the truncated text
+```
+
+## Warning
+
+This function is designed for text content with multiple sentences.

package/docs/functions/truncateToTokenLimitEx.md

@@ -0,0 +1,25 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / truncateToTokenLimitEx
+
+# Function: truncateToTokenLimitEx()
+
+> **truncateToTokenLimitEx**(`sentences`, `options`?): `Promise`\<`string`[]\>
+
+Defined in: [packages/ai-tool/src/utils/truncate-to-token-limit.ts:111](https://github.com/isdk/ai-tool.js/blob/7135b3a67072644f21685b76900b7f351401749e/src/utils/truncate-to-token-limit.ts#L111)
+
+## Parameters
+
+### sentences
+
+`string`[]
+
+### options?
+
+[`ITruncateToTokenLimitOptions`](../interfaces/ITruncateToTokenLimitOptions.md)
+
+## Returns
+
+`Promise`\<`string`[]\>