From a6f9d05181fab2217de72eae3adbec4bca35ab0f Mon Sep 17 00:00:00 2001 From: moon Date: Fri, 8 Mar 2024 22:35:50 -0800 Subject: [PATCH] update docs --- docs/docs/classes/BgentRuntime.md | 8 +- docs/docs/classes/DatabaseAdapter.md | 351 +++++++++++++++ docs/docs/classes/SupabaseDatabaseAdapter.md | 434 +++++++++++++++++++ docs/docs/modules.md | 2 + 4 files changed, 791 insertions(+), 4 deletions(-) create mode 100644 docs/docs/classes/DatabaseAdapter.md create mode 100644 docs/docs/classes/SupabaseDatabaseAdapter.md diff --git a/docs/docs/classes/BgentRuntime.md b/docs/docs/classes/BgentRuntime.md index e830153..51843e9 100644 --- a/docs/docs/classes/BgentRuntime.md +++ b/docs/docs/classes/BgentRuntime.md @@ -23,7 +23,7 @@ Creates an instance of BgentRuntime. | :------ | :------ | :------ | | `opts` | `Object` | The options for configuring the BgentRuntime. | | `opts.actions?` | [`Action`](../interfaces/Action.md)[] | Optional custom actions. | -| `opts.databaseAdapter` | `DatabaseAdapter` | The database adapter used for interacting with the database. | +| `opts.databaseAdapter` | [`DatabaseAdapter`](DatabaseAdapter.md) | The database adapter used for interacting with the database. | | `opts.debugMode?` | `boolean` | If true, debug messages will be logged. | | `opts.embeddingModel?` | `string` | The model to use for embedding. | | `opts.evaluators?` | [`Evaluator`](../interfaces/Evaluator.md)[] | Optional custom evaluators. | @@ -49,7 +49,7 @@ ___ ### databaseAdapter -• **databaseAdapter**: `DatabaseAdapter` +• **databaseAdapter**: [`DatabaseAdapter`](DatabaseAdapter.md) The database adapter used for interacting with the database. @@ -245,7 +245,7 @@ ___ ### processActions -▸ **processActions**(`message`, `content`): `Promise`\<`void`\> +▸ **processActions**(`message`, `content`): `Promise`\<`unknown`\> Process the actions of a message. @@ -258,7 +258,7 @@ Process the actions of a message. #### Returns -`Promise`\<`void`\> +`Promise`\<`unknown`\> ___ diff --git a/docs/docs/classes/DatabaseAdapter.md b/docs/docs/classes/DatabaseAdapter.md new file mode 100644 index 0000000..91cec65 --- /dev/null +++ b/docs/docs/classes/DatabaseAdapter.md @@ -0,0 +1,351 @@ +--- +id: "DatabaseAdapter" +title: "Class: DatabaseAdapter" +sidebar_label: "DatabaseAdapter" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- **`DatabaseAdapter`** + + ↳ [`SupabaseDatabaseAdapter`](SupabaseDatabaseAdapter.md) + +## Constructors + +### constructor + +• **new DatabaseAdapter**(): [`DatabaseAdapter`](DatabaseAdapter.md) + +#### Returns + +[`DatabaseAdapter`](DatabaseAdapter.md) + +## Methods + +### countMemoriesByUserIds + +▸ **countMemoriesByUserIds**(`userIds`, `unique?`, `tableName?`): `Promise`\<`number`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | +| `unique?` | `boolean` | +| `tableName?` | `string` | + +#### Returns + +`Promise`\<`number`\> + +___ + +### createAccount + +▸ **createAccount**(`account`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `account` | `Account` | + +#### Returns + +`Promise`\<`void`\> + +___ + +### createGoal + +▸ **createGoal**(`goal`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `goal` | [`Goal`](../interfaces/Goal.md) | + +#### Returns + +`Promise`\<`void`\> + +___ + +### createMemory + +▸ **createMemory**(`memory`, `tableName`, `unique?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `memory` | [`Memory`](../interfaces/Memory.md) | +| `tableName` | `string` | +| `unique?` | `boolean` | + +#### Returns + +`Promise`\<`void`\> + +___ + +### createRelationship + +▸ **createRelationship**(`params`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.userA` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.userB` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | + +#### Returns + +`Promise`\<`boolean`\> + +___ + +### getAccountById + +▸ **getAccountById**(`userId`): `Promise`\<``null`` \| `Account`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | + +#### Returns + +`Promise`\<``null`` \| `Account`\> + +___ + +### getActorDetails + +▸ **getActorDetails**(`params`): `Promise`\<[`Actor`](../interfaces/Actor.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Actor`](../interfaces/Actor.md)[]\> + +___ + +### getGoals + +▸ **getGoals**(`params`): `Promise`\<[`Goal`](../interfaces/Goal.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.count?` | `number` | +| `params.onlyInProgress?` | `boolean` | +| `params.userId?` | ``null`` \| \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Goal`](../interfaces/Goal.md)[]\> + +___ + +### getMemoriesByIds + +▸ **getMemoriesByIds**(`params`): `Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.count?` | `number` | +| `params.tableName` | `string` | +| `params.unique?` | `boolean` | +| `params.userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +___ + +### getRelationship + +▸ **getRelationship**(`params`): `Promise`\<``null`` \| [`Relationship`](../interfaces/Relationship.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.userA` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.userB` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | + +#### Returns + +`Promise`\<``null`` \| [`Relationship`](../interfaces/Relationship.md)\> + +___ + +### getRelationships + +▸ **getRelationships**(`params`): `Promise`\<[`Relationship`](../interfaces/Relationship.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.userId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | + +#### Returns + +`Promise`\<[`Relationship`](../interfaces/Relationship.md)[]\> + +___ + +### log + +▸ **log**(`params`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.agent_id` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.body` | `Object` | +| `params.room_id` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.type` | `string` | +| `params.user_id` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.user_ids` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<`void`\> + +___ + +### removeAllMemoriesByUserIds + +▸ **removeAllMemoriesByUserIds**(`userIds`, `tableName`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | +| `tableName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +___ + +### removeMemory + +▸ **removeMemory**(`memoryId`, `tableName`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `memoryId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `tableName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +___ + +### searchMemories + +▸ **searchMemories**(`params`): `Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.embedding` | `number`[] | +| `params.match_count` | `number` | +| `params.match_threshold` | `number` | +| `params.tableName` | `string` | +| `params.unique` | `boolean` | +| `params.userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +___ + +### searchMemoriesByEmbedding + +▸ **searchMemoriesByEmbedding**(`embedding`, `params`): `Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `embedding` | `number`[] | +| `params` | `Object` | +| `params.count?` | `number` | +| `params.match_threshold?` | `number` | +| `params.tableName` | `string` | +| `params.unique?` | `boolean` | +| `params.userIds?` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +___ + +### updateGoal + +▸ **updateGoal**(`goal`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `goal` | [`Goal`](../interfaces/Goal.md) | + +#### Returns + +`Promise`\<`void`\> + +___ + +### updateGoalStatus + +▸ **updateGoalStatus**(`params`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.goalId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.status` | [`GoalStatus`](../enums/GoalStatus.md) | + +#### Returns + +`Promise`\<`void`\> diff --git a/docs/docs/classes/SupabaseDatabaseAdapter.md b/docs/docs/classes/SupabaseDatabaseAdapter.md new file mode 100644 index 0000000..6a70b08 --- /dev/null +++ b/docs/docs/classes/SupabaseDatabaseAdapter.md @@ -0,0 +1,434 @@ +--- +id: "SupabaseDatabaseAdapter" +title: "Class: SupabaseDatabaseAdapter" +sidebar_label: "SupabaseDatabaseAdapter" +sidebar_position: 0 +custom_edit_url: null +--- + +## Hierarchy + +- [`DatabaseAdapter`](DatabaseAdapter.md) + + ↳ **`SupabaseDatabaseAdapter`** + +## Constructors + +### constructor + +• **new SupabaseDatabaseAdapter**(`supabaseUrl`, `supabaseKey`): [`SupabaseDatabaseAdapter`](SupabaseDatabaseAdapter.md) + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `supabaseUrl` | `string` | +| `supabaseKey` | `string` | + +#### Returns + +[`SupabaseDatabaseAdapter`](SupabaseDatabaseAdapter.md) + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[constructor](DatabaseAdapter.md#constructor) + +## Methods + +### countMemoriesByUserIds + +▸ **countMemoriesByUserIds**(`userIds`, `unique?`, `tableName`): `Promise`\<`number`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | `undefined` | +| `unique` | `boolean` | `true` | +| `tableName` | `string` | `undefined` | + +#### Returns + +`Promise`\<`number`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[countMemoriesByUserIds](DatabaseAdapter.md#countmemoriesbyuserids) + +___ + +### createAccount + +▸ **createAccount**(`account`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `account` | `Account` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[createAccount](DatabaseAdapter.md#createaccount) + +___ + +### createGoal + +▸ **createGoal**(`goal`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `goal` | [`Goal`](../interfaces/Goal.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[createGoal](DatabaseAdapter.md#creategoal) + +___ + +### createMemory + +▸ **createMemory**(`memory`, `tableName`, `unique?`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | Default value | +| :------ | :------ | :------ | +| `memory` | [`Memory`](../interfaces/Memory.md) | `undefined` | +| `tableName` | `string` | `undefined` | +| `unique` | `boolean` | `false` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[createMemory](DatabaseAdapter.md#creatememory) + +___ + +### createRelationship + +▸ **createRelationship**(`params`): `Promise`\<`boolean`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.userA` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.userB` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | + +#### Returns + +`Promise`\<`boolean`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[createRelationship](DatabaseAdapter.md#createrelationship) + +___ + +### getAccountById + +▸ **getAccountById**(`userId`): `Promise`\<``null`` \| `Account`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | + +#### Returns + +`Promise`\<``null`` \| `Account`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[getAccountById](DatabaseAdapter.md#getaccountbyid) + +___ + +### getActorDetails + +▸ **getActorDetails**(`params`): `Promise`\<[`Actor`](../interfaces/Actor.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Actor`](../interfaces/Actor.md)[]\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[getActorDetails](DatabaseAdapter.md#getactordetails) + +___ + +### getGoals + +▸ **getGoals**(`params`): `Promise`\<[`Goal`](../interfaces/Goal.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.count?` | `number` | +| `params.onlyInProgress?` | `boolean` | +| `params.userId?` | ``null`` \| \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Goal`](../interfaces/Goal.md)[]\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[getGoals](DatabaseAdapter.md#getgoals) + +___ + +### getMemoriesByIds + +▸ **getMemoriesByIds**(`params`): `Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.count?` | `number` | +| `params.tableName` | `string` | +| `params.unique?` | `boolean` | +| `params.userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[getMemoriesByIds](DatabaseAdapter.md#getmemoriesbyids) + +___ + +### getRelationship + +▸ **getRelationship**(`params`): `Promise`\<``null`` \| [`Relationship`](../interfaces/Relationship.md)\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.userA` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.userB` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | + +#### Returns + +`Promise`\<``null`` \| [`Relationship`](../interfaces/Relationship.md)\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[getRelationship](DatabaseAdapter.md#getrelationship) + +___ + +### getRelationships + +▸ **getRelationships**(`params`): `Promise`\<[`Relationship`](../interfaces/Relationship.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.userId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | + +#### Returns + +`Promise`\<[`Relationship`](../interfaces/Relationship.md)[]\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[getRelationships](DatabaseAdapter.md#getrelationships) + +___ + +### log + +▸ **log**(`params`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.agent_id` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.body` | `Object` | +| `params.room_id` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.type` | `string` | +| `params.user_id` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.user_ids` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[log](DatabaseAdapter.md#log) + +___ + +### removeAllMemoriesByUserIds + +▸ **removeAllMemoriesByUserIds**(`userIds`, `tableName`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | +| `tableName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[removeAllMemoriesByUserIds](DatabaseAdapter.md#removeallmemoriesbyuserids) + +___ + +### removeMemory + +▸ **removeMemory**(`memoryId`, `tableName`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `memoryId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `tableName` | `string` | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[removeMemory](DatabaseAdapter.md#removememory) + +___ + +### searchMemories + +▸ **searchMemories**(`params`): `Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.embedding` | `number`[] | +| `params.match_count` | `number` | +| `params.match_threshold` | `number` | +| `params.tableName` | `string` | +| `params.unique` | `boolean` | +| `params.userIds` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[searchMemories](DatabaseAdapter.md#searchmemories) + +___ + +### searchMemoriesByEmbedding + +▸ **searchMemoriesByEmbedding**(`embedding`, `params`): `Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `embedding` | `number`[] | +| `params` | `Object` | +| `params.count?` | `number` | +| `params.match_threshold?` | `number` | +| `params.tableName` | `string` | +| `params.unique?` | `boolean` | +| `params.userIds?` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`[] | + +#### Returns + +`Promise`\<[`Memory`](../interfaces/Memory.md)[]\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[searchMemoriesByEmbedding](DatabaseAdapter.md#searchmemoriesbyembedding) + +___ + +### updateGoal + +▸ **updateGoal**(`goal`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `goal` | [`Goal`](../interfaces/Goal.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[updateGoal](DatabaseAdapter.md#updategoal) + +___ + +### updateGoalStatus + +▸ **updateGoalStatus**(`params`): `Promise`\<`void`\> + +#### Parameters + +| Name | Type | +| :------ | :------ | +| `params` | `Object` | +| `params.goalId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | +| `params.status` | [`GoalStatus`](../enums/GoalStatus.md) | + +#### Returns + +`Promise`\<`void`\> + +#### Overrides + +[DatabaseAdapter](DatabaseAdapter.md).[updateGoalStatus](DatabaseAdapter.md#updategoalstatus) diff --git a/docs/docs/modules.md b/docs/docs/modules.md index 54ef7f8..3dc7ae5 100644 --- a/docs/docs/modules.md +++ b/docs/docs/modules.md @@ -13,7 +13,9 @@ custom_edit_url: null ## Classes - [BgentRuntime](classes/BgentRuntime.md) +- [DatabaseAdapter](classes/DatabaseAdapter.md) - [MemoryManager](classes/MemoryManager.md) +- [SupabaseDatabaseAdapter](classes/SupabaseDatabaseAdapter.md) ## Interfaces