@isdk/ai-tool 0.5.8 → 0.7.0

package/docs/api/interfaces/IServerToolTransport.md

@@ -0,0 +1,159 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / IServerToolTransport
+
+# Interface: IServerToolTransport
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:9](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L9)
+
+Defines the public interface for a server-side transport,
+responsible for exposing ServerTools to the network.
+
+## Extends
+
+- [`IToolTransport`](IToolTransport.md)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### apiRoot
+
+> **apiRoot**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:22](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L22)
+
+The root endpoint for the remote service.
+For HTTP, this is a URL. For IPC, it could be a channel name.
+
+#### Inherited from
+
+[`IToolTransport`](IToolTransport.md).[`apiRoot`](IToolTransport.md#apiroot)
+
+***
+
+### options?
+
+> `optional` **options**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:26](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L26)
+
+Additional options for the transport start or fetch, passed by mount.
+
+#### Inherited from
+
+[`IToolTransport`](IToolTransport.md).[`options`](IToolTransport.md#options)
+
+***
+
+### Tools
+
+> **Tools**: *typeof* [`ToolFunc`](../classes/ToolFunc.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:17](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L17)
+
+#### Inherited from
+
+[`IToolTransport`](IToolTransport.md).[`Tools`](IToolTransport.md#tools)
+
+## Methods
+
+### getRaw()?
+
+> `optional` **getRaw**(): `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:34](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L34)
+
+Gets the underlying raw server instance.
+
+#### Returns
+
+`any`
+
+***
+
+### mount()
+
+> **mount**(`serverTools`, `apiPrefix`?, `options`?): `void`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:16](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L16)
+
+Mounts the ServerTools registry, creating the necessary API routes.
+
+#### Parameters
+
+##### serverTools
+
+*typeof* [`ServerTools`](../classes/ServerTools.md)
+
+The ServerTools class.
+
+##### apiPrefix?
+
+`string`
+
+An optional prefix for all API routes.
+
+##### options?
+
+`any`
+
+Additional options for the transport start.
+
+#### Returns
+
+`void`
+
+#### Overrides
+
+[`IToolTransport`](IToolTransport.md).[`mount`](IToolTransport.md#mount)
+
+***
+
+### start()
+
+> **start**(`options`?): `Promise`\<`any`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:22](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L22)
+
+Starts the transport layer, making it listen for incoming connections.
+
+#### Parameters
+
+##### options?
+
+`any`
+
+Protocol-specific options (e.g., { port, host }).
+
+#### Returns
+
+`Promise`\<`any`\>
+
+***
+
+### stop()
+
+> **stop**(`force`?): `Promise`\<`void`\>
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/server.ts:29](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/server.ts#L29)
+
+Stops the server instance gracefully.
+
+#### Parameters
+
+##### force?
+
+`boolean`
+
+Optional flag to force shutdown immediately
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Promise<void> when server is fully stopped

package/docs/api/interfaces/IToolTransport.md

@@ -0,0 +1,73 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / IToolTransport
+
+# Interface: IToolTransport
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:16](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L16)
+
+## Extended by
+
+- [`IClientToolTransport`](IClientToolTransport.md)
+- [`IServerToolTransport`](IServerToolTransport.md)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### apiRoot
+
+> **apiRoot**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:22](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L22)
+
+The root endpoint for the remote service.
+For HTTP, this is a URL. For IPC, it could be a channel name.
+
+***
+
+### options?
+
+> `optional` **options**: `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:26](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L26)
+
+Additional options for the transport start or fetch, passed by mount.
+
+***
+
+### Tools
+
+> **Tools**: *typeof* [`ToolFunc`](../classes/ToolFunc.md)
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:17](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L17)
+
+## Methods
+
+### mount()
+
+> **mount**(`Tools`, `apiRoot`?, `options`?): `any`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/base.ts:28](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/base.ts#L28)
+
+#### Parameters
+
+##### Tools
+
+*typeof* [`ToolFunc`](../classes/ToolFunc.md)
+
+##### apiRoot?
+
+`string`
+
+##### options?
+
+`any`
+
+#### Returns
+
+`any`

package/docs/api/interfaces/ITruncateToTokenLimitOptions.md

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

package/docs/api/interfaces/JsonFilter.md

@@ -0,0 +1,13 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / JsonFilter
+
+# Interface: JsonFilter
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/json-filter.ts:1](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/json-filter.ts#L1)
+
+## Indexable
+
+\[`key`: `string`\]: `any`

package/docs/api/interfaces/ParseObjectArgumentOptions.md

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

package/docs/api/interfaces/ProbabilityItem.md

@@ -0,0 +1,41 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / ProbabilityItem
+
+# Interface: ProbabilityItem
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:1](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/calc-perplexity.ts#L1)
+
+## Properties
+
+### id?
+
+> `optional` **id**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:5](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/calc-perplexity.ts#L5)
+
+The id of the token.
+
+***
+
+### probability
+
+> **probability**: `number`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:16](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/calc-perplexity.ts#L16)
+
+The natural logarithm of the probability (log probability) assigned to this token.
+Using log probabilities helps prevent numerical underflow when multiplying
+many small probabilities together in language model calculations.
+
+***
+
+### token
+
+> **token**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/utils/calc-perplexity.ts:9](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/utils/calc-perplexity.ts#L9)
+
+The token string being analyzed

package/docs/api/interfaces/PromptExampleSelectorOptions.md

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

package/docs/api/interfaces/PromptTemplateOptions.md

@@ -0,0 +1,73 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / PromptTemplateOptions
+
+# Interface: PromptTemplateOptions
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:13
+
+## Extended by
+
+- [`FewShotPromptTemplateOptions`](FewShotPromptTemplateOptions.md)
+
+## Indexable
+
+\[`name`: `string`\]: `any`
+
+## Properties
+
+### compiledTemplate?
+
+> `optional` **compiledTemplate**: `any`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:18
+
+***
+
+### data?
+
+> `optional` **data**: `Record`\<`string`, `any`\>
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:15
+
+***
+
+### ignoreInitialize?
+
+> `optional` **ignoreInitialize**: `boolean`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:19
+
+***
+
+### index?
+
+> `optional` **index**: `number`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:20
+
+***
+
+### inputVariables?
+
+> `optional` **inputVariables**: `string`[]
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:17
+
+***
+
+### template?
+
+> `optional` **template**: `string`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:14
+
+***
+
+### templateFormat?
+
+> `optional` **templateFormat**: `string`
+
+Defined in: @isdk/ai-tools/packages/template-engines/dist/index.d.ts:16

package/docs/api/interfaces/PubSubClient.md

@@ -0,0 +1,27 @@
+[**@isdk/ai-tool**](../README.md)
+
+***
+
+[@isdk/ai-tool](../globals.md) / PubSubClient
+
+# Interface: PubSubClient
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:14](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L14)
+
+Represents a client as seen by the transport layer after a subscription is made.
+It contains the client's ID and can hold other transport-specific metadata.
+
+## Indexable
+
+\[`k`: `string`\]: `any`
+
+## Properties
+
+### clientId?
+
+> `optional` **clientId**: `string`
+
+Defined in: [@isdk/ai-tools/packages/ai-tool/src/transports/pubsub/server.ts:19](https://github.com/isdk/ai-tool.js/blob/209a87173b5eabb2f81db6ea9a6784f34c24e271/src/transports/pubsub/server.ts#L19)
+
+The unique identifier for this client.
+This can be assigned by the client during connection or generated by the server.