@isdk/ai-tool 0.3.0 → 0.5.0

package/docs/classes/NotImplementationError.md

@@ -1,348 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / NotImplementationError
-
-# Class: NotImplementationError
-
-Represents an error when a function or method is not implemented.
-Inherits from BaseError.
-
-## Example
-
-```ts
-throw new NotImplementationError()
-```
-
-## Extends
-
-- [`CommonError`](CommonError.md)
-
-## Constructors
-
-### new NotImplementationError()
-
-> **new NotImplementationError**(`msg`?, `name`?): [`NotImplementationError`](NotImplementationError.md)
-
-#### Parameters
-
-• **msg?**: `string`
-
-• **name?**: `string` \| `Record`\<`string`, `any`\>
-
-#### Returns
-
-[`NotImplementationError`](NotImplementationError.md)
-
-#### Overrides
-
-[`CommonError`](CommonError.md).[`constructor`](CommonError.md#constructors)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:114
-
-## Properties
-
-### caller
-
-> **caller**: `string`
-
-The name of the function that threw the error.
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`caller`](CommonError.md#caller)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:63
-
-***
-
-### cause?
-
-> `optional` **cause**: `unknown`
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`cause`](CommonError.md#cause)
-
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:24
-
-***
-
-### code
-
-> **code**: `ErrorCodeType`
-
-the error code
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`code`](CommonError.md#code)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:64
-
-***
-
-### data?
-
-> `optional` **data**: `any`
-
-Additional data associated with the error.
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`data`](CommonError.md#data)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:65
-
-***
-
-### message
-
-> **message**: `string`
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`message`](CommonError.md#message)
-
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
-
-***
-
-### name
-
-> **name**: `string`
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`name`](CommonError.md#name)
-
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1076
-
-***
-
-### stack?
-
-> `optional` **stack**: `string`
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`stack`](CommonError.md#stack)
-
-#### Defined in
-
-node\_modules/.pnpm/typescript@5.6.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
-
-***
-
-### code
-
-> `static` **code**: `ErrorCodeType`
-
-The error code associated with the error.
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`code`](CommonError.md#code-1)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:62
-
-***
-
-### prepareStackTrace()?
-
-> `static` `optional` **prepareStackTrace**: (`err`, `stackTraces`) => `any`
-
-Optional override for formatting stack traces
-
-#### Parameters
-
-• **err**: `Error`
-
-• **stackTraces**: `CallSite`[]
-
-#### Returns
-
-`any`
-
-#### See
-
-https://v8.dev/docs/stack-trace-api#customizing-stack-traces
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`prepareStackTrace`](CommonError.md#preparestacktrace)
-
-#### Defined in
-
-node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:143
-
-***
-
-### stackTraceLimit
-
-> `static` **stackTraceLimit**: `number`
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`stackTraceLimit`](CommonError.md#stacktracelimit)
-
-#### Defined in
-
-node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:145
-
-## Methods
-
-### fromJSON()
-
-> **fromJSON**(`json`): [`BaseError`](BaseError.md)
-
-Creates a new BaseError instance from a JSON representation.
-
-#### Parameters
-
-• **json**: `any`
-
-A JSON representation of the error.
-
-#### Returns
-
-[`BaseError`](BaseError.md)
-
-A new BaseError instance.
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`fromJSON`](CommonError.md#fromjson)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:93
-
-***
-
-### toJSON()
-
-> **toJSON**(): `any`
-
-Returns a JSON representation of the error.
-
-#### Returns
-
-`any`
-
-A JSON representation of the error.
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`toJSON`](CommonError.md#tojson)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:86
-
-***
-
-### captureStackTrace()
-
-> `static` **captureStackTrace**(`targetObject`, `constructorOpt`?): `void`
-
-Create .stack property on a target object
-
-#### Parameters
-
-• **targetObject**: `object`
-
-• **constructorOpt?**: `Function`
-
-#### Returns
-
-`void`
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`captureStackTrace`](CommonError.md#capturestacktrace)
-
-#### Defined in
-
-node\_modules/.pnpm/@types+node@22.7.6/node\_modules/@types/node/globals.d.ts:136
-
-***
-
-### create()
-
-> `static` **create**(`__namedParameters`): [`CommonError`](CommonError.md)
-
-#### Parameters
-
-• **\_\_namedParameters**
-
-• **\_\_namedParameters.code?**: `string` \| `number`
-
-• **\_\_namedParameters.data?**: `any`
-
-• **\_\_namedParameters.error**: `string`
-
-• **\_\_namedParameters.name?**: `string`
-
-#### Returns
-
-[`CommonError`](CommonError.md)
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`create`](CommonError.md#create)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:96
-
-***
-
-### createErrorClass()
-
-> `static` **createErrorClass**(`aType`, `aErrorCode`?, `ParentErrorClass`?): *typeof* [`BaseError`](BaseError.md)
-
-Create an Error Class
-
-#### Parameters
-
-• **aType**: `string`
-
-the error type(class) name
-
-• **aErrorCode?**: `string` \| `number` \| *typeof* `AbstractError`
-
-• **ParentErrorClass?**: *typeof* [`BaseError`](BaseError.md)
-
-the parent error class. defaults to AbstractError
-
-#### Returns
-
-*typeof* [`BaseError`](BaseError.md)
-
-the new Error Class
-
-#### Inherited from
-
-[`CommonError`](CommonError.md).[`createErrorClass`](CommonError.md#createerrorclass)
-
-#### Defined in
-
-node\_modules/.pnpm/@isdk+common-error@0.1.3/node\_modules/@isdk/common-error/dist/index.d.ts:66

package/docs/classes/PromptExampleSelector.md

@@ -1,195 +0,0 @@
-[**@isdk/ai-tool**](../README.md) • **Docs**
-
-***
-
-[@isdk/ai-tool](../globals.md) / PromptExampleSelector
-
-# Class: PromptExampleSelector\<T\>
-
-The `PromptExampleSelector` class provides a mechanism to selectively choose examples from a given set based on
-configurable options such as maximum length and probability threshold. This class is meant to be extended and customized
-with an implementation of the `selectExample` method.
-
-## Example
-
-```ts
-// Custom selector that selects examples based on a custom condition
-class MyPromptExampleSelector extends PromptExampleSelector<string> {
-  selectExample(example: string, threshold?: number): string | void {
-    if (example.includes('keyword')) {
-      return super.selectExample(example, threshold);
-    }
-  }
-}
-
-// Create an instance with examples and options
-const examples = ['example1', 'keyword1', 'keyword2', 'keyword3', 'example2', 'keyword4'];
-const selector = new MyPromptExampleSelector(examples, { maxLength: 2, threshold: 0.8 });
-
-// Iterate through selected examples
-for await (const selectedExample of selector) {
-  console.log(selectedExample);
-}
-```
-
-## Type Parameters
-
-• **T** = `any`
-
-The type of the prompt examples.
-
-## Constructors
-
-### new PromptExampleSelector()
-
-> **new PromptExampleSelector**\<`T`\>(`examples`, `options`?): [`PromptExampleSelector`](PromptExampleSelector.md)\<`T`\>
-
-Constructs a new `PromptExampleSelector` instance with the given examples and options.
-
-#### Parameters
-
-• **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
-
-The prompt examples to select from.
-
-• **options?**: [`PromptExampleSelectorOptions`](../interfaces/PromptExampleSelectorOptions.md)
-
-An optional configuration object.
-
-#### Returns
-
-[`PromptExampleSelector`](PromptExampleSelector.md)\<`T`\>
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:62](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L62)
-
-## Properties
-
-### examples
-
-> **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
-
-The collection of prompt examples.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:55](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L55)
-
-***
-
-### maxLength
-
-> **maxLength**: `undefined` \| `number`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:47](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L47)
-
-***
-
-### threshold
-
-> **threshold**: `undefined` \| `number`
-
-The probability threshold (0-1) for selecting an example. If `undefined`, no filtering by probability occurs.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:51](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L51)
-
-## Methods
-
-### \[asyncIterator\]()
-
-> **\[asyncIterator\]**(): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
-
-Returns an asynchronous iterator for the selected examples.
-
-#### Returns
-
-`AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
-
-An asynchronous iterator over the selected examples.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:119](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L119)
-
-***
-
-### initialize()
-
-> **initialize**(`examples`, `options`?): `void`
-
-Initializes the selector with examples and options.
-
-#### Parameters
-
-• **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\>
-
-The prompt examples to select from.
-
-• **options?**: [`PromptExampleSelectorOptions`](../interfaces/PromptExampleSelectorOptions.md)
-
-An optional configuration object.
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:71](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L71)
-
-***
-
-### selectExample()
-
-> **selectExample**(`example`, `threshold`?): `void` \| `T`
-
-Select an example. Can overwrite this in subclasses.
-
-#### Parameters
-
-• **example**: `T`
-
-The example to potentially select.
-
-• **threshold?**: `number`
-
-report the current probability [0-1) for the selecting example.
-
-#### Returns
-
-`void` \| `T`
-
-The selected example, or `undefined` if not selected.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:92](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L92)
-
-***
-
-### selectExamples()
-
-> **selectExamples**(`examples`): `AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
-
-Asynchronously selects examples from the given examples, applying the configured threshold (if any).
-
-#### Parameters
-
-• **examples**: [`PromptExamples`](../type-aliases/PromptExamples.md)\<`T`\> = `...`
-
-The examples to select from. Defaults to the selector's examples if not provided.
-
-#### Returns
-
-`AsyncGenerator`\<`Awaited`\<`T`\>, `void`, `unknown`\>
-
-An asynchronous iterator yielding selected examples.
-
-#### Defined in
-
-[packages/ai-tool/src/utils/prompt/prompt-example-selector.ts:103](https://github.com/isdk/ai-tool.js/blob/e324043799402aa2caa41711a9168487ab85c166/src/utils/prompt/prompt-example-selector.ts#L103)