@isdk/ai-tool 0.0.2

package/docs/interfaces/AIResult.md

@@ -0,0 +1,65 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / AIResult
+
+# Interface: AIResult\<TValue, TOptions\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `TValue` | `any` |
+| `TOptions` | `any` |
+
+## Table of contents
+
+### Properties
+
+- [content](AIResult.md#content)
+- [finishReason](AIResult.md#finishreason)
+- [options](AIResult.md#options)
+- [stop](AIResult.md#stop)
+
+## Properties
+
+### content
+
+• `Optional` **content**: `TValue`
+
+The generated value.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/chat.ts:16](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/chat.ts#L16)
+
+___
+
+### finishReason
+
+• `Optional` **finishReason**: ``null`` \| ``"length"`` \| ``"stop"`` \| ``"content-filter"`` \| ``"tool-calls"`` \| ``"abort"`` \| ``"error"`` \| ``"other"``
+
+The reason why the generation stopped.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/chat.ts:21](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/chat.ts#L21)
+
+___
+
+### options
+
+• `Optional` **options**: `TOptions`
+
+#### Defined in
+
+[packages/ai-tool/src/utils/chat.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/chat.ts#L22)
+
+___
+
+### stop
+
+• `Optional` **stop**: `boolean`
+
+for stream mode
+
+#### Defined in
+
+[packages/ai-tool/src/utils/chat.ts:26](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/chat.ts#L26)

package/docs/interfaces/AIStreamCallbacksAndOptions.md

@@ -0,0 +1,158 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / AIStreamCallbacksAndOptions
+
+# Interface: AIStreamCallbacksAndOptions
+
+Configuration options and helper callback methods for AIStream stream lifecycle events.
+
+## Table of contents
+
+### Properties
+
+- [experimental\_streamData](AIStreamCallbacksAndOptions.md#experimental_streamdata)
+- [onCompletion](AIStreamCallbacksAndOptions.md#oncompletion)
+- [onFinal](AIStreamCallbacksAndOptions.md#onfinal)
+- [onStart](AIStreamCallbacksAndOptions.md#onstart)
+- [onText](AIStreamCallbacksAndOptions.md#ontext)
+- [onToken](AIStreamCallbacksAndOptions.md#ontoken)
+
+## Properties
+
+### experimental\_streamData
+
+• `Optional` **experimental\_streamData**: `boolean`
+
+A flag for enabling the experimental_StreamData class and the new protocol.
+
+**`See`**
+
+https://github.com/vercel-labs/ai/pull/425
+
+When StreamData is rolled out, this will be removed and the new protocol will be used by default.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:31](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/stream/ai-stream.ts#L31)
+
+___
+
+### onCompletion
+
+• `Optional` **onCompletion**: (`completion`: `string`) => `void` \| `Promise`\<`void`\>
+
+`onCompletion`: Called for each tokenized message.
+
+#### Type declaration
+
+▸ (`completion`): `void` \| `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `completion` | `string` |
+
+##### Returns
+
+`void` \| `Promise`\<`void`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:18](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/stream/ai-stream.ts#L18)
+
+___
+
+### onFinal
+
+• `Optional` **onFinal**: (`completion`: `string`) => `void` \| `Promise`\<`void`\>
+
+`onFinal`: Called once when the stream is closed with the final completion message.
+
+#### Type declaration
+
+▸ (`completion`): `void` \| `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `completion` | `string` |
+
+##### Returns
+
+`void` \| `Promise`\<`void`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:20](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/stream/ai-stream.ts#L20)
+
+___
+
+### onStart
+
+• `Optional` **onStart**: () => `void` \| `Promise`\<`void`\>
+
+`onStart`: Called once when the stream is initialized.
+
+#### Type declaration
+
+▸ (): `void` \| `Promise`\<`void`\>
+
+##### Returns
+
+`void` \| `Promise`\<`void`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:16](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/stream/ai-stream.ts#L16)
+
+___
+
+### onText
+
+• `Optional` **onText**: (`text`: `string`) => `void` \| `Promise`\<`void`\>
+
+`onText`: Called for each text chunk.
+
+#### Type declaration
+
+▸ (`text`): `void` \| `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+
+##### Returns
+
+`void` \| `Promise`\<`void`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/stream/ai-stream.ts#L24)
+
+___
+
+### onToken
+
+• `Optional` **onToken**: (`token`: `string`) => `void` \| `Promise`\<`void`\>
+
+`onToken`: Called for each tokenized message.
+
+#### Type declaration
+
+▸ (`token`): `void` \| `Promise`\<`void`\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `token` | `string` |
+
+##### Returns
+
+`void` \| `Promise`\<`void`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/stream/ai-stream.ts#L22)

package/docs/interfaces/AIStreamParser.md

@@ -0,0 +1,33 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / AIStreamParser
+
+# Interface: AIStreamParser\<T, TOptions\>
+
+Custom parser for AIStream data.
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `T` | `any` |
+| `TOptions` | `any` |
+
+## Callable
+
+### AIStreamParser
+
+▸ **AIStreamParser**(`data`, `options`): `void` \| [`AIResult`](AIResult.md)\<`T`, `TOptions`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `data` | `string` |
+| `options` | [`AIStreamParserOptions`](AIStreamParserOptions.md) |
+
+#### Returns
+
+`void` \| [`AIResult`](AIResult.md)\<`T`, `TOptions`\>
+
+#### Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:51](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/stream/ai-stream.ts#L51)

package/docs/interfaces/AIStreamParserOptions.md

@@ -0,0 +1,23 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / AIStreamParserOptions
+
+# Interface: AIStreamParserOptions
+
+Options for the AIStreamParser.
+
+## Table of contents
+
+### Properties
+
+- [event](AIStreamParserOptions.md#event)
+
+## Properties
+
+### event
+
+• `Optional` **event**: `string`
+
+The event (type) from the server side event stream.
+
+#### Defined in
+
+[packages/ai-tool/src/utils/stream/ai-stream.ts:40](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/stream/ai-stream.ts#L40)

package/docs/interfaces/BaseFunc.md

@@ -0,0 +1,145 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / BaseFunc
+
+# Interface: BaseFunc
+
+## Hierarchy
+
+- [`BaseFuncItem`](BaseFuncItem.md)
+
+  ↳ **`BaseFunc`**
+
+  ↳↳ [`ToolFunc`](../classes/ToolFunc.md)
+
+## Table of contents
+
+### Properties
+
+- [name](BaseFunc.md#name)
+- [params](BaseFunc.md#params)
+- [result](BaseFunc.md#result)
+- [scope](BaseFunc.md#scope)
+- [setup](BaseFunc.md#setup)
+- [tags](BaseFunc.md#tags)
+
+### Methods
+
+- [func](BaseFunc.md#func)
+
+## Properties
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[name](BaseFuncItem.md#name)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L21)
+
+___
+
+### params
+
+• `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[params](BaseFuncItem.md#params)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L22)
+
+___
+
+### result
+
+• `Optional` **result**: `string`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[result](BaseFuncItem.md#result)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L23)
+
+___
+
+### scope
+
+• `Optional` **scope**: `any`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[scope](BaseFuncItem.md#scope)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L24)
+
+___
+
+### setup
+
+• `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
+
+#### Type declaration
+
+▸ (`this`, `options?`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `this` | [`ToolFunc`](../classes/ToolFunc.md) |
+| `options?` | [`FuncItem`](FuncItem.md) |
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[setup](BaseFuncItem.md#setup)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L26)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string` \| `string`[]
+
+#### Inherited from
+
+[BaseFuncItem](BaseFuncItem.md).[tags](BaseFuncItem.md#tags)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L25)
+
+## Methods
+
+### func
+
+▸ **func**(`...params`): `any`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `...params` | `any` |
+
+#### Returns
+
+`any`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:34](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L34)

package/docs/interfaces/BaseFuncItem.md

@@ -0,0 +1,99 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / BaseFuncItem
+
+# Interface: BaseFuncItem
+
+## Hierarchy
+
+- **`BaseFuncItem`**
+
+  ↳ [`RemoteFuncItem`](RemoteFuncItem.md)
+
+  ↳ [`FuncItem`](FuncItem.md)
+
+  ↳ [`BaseFunc`](BaseFunc.md)
+
+## Table of contents
+
+### Properties
+
+- [name](BaseFuncItem.md#name)
+- [params](BaseFuncItem.md#params)
+- [result](BaseFuncItem.md#result)
+- [scope](BaseFuncItem.md#scope)
+- [setup](BaseFuncItem.md#setup)
+- [tags](BaseFuncItem.md#tags)
+
+## Properties
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L21)
+
+___
+
+### params
+
+• `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L22)
+
+___
+
+### result
+
+• `Optional` **result**: `string`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L23)
+
+___
+
+### scope
+
+• `Optional` **scope**: `any`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L24)
+
+___
+
+### setup
+
+• `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
+
+#### Type declaration
+
+▸ (`this`, `options?`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `this` | [`ToolFunc`](../classes/ToolFunc.md) |
+| `options?` | [`FuncItem`](FuncItem.md) |
+
+##### Returns
+
+`void`
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L26)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string` \| `string`[]
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L25)

package/docs/interfaces/ClientFuncItem.md

@@ -0,0 +1,181 @@
+[@isdk/ai-tool](../README.md) / [Exports](../modules.md) / ClientFuncItem
+
+# Interface: ClientFuncItem
+
+## Hierarchy
+
+- [`RemoteFuncItem`](RemoteFuncItem.md)
+
+  ↳ **`ClientFuncItem`**
+
+  ↳↳ [`ClientTools`](../classes/ClientTools.md)
+
+## Table of contents
+
+### Properties
+
+- [action](ClientFuncItem.md#action)
+- [apiRoot](ClientFuncItem.md#apiroot)
+- [fetchOptions](ClientFuncItem.md#fetchoptions)
+- [name](ClientFuncItem.md#name)
+- [params](ClientFuncItem.md#params)
+- [result](ClientFuncItem.md#result)
+- [scope](ClientFuncItem.md#scope)
+- [setup](ClientFuncItem.md#setup)
+- [stream](ClientFuncItem.md#stream)
+- [tags](ClientFuncItem.md#tags)
+
+## Properties
+
+### action
+
+• `Optional` **action**: ``"get"`` \| ``"post"`` \| ``"put"`` \| ``"delete"`` \| ``"patch"`` \| ``"list"`` \| ``"res"``
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[action](RemoteFuncItem.md#action)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:36](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L36)
+
+___
+
+### apiRoot
+
+• `Optional` **apiRoot**: `string`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[apiRoot](RemoteFuncItem.md#apiroot)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:35](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L35)
+
+___
+
+### fetchOptions
+
+• `Optional` **fetchOptions**: `any`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[fetchOptions](RemoteFuncItem.md#fetchoptions)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:37](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L37)
+
+___
+
+### name
+
+• `Optional` **name**: `string`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[name](RemoteFuncItem.md#name)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:21](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L21)
+
+___
+
+### params
+
+• `Optional` **params**: [`FuncParams`](FuncParams.md) \| [`FuncParam`](FuncParam.md)[]
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[params](RemoteFuncItem.md#params)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:22](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L22)
+
+___
+
+### result
+
+• `Optional` **result**: `string`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[result](RemoteFuncItem.md#result)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:23](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L23)
+
+___
+
+### scope
+
+• `Optional` **scope**: `any`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[scope](RemoteFuncItem.md#scope)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:24](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L24)
+
+___
+
+### setup
+
+• `Optional` **setup**: (`this`: [`ToolFunc`](../classes/ToolFunc.md), `options?`: [`FuncItem`](FuncItem.md)) => `void`
+
+#### Type declaration
+
+▸ (`this`, `options?`): `void`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `this` | [`ToolFunc`](../classes/ToolFunc.md) |
+| `options?` | [`FuncItem`](FuncItem.md) |
+
+##### Returns
+
+`void`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[setup](RemoteFuncItem.md#setup)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:26](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L26)
+
+___
+
+### stream
+
+• `Optional` **stream**: `boolean`
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[stream](RemoteFuncItem.md#stream)
+
+#### Defined in
+
+[packages/ai-tool/src/utils/consts.ts:38](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/utils/consts.ts#L38)
+
+___
+
+### tags
+
+• `Optional` **tags**: `string` \| `string`[]
+
+#### Inherited from
+
+[RemoteFuncItem](RemoteFuncItem.md).[tags](RemoteFuncItem.md#tags)
+
+#### Defined in
+
+[packages/ai-tool/src/tool-func.ts:25](https://github.com/isdk/ai-tool.js/blob/e7fb80e8b32da0eb475b223017e88d973ef7af19/src/tool-func.ts#L25)