From e28c98b7ab0d5279ee18710332bda2d501aba5ef Mon Sep 17 00:00:00 2001 From: JW Date: Fri, 15 Nov 2024 22:49:27 -0500 Subject: [PATCH 01/10] change default configuration of Heurist --- .env.example | 6 +++++- docs/docs/advanced/fine-tuning.md | 10 +++++----- docs/docs/api/type-aliases/Models.md | 4 ++++ docs/docs/guides/configuration.md | 17 ++++++++++------- docs/docs/quickstart.md | 6 +++--- packages/core/src/generation.ts | 2 +- 6 files changed, 28 insertions(+), 17 deletions(-) diff --git a/.env.example b/.env.example index caf26ced0cf..6407ffd8a3e 100644 --- a/.env.example +++ b/.env.example @@ -55,8 +55,12 @@ LARGE_OLLAMA_MODEL= #default hermes3:70b # For asking Claude stuff ANTHROPIC_API_KEY= -# Heurist API +# Heurist API (Get API Key at https://heurist.ai/dev-access) HEURIST_API_KEY= +SMALL_HEURIST_LANGUAGE_MODEL= +MEDIUM_HEURIST_LANGUAGE_MODEL= +LARGE_HEURIST_LANGUAGE_MODEL= +HEURIST_IMAGE_MODEL= WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY diff --git a/docs/docs/advanced/fine-tuning.md b/docs/docs/advanced/fine-tuning.md index f256483a7e5..331b8cab2b2 100644 --- a/docs/docs/advanced/fine-tuning.md +++ b/docs/docs/advanced/fine-tuning.md @@ -273,7 +273,7 @@ const llamaLocalSettings = { const heuristSettings = { settings: { stop: [], - maxInputTokens: 128000, + maxInputTokens: 32768, maxOutputTokens: 8192, repetition_penalty: 0.0, temperature: 0.7, @@ -283,11 +283,11 @@ const heuristSettings = { }, endpoint: "https://llm-gateway.heurist.xyz", model: { - [ModelClass.SMALL]: "meta-llama/llama-3-70b-instruct", - [ModelClass.MEDIUM]: "meta-llama/llama-3-70b-instruct", - [ModelClass.LARGE]: "meta-llama/llama-3.1-405b-instruct", + [ModelClass.SMALL]: "hermes-3-llama3.1-8b", + [ModelClass.MEDIUM]: "mistralai/mixtral-8x7b-instruct", + [ModelClass.LARGE]: "nvidia/llama-3.1-nemotron-70b-instruct", [ModelClass.EMBEDDING]: "", // Add later - [ModelClass.IMAGE]: "PepeXL", + [ModelClass.IMAGE]: "FLUX.1-dev", }, }; ``` diff --git a/docs/docs/api/type-aliases/Models.md b/docs/docs/api/type-aliases/Models.md index 6b21703b900..b118fa2c26a 100644 --- a/docs/docs/api/type-aliases/Models.md +++ b/docs/docs/api/type-aliases/Models.md @@ -48,6 +48,10 @@ > **redpill**: [`Model`](Model.md) +### heurist + +> **heurist**: [`Model`](Model.md) + ## Defined in [packages/core/src/types.ts:105](https://github.com/ai16z/eliza/blob/7fcf54e7fb2ba027d110afcc319c0b01b3f181dc/packages/core/src/types.ts#L105) diff --git a/docs/docs/guides/configuration.md b/docs/docs/guides/configuration.md index 463d46d6908..074337fdbdb 100644 --- a/docs/docs/guides/configuration.md +++ b/docs/docs/guides/configuration.md @@ -70,6 +70,9 @@ ANTHROPIC_API_KEY= # Together.ai Settings TOGETHER_API_KEY= +# Heurist Settings +HEURIST_API_KEY= + # Local Model Settings XAI_MODEL=meta-llama/Llama-3.1-7b-instruct ``` @@ -80,12 +83,12 @@ Configure image generation in your character file: ```json { - "modelProvider": "HEURIST", + "modelProvider": "heurist", "settings": { "imageSettings": { "steps": 20, - "width": 512, - "height": 512 + "width": 1024, + "height": 1024 } } } @@ -96,13 +99,13 @@ Example usage: ```typescript const result = await generateImage( { - prompt: "pepe_frog, meme, web comic, cartoon, 3d render", - width: 512, - height: 512, + prompt: "A cute anime girl with big breasts and straight long black hair wearing orange T-shirt. The T-shirt has \"ai16z\" texts in the front. The girl is looking at the viewer", + width: 1024, + height: 1024, numIterations: 20, // optional guidanceScale: 3, // optional seed: -1, // optional - modelId: "PepeXL", // optional + modelId: "FLUX.1-dev", // optional }, runtime, ); diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md index d3d851ff195..f678a716230 100644 --- a/docs/docs/quickstart.md +++ b/docs/docs/quickstart.md @@ -67,9 +67,9 @@ Before getting started with Eliza, ensure you have: Eliza supports multiple AI models: -- **Heurist**: Set `modelProvider: "HEURIST"` in your character file - - LLM: Uses Llama models (more available LLM models [here](https://heurist.mintlify.app/developer/supported-models)) - - Image Generation: Uses PepeXL model (more info of available models [here](https://heurist.mintlify.app/developer/image-generation-api)) +- **Heurist**: Set `modelProvider: "heurist"` in your character file. Most models are uncensored. + - LLM: Select available LLMs [here](https://docs.heurist.ai/dev-guide/supported-models#large-language-models-llms) and configure `SMALL_HEURIST_LANGUAGE_MODEL`,`MEDIUM_HEURIST_LANGUAGE_MODEL`,`LARGE_HEURIST_LANGUAGE_MODEL` + - Image Generation: Select available Stable Diffusion or Flux models [here](https://docs.heurist.ai/dev-guide/supported-models#image-generation-models) and configure `HEURIST_IMAGE_MODEL` (default is FLUX.1-dev) - **Llama**: Set `XAI_MODEL=meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` - **Grok**: Set `XAI_MODEL=grok-beta` - **OpenAI**: Set `XAI_MODEL=gpt-4o-mini` or `gpt-4o` diff --git a/packages/core/src/generation.ts b/packages/core/src/generation.ts index abbd7b159f8..f213a2de1e9 100644 --- a/packages/core/src/generation.ts +++ b/packages/core/src/generation.ts @@ -771,7 +771,7 @@ export const generateImage = async ( seed: data.seed || -1, }, }, - model_id: data.modelId || "PepeXL", // Default to SD 1.5 if not specified + model_id: data.modelId || "FLUX.1-dev", }), } ); From 0b819e752c91a5010a1f4fd384406380c2c56928 Mon Sep 17 00:00:00 2001 From: ponderingdemocritus Date: Sat, 16 Nov 2024 16:38:42 +1100 Subject: [PATCH 02/10] trust db --- packages/agent/src/index.ts | 3 +- packages/client-auto/package.json | 1 + packages/client-auto/src/index.ts | 2 +- packages/plugin-solana/package.json | 1 + .../plugin-solana/src/evaluators/trust.ts | 2 +- packages/plugin-solana/src/index.ts | 1 - .../src/providers/trustScoreProvider.ts | 2 +- packages/plugin-starknet/src/index.ts | 16 ++-- .../plugin-starknet/src/providers/avnu.ts | 80 ++++++++++++++++--- packages/plugin-trustdb/package.json | 20 +++++ .../src/adapters/trustScoreDatabase.ts | 3 - packages/plugin-trustdb/src/index.ts | 1 + packages/plugin-trustdb/tsconfig.json | 8 ++ packages/plugin-trustdb/tsup.config.ts | 10 +++ pnpm-lock.yaml | 24 ++++++ scripts/build.sh | 1 + 16 files changed, 148 insertions(+), 27 deletions(-) create mode 100644 packages/plugin-trustdb/package.json rename packages/{plugin-solana => plugin-trustdb}/src/adapters/trustScoreDatabase.ts (99%) create mode 100644 packages/plugin-trustdb/src/index.ts create mode 100644 packages/plugin-trustdb/tsconfig.json create mode 100644 packages/plugin-trustdb/tsup.config.ts diff --git a/packages/agent/src/index.ts b/packages/agent/src/index.ts index fe5c40141aa..bc8f51d53d0 100644 --- a/packages/agent/src/index.ts +++ b/packages/agent/src/index.ts @@ -21,6 +21,7 @@ import Database from "better-sqlite3"; import fs from "fs"; import readline from "readline"; import yargs from "yargs"; +import { blobert } from "./blobert.ts"; export const wait = (minTime: number = 1000, maxTime: number = 3000) => { const waitTime = @@ -272,7 +273,7 @@ const startAgents = async () => { let charactersArg = args.characters || args.character; - let characters = [defaultCharacter]; + let characters = [blobert]; if (charactersArg) { characters = await loadCharacters(charactersArg); diff --git a/packages/client-auto/package.json b/packages/client-auto/package.json index 277a8325f87..23317639ed5 100644 --- a/packages/client-auto/package.json +++ b/packages/client-auto/package.json @@ -8,6 +8,7 @@ "@ai16z/eliza": "workspace:*", "@ai16z/plugin-image-generation": "workspace:*", "@ai16z/plugin-solana": "workspace:*", + "@ai16z/plugin-trustdb": "workspace:*", "@types/body-parser": "1.19.5", "@types/cors": "2.8.17", "@types/express": "5.0.0", diff --git a/packages/client-auto/src/index.ts b/packages/client-auto/src/index.ts index f7c746e1fad..1c242341a1c 100644 --- a/packages/client-auto/src/index.ts +++ b/packages/client-auto/src/index.ts @@ -2,7 +2,7 @@ import { Client, IAgentRuntime } from "@ai16z/eliza"; import { TrustScoreManager } from "@ai16z/plugin-solana"; import { TokenProvider } from "@ai16z/plugin-solana"; import { WalletProvider } from "@ai16z/plugin-solana"; -import { TrustScoreDatabase } from "@ai16z/plugin-solana"; +import { TrustScoreDatabase } from "@ai16z/plugin-trustdb"; import { Connection, PublicKey } from "@solana/web3.js"; export class AutoClient { diff --git a/packages/plugin-solana/package.json b/packages/plugin-solana/package.json index fb483be44e8..b804baf3f41 100644 --- a/packages/plugin-solana/package.json +++ b/packages/plugin-solana/package.json @@ -6,6 +6,7 @@ "types": "dist/index.d.ts", "dependencies": { "@ai16z/eliza": "workspace:*", + "@ai16z/plugin-trustdb": "workspace:*", "@coral-xyz/anchor": "^0.30.1", "@solana/spl-token": "0.4.9", "@solana/web3.js": "1.95.4", diff --git a/packages/plugin-solana/src/evaluators/trust.ts b/packages/plugin-solana/src/evaluators/trust.ts index bfdd382f08b..04f020cc6c5 100644 --- a/packages/plugin-solana/src/evaluators/trust.ts +++ b/packages/plugin-solana/src/evaluators/trust.ts @@ -13,7 +13,7 @@ import { import { TrustScoreManager } from "../providers/trustScoreProvider.ts"; import { TokenProvider } from "../providers/token.ts"; import { WalletProvider } from "../providers/wallet.ts"; -import { TrustScoreDatabase } from "../adapters/trustScoreDatabase.ts"; +import { TrustScoreDatabase } from "@ai16z/plugin-trustdb"; import { Connection, PublicKey } from "@solana/web3.js"; const shouldProcessTemplate = diff --git a/packages/plugin-solana/src/index.ts b/packages/plugin-solana/src/index.ts index 52d5fa71b92..78d992be442 100644 --- a/packages/plugin-solana/src/index.ts +++ b/packages/plugin-solana/src/index.ts @@ -2,7 +2,6 @@ export * from "./providers/token.ts"; export * from "./providers/wallet.ts"; export * from "./providers/trustScoreProvider.ts"; export * from "./evaluators/trust.ts"; -export * from "./adapters/trustScoreDatabase.ts"; import { Plugin } from "@ai16z/eliza"; //import { executeSwap } from "./actions/swap.ts"; diff --git a/packages/plugin-solana/src/providers/trustScoreProvider.ts b/packages/plugin-solana/src/providers/trustScoreProvider.ts index 8243879f355..8556f7a0329 100644 --- a/packages/plugin-solana/src/providers/trustScoreProvider.ts +++ b/packages/plugin-solana/src/providers/trustScoreProvider.ts @@ -16,7 +16,7 @@ import { TokenPerformance, TradePerformance, TokenRecommendation, -} from "../adapters/trustScoreDatabase.ts"; +} from "@ai16z/plugin-trustdb"; import settings from "@ai16z/eliza/src/settings.ts"; import { IAgentRuntime, Memory, Provider, State } from "@ai16z/eliza"; diff --git a/packages/plugin-starknet/src/index.ts b/packages/plugin-starknet/src/index.ts index 7f78b771474..f97ef404265 100644 --- a/packages/plugin-starknet/src/index.ts +++ b/packages/plugin-starknet/src/index.ts @@ -1,16 +1,14 @@ import { Plugin } from "@ai16z/eliza"; -import { executeSwap } from "./actions/swap"; -import { - getStarknetAccountProvider, - getStarknetRpcProvider, -} from "./providers/avnu"; +import { avnuProvider } from "./providers/avnu.ts"; export const starknetPlugin: Plugin = { - name: "Starknet", - description: "Starknet Swap Plugin for Eliza", - actions: [executeSwap], + name: "starknet", + description: "Starknet Plugin for Eliza", + actions: [ + // TODO: Add actions like swap, etc. + ], evaluators: [], - providers: [getStarknetAccountProvider, getStarknetRpcProvider], + providers: [avnuProvider], }; export default starknetPlugin; diff --git a/packages/plugin-starknet/src/providers/avnu.ts b/packages/plugin-starknet/src/providers/avnu.ts index 38ff054d524..15fbd874f0c 100644 --- a/packages/plugin-starknet/src/providers/avnu.ts +++ b/packages/plugin-starknet/src/providers/avnu.ts @@ -1,14 +1,74 @@ -import { IAgentRuntime, Memory, Provider, State } from "@ai16z/eliza"; -import { getStarknetAccount, getStarknetProvider } from "./wallet"; +import { IAgentRuntime } from "@ai16z/eliza"; -export const getStarknetAccountProvider: Provider = { - get: async (runtime: IAgentRuntime, _message: Memory, _state?: State) => { - return getStarknetAccount(runtime); - }, -}; +interface AvnuQuoteParams { + sellTokenAddress: string; + buyTokenAddress: string; + sellAmount?: string; + takerAddress?: string; + excludeSources?: string[]; + size?: number; + integratorName?: string; +} + +export async function fetchAvnuQuote( + runtime: IAgentRuntime, + params: AvnuQuoteParams +) { + const apiKey = runtime.getSetting("AVNU_API_KEY"); + + // Build query parameters + const queryParams = new URLSearchParams(); + queryParams.append("sellTokenAddress", params.sellTokenAddress); + queryParams.append("buyTokenAddress", params.buyTokenAddress); + + if (params.sellAmount) { + queryParams.append("sellAmount", params.sellAmount); + } + if (params.takerAddress) { + queryParams.append("takerAddress", params.takerAddress); + } + if (params.excludeSources) { + queryParams.append("excludeSources", params.excludeSources.join(",")); + } + if (params.size) { + queryParams.append("size", params.size.toString()); + } + if (params.integratorName) { + queryParams.append("integratorName", params.integratorName); + } + + const url = `https://starknet.api.avnu.fi/swap/v2/quotes?${queryParams.toString()}`; + + const response = await fetch(url, { + method: "GET", + headers: { + Accept: "application/json", + Authorization: `Bearer ${apiKey}`, + }, + }); + + if (!response.ok) { + const errorText = await response.text(); + throw new Error(`Failed to fetch Avnu quote: ${errorText}`); + } + + return response.json(); +} + +export const avnuProvider = { + get: async (runtime: IAgentRuntime) => { + try { + const params = { + sellTokenAddress: runtime.getSetting("SELL_TOKEN_ADDRESS"), + buyTokenAddress: runtime.getSetting("BUY_TOKEN_ADDRESS"), + sellAmount: runtime.getSetting("SELL_AMOUNT"), + }; -export const getStarknetRpcProvider: Provider = { - get: async (runtime: IAgentRuntime, _message: Memory, _state?: State) => { - return getStarknetProvider(runtime); + const quote = await fetchAvnuQuote(runtime, params); + return JSON.stringify(quote, null, 2); + } catch (error) { + console.error("Error fetching Avnu quote:", error); + return `Failed to fetch quote: ${error instanceof Error ? error.message : "Unknown error"}`; + } }, }; diff --git a/packages/plugin-trustdb/package.json b/packages/plugin-trustdb/package.json new file mode 100644 index 00000000000..9849e28daf6 --- /dev/null +++ b/packages/plugin-trustdb/package.json @@ -0,0 +1,20 @@ +{ + "name": "@ai16z/plugin-trustdb", + "version": "0.0.1", + "main": "dist/index.js", + "type": "module", + "types": "dist/index.d.ts", + "dependencies": { + "@ai16z/eliza": "workspace:*", + "tsup": "^8.3.5", + "uuid": "11.0.2", + "vitest": "^2.1.4" + }, + "scripts": { + "build": "tsup --format esm --dts", + "test": "vitest" + }, + "peerDependencies": { + "whatwg-url": "7.1.0" + } +} diff --git a/packages/plugin-solana/src/adapters/trustScoreDatabase.ts b/packages/plugin-trustdb/src/adapters/trustScoreDatabase.ts similarity index 99% rename from packages/plugin-solana/src/adapters/trustScoreDatabase.ts rename to packages/plugin-trustdb/src/adapters/trustScoreDatabase.ts index 417bdf76f9a..8cdf2d54114 100644 --- a/packages/plugin-solana/src/adapters/trustScoreDatabase.ts +++ b/packages/plugin-trustdb/src/adapters/trustScoreDatabase.ts @@ -1,9 +1,6 @@ -// src/adapters/sqlite/trustScoreDatabase.ts - import { Database } from "better-sqlite3"; import { v4 as uuidv4 } from "uuid"; -// Define interfaces export interface Recommender { id: string; // UUID address: string; diff --git a/packages/plugin-trustdb/src/index.ts b/packages/plugin-trustdb/src/index.ts new file mode 100644 index 00000000000..5709fc4ce9c --- /dev/null +++ b/packages/plugin-trustdb/src/index.ts @@ -0,0 +1 @@ +export * from "./adapters/trustScoreDatabase.ts"; diff --git a/packages/plugin-trustdb/tsconfig.json b/packages/plugin-trustdb/tsconfig.json new file mode 100644 index 00000000000..eaa78145aa3 --- /dev/null +++ b/packages/plugin-trustdb/tsconfig.json @@ -0,0 +1,8 @@ +{ + "extends": "../../tsconfig.json", + "compilerOptions": { + "outDir": "dist", + "rootDir": "./src" + }, + "include": ["src"] +} diff --git a/packages/plugin-trustdb/tsup.config.ts b/packages/plugin-trustdb/tsup.config.ts new file mode 100644 index 00000000000..1a55f7a745f --- /dev/null +++ b/packages/plugin-trustdb/tsup.config.ts @@ -0,0 +1,10 @@ +import { defineConfig } from "tsup"; + +export default defineConfig({ + entry: ["src/index.ts"], + outDir: "dist", + sourcemap: true, + clean: true, + format: ["esm"], // Ensure you're targeting CommonJS + external: [], +}); diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 6e81c8de578..b66ba203f18 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -237,6 +237,9 @@ importers: '@ai16z/plugin-solana': specifier: workspace:* version: link:../plugin-solana + '@ai16z/plugin-trustdb': + specifier: workspace:* + version: link:../plugin-trustdb '@types/body-parser': specifier: 1.19.5 version: 1.19.5 @@ -727,6 +730,9 @@ importers: '@ai16z/eliza': specifier: workspace:* version: link:../core + '@ai16z/plugin-trustdb': + specifier: workspace:* + version: link:../plugin-trustdb '@coral-xyz/anchor': specifier: ^0.30.1 version: 0.30.1(bufferutil@4.0.8)(encoding@0.1.13)(utf-8-validate@5.0.10) @@ -779,6 +785,24 @@ importers: specifier: 7.1.0 version: 7.1.0 + packages/plugin-trustdb: + dependencies: + '@ai16z/eliza': + specifier: workspace:* + version: link:../core + tsup: + specifier: ^8.3.5 + version: 8.3.5(jiti@1.21.6)(postcss@8.4.49)(typescript@5.6.3)(yaml@2.6.0) + uuid: + specifier: 11.0.2 + version: 11.0.2 + vitest: + specifier: ^2.1.4 + version: 2.1.5(@types/node@22.8.4)(terser@5.36.0) + whatwg-url: + specifier: 7.1.0 + version: 7.1.0 + packages: '@adraffy/ens-normalize@1.10.1': diff --git a/scripts/build.sh b/scripts/build.sh index 0e8897d3419..10cf19cce30 100644 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -21,6 +21,7 @@ fi # Define packages to build in order PACKAGES=( "core" + "plugin-trustdb" "plugin-solana" "plugin-starknet" "adapter-postgres" From e4474d8a62ccbf1ed856da6901e7dce8a2731162 Mon Sep 17 00:00:00 2001 From: ponderingdemocritus Date: Sat, 16 Nov 2024 16:39:28 +1100 Subject: [PATCH 03/10] remove --- packages/agent/src/index.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/agent/src/index.ts b/packages/agent/src/index.ts index bc8f51d53d0..fe5c40141aa 100644 --- a/packages/agent/src/index.ts +++ b/packages/agent/src/index.ts @@ -21,7 +21,6 @@ import Database from "better-sqlite3"; import fs from "fs"; import readline from "readline"; import yargs from "yargs"; -import { blobert } from "./blobert.ts"; export const wait = (minTime: number = 1000, maxTime: number = 3000) => { const waitTime = @@ -273,7 +272,7 @@ const startAgents = async () => { let charactersArg = args.characters || args.character; - let characters = [blobert]; + let characters = [defaultCharacter]; if (charactersArg) { characters = await loadCharacters(charactersArg); From 87a175799fa0ef33f91f7f22b1a25e5f78ec1fcb Mon Sep 17 00:00:00 2001 From: ponderingdemocritus Date: Sat, 16 Nov 2024 16:49:57 +1100 Subject: [PATCH 04/10] clean plugin --- .../plugin-starknet/src/providers/avnu.ts | 74 ------------------- 1 file changed, 74 deletions(-) delete mode 100644 packages/plugin-starknet/src/providers/avnu.ts diff --git a/packages/plugin-starknet/src/providers/avnu.ts b/packages/plugin-starknet/src/providers/avnu.ts deleted file mode 100644 index 15fbd874f0c..00000000000 --- a/packages/plugin-starknet/src/providers/avnu.ts +++ /dev/null @@ -1,74 +0,0 @@ -import { IAgentRuntime } from "@ai16z/eliza"; - -interface AvnuQuoteParams { - sellTokenAddress: string; - buyTokenAddress: string; - sellAmount?: string; - takerAddress?: string; - excludeSources?: string[]; - size?: number; - integratorName?: string; -} - -export async function fetchAvnuQuote( - runtime: IAgentRuntime, - params: AvnuQuoteParams -) { - const apiKey = runtime.getSetting("AVNU_API_KEY"); - - // Build query parameters - const queryParams = new URLSearchParams(); - queryParams.append("sellTokenAddress", params.sellTokenAddress); - queryParams.append("buyTokenAddress", params.buyTokenAddress); - - if (params.sellAmount) { - queryParams.append("sellAmount", params.sellAmount); - } - if (params.takerAddress) { - queryParams.append("takerAddress", params.takerAddress); - } - if (params.excludeSources) { - queryParams.append("excludeSources", params.excludeSources.join(",")); - } - if (params.size) { - queryParams.append("size", params.size.toString()); - } - if (params.integratorName) { - queryParams.append("integratorName", params.integratorName); - } - - const url = `https://starknet.api.avnu.fi/swap/v2/quotes?${queryParams.toString()}`; - - const response = await fetch(url, { - method: "GET", - headers: { - Accept: "application/json", - Authorization: `Bearer ${apiKey}`, - }, - }); - - if (!response.ok) { - const errorText = await response.text(); - throw new Error(`Failed to fetch Avnu quote: ${errorText}`); - } - - return response.json(); -} - -export const avnuProvider = { - get: async (runtime: IAgentRuntime) => { - try { - const params = { - sellTokenAddress: runtime.getSetting("SELL_TOKEN_ADDRESS"), - buyTokenAddress: runtime.getSetting("BUY_TOKEN_ADDRESS"), - sellAmount: runtime.getSetting("SELL_AMOUNT"), - }; - - const quote = await fetchAvnuQuote(runtime, params); - return JSON.stringify(quote, null, 2); - } catch (error) { - console.error("Error fetching Avnu quote:", error); - return `Failed to fetch quote: ${error instanceof Error ? error.message : "Unknown error"}`; - } - }, -}; From 20f965f01323c605cb087714902c2de99bb64f32 Mon Sep 17 00:00:00 2001 From: ponderingdemocritus Date: Sat, 16 Nov 2024 17:02:05 +1100 Subject: [PATCH 05/10] plug --- packages/plugin-starknet/src/index.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/packages/plugin-starknet/src/index.ts b/packages/plugin-starknet/src/index.ts index f97ef404265..353ac1363d7 100644 --- a/packages/plugin-starknet/src/index.ts +++ b/packages/plugin-starknet/src/index.ts @@ -1,5 +1,4 @@ import { Plugin } from "@ai16z/eliza"; -import { avnuProvider } from "./providers/avnu.ts"; export const starknetPlugin: Plugin = { name: "starknet", @@ -8,7 +7,7 @@ export const starknetPlugin: Plugin = { // TODO: Add actions like swap, etc. ], evaluators: [], - providers: [avnuProvider], + providers: [], }; export default starknetPlugin; From d155b60da937ac42dcd4fc4242e9ba47346eb878 Mon Sep 17 00:00:00 2001 From: joven_area Date: Sat, 16 Nov 2024 16:24:30 +0800 Subject: [PATCH 06/10] Add Community & contact and Star History --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index be810a2954f..73d580d70f5 100644 --- a/README.md +++ b/README.md @@ -198,3 +198,20 @@ pnpm docker This will drop you into a shell inside the docker container where you can continue to configure the instance and then you can start it with `pnpm start` + + +## Community & contact + +* [GitHub Issues](https://github.com/ai16z/eliza/issues). Best for: bugs you encounter using Eliza, and feature proposals. +* [Discord](https://discord.gg/ai16z). Best for: sharing your applications and hanging out with the community. + + +**Contributors** + + + + + +## Star History + +[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date) From ba142f28e61c95c1e659a6882974f2f270c7352b Mon Sep 17 00:00:00 2001 From: ponderingdemocritus Date: Sat, 16 Nov 2024 19:32:59 +1100 Subject: [PATCH 07/10] fixes --- packages/plugin-solana/src/actions/pumpfun.ts | 5 +- packages/plugin-solana/src/actions/swap.ts | 8 +- .../plugin-solana/src/evaluators/trust.ts | 9 +- .../plugin-solana/src/providers/balances.ts | 108 ------------------ .../plugin-solana/src/providers/orderBook.ts | 2 +- packages/plugin-solana/src/providers/token.ts | 2 +- .../src/providers/trustScoreProvider.ts | 2 +- 7 files changed, 13 insertions(+), 123 deletions(-) delete mode 100644 packages/plugin-solana/src/providers/balances.ts diff --git a/packages/plugin-solana/src/actions/pumpfun.ts b/packages/plugin-solana/src/actions/pumpfun.ts index 757a8b2715b..96fe39d0eca 100644 --- a/packages/plugin-solana/src/actions/pumpfun.ts +++ b/packages/plugin-solana/src/actions/pumpfun.ts @@ -25,10 +25,7 @@ import { type Action, } from "@ai16z/eliza"; -import { - walletProvider, - //WalletProvider, -} from "../providers/wallet.ts"; +import { walletProvider } from "../providers/wallet.ts"; export interface CreateAndBuyContent extends Content { tokenMetadata: { diff --git a/packages/plugin-solana/src/actions/swap.ts b/packages/plugin-solana/src/actions/swap.ts index 590e4d72e0f..e1803eb8c03 100644 --- a/packages/plugin-solana/src/actions/swap.ts +++ b/packages/plugin-solana/src/actions/swap.ts @@ -7,10 +7,7 @@ import { } from "@solana/web3.js"; import BigNumber from "bignumber.js"; import { v4 as uuidv4 } from "uuid"; -import { TrustScoreDatabase } from "../adapters/trustScoreDatabase.ts"; -import { composeContext } from "@ai16z/eliza"; -import { generateObject } from "@ai16z/eliza"; -import { settings } from "@ai16z/eliza"; +import { TrustScoreDatabase } from "@ai16z/plugin-trustdb"; import { ActionExample, HandlerCallback, @@ -19,6 +16,9 @@ import { ModelClass, State, type Action, + composeContext, + generateObject, + settings, } from "@ai16z/eliza"; import { TokenProvider } from "../providers/token.ts"; import { TrustScoreManager } from "../providers/trustScoreProvider.ts"; diff --git a/packages/plugin-solana/src/evaluators/trust.ts b/packages/plugin-solana/src/evaluators/trust.ts index 04f020cc6c5..9160888e61b 100644 --- a/packages/plugin-solana/src/evaluators/trust.ts +++ b/packages/plugin-solana/src/evaluators/trust.ts @@ -1,8 +1,9 @@ -import { composeContext } from "@ai16z/eliza"; -import { generateObjectArray, generateTrueOrFalse } from "@ai16z/eliza"; -import { MemoryManager } from "@ai16z/eliza"; -import { booleanFooter } from "@ai16z/eliza"; import { + composeContext, + generateObjectArray, + generateTrueOrFalse, + MemoryManager, + booleanFooter, ActionExample, Content, IAgentRuntime, diff --git a/packages/plugin-solana/src/providers/balances.ts b/packages/plugin-solana/src/providers/balances.ts deleted file mode 100644 index 4e28a31f7f1..00000000000 --- a/packages/plugin-solana/src/providers/balances.ts +++ /dev/null @@ -1,108 +0,0 @@ -// TokenBalanceProvider.ts -import { Connection, PublicKey } from "@solana/web3.js"; -import { getTokenBalances, getTokenPriceInSol } from "./tokenUtils.ts"; - -interface Item { - name: string; - symbol: string; - decimals: number; - balance: string; - uiAmount: string; - priceUSD: string; - valueUSD: string; -} -interface walletPortfolio { - totalUsd: string; - items: Array; -} -interface price { - usd: string; -} -interface Prices { - solana: price; - bitcoin: price; - ethereum: price; -} -const API_Key = ""; -export default class WalletProvider { - private connection: Connection; - private walletPublicKey: PublicKey; - - constructor(connection: Connection, walletPublicKey: PublicKey) { - this.connection = connection; - this.walletPublicKey = walletPublicKey; - } - - async getFormattedTokenBalances(): Promise { - const tokenBalances = await getTokenBalances( - this.connection, - this.walletPublicKey - ); - - let formattedBalances = "Token Balances:\n"; - let totalValueInSol = 0; - - for (const [tokenName, balance] of Object.entries(tokenBalances)) { - const tokenPrice = await getTokenPriceInSol(tokenName); - const totalValue = balance * tokenPrice; - totalValueInSol += totalValue; - - formattedBalances += `${tokenName}: ${balance} (${totalValue} SOL)\n`; - } - - formattedBalances += `\nTotal Value: ${totalValueInSol} SOL`; - - return formattedBalances; - } - - async fetchPortfolioValue( - walletPublicKey: string - ): Promise { - try { - const options = { - method: "GET", - headers: { - accept: "application/json", - "x-chain": "solana", - "X-API-KEY": API_Key, - }, - }; - const walletPortfolio = await fetch( - `https://public-api.birdeye.so/v1/wallet/token_list?wallet=${walletPublicKey}`, - options - ); - const walletPortfolioJson = await walletPortfolio.json(); - const data = walletPortfolioJson.data; - const totalUsd = data.totalUsd; - const items = data.items; - const walletPortfolioFormatted = { - totalUsd, - items, - }; - return walletPortfolioFormatted; - } catch (error) { - console.log(error); - } - } - - async fetchPrices(): Promise { - const apiUrl = "https://api.coingecko.com/api/v3/simple/price"; - const ids = "solana,bitcoin,ethereum"; - const vsCurrencies = "usd"; - - try { - const response = await fetch( - `${apiUrl}?ids=${ids}&vs_currencies=${vsCurrencies}` - ); - - if (!response.ok) { - throw new Error("Failed to fetch prices"); - } - - const data = await response.json(); - return data; - } catch (error) { - console.log("Error fetching prices:", error); - } - } -} diff --git a/packages/plugin-solana/src/providers/orderBook.ts b/packages/plugin-solana/src/providers/orderBook.ts index 40a215762ab..fc3e38aeeba 100644 --- a/packages/plugin-solana/src/providers/orderBook.ts +++ b/packages/plugin-solana/src/providers/orderBook.ts @@ -1,6 +1,6 @@ import { IAgentRuntime, Memory, Provider, State } from "@ai16z/eliza"; import * as fs from "fs"; -import settings from "@ai16z/eliza/src/settings.ts"; +import { settings } from "@ai16z/eliza"; interface Order { userId: string; diff --git a/packages/plugin-solana/src/providers/token.ts b/packages/plugin-solana/src/providers/token.ts index 538e44349a7..940b60ad919 100644 --- a/packages/plugin-solana/src/providers/token.ts +++ b/packages/plugin-solana/src/providers/token.ts @@ -1,4 +1,4 @@ -import settings from "@ai16z/eliza/src/settings.ts"; +import { settings } from "@ai16z/eliza"; import { IAgentRuntime, Memory, Provider, State } from "@ai16z/eliza"; import { DexScreenerData, diff --git a/packages/plugin-solana/src/providers/trustScoreProvider.ts b/packages/plugin-solana/src/providers/trustScoreProvider.ts index 9ac3337ea66..cd0976b751a 100644 --- a/packages/plugin-solana/src/providers/trustScoreProvider.ts +++ b/packages/plugin-solana/src/providers/trustScoreProvider.ts @@ -17,7 +17,7 @@ import { TradePerformance, TokenRecommendation, } from "@ai16z/plugin-trustdb"; -import settings from "@ai16z/eliza/src/settings.ts"; +import { settings } from "@ai16z/eliza"; import { IAgentRuntime, Memory, Provider, State } from "@ai16z/eliza"; const Wallet = settings.MAIN_WALLET_ADDRESS; From f118f5cc96e667a6124528363e43f02488d643b0 Mon Sep 17 00:00:00 2001 From: ponderingdemocritus Date: Sat, 16 Nov 2024 19:34:59 +1100 Subject: [PATCH 08/10] pnpm --- pnpm-lock.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 5836632c017..950bfc0ce4b 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -21486,7 +21486,7 @@ snapshots: log-symbols@4.1.0: dependencies: - chalk: 4.1.2 + chalk: 4.1.0 is-unicode-supported: 0.1.0 log-symbols@6.0.0: From 35f243aa3f43c309efe03162ffa4465384ccf972 Mon Sep 17 00:00:00 2001 From: Oguz Serdar Date: Sat, 16 Nov 2024 08:33:03 -0700 Subject: [PATCH 09/10] update tweet interval to 90-180 mins Temporary solution for controlled post frequency range of 8-16 posts per day --- packages/client-twitter/src/post.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/client-twitter/src/post.ts b/packages/client-twitter/src/post.ts index 4350acfc847..a999dded379 100644 --- a/packages/client-twitter/src/post.ts +++ b/packages/client-twitter/src/post.ts @@ -33,8 +33,8 @@ export class TwitterPostClient extends ClientBase { this.generateNewTweet(); setTimeout( generateNewTweetLoop, - (Math.floor(Math.random() * (4 - 1 + 1)) + 1) * 60 * 60 * 1000 - ); // Random interval between 1 and 4 hours + (Math.floor(Math.random() * (180 - 90 + 1)) + 90) * 60 * 1000 + ); // Random interval: min 90min/max 180min (1.5-3h), Results in min 8/max 16 posts per day }; // setTimeout(() => { generateNewTweetLoop(); From 7e7a23059e7d510c01cf4acba5191c62c74a627e Mon Sep 17 00:00:00 2001 From: madjin <32600939+madjin@users.noreply.github.com> Date: Sat, 16 Nov 2024 14:06:08 -0500 Subject: [PATCH 10/10] update docs with new stream notes --- docs/api/classes/AgentRuntime.md | 70 ++-- docs/api/classes/DatabaseAdapter.md | 84 ++--- docs/api/classes/MemoryManager.md | 22 +- docs/api/classes/Service.md | 2 +- docs/api/enumerations/Clients.md | 6 +- docs/api/enumerations/GoalStatus.md | 8 +- docs/api/enumerations/ModelClass.md | 8 +- docs/api/enumerations/ModelProviderName.md | 26 +- docs/api/enumerations/ServiceType.md | 24 +- docs/api/interfaces/Account.md | 12 +- docs/api/interfaces/Action.md | 10 +- docs/api/interfaces/ActionExample.md | 2 +- docs/api/interfaces/Actor.md | 6 +- docs/api/interfaces/Content.md | 12 +- docs/api/interfaces/ConversationExample.md | 2 +- docs/api/interfaces/EvaluationExample.md | 4 +- docs/api/interfaces/Evaluator.md | 12 +- docs/api/interfaces/GenerationOptions.md | 22 +- docs/api/interfaces/Goal.md | 10 +- docs/api/interfaces/IAgentRuntime.md | 58 +-- docs/api/interfaces/IBrowserService.md | 4 +- docs/api/interfaces/IDatabaseAdapter.md | 84 ++--- .../interfaces/IImageDescriptionService.md | 4 +- docs/api/interfaces/IMemoryManager.md | 24 +- docs/api/interfaces/ITextGenerationService.md | 20 +- docs/api/interfaces/ITranscriptionService.md | 6 +- docs/api/interfaces/IVideoService.md | 6 +- docs/api/interfaces/Memory.md | 14 +- docs/api/interfaces/MessageExample.md | 2 +- docs/api/interfaces/Objective.md | 4 +- docs/api/interfaces/Participant.md | 2 +- docs/api/interfaces/Relationship.md | 12 +- docs/api/interfaces/Room.md | 2 +- docs/api/interfaces/State.md | 46 +-- docs/api/type-aliases/Character.md | 4 +- docs/api/type-aliases/Model.md | 12 +- docs/api/type-aliases/Models.md | 12 +- docs/api/typedoc-sidebar.cjs | 352 +----------------- docs/api/variables/stringArrayFooter.md | 2 +- docs/docs/api/_media/README_FR.md | 172 +++++++++ docs/docs/api/_media/README_JA.md | 174 +++++++++ docs/docs/api/_media/README_KOR.md | 171 +++++++++ docs/docs/community/streams/2024-11-10.md | 40 ++ docs/docs/community/streams/2024-11-15.md | 48 +++ docs/sidebars.js | 10 + 45 files changed, 947 insertions(+), 680 deletions(-) create mode 100644 docs/docs/api/_media/README_FR.md create mode 100644 docs/docs/api/_media/README_JA.md create mode 100644 docs/docs/api/_media/README_KOR.md create mode 100644 docs/docs/community/streams/2024-11-10.md create mode 100644 docs/docs/community/streams/2024-11-15.md diff --git a/docs/api/classes/AgentRuntime.md b/docs/api/classes/AgentRuntime.md index 4221daffd88..8987bd1b35d 100644 --- a/docs/api/classes/AgentRuntime.md +++ b/docs/api/classes/AgentRuntime.md @@ -97,7 +97,7 @@ The ID of the agent [packages/core/src/runtime.ts:59](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L59) ---- +*** ### serverUrl @@ -113,7 +113,7 @@ The base URL of the server where the agent's requests are processed. [packages/core/src/runtime.ts:63](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L63) ---- +*** ### databaseAdapter @@ -129,7 +129,7 @@ The database adapter used for interacting with the database. [packages/core/src/runtime.ts:68](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L68) ---- +*** ### token @@ -145,7 +145,7 @@ Authentication token used for securing requests. [packages/core/src/runtime.ts:73](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L73) ---- +*** ### actions @@ -161,7 +161,7 @@ Custom actions that the agent can perform. [packages/core/src/runtime.ts:78](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L78) ---- +*** ### evaluators @@ -177,7 +177,7 @@ Evaluators used to assess and guide the agent's responses. [packages/core/src/runtime.ts:83](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L83) ---- +*** ### providers @@ -193,7 +193,7 @@ Context providers used to provide context for message generation. [packages/core/src/runtime.ts:88](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L88) ---- +*** ### modelProvider @@ -209,7 +209,7 @@ The model to use for generateText. [packages/core/src/runtime.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L93) ---- +*** ### fetch() @@ -244,7 +244,7 @@ Some environments may not have access to the global fetch function and need a cu [packages/core/src/runtime.ts:99](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L99) ---- +*** ### character @@ -260,7 +260,7 @@ The character to use for the agent [packages/core/src/runtime.ts:104](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L104) ---- +*** ### messageManager @@ -276,7 +276,7 @@ Store messages that are sent and received by the agent. [packages/core/src/runtime.ts:109](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L109) ---- +*** ### descriptionManager @@ -292,7 +292,7 @@ Store and recall descriptions of users based on conversations. [packages/core/src/runtime.ts:114](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L114) ---- +*** ### loreManager @@ -308,7 +308,7 @@ Manage the creation and recall of static information (documents, historical game [packages/core/src/runtime.ts:119](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L119) ---- +*** ### documentsManager @@ -320,7 +320,7 @@ Hold large documents that can be referenced [packages/core/src/runtime.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L124) ---- +*** ### knowledgeManager @@ -332,7 +332,7 @@ Searchable document fragments [packages/core/src/runtime.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L129) ---- +*** ### services @@ -346,7 +346,7 @@ Searchable document fragments [packages/core/src/runtime.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L131) ---- +*** ### memoryManagers @@ -378,7 +378,7 @@ Searchable document fragments [packages/core/src/runtime.ts:134](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L134) ---- +*** ### getMemoryManager() @@ -400,11 +400,11 @@ Searchable document fragments [packages/core/src/runtime.ts:149](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L149) ---- +*** ### getService() -> **getService**(`service`): _typeof_ [`Service`](Service.md) +> **getService**(`service`): *typeof* [`Service`](Service.md) #### Parameters @@ -412,7 +412,7 @@ Searchable document fragments #### Returns -_typeof_ [`Service`](Service.md) +*typeof* [`Service`](Service.md) #### Implementation of @@ -422,7 +422,7 @@ _typeof_ [`Service`](Service.md) [packages/core/src/runtime.ts:153](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L153) ---- +*** ### registerService() @@ -444,7 +444,7 @@ _typeof_ [`Service`](Service.md) [packages/core/src/runtime.ts:161](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L161) ---- +*** ### getSetting() @@ -466,7 +466,7 @@ _typeof_ [`Service`](Service.md) [packages/core/src/runtime.ts:368](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L368) ---- +*** ### getConversationLength() @@ -488,7 +488,7 @@ The number of recent messages to be kept in memory. [packages/core/src/runtime.ts:390](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L390) ---- +*** ### registerAction() @@ -514,7 +514,7 @@ The action to register. [packages/core/src/runtime.ts:398](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L398) ---- +*** ### registerEvaluator() @@ -536,7 +536,7 @@ The evaluator to register. [packages/core/src/runtime.ts:407](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L407) ---- +*** ### registerContextProvider() @@ -558,7 +558,7 @@ The context provider to register. [packages/core/src/runtime.ts:415](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L415) ---- +*** ### processActions() @@ -590,7 +590,7 @@ The message to process. [packages/core/src/runtime.ts:424](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L424) ---- +*** ### evaluate() @@ -626,7 +626,7 @@ The results of the evaluation. [packages/core/src/runtime.ts:497](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L497) ---- +*** ### ensureParticipantExists() @@ -658,7 +658,7 @@ An error if the participant cannot be added. [packages/core/src/runtime.ts:567](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L567) ---- +*** ### ensureUserExists() @@ -694,7 +694,7 @@ The user name to ensure the existence of. [packages/core/src/runtime.ts:583](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L583) ---- +*** ### ensureParticipantInRoom() @@ -718,7 +718,7 @@ The user name to ensure the existence of. [packages/core/src/runtime.ts:603](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L603) ---- +*** ### ensureConnection() @@ -748,7 +748,7 @@ The user name to ensure the existence of. [packages/core/src/runtime.ts:614](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L614) ---- +*** ### ensureRoomExists() @@ -779,7 +779,7 @@ An error if the room cannot be created. [packages/core/src/runtime.ts:650](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L650) ---- +*** ### composeState() @@ -809,7 +809,7 @@ The state of the agent. [packages/core/src/runtime.ts:663](https://github.com/ai16z/eliza/blob/main/packages/core/src/runtime.ts#L663) ---- +*** ### updateRecentMessageState() diff --git a/docs/api/classes/DatabaseAdapter.md b/docs/api/classes/DatabaseAdapter.md index 26e39894ed1..74de091a3ec 100644 --- a/docs/api/classes/DatabaseAdapter.md +++ b/docs/api/classes/DatabaseAdapter.md @@ -63,7 +63,7 @@ A Promise that resolves to the Account object or null if not found. [packages/core/src/database.ts:27](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L27) ---- +*** ### createAccount() @@ -91,7 +91,7 @@ A Promise that resolves when the account creation is complete. [packages/core/src/database.ts:34](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L34) ---- +*** ### getMemories() @@ -127,7 +127,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:41](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L41) ---- +*** ### getMemoriesByRoomIds() @@ -155,7 +155,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:48](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L48) ---- +*** ### getMemoryById() @@ -177,7 +177,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:54](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L54) ---- +*** ### getCachedEmbeddings() @@ -191,17 +191,17 @@ Retrieves cached embeddings based on the specified query parameters. An object containing parameters for the embedding retrieval. -• **params.query_table_name**: `string` +• **params.query\_table\_name**: `string` -• **params.query_threshold**: `number` +• **params.query\_threshold**: `number` -• **params.query_input**: `string` +• **params.query\_input**: `string` -• **params.query_field_name**: `string` +• **params.query\_field\_name**: `string` -• **params.query_field_sub_name**: `string` +• **params.query\_field\_sub\_name**: `string` -• **params.query_match_count**: `number` +• **params.query\_match\_count**: `number` #### Returns @@ -217,7 +217,7 @@ A Promise that resolves to an array of objects containing embeddings and levensh [packages/core/src/database.ts:61](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L61) ---- +*** ### log() @@ -253,7 +253,7 @@ A Promise that resolves when the log entry has been saved. [packages/core/src/database.ts:87](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L87) ---- +*** ### getActorDetails() @@ -283,7 +283,7 @@ A Promise that resolves to an array of Actor objects. [packages/core/src/database.ts:99](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L99) ---- +*** ### searchMemories() @@ -303,9 +303,9 @@ An object containing parameters for the memory search. • **params.embedding**: `number`[] -• **params.match_threshold**: `number` +• **params.match\_threshold**: `number` -• **params.match_count**: `number` +• **params.match\_count**: `number` • **params.unique**: `boolean` @@ -323,7 +323,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:106](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L106) ---- +*** ### updateGoalStatus() @@ -355,7 +355,7 @@ A Promise that resolves when the goal status has been updated. [packages/core/src/database.ts:120](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L120) ---- +*** ### searchMemoriesByEmbedding() @@ -373,7 +373,7 @@ The embedding vector to search with. Additional parameters for the search. -• **params.match_threshold?**: `number` +• **params.match\_threshold?**: `number` • **params.count?**: `number` @@ -399,7 +399,7 @@ A Promise that resolves to an array of Memory objects. [packages/core/src/database.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L131) ---- +*** ### createMemory() @@ -435,7 +435,7 @@ A Promise that resolves when the memory has been created. [packages/core/src/database.ts:150](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L150) ---- +*** ### removeMemory() @@ -467,7 +467,7 @@ A Promise that resolves when the memory has been removed. [packages/core/src/database.ts:162](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L162) ---- +*** ### removeAllMemories() @@ -499,7 +499,7 @@ A Promise that resolves when all memories have been removed. [packages/core/src/database.ts:170](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L170) ---- +*** ### countMemories() @@ -535,7 +535,7 @@ A Promise that resolves to the number of memories. [packages/core/src/database.ts:179](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L179) ---- +*** ### getGoals() @@ -571,7 +571,7 @@ A Promise that resolves to an array of Goal objects. [packages/core/src/database.ts:190](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L190) ---- +*** ### updateGoal() @@ -599,7 +599,7 @@ A Promise that resolves when the goal has been updated. [packages/core/src/database.ts:202](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L202) ---- +*** ### createGoal() @@ -627,7 +627,7 @@ A Promise that resolves when the goal has been created. [packages/core/src/database.ts:209](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L209) ---- +*** ### removeGoal() @@ -655,7 +655,7 @@ A Promise that resolves when the goal has been removed. [packages/core/src/database.ts:216](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L216) ---- +*** ### removeAllGoals() @@ -683,7 +683,7 @@ A Promise that resolves when all goals have been removed. [packages/core/src/database.ts:223](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L223) ---- +*** ### getRoom() @@ -711,7 +711,7 @@ A Promise that resolves to the room ID or null if not found. [packages/core/src/database.ts:230](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L230) ---- +*** ### createRoom() @@ -739,7 +739,7 @@ A Promise that resolves to the UUID of the created room. [packages/core/src/database.ts:237](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L237) ---- +*** ### removeRoom() @@ -767,7 +767,7 @@ A Promise that resolves when the room has been removed. [packages/core/src/database.ts:244](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L244) ---- +*** ### getRoomsForParticipant() @@ -795,7 +795,7 @@ A Promise that resolves to an array of room IDs. [packages/core/src/database.ts:251](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L251) ---- +*** ### getRoomsForParticipants() @@ -823,7 +823,7 @@ A Promise that resolves to an array of room IDs. [packages/core/src/database.ts:258](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L258) ---- +*** ### addParticipant() @@ -855,7 +855,7 @@ A Promise that resolves to a boolean indicating success or failure. [packages/core/src/database.ts:266](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L266) ---- +*** ### removeParticipant() @@ -887,7 +887,7 @@ A Promise that resolves to a boolean indicating success or failure. [packages/core/src/database.ts:274](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L274) ---- +*** ### getParticipantsForAccount() @@ -943,7 +943,7 @@ A Promise that resolves to an array of Participant objects. [packages/core/src/database.ts:288](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L288) ---- +*** ### getParticipantsForRoom() @@ -971,7 +971,7 @@ A Promise that resolves to an array of UUIDs representing the participants. [packages/core/src/database.ts:295](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L295) ---- +*** ### getParticipantUserState() @@ -995,7 +995,7 @@ A Promise that resolves to an array of UUIDs representing the participants. [packages/core/src/database.ts:297](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L297) ---- +*** ### setParticipantUserState() @@ -1021,7 +1021,7 @@ A Promise that resolves to an array of UUIDs representing the participants. [packages/core/src/database.ts:301](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L301) ---- +*** ### createRelationship() @@ -1053,7 +1053,7 @@ A Promise that resolves to a boolean indicating success or failure of the creati [packages/core/src/database.ts:312](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L312) ---- +*** ### getRelationship() @@ -1085,7 +1085,7 @@ A Promise that resolves to the Relationship object or null if not found. [packages/core/src/database.ts:322](https://github.com/ai16z/eliza/blob/main/packages/core/src/database.ts#L322) ---- +*** ### getRelationships() diff --git a/docs/api/classes/MemoryManager.md b/docs/api/classes/MemoryManager.md index c7991909787..8beb89e784c 100644 --- a/docs/api/classes/MemoryManager.md +++ b/docs/api/classes/MemoryManager.md @@ -54,7 +54,7 @@ The AgentRuntime instance associated with this manager. [packages/core/src/memory.ts:22](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L22) ---- +*** ### tableName @@ -98,7 +98,7 @@ A Promise resolving to the memory object, potentially updated with an embedding [packages/core/src/memory.ts:45](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L45) ---- +*** ### getMemories() @@ -144,7 +144,7 @@ A Promise resolving to an array of Memory objects. [packages/core/src/memory.ts:66](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L66) ---- +*** ### getCachedEmbeddings() @@ -166,7 +166,7 @@ A Promise resolving to an array of Memory objects. [packages/core/src/memory.ts:93](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L93) ---- +*** ### searchMemoriesByEmbedding() @@ -184,7 +184,7 @@ The embedding vector to search with. Options including match threshold, count, user IDs, and uniqueness. -• **opts.match_threshold?**: `number` +• **opts.match\_threshold?**: `number` The similarity threshold for matching memories. @@ -216,7 +216,7 @@ A Promise resolving to an array of Memory objects that match the embedding. [packages/core/src/memory.ts:120](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L120) ---- +*** ### createMemory() @@ -248,7 +248,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:158](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L158) ---- +*** ### getMemoriesByRoomIds() @@ -274,7 +274,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:173](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L173) ---- +*** ### getMemoryById() @@ -296,7 +296,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:184](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L184) ---- +*** ### removeMemory() @@ -324,7 +324,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:194](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L194) ---- +*** ### removeAllMemories() @@ -352,7 +352,7 @@ A Promise that resolves when the operation completes. [packages/core/src/memory.ts:206](https://github.com/ai16z/eliza/blob/main/packages/core/src/memory.ts#L206) ---- +*** ### countMemories() diff --git a/docs/api/classes/Service.md b/docs/api/classes/Service.md index 472c53012bd..ac9a27129a1 100644 --- a/docs/api/classes/Service.md +++ b/docs/api/classes/Service.md @@ -40,7 +40,7 @@ #### Type Parameters -• **T** _extends_ [`Service`](Service.md) +• **T** *extends* [`Service`](Service.md) #### Returns diff --git a/docs/api/enumerations/Clients.md b/docs/api/enumerations/Clients.md index 4822e4915e4..9dd05e6ceb9 100644 --- a/docs/api/enumerations/Clients.md +++ b/docs/api/enumerations/Clients.md @@ -12,7 +12,7 @@ [packages/core/src/types.ts:323](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L323) ---- +*** ### DIRECT @@ -22,7 +22,7 @@ [packages/core/src/types.ts:324](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L324) ---- +*** ### TWITTER @@ -32,7 +32,7 @@ [packages/core/src/types.ts:325](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L325) ---- +*** ### TELEGRAM diff --git a/docs/api/enumerations/GoalStatus.md b/docs/api/enumerations/GoalStatus.md index 1608c034ed1..f8c11f9fc2a 100644 --- a/docs/api/enumerations/GoalStatus.md +++ b/docs/api/enumerations/GoalStatus.md @@ -12,7 +12,7 @@ [packages/core/src/types.ts:57](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L57) ---- +*** ### FAILED @@ -22,11 +22,11 @@ [packages/core/src/types.ts:58](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L58) ---- +*** -### IN_PROGRESS +### IN\_PROGRESS -> **IN_PROGRESS**: `"IN_PROGRESS"` +> **IN\_PROGRESS**: `"IN_PROGRESS"` #### Defined in diff --git a/docs/api/enumerations/ModelClass.md b/docs/api/enumerations/ModelClass.md index d4f3cafaf3f..2ee04c649b4 100644 --- a/docs/api/enumerations/ModelClass.md +++ b/docs/api/enumerations/ModelClass.md @@ -12,7 +12,7 @@ [packages/core/src/types.ts:75](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L75) ---- +*** ### MEDIUM @@ -22,7 +22,7 @@ [packages/core/src/types.ts:76](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L76) ---- +*** ### LARGE @@ -32,7 +32,7 @@ [packages/core/src/types.ts:77](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L77) ---- +*** ### EMBEDDING @@ -42,7 +42,7 @@ [packages/core/src/types.ts:78](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L78) ---- +*** ### IMAGE diff --git a/docs/api/enumerations/ModelProviderName.md b/docs/api/enumerations/ModelProviderName.md index 92560871762..46a1d05618d 100644 --- a/docs/api/enumerations/ModelProviderName.md +++ b/docs/api/enumerations/ModelProviderName.md @@ -12,7 +12,7 @@ [packages/core/src/types.ts:121](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L121) ---- +*** ### ANTHROPIC @@ -22,7 +22,7 @@ [packages/core/src/types.ts:122](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L122) ---- +*** ### GROK @@ -32,7 +32,7 @@ [packages/core/src/types.ts:123](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L123) ---- +*** ### GROQ @@ -42,7 +42,7 @@ [packages/core/src/types.ts:124](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L124) ---- +*** ### LLAMACLOUD @@ -52,7 +52,7 @@ [packages/core/src/types.ts:125](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L125) ---- +*** ### LLAMALOCAL @@ -62,7 +62,7 @@ [packages/core/src/types.ts:126](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L126) ---- +*** ### GOOGLE @@ -72,17 +72,17 @@ [packages/core/src/types.ts:127](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L127) ---- +*** -### CLAUDE_VERTEX +### CLAUDE\_VERTEX -> **CLAUDE_VERTEX**: `"claude_vertex"` +> **CLAUDE\_VERTEX**: `"claude_vertex"` #### Defined in [packages/core/src/types.ts:128](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L128) ---- +*** ### REDPILL @@ -92,7 +92,7 @@ [packages/core/src/types.ts:129](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L129) ---- +*** ### OPENROUTER @@ -102,7 +102,7 @@ [packages/core/src/types.ts:130](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L130) ---- +*** ### OLLAMA @@ -112,7 +112,7 @@ [packages/core/src/types.ts:131](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L131) ---- +*** ### HEURIST diff --git a/docs/api/enumerations/ServiceType.md b/docs/api/enumerations/ServiceType.md index ab704c6558d..340e1987e01 100644 --- a/docs/api/enumerations/ServiceType.md +++ b/docs/api/enumerations/ServiceType.md @@ -4,15 +4,15 @@ ## Enumeration Members -### IMAGE_DESCRIPTION +### IMAGE\_DESCRIPTION -> **IMAGE_DESCRIPTION**: `"image_description"` +> **IMAGE\_DESCRIPTION**: `"image_description"` #### Defined in [packages/core/src/types.ts:658](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L658) ---- +*** ### TRANSCRIPTION @@ -22,7 +22,7 @@ [packages/core/src/types.ts:659](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L659) ---- +*** ### VIDEO @@ -32,17 +32,17 @@ [packages/core/src/types.ts:660](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L660) ---- +*** -### TEXT_GENERATION +### TEXT\_GENERATION -> **TEXT_GENERATION**: `"text_generation"` +> **TEXT\_GENERATION**: `"text_generation"` #### Defined in [packages/core/src/types.ts:661](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L661) ---- +*** ### BROWSER @@ -52,17 +52,17 @@ [packages/core/src/types.ts:662](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L662) ---- +*** -### SPEECH_GENERATION +### SPEECH\_GENERATION -> **SPEECH_GENERATION**: `"speech_generation"` +> **SPEECH\_GENERATION**: `"speech_generation"` #### Defined in [packages/core/src/types.ts:663](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L663) ---- +*** ### PDF diff --git a/docs/api/interfaces/Account.md b/docs/api/interfaces/Account.md index b28d0af497d..3591b68e7b1 100644 --- a/docs/api/interfaces/Account.md +++ b/docs/api/interfaces/Account.md @@ -14,7 +14,7 @@ Represents a user, including their name, details, and a unique identifier. [packages/core/src/types.ts:275](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L275) ---- +*** ### name @@ -24,7 +24,7 @@ Represents a user, including their name, details, and a unique identifier. [packages/core/src/types.ts:276](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L276) ---- +*** ### username @@ -34,7 +34,7 @@ Represents a user, including their name, details, and a unique identifier. [packages/core/src/types.ts:277](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L277) ---- +*** ### details? @@ -42,13 +42,13 @@ Represents a user, including their name, details, and a unique identifier. #### Index Signature -\[`key`: `string`\]: `any` + \[`key`: `string`\]: `any` #### Defined in [packages/core/src/types.ts:278](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L278) ---- +*** ### email? @@ -58,7 +58,7 @@ Represents a user, including their name, details, and a unique identifier. [packages/core/src/types.ts:279](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L279) ---- +*** ### avatarUrl? diff --git a/docs/api/interfaces/Action.md b/docs/api/interfaces/Action.md index f60a0f9bddf..65ea3990aba 100644 --- a/docs/api/interfaces/Action.md +++ b/docs/api/interfaces/Action.md @@ -14,7 +14,7 @@ Represents an action that the agent can perform, including conditions for its us [packages/core/src/types.ts:217](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L217) ---- +*** ### description @@ -24,7 +24,7 @@ Represents an action that the agent can perform, including conditions for its us [packages/core/src/types.ts:218](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L218) ---- +*** ### examples @@ -34,7 +34,7 @@ Represents an action that the agent can perform, including conditions for its us [packages/core/src/types.ts:219](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L219) ---- +*** ### handler @@ -44,7 +44,7 @@ Represents an action that the agent can perform, including conditions for its us [packages/core/src/types.ts:220](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L220) ---- +*** ### name @@ -54,7 +54,7 @@ Represents an action that the agent can perform, including conditions for its us [packages/core/src/types.ts:221](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L221) ---- +*** ### validate diff --git a/docs/api/interfaces/ActionExample.md b/docs/api/interfaces/ActionExample.md index c17ef42017f..4b9857324df 100644 --- a/docs/api/interfaces/ActionExample.md +++ b/docs/api/interfaces/ActionExample.md @@ -14,7 +14,7 @@ Represents an example of content, typically used for demonstrating or testing pu [packages/core/src/types.ts:25](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L25) ---- +*** ### content diff --git a/docs/api/interfaces/Actor.md b/docs/api/interfaces/Actor.md index 0e613ce860c..f6d2aac0238 100644 --- a/docs/api/interfaces/Actor.md +++ b/docs/api/interfaces/Actor.md @@ -14,7 +14,7 @@ Represents an actor in the conversation, which could be a user or the agent itse [packages/core/src/types.ts:41](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L41) ---- +*** ### username @@ -24,7 +24,7 @@ Represents an actor in the conversation, which could be a user or the agent itse [packages/core/src/types.ts:42](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L42) ---- +*** ### details @@ -46,7 +46,7 @@ Represents an actor in the conversation, which could be a user or the agent itse [packages/core/src/types.ts:43](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L43) ---- +*** ### id diff --git a/docs/api/interfaces/Content.md b/docs/api/interfaces/Content.md index fbdbbdc6491..8ed06147ca9 100644 --- a/docs/api/interfaces/Content.md +++ b/docs/api/interfaces/Content.md @@ -6,7 +6,7 @@ Represents the content of a message, including its main text (`content`), any as ## Indexable -\[`key`: `string`\]: `unknown` + \[`key`: `string`\]: `unknown` ## Properties @@ -18,7 +18,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:12](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L12) ---- +*** ### action? @@ -28,7 +28,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:13](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L13) ---- +*** ### source? @@ -38,7 +38,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:14](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L14) ---- +*** ### url? @@ -48,7 +48,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:15](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L15) ---- +*** ### inReplyTo? @@ -58,7 +58,7 @@ Represents the content of a message, including its main text (`content`), any as [packages/core/src/types.ts:16](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L16) ---- +*** ### attachments? diff --git a/docs/api/interfaces/ConversationExample.md b/docs/api/interfaces/ConversationExample.md index 28f7f975a5d..85d70796dd2 100644 --- a/docs/api/interfaces/ConversationExample.md +++ b/docs/api/interfaces/ConversationExample.md @@ -14,7 +14,7 @@ Represents an example of content, typically used for demonstrating or testing pu [packages/core/src/types.ts:33](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L33) ---- +*** ### content diff --git a/docs/api/interfaces/EvaluationExample.md b/docs/api/interfaces/EvaluationExample.md index c1dab7cea23..69a591cab26 100644 --- a/docs/api/interfaces/EvaluationExample.md +++ b/docs/api/interfaces/EvaluationExample.md @@ -14,7 +14,7 @@ Represents an example for evaluation, including the context, an array of message [packages/core/src/types.ts:229](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L229) ---- +*** ### messages @@ -24,7 +24,7 @@ Represents an example for evaluation, including the context, an array of message [packages/core/src/types.ts:230](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L230) ---- +*** ### outcome diff --git a/docs/api/interfaces/Evaluator.md b/docs/api/interfaces/Evaluator.md index dcb4daae488..301acc1d78b 100644 --- a/docs/api/interfaces/Evaluator.md +++ b/docs/api/interfaces/Evaluator.md @@ -14,7 +14,7 @@ Represents an evaluator, which is used to assess and guide the agent's responses [packages/core/src/types.ts:238](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L238) ---- +*** ### description @@ -24,7 +24,7 @@ Represents an evaluator, which is used to assess and guide the agent's responses [packages/core/src/types.ts:239](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L239) ---- +*** ### similes @@ -34,7 +34,7 @@ Represents an evaluator, which is used to assess and guide the agent's responses [packages/core/src/types.ts:240](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L240) ---- +*** ### examples @@ -44,7 +44,7 @@ Represents an evaluator, which is used to assess and guide the agent's responses [packages/core/src/types.ts:241](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L241) ---- +*** ### handler @@ -54,7 +54,7 @@ Represents an evaluator, which is used to assess and guide the agent's responses [packages/core/src/types.ts:242](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L242) ---- +*** ### name @@ -64,7 +64,7 @@ Represents an evaluator, which is used to assess and guide the agent's responses [packages/core/src/types.ts:243](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L243) ---- +*** ### validate diff --git a/docs/api/interfaces/GenerationOptions.md b/docs/api/interfaces/GenerationOptions.md index 8e91690dcc0..b2d781563f3 100644 --- a/docs/api/interfaces/GenerationOptions.md +++ b/docs/api/interfaces/GenerationOptions.md @@ -14,7 +14,7 @@ Configuration options for generating objects with a model. [packages/core/src/generation.ts:867](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L867) ---- +*** ### context @@ -24,7 +24,7 @@ Configuration options for generating objects with a model. [packages/core/src/generation.ts:868](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L868) ---- +*** ### modelClass @@ -34,17 +34,17 @@ Configuration options for generating objects with a model. [packages/core/src/generation.ts:869](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L869) ---- +*** ### schema? -> `optional` **schema**: `ZodType`\<`any`, `ZodTypeDef`, `any`\> +> `optional` **schema**: `ZodSchema` #### Defined in [packages/core/src/generation.ts:870](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L870) ---- +*** ### schemaName? @@ -54,7 +54,7 @@ Configuration options for generating objects with a model. [packages/core/src/generation.ts:871](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L871) ---- +*** ### schemaDescription? @@ -64,7 +64,7 @@ Configuration options for generating objects with a model. [packages/core/src/generation.ts:872](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L872) ---- +*** ### stop? @@ -74,7 +74,7 @@ Configuration options for generating objects with a model. [packages/core/src/generation.ts:873](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L873) ---- +*** ### mode? @@ -84,11 +84,11 @@ Configuration options for generating objects with a model. [packages/core/src/generation.ts:874](https://github.com/ai16z/eliza/blob/main/packages/core/src/generation.ts#L874) ---- +*** -### experimental_providerMetadata? +### experimental\_providerMetadata? -> `optional` **experimental_providerMetadata**: `Record`\<`string`, `unknown`\> +> `optional` **experimental\_providerMetadata**: `Record`\<`string`, `unknown`\> #### Defined in diff --git a/docs/api/interfaces/Goal.md b/docs/api/interfaces/Goal.md index 41456943b3c..ddc338ab47e 100644 --- a/docs/api/interfaces/Goal.md +++ b/docs/api/interfaces/Goal.md @@ -14,7 +14,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:66](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L66) ---- +*** ### roomId @@ -24,7 +24,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:67](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L67) ---- +*** ### userId @@ -34,7 +34,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:68](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L68) ---- +*** ### name @@ -44,7 +44,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:69](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L69) ---- +*** ### status @@ -54,7 +54,7 @@ Represents a goal, which is a higher-level aim composed of one or more objective [packages/core/src/types.ts:70](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L70) ---- +*** ### objectives diff --git a/docs/api/interfaces/IAgentRuntime.md b/docs/api/interfaces/IAgentRuntime.md index 40d442301fe..7c493e60b1c 100644 --- a/docs/api/interfaces/IAgentRuntime.md +++ b/docs/api/interfaces/IAgentRuntime.md @@ -14,7 +14,7 @@ Properties [packages/core/src/types.ts:532](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L532) ---- +*** ### serverUrl @@ -24,7 +24,7 @@ Properties [packages/core/src/types.ts:533](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L533) ---- +*** ### databaseAdapter @@ -34,7 +34,7 @@ Properties [packages/core/src/types.ts:534](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L534) ---- +*** ### token @@ -44,7 +44,7 @@ Properties [packages/core/src/types.ts:535](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L535) ---- +*** ### modelProvider @@ -54,7 +54,7 @@ Properties [packages/core/src/types.ts:536](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L536) ---- +*** ### character @@ -64,7 +64,7 @@ Properties [packages/core/src/types.ts:537](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L537) ---- +*** ### providers @@ -74,7 +74,7 @@ Properties [packages/core/src/types.ts:538](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L538) ---- +*** ### actions @@ -84,7 +84,7 @@ Properties [packages/core/src/types.ts:539](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L539) ---- +*** ### evaluators @@ -94,7 +94,7 @@ Properties [packages/core/src/types.ts:540](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L540) ---- +*** ### messageManager @@ -104,7 +104,7 @@ Properties [packages/core/src/types.ts:542](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L542) ---- +*** ### descriptionManager @@ -114,7 +114,7 @@ Properties [packages/core/src/types.ts:543](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L543) ---- +*** ### loreManager @@ -124,7 +124,7 @@ Properties [packages/core/src/types.ts:544](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L544) ---- +*** ### services @@ -152,7 +152,7 @@ Properties [packages/core/src/types.ts:547](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L547) ---- +*** ### getMemoryManager() @@ -170,11 +170,11 @@ Properties [packages/core/src/types.ts:549](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L549) ---- +*** ### getService() -> **getService**(`service`): _typeof_ [`Service`](../classes/Service.md) +> **getService**(`service`): *typeof* [`Service`](../classes/Service.md) #### Parameters @@ -182,13 +182,13 @@ Properties #### Returns -_typeof_ [`Service`](../classes/Service.md) +*typeof* [`Service`](../classes/Service.md) #### Defined in [packages/core/src/types.ts:551](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L551) ---- +*** ### registerService() @@ -206,7 +206,7 @@ _typeof_ [`Service`](../classes/Service.md) [packages/core/src/types.ts:553](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L553) ---- +*** ### getSetting() @@ -224,7 +224,7 @@ _typeof_ [`Service`](../classes/Service.md) [packages/core/src/types.ts:555](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L555) ---- +*** ### getConversationLength() @@ -240,7 +240,7 @@ Methods [packages/core/src/types.ts:558](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L558) ---- +*** ### processActions() @@ -264,7 +264,7 @@ Methods [packages/core/src/types.ts:559](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L559) ---- +*** ### evaluate() @@ -286,7 +286,7 @@ Methods [packages/core/src/types.ts:565](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L565) ---- +*** ### ensureParticipantExists() @@ -306,7 +306,7 @@ Methods [packages/core/src/types.ts:570](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L570) ---- +*** ### ensureUserExists() @@ -330,7 +330,7 @@ Methods [packages/core/src/types.ts:571](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L571) ---- +*** ### registerAction() @@ -348,7 +348,7 @@ Methods [packages/core/src/types.ts:577](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L577) ---- +*** ### ensureConnection() @@ -374,7 +374,7 @@ Methods [packages/core/src/types.ts:578](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L578) ---- +*** ### ensureParticipantInRoom() @@ -394,7 +394,7 @@ Methods [packages/core/src/types.ts:585](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L585) ---- +*** ### ensureRoomExists() @@ -412,7 +412,7 @@ Methods [packages/core/src/types.ts:586](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L586) ---- +*** ### composeState() @@ -432,7 +432,7 @@ Methods [packages/core/src/types.ts:587](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L587) ---- +*** ### updateRecentMessageState() diff --git a/docs/api/interfaces/IBrowserService.md b/docs/api/interfaces/IBrowserService.md index 1960e7f069a..7360d1de07d 100644 --- a/docs/api/interfaces/IBrowserService.md +++ b/docs/api/interfaces/IBrowserService.md @@ -20,7 +20,7 @@ [packages/core/src/types.ts:641](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L641) ---- +*** ### closeBrowser() @@ -34,7 +34,7 @@ [packages/core/src/types.ts:642](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L642) ---- +*** ### getPageContent() diff --git a/docs/api/interfaces/IDatabaseAdapter.md b/docs/api/interfaces/IDatabaseAdapter.md index 110080ba08f..116e38251fb 100644 --- a/docs/api/interfaces/IDatabaseAdapter.md +++ b/docs/api/interfaces/IDatabaseAdapter.md @@ -30,7 +30,7 @@ [packages/core/src/types.ts:376](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L376) ---- +*** ### createAccount() @@ -48,7 +48,7 @@ [packages/core/src/types.ts:377](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L377) ---- +*** ### getMemories() @@ -80,7 +80,7 @@ [packages/core/src/types.ts:378](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L378) ---- +*** ### getMemoryById() @@ -98,7 +98,7 @@ [packages/core/src/types.ts:387](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L387) ---- +*** ### getMemoriesByRoomIds() @@ -120,7 +120,7 @@ [packages/core/src/types.ts:388](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L388) ---- +*** ### getCachedEmbeddings() @@ -130,17 +130,17 @@ • **params** -• **params.query_table_name**: `string` +• **params.query\_table\_name**: `string` -• **params.query_threshold**: `number` +• **params.query\_threshold**: `number` -• **params.query_input**: `string` +• **params.query\_input**: `string` -• **params.query_field_name**: `string` +• **params.query\_field\_name**: `string` -• **params.query_field_sub_name**: `string` +• **params.query\_field\_sub\_name**: `string` -• **params.query_match_count**: `number` +• **params.query\_match\_count**: `number` #### Returns @@ -150,7 +150,7 @@ [packages/core/src/types.ts:392](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L392) ---- +*** ### log() @@ -176,7 +176,7 @@ [packages/core/src/types.ts:400](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L400) ---- +*** ### getActorDetails() @@ -196,7 +196,7 @@ [packages/core/src/types.ts:406](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L406) ---- +*** ### searchMemories() @@ -212,9 +212,9 @@ • **params.embedding**: `number`[] -• **params.match_threshold**: `number` +• **params.match\_threshold**: `number` -• **params.match_count**: `number` +• **params.match\_count**: `number` • **params.unique**: `boolean` @@ -226,7 +226,7 @@ [packages/core/src/types.ts:407](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L407) ---- +*** ### updateGoalStatus() @@ -248,7 +248,7 @@ [packages/core/src/types.ts:415](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L415) ---- +*** ### searchMemoriesByEmbedding() @@ -260,7 +260,7 @@ • **params** -• **params.match_threshold?**: `number` +• **params.match\_threshold?**: `number` • **params.count?**: `number` @@ -280,7 +280,7 @@ [packages/core/src/types.ts:419](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L419) ---- +*** ### createMemory() @@ -302,7 +302,7 @@ [packages/core/src/types.ts:430](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L430) ---- +*** ### removeMemory() @@ -322,7 +322,7 @@ [packages/core/src/types.ts:435](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L435) ---- +*** ### removeAllMemories() @@ -342,7 +342,7 @@ [packages/core/src/types.ts:436](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L436) ---- +*** ### countMemories() @@ -364,7 +364,7 @@ [packages/core/src/types.ts:437](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L437) ---- +*** ### getGoals() @@ -390,7 +390,7 @@ [packages/core/src/types.ts:442](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L442) ---- +*** ### updateGoal() @@ -408,7 +408,7 @@ [packages/core/src/types.ts:448](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L448) ---- +*** ### createGoal() @@ -426,7 +426,7 @@ [packages/core/src/types.ts:449](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L449) ---- +*** ### removeGoal() @@ -444,7 +444,7 @@ [packages/core/src/types.ts:450](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L450) ---- +*** ### removeAllGoals() @@ -462,7 +462,7 @@ [packages/core/src/types.ts:451](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L451) ---- +*** ### getRoom() @@ -480,7 +480,7 @@ [packages/core/src/types.ts:452](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L452) ---- +*** ### createRoom() @@ -498,7 +498,7 @@ [packages/core/src/types.ts:453](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L453) ---- +*** ### removeRoom() @@ -516,7 +516,7 @@ [packages/core/src/types.ts:454](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L454) ---- +*** ### getRoomsForParticipant() @@ -534,7 +534,7 @@ [packages/core/src/types.ts:455](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L455) ---- +*** ### getRoomsForParticipants() @@ -552,7 +552,7 @@ [packages/core/src/types.ts:456](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L456) ---- +*** ### addParticipant() @@ -572,7 +572,7 @@ [packages/core/src/types.ts:457](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L457) ---- +*** ### removeParticipant() @@ -592,7 +592,7 @@ [packages/core/src/types.ts:458](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L458) ---- +*** ### getParticipantsForAccount() @@ -610,7 +610,7 @@ [packages/core/src/types.ts:459](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L459) ---- +*** ### getParticipantsForRoom() @@ -628,7 +628,7 @@ [packages/core/src/types.ts:460](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L460) ---- +*** ### getParticipantUserState() @@ -648,7 +648,7 @@ [packages/core/src/types.ts:461](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L461) ---- +*** ### setParticipantUserState() @@ -670,7 +670,7 @@ [packages/core/src/types.ts:465](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L465) ---- +*** ### createRelationship() @@ -692,7 +692,7 @@ [packages/core/src/types.ts:470](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L470) ---- +*** ### getRelationship() @@ -714,7 +714,7 @@ [packages/core/src/types.ts:471](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L471) ---- +*** ### getRelationships() diff --git a/docs/api/interfaces/IImageDescriptionService.md b/docs/api/interfaces/IImageDescriptionService.md index 5f29d8a9970..17cc8833bd0 100644 --- a/docs/api/interfaces/IImageDescriptionService.md +++ b/docs/api/interfaces/IImageDescriptionService.md @@ -20,7 +20,7 @@ [packages/core/src/types.ts:595](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L595) ---- +*** ### initialize() @@ -40,7 +40,7 @@ [packages/core/src/types.ts:596](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L596) ---- +*** ### describeImage() diff --git a/docs/api/interfaces/IMemoryManager.md b/docs/api/interfaces/IMemoryManager.md index a10169784be..84f44e69fbe 100644 --- a/docs/api/interfaces/IMemoryManager.md +++ b/docs/api/interfaces/IMemoryManager.md @@ -12,7 +12,7 @@ [packages/core/src/types.ts:479](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L479) ---- +*** ### tableName @@ -22,7 +22,7 @@ [packages/core/src/types.ts:480](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L480) ---- +*** ### constructor @@ -50,7 +50,7 @@ [packages/core/src/types.ts:484](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L484) ---- +*** ### getMemories() @@ -80,7 +80,7 @@ [packages/core/src/types.ts:485](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L485) ---- +*** ### getCachedEmbeddings() @@ -98,7 +98,7 @@ [packages/core/src/types.ts:493](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L493) ---- +*** ### getMemoryById() @@ -116,7 +116,7 @@ [packages/core/src/types.ts:496](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L496) ---- +*** ### getMemoriesByRoomIds() @@ -138,7 +138,7 @@ [packages/core/src/types.ts:497](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L497) ---- +*** ### searchMemoriesByEmbedding() @@ -150,7 +150,7 @@ • **opts** -• **opts.match_threshold?**: `number` +• **opts.match\_threshold?**: `number` • **opts.count?**: `number` @@ -168,7 +168,7 @@ [packages/core/src/types.ts:501](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L501) ---- +*** ### createMemory() @@ -188,7 +188,7 @@ [packages/core/src/types.ts:511](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L511) ---- +*** ### removeMemory() @@ -206,7 +206,7 @@ [packages/core/src/types.ts:512](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L512) ---- +*** ### removeAllMemories() @@ -224,7 +224,7 @@ [packages/core/src/types.ts:513](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L513) ---- +*** ### countMemories() diff --git a/docs/api/interfaces/ITextGenerationService.md b/docs/api/interfaces/ITextGenerationService.md index 5be0dbf0405..8d6efe38ebb 100644 --- a/docs/api/interfaces/ITextGenerationService.md +++ b/docs/api/interfaces/ITextGenerationService.md @@ -20,7 +20,7 @@ [packages/core/src/types.ts:619](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L619) ---- +*** ### initializeModel() @@ -34,7 +34,7 @@ [packages/core/src/types.ts:620](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L620) ---- +*** ### queueMessageCompletion() @@ -48,11 +48,11 @@ • **stop**: `string`[] -• **frequency_penalty**: `number` +• **frequency\_penalty**: `number` -• **presence_penalty**: `number` +• **presence\_penalty**: `number` -• **max_tokens**: `number` +• **max\_tokens**: `number` #### Returns @@ -62,7 +62,7 @@ [packages/core/src/types.ts:621](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L621) ---- +*** ### queueTextCompletion() @@ -76,11 +76,11 @@ • **stop**: `string`[] -• **frequency_penalty**: `number` +• **frequency\_penalty**: `number` -• **presence_penalty**: `number` +• **presence\_penalty**: `number` -• **max_tokens**: `number` +• **max\_tokens**: `number` #### Returns @@ -90,7 +90,7 @@ [packages/core/src/types.ts:629](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L629) ---- +*** ### getEmbeddingResponse() diff --git a/docs/api/interfaces/ITranscriptionService.md b/docs/api/interfaces/ITranscriptionService.md index 5634219f53b..30f85965531 100644 --- a/docs/api/interfaces/ITranscriptionService.md +++ b/docs/api/interfaces/ITranscriptionService.md @@ -24,7 +24,7 @@ [packages/core/src/types.ts:603](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L603) ---- +*** ### transcribeAttachmentLocally() @@ -42,7 +42,7 @@ [packages/core/src/types.ts:604](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L604) ---- +*** ### transcribe() @@ -60,7 +60,7 @@ [packages/core/src/types.ts:607](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L607) ---- +*** ### transcribeLocally() diff --git a/docs/api/interfaces/IVideoService.md b/docs/api/interfaces/IVideoService.md index f62ab655dbc..cd20ae6c111 100644 --- a/docs/api/interfaces/IVideoService.md +++ b/docs/api/interfaces/IVideoService.md @@ -24,7 +24,7 @@ [packages/core/src/types.ts:612](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L612) ---- +*** ### processVideo() @@ -42,7 +42,7 @@ [packages/core/src/types.ts:613](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L613) ---- +*** ### fetchVideoInfo() @@ -60,7 +60,7 @@ [packages/core/src/types.ts:614](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L614) ---- +*** ### downloadVideo() diff --git a/docs/api/interfaces/Memory.md b/docs/api/interfaces/Memory.md index 040cdf1e71a..f4797d87552 100644 --- a/docs/api/interfaces/Memory.md +++ b/docs/api/interfaces/Memory.md @@ -14,7 +14,7 @@ Represents a memory record, which could be a message or any other piece of infor [packages/core/src/types.ts:169](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L169) ---- +*** ### userId @@ -24,7 +24,7 @@ Represents a memory record, which could be a message or any other piece of infor [packages/core/src/types.ts:170](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L170) ---- +*** ### agentId @@ -34,7 +34,7 @@ Represents a memory record, which could be a message or any other piece of infor [packages/core/src/types.ts:171](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L171) ---- +*** ### createdAt? @@ -44,7 +44,7 @@ Represents a memory record, which could be a message or any other piece of infor [packages/core/src/types.ts:172](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L172) ---- +*** ### content @@ -54,7 +54,7 @@ Represents a memory record, which could be a message or any other piece of infor [packages/core/src/types.ts:173](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L173) ---- +*** ### embedding? @@ -64,7 +64,7 @@ Represents a memory record, which could be a message or any other piece of infor [packages/core/src/types.ts:174](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L174) ---- +*** ### roomId @@ -74,7 +74,7 @@ Represents a memory record, which could be a message or any other piece of infor [packages/core/src/types.ts:175](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L175) ---- +*** ### unique? diff --git a/docs/api/interfaces/MessageExample.md b/docs/api/interfaces/MessageExample.md index dbc07ae96c1..b59046d7864 100644 --- a/docs/api/interfaces/MessageExample.md +++ b/docs/api/interfaces/MessageExample.md @@ -14,7 +14,7 @@ Represents an example of a message, typically used for demonstrating or testing [packages/core/src/types.ts:183](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L183) ---- +*** ### content diff --git a/docs/api/interfaces/Objective.md b/docs/api/interfaces/Objective.md index 4a9c5854f71..554e13b00ac 100644 --- a/docs/api/interfaces/Objective.md +++ b/docs/api/interfaces/Objective.md @@ -14,7 +14,7 @@ Represents an objective within a goal, detailing what needs to be achieved and w [packages/core/src/types.ts:51](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L51) ---- +*** ### description @@ -24,7 +24,7 @@ Represents an objective within a goal, detailing what needs to be achieved and w [packages/core/src/types.ts:52](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L52) ---- +*** ### completed diff --git a/docs/api/interfaces/Participant.md b/docs/api/interfaces/Participant.md index 74b1096c000..833d1146296 100644 --- a/docs/api/interfaces/Participant.md +++ b/docs/api/interfaces/Participant.md @@ -14,7 +14,7 @@ Represents a participant in a room, including their ID and account details. [packages/core/src/types.ts:287](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L287) ---- +*** ### account diff --git a/docs/api/interfaces/Relationship.md b/docs/api/interfaces/Relationship.md index 9dbafcb2fc5..e0790ebf5f5 100644 --- a/docs/api/interfaces/Relationship.md +++ b/docs/api/interfaces/Relationship.md @@ -14,7 +14,7 @@ Represents a relationship between two users, including their IDs, the status of [packages/core/src/types.ts:262](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L262) ---- +*** ### userA @@ -24,7 +24,7 @@ Represents a relationship between two users, including their IDs, the status of [packages/core/src/types.ts:263](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L263) ---- +*** ### userB @@ -34,7 +34,7 @@ Represents a relationship between two users, including their IDs, the status of [packages/core/src/types.ts:264](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L264) ---- +*** ### userId @@ -44,7 +44,7 @@ Represents a relationship between two users, including their IDs, the status of [packages/core/src/types.ts:265](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L265) ---- +*** ### roomId @@ -54,7 +54,7 @@ Represents a relationship between two users, including their IDs, the status of [packages/core/src/types.ts:266](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L266) ---- +*** ### status @@ -64,7 +64,7 @@ Represents a relationship between two users, including their IDs, the status of [packages/core/src/types.ts:267](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L267) ---- +*** ### createdAt? diff --git a/docs/api/interfaces/Room.md b/docs/api/interfaces/Room.md index ab9ce15c57a..9911152e482 100644 --- a/docs/api/interfaces/Room.md +++ b/docs/api/interfaces/Room.md @@ -14,7 +14,7 @@ Represents a room or conversation context, including its ID and a list of partic [packages/core/src/types.ts:295](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L295) ---- +*** ### participants diff --git a/docs/api/interfaces/State.md b/docs/api/interfaces/State.md index 6897899d263..6ea2c76c0cb 100644 --- a/docs/api/interfaces/State.md +++ b/docs/api/interfaces/State.md @@ -6,7 +6,7 @@ Represents the state of the conversation or context in which the agent is operat ## Indexable -\[`key`: `string`\]: `unknown` + \[`key`: `string`\]: `unknown` ## Properties @@ -18,7 +18,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:139](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L139) ---- +*** ### agentId? @@ -28,7 +28,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:140](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L140) ---- +*** ### bio @@ -38,7 +38,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:141](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L141) ---- +*** ### lore @@ -48,7 +48,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:142](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L142) ---- +*** ### messageDirections @@ -58,7 +58,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:143](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L143) ---- +*** ### postDirections @@ -68,7 +68,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:144](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L144) ---- +*** ### roomId @@ -78,7 +78,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:145](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L145) ---- +*** ### agentName? @@ -88,7 +88,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:146](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L146) ---- +*** ### senderName? @@ -98,7 +98,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:147](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L147) ---- +*** ### actors @@ -108,7 +108,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:148](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L148) ---- +*** ### actorsData? @@ -118,7 +118,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:149](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L149) ---- +*** ### goals? @@ -128,7 +128,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:150](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L150) ---- +*** ### goalsData? @@ -138,7 +138,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:151](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L151) ---- +*** ### recentMessages @@ -148,7 +148,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:152](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L152) ---- +*** ### recentMessagesData @@ -158,7 +158,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:153](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L153) ---- +*** ### actionNames? @@ -168,7 +168,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:154](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L154) ---- +*** ### actions? @@ -178,7 +178,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:155](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L155) ---- +*** ### actionsData? @@ -188,7 +188,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:156](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L156) ---- +*** ### actionExamples? @@ -198,7 +198,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:157](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L157) ---- +*** ### providers? @@ -208,7 +208,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:158](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L158) ---- +*** ### responseData? @@ -218,7 +218,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:159](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L159) ---- +*** ### recentInteractionsData? @@ -228,7 +228,7 @@ Represents the state of the conversation or context in which the agent is operat [packages/core/src/types.ts:160](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L160) ---- +*** ### recentInteractions? diff --git a/docs/api/type-aliases/Character.md b/docs/api/type-aliases/Character.md index 508aefc3a30..810eef4c640 100644 --- a/docs/api/type-aliases/Character.md +++ b/docs/api/type-aliases/Character.md @@ -32,7 +32,7 @@ #### Index Signature -\[`key`: `string`\]: `string` + \[`key`: `string`\]: `string` ### bio @@ -84,7 +84,7 @@ #### Index Signature -\[`key`: `string`\]: `string` + \[`key`: `string`\]: `string` ### settings.voice? diff --git a/docs/api/type-aliases/Model.md b/docs/api/type-aliases/Model.md index 4d5a45b9d59..de42259011c 100644 --- a/docs/api/type-aliases/Model.md +++ b/docs/api/type-aliases/Model.md @@ -22,17 +22,17 @@ > **maxOutputTokens**: `number` -### settings.frequency_penalty? +### settings.frequency\_penalty? -> `optional` **frequency_penalty**: `number` +> `optional` **frequency\_penalty**: `number` -### settings.presence_penalty? +### settings.presence\_penalty? -> `optional` **presence_penalty**: `number` +> `optional` **presence\_penalty**: `number` -### settings.repetition_penalty? +### settings.repetition\_penalty? -> `optional` **repetition_penalty**: `number` +> `optional` **repetition\_penalty**: `number` ### settings.stop diff --git a/docs/api/type-aliases/Models.md b/docs/api/type-aliases/Models.md index ded8014918d..73f34915666 100644 --- a/docs/api/type-aliases/Models.md +++ b/docs/api/type-aliases/Models.md @@ -22,21 +22,21 @@ > **groq**: [`Model`](Model.md) -### llama_cloud +### llama\_cloud -> **llama_cloud**: [`Model`](Model.md) +> **llama\_cloud**: [`Model`](Model.md) -### llama_local +### llama\_local -> **llama_local**: [`Model`](Model.md) +> **llama\_local**: [`Model`](Model.md) ### google > **google**: [`Model`](Model.md) -### claude_vertex +### claude\_vertex -> **claude_vertex**: [`Model`](Model.md) +> **claude\_vertex**: [`Model`](Model.md) ### redpill diff --git a/docs/api/typedoc-sidebar.cjs b/docs/api/typedoc-sidebar.cjs index cb7e9697647..5a314c8c8bb 100644 --- a/docs/api/typedoc-sidebar.cjs +++ b/docs/api/typedoc-sidebar.cjs @@ -1,352 +1,4 @@ // @ts-check /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ -const typedocSidebar = { - items: [ - { - type: "category", - label: "Enumerations", - items: [ - { type: "doc", id: "enumerations/GoalStatus", label: "GoalStatus" }, - { type: "doc", id: "enumerations/ModelClass", label: "ModelClass" }, - { - type: "doc", - id: "enumerations/ModelProviderName", - label: "ModelProviderName", - }, - { type: "doc", id: "enumerations/Clients", label: "Clients" }, - { type: "doc", id: "enumerations/ServiceType", label: "ServiceType" }, - ], - }, - { - type: "category", - label: "Classes", - items: [ - { - type: "doc", - id: "classes/DatabaseAdapter", - label: "DatabaseAdapter", - }, - { type: "doc", id: "classes/MemoryManager", label: "MemoryManager" }, - { type: "doc", id: "classes/AgentRuntime", label: "AgentRuntime" }, - { type: "doc", id: "classes/Service", label: "Service" }, - ], - }, - { - type: "category", - label: "Interfaces", - items: [ - { - type: "doc", - id: "interfaces/GenerationOptions", - label: "GenerationOptions", - }, - { type: "doc", id: "interfaces/Content", label: "Content" }, - { type: "doc", id: "interfaces/ActionExample", label: "ActionExample" }, - { - type: "doc", - id: "interfaces/ConversationExample", - label: "ConversationExample", - }, - { type: "doc", id: "interfaces/Actor", label: "Actor" }, - { type: "doc", id: "interfaces/Objective", label: "Objective" }, - { type: "doc", id: "interfaces/Goal", label: "Goal" }, - { type: "doc", id: "interfaces/State", label: "State" }, - { type: "doc", id: "interfaces/Memory", label: "Memory" }, - { - type: "doc", - id: "interfaces/MessageExample", - label: "MessageExample", - }, - { type: "doc", id: "interfaces/Action", label: "Action" }, - { - type: "doc", - id: "interfaces/EvaluationExample", - label: "EvaluationExample", - }, - { type: "doc", id: "interfaces/Evaluator", label: "Evaluator" }, - { type: "doc", id: "interfaces/Provider", label: "Provider" }, - { type: "doc", id: "interfaces/Relationship", label: "Relationship" }, - { type: "doc", id: "interfaces/Account", label: "Account" }, - { type: "doc", id: "interfaces/Participant", label: "Participant" }, - { type: "doc", id: "interfaces/Room", label: "Room" }, - { - type: "doc", - id: "interfaces/IDatabaseAdapter", - label: "IDatabaseAdapter", - }, - { - type: "doc", - id: "interfaces/IMemoryManager", - label: "IMemoryManager", - }, - { type: "doc", id: "interfaces/IAgentRuntime", label: "IAgentRuntime" }, - { - type: "doc", - id: "interfaces/IImageDescriptionService", - label: "IImageDescriptionService", - }, - { - type: "doc", - id: "interfaces/ITranscriptionService", - label: "ITranscriptionService", - }, - { type: "doc", id: "interfaces/IVideoService", label: "IVideoService" }, - { - type: "doc", - id: "interfaces/ITextGenerationService", - label: "ITextGenerationService", - }, - { - type: "doc", - id: "interfaces/IBrowserService", - label: "IBrowserService", - }, - { - type: "doc", - id: "interfaces/ISpeechService", - label: "ISpeechService", - }, - { type: "doc", id: "interfaces/IPdfService", label: "IPdfService" }, - ], - }, - { - type: "category", - label: "Type Aliases", - items: [ - { type: "doc", id: "type-aliases/UUID", label: "UUID" }, - { type: "doc", id: "type-aliases/Model", label: "Model" }, - { type: "doc", id: "type-aliases/Models", label: "Models" }, - { type: "doc", id: "type-aliases/Handler", label: "Handler" }, - { - type: "doc", - id: "type-aliases/HandlerCallback", - label: "HandlerCallback", - }, - { type: "doc", id: "type-aliases/Validator", label: "Validator" }, - { type: "doc", id: "type-aliases/Media", label: "Media" }, - { type: "doc", id: "type-aliases/Client", label: "Client" }, - { type: "doc", id: "type-aliases/Plugin", label: "Plugin" }, - { type: "doc", id: "type-aliases/Character", label: "Character" }, - ], - }, - { - type: "category", - label: "Variables", - items: [ - { - type: "doc", - id: "variables/defaultCharacter", - label: "defaultCharacter", - }, - { - type: "doc", - id: "variables/evaluationTemplate", - label: "evaluationTemplate", - }, - { type: "doc", id: "variables/elizaLogger", label: "elizaLogger" }, - { - type: "doc", - id: "variables/embeddingDimension", - label: "embeddingDimension", - }, - { - type: "doc", - id: "variables/embeddingZeroVector", - label: "embeddingZeroVector", - }, - { type: "doc", id: "variables/models", label: "models" }, - { - type: "doc", - id: "variables/messageCompletionFooter", - label: "messageCompletionFooter", - }, - { - type: "doc", - id: "variables/shouldRespondFooter", - label: "shouldRespondFooter", - }, - { type: "doc", id: "variables/booleanFooter", label: "booleanFooter" }, - { - type: "doc", - id: "variables/stringArrayFooter", - label: "stringArrayFooter", - }, - { type: "doc", id: "variables/settings", label: "settings" }, - ], - }, - { - type: "category", - label: "Functions", - items: [ - { - type: "doc", - id: "functions/composeActionExamples", - label: "composeActionExamples", - }, - { - type: "doc", - id: "functions/formatActionNames", - label: "formatActionNames", - }, - { type: "doc", id: "functions/formatActions", label: "formatActions" }, - { - type: "doc", - id: "functions/composeContext", - label: "composeContext", - }, - { type: "doc", id: "functions/addHeader", label: "addHeader" }, - { type: "doc", id: "functions/embed", label: "embed" }, - { - type: "doc", - id: "functions/retrieveCachedEmbedding", - label: "retrieveCachedEmbedding", - }, - { - type: "doc", - id: "functions/formatEvaluatorNames", - label: "formatEvaluatorNames", - }, - { - type: "doc", - id: "functions/formatEvaluators", - label: "formatEvaluators", - }, - { - type: "doc", - id: "functions/formatEvaluatorExamples", - label: "formatEvaluatorExamples", - }, - { - type: "doc", - id: "functions/formatEvaluatorExampleDescriptions", - label: "formatEvaluatorExampleDescriptions", - }, - { type: "doc", id: "functions/generateText", label: "generateText" }, - { type: "doc", id: "functions/trimTokens", label: "trimTokens" }, - { - type: "doc", - id: "functions/generateShouldRespond", - label: "generateShouldRespond", - }, - { type: "doc", id: "functions/splitChunks", label: "splitChunks" }, - { - type: "doc", - id: "functions/generateTrueOrFalse", - label: "generateTrueOrFalse", - }, - { - type: "doc", - id: "functions/generateTextArray", - label: "generateTextArray", - }, - { - type: "doc", - id: "functions/generateObject", - label: "generateObject", - }, - { - type: "doc", - id: "functions/generateObjectArray", - label: "generateObjectArray", - }, - { - type: "doc", - id: "functions/generateMessageResponse", - label: "generateMessageResponse", - }, - { type: "doc", id: "functions/generateImage", label: "generateImage" }, - { - type: "doc", - id: "functions/generateCaption", - label: "generateCaption", - }, - { - type: "doc", - id: "functions/generateObjectV2", - label: "generateObjectV2", - }, - { - type: "doc", - id: "functions/handleProvider", - label: "handleProvider", - }, - { type: "doc", id: "functions/getGoals", label: "getGoals" }, - { - type: "doc", - id: "functions/formatGoalsAsString", - label: "formatGoalsAsString", - }, - { type: "doc", id: "functions/updateGoal", label: "updateGoal" }, - { type: "doc", id: "functions/createGoal", label: "createGoal" }, - { - type: "doc", - id: "functions/getActorDetails", - label: "getActorDetails", - }, - { type: "doc", id: "functions/formatActors", label: "formatActors" }, - { - type: "doc", - id: "functions/formatMessages", - label: "formatMessages", - }, - { - type: "doc", - id: "functions/formatTimestamp", - label: "formatTimestamp", - }, - { type: "doc", id: "functions/getModel", label: "getModel" }, - { type: "doc", id: "functions/getEndpoint", label: "getEndpoint" }, - { - type: "doc", - id: "functions/parseShouldRespondFromText", - label: "parseShouldRespondFromText", - }, - { - type: "doc", - id: "functions/parseBooleanFromText", - label: "parseBooleanFromText", - }, - { - type: "doc", - id: "functions/parseJsonArrayFromText", - label: "parseJsonArrayFromText", - }, - { - type: "doc", - id: "functions/parseJSONObjectFromText", - label: "parseJSONObjectFromText", - }, - { type: "doc", id: "functions/formatPosts", label: "formatPosts" }, - { type: "doc", id: "functions/getProviders", label: "getProviders" }, - { - type: "doc", - id: "functions/createRelationship", - label: "createRelationship", - }, - { - type: "doc", - id: "functions/getRelationship", - label: "getRelationship", - }, - { - type: "doc", - id: "functions/getRelationships", - label: "getRelationships", - }, - { - type: "doc", - id: "functions/formatRelationships", - label: "formatRelationships", - }, - { - type: "doc", - id: "functions/findNearestEnvFile", - label: "findNearestEnvFile", - }, - { type: "doc", id: "functions/loadEnvConfig", label: "loadEnvConfig" }, - { type: "doc", id: "functions/stringToUuid", label: "stringToUuid" }, - ], - }, - ], -}; -module.exports = typedocSidebar.items; +const typedocSidebar = { items: [{"type":"category","label":"Enumerations","items":[{"type":"doc","id":"enumerations/GoalStatus","label":"GoalStatus"},{"type":"doc","id":"enumerations/ModelClass","label":"ModelClass"},{"type":"doc","id":"enumerations/ModelProviderName","label":"ModelProviderName"},{"type":"doc","id":"enumerations/Clients","label":"Clients"},{"type":"doc","id":"enumerations/ServiceType","label":"ServiceType"}]},{"type":"category","label":"Classes","items":[{"type":"doc","id":"classes/DatabaseAdapter","label":"DatabaseAdapter"},{"type":"doc","id":"classes/MemoryManager","label":"MemoryManager"},{"type":"doc","id":"classes/AgentRuntime","label":"AgentRuntime"},{"type":"doc","id":"classes/Service","label":"Service"}]},{"type":"category","label":"Interfaces","items":[{"type":"doc","id":"interfaces/GenerationOptions","label":"GenerationOptions"},{"type":"doc","id":"interfaces/Content","label":"Content"},{"type":"doc","id":"interfaces/ActionExample","label":"ActionExample"},{"type":"doc","id":"interfaces/ConversationExample","label":"ConversationExample"},{"type":"doc","id":"interfaces/Actor","label":"Actor"},{"type":"doc","id":"interfaces/Objective","label":"Objective"},{"type":"doc","id":"interfaces/Goal","label":"Goal"},{"type":"doc","id":"interfaces/State","label":"State"},{"type":"doc","id":"interfaces/Memory","label":"Memory"},{"type":"doc","id":"interfaces/MessageExample","label":"MessageExample"},{"type":"doc","id":"interfaces/Action","label":"Action"},{"type":"doc","id":"interfaces/EvaluationExample","label":"EvaluationExample"},{"type":"doc","id":"interfaces/Evaluator","label":"Evaluator"},{"type":"doc","id":"interfaces/Provider","label":"Provider"},{"type":"doc","id":"interfaces/Relationship","label":"Relationship"},{"type":"doc","id":"interfaces/Account","label":"Account"},{"type":"doc","id":"interfaces/Participant","label":"Participant"},{"type":"doc","id":"interfaces/Room","label":"Room"},{"type":"doc","id":"interfaces/IDatabaseAdapter","label":"IDatabaseAdapter"},{"type":"doc","id":"interfaces/IMemoryManager","label":"IMemoryManager"},{"type":"doc","id":"interfaces/IAgentRuntime","label":"IAgentRuntime"},{"type":"doc","id":"interfaces/IImageDescriptionService","label":"IImageDescriptionService"},{"type":"doc","id":"interfaces/ITranscriptionService","label":"ITranscriptionService"},{"type":"doc","id":"interfaces/IVideoService","label":"IVideoService"},{"type":"doc","id":"interfaces/ITextGenerationService","label":"ITextGenerationService"},{"type":"doc","id":"interfaces/IBrowserService","label":"IBrowserService"},{"type":"doc","id":"interfaces/ISpeechService","label":"ISpeechService"},{"type":"doc","id":"interfaces/IPdfService","label":"IPdfService"}]},{"type":"category","label":"Type Aliases","items":[{"type":"doc","id":"type-aliases/UUID","label":"UUID"},{"type":"doc","id":"type-aliases/Model","label":"Model"},{"type":"doc","id":"type-aliases/Models","label":"Models"},{"type":"doc","id":"type-aliases/Handler","label":"Handler"},{"type":"doc","id":"type-aliases/HandlerCallback","label":"HandlerCallback"},{"type":"doc","id":"type-aliases/Validator","label":"Validator"},{"type":"doc","id":"type-aliases/Media","label":"Media"},{"type":"doc","id":"type-aliases/Client","label":"Client"},{"type":"doc","id":"type-aliases/Plugin","label":"Plugin"},{"type":"doc","id":"type-aliases/Character","label":"Character"}]},{"type":"category","label":"Variables","items":[{"type":"doc","id":"variables/defaultCharacter","label":"defaultCharacter"},{"type":"doc","id":"variables/evaluationTemplate","label":"evaluationTemplate"},{"type":"doc","id":"variables/elizaLogger","label":"elizaLogger"},{"type":"doc","id":"variables/embeddingDimension","label":"embeddingDimension"},{"type":"doc","id":"variables/embeddingZeroVector","label":"embeddingZeroVector"},{"type":"doc","id":"variables/models","label":"models"},{"type":"doc","id":"variables/messageCompletionFooter","label":"messageCompletionFooter"},{"type":"doc","id":"variables/shouldRespondFooter","label":"shouldRespondFooter"},{"type":"doc","id":"variables/booleanFooter","label":"booleanFooter"},{"type":"doc","id":"variables/stringArrayFooter","label":"stringArrayFooter"},{"type":"doc","id":"variables/settings","label":"settings"}]},{"type":"category","label":"Functions","items":[{"type":"doc","id":"functions/composeActionExamples","label":"composeActionExamples"},{"type":"doc","id":"functions/formatActionNames","label":"formatActionNames"},{"type":"doc","id":"functions/formatActions","label":"formatActions"},{"type":"doc","id":"functions/composeContext","label":"composeContext"},{"type":"doc","id":"functions/addHeader","label":"addHeader"},{"type":"doc","id":"functions/embed","label":"embed"},{"type":"doc","id":"functions/retrieveCachedEmbedding","label":"retrieveCachedEmbedding"},{"type":"doc","id":"functions/formatEvaluatorNames","label":"formatEvaluatorNames"},{"type":"doc","id":"functions/formatEvaluators","label":"formatEvaluators"},{"type":"doc","id":"functions/formatEvaluatorExamples","label":"formatEvaluatorExamples"},{"type":"doc","id":"functions/formatEvaluatorExampleDescriptions","label":"formatEvaluatorExampleDescriptions"},{"type":"doc","id":"functions/generateText","label":"generateText"},{"type":"doc","id":"functions/trimTokens","label":"trimTokens"},{"type":"doc","id":"functions/generateShouldRespond","label":"generateShouldRespond"},{"type":"doc","id":"functions/splitChunks","label":"splitChunks"},{"type":"doc","id":"functions/generateTrueOrFalse","label":"generateTrueOrFalse"},{"type":"doc","id":"functions/generateTextArray","label":"generateTextArray"},{"type":"doc","id":"functions/generateObject","label":"generateObject"},{"type":"doc","id":"functions/generateObjectArray","label":"generateObjectArray"},{"type":"doc","id":"functions/generateMessageResponse","label":"generateMessageResponse"},{"type":"doc","id":"functions/generateImage","label":"generateImage"},{"type":"doc","id":"functions/generateCaption","label":"generateCaption"},{"type":"doc","id":"functions/generateObjectV2","label":"generateObjectV2"},{"type":"doc","id":"functions/handleProvider","label":"handleProvider"},{"type":"doc","id":"functions/getGoals","label":"getGoals"},{"type":"doc","id":"functions/formatGoalsAsString","label":"formatGoalsAsString"},{"type":"doc","id":"functions/updateGoal","label":"updateGoal"},{"type":"doc","id":"functions/createGoal","label":"createGoal"},{"type":"doc","id":"functions/getActorDetails","label":"getActorDetails"},{"type":"doc","id":"functions/formatActors","label":"formatActors"},{"type":"doc","id":"functions/formatMessages","label":"formatMessages"},{"type":"doc","id":"functions/formatTimestamp","label":"formatTimestamp"},{"type":"doc","id":"functions/getModel","label":"getModel"},{"type":"doc","id":"functions/getEndpoint","label":"getEndpoint"},{"type":"doc","id":"functions/parseShouldRespondFromText","label":"parseShouldRespondFromText"},{"type":"doc","id":"functions/parseBooleanFromText","label":"parseBooleanFromText"},{"type":"doc","id":"functions/parseJsonArrayFromText","label":"parseJsonArrayFromText"},{"type":"doc","id":"functions/parseJSONObjectFromText","label":"parseJSONObjectFromText"},{"type":"doc","id":"functions/formatPosts","label":"formatPosts"},{"type":"doc","id":"functions/getProviders","label":"getProviders"},{"type":"doc","id":"functions/createRelationship","label":"createRelationship"},{"type":"doc","id":"functions/getRelationship","label":"getRelationship"},{"type":"doc","id":"functions/getRelationships","label":"getRelationships"},{"type":"doc","id":"functions/formatRelationships","label":"formatRelationships"},{"type":"doc","id":"functions/findNearestEnvFile","label":"findNearestEnvFile"},{"type":"doc","id":"functions/loadEnvConfig","label":"loadEnvConfig"},{"type":"doc","id":"functions/stringToUuid","label":"stringToUuid"}]}]}; +module.exports = typedocSidebar.items; \ No newline at end of file diff --git a/docs/api/variables/stringArrayFooter.md b/docs/api/variables/stringArrayFooter.md index c44ee2b3f8d..00c2643942e 100644 --- a/docs/api/variables/stringArrayFooter.md +++ b/docs/api/variables/stringArrayFooter.md @@ -2,7 +2,7 @@ # Variable: stringArrayFooter -> `const` **stringArrayFooter**: "Respond with a JSON array containing the values in a JSON block formatted for markdown with this structure:\n\`\`\`json\n\[\n 'value',\n 'value'\n\]\n\`\`\`\n\nYour response must include the JSON block." +> `const` **stringArrayFooter**: "Respond with a JSON array containing the values in a JSON block formatted for markdown with this structure:\n\`\`\`json\n\[\n 'value',\n 'value'\n\]\n\`\`\`\n\nYour response must include the JSON block." ## Defined in diff --git a/docs/docs/api/_media/README_FR.md b/docs/docs/api/_media/README_FR.md new file mode 100644 index 00000000000..a0e96bda4e8 --- /dev/null +++ b/docs/docs/api/_media/README_FR.md @@ -0,0 +1,172 @@ +# Eliza + +Eliza Banner + +## la fonctionnalité + +- 🛠 soutenir la connexion discord/ twitter /telegram +- 👥 soutien aux agents multimodaux +- 📚 simple à importer des documents et interagir avec les documents +- mémoire et stockage des documents accessibles +- 🚀 haute scalabilité, vous pouvez personnaliser les clients et les comportements pour une extension fonctionnelle +- ☁ ️ plusieurs modèles, y compris Llama, OpenAI Grok Anthropic, etc. +- 📦 simple et facile à utiliser + +Que pouvez-vous faire avec Eliza? + +- 🤖 le chatbot +- 🕵 ️ Agents autonomes +- 📈 processus métier pour automatiser le traitement +- 🎮 jeux PNJ + +# commencez à utiliser + +**pré-requis (obligatoire) :** + +- [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +- installation Nodejs +- [pnpm](https://pnpm.io/installation) +- travailler avec PNPM + +### éditer le fichier.env + +- copiez.env.example en.env et remplissez la valeur appropriée +- modifier l’environnement twitter et entrer votre compte twitter et mot de passe + +### modifier les fichiers de rôles + +- voir le document ` src/core/defaultCharacter ts ` - vous pouvez le modifier +- vous pouvez également utiliser `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json" ` et simultanément plusieurs robots. + +Après avoir terminé la configuration des fichiers de compte et de rôle, lancez votre bot en tapant la ligne de commande suivante: + + +``` +pnpm i +pnpm start +``` + +# personnalisez votre Eliza + +### ajouter un comportement régulier + +Pour éviter les conflits Git dans le répertoire core, nous vous recommandons d’ajouter les actions personnalisées dans le répertoire custom_actions et de les configurer dans le fichier elizaconfig.yaml. Vous pouvez consulter l’exemple dans le fichier elizaconfig.example.yaml. + +## configurez différents grands modèles + +### configurer Llama + +Vous pouvez exécuter en définissant la variable d’environnement `XAI_MODEL` à `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` ou `meta-llama/Meta-Llama-3.1-405B-Instruct` Llama 70B ou 405B modèle + +### configurer OpenAI + +Vous pouvez exécuter le modèle OpenAI en définissant la variable d’environnement `XAI_MODEL` à `gpt-4o-mini` ou `gpt-4o` + +## autres demandes + +Vous devrez peut-être installer Sharp. Si vous voyez une erreur au démarrage, essayez d’installer avec la commande suivante: + +``` +pnpm install --include=optional sharp +``` + +# paramètres de l’environnement + +Vous devez ajouter des variables d’environnement à votre fichier.env pour vous connecter à différentes plates-formes: + +``` +# Required environment variables +DISCORD_APPLICATION_ID= +DISCORD_API_TOKEN= # Bot token +OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk- +ELEVENLABS_XI_API_KEY= # API key from elevenlabs + +# ELEVENLABS SETTINGS +ELEVENLABS_MODEL_ID=eleven_multilingual_v2 +ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM +ELEVENLABS_VOICE_STABILITY=0.5 +ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9 +ELEVENLABS_VOICE_STYLE=0.66 +ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false +ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4 +ELEVENLABS_OUTPUT_FORMAT=pcm_16000 + +TWITTER_DRY_RUN=false +TWITTER_USERNAME= # Account username +TWITTER_PASSWORD= # Account password +TWITTER_EMAIL= # Account email +TWITTER_COOKIES= # Account cookies + +X_SERVER_URL= +XAI_API_KEY= +XAI_MODEL= + + +# For asking Claude stuff +ANTHROPIC_API_KEY= + +WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY +WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY + +BIRDEYE_API_KEY= + +SOL_ADDRESS=So11111111111111111111111111111111111111112 +SLIPPAGE=1 +RPC_URL=https://api.mainnet-beta.solana.com +HELIUS_API_KEY= + + +## Telegram +TELEGRAM_BOT_TOKEN= + +TOGETHER_API_KEY= +``` + +# paramètres locaux + +### ensemble CUDA + +Si vous avez une carte graphique nvidia haute performance, vous pouvez faire l’accélération locale avec la ligne de commande suivante CUDA + +``` +pnpm install +npx --no node-llama-cpp source download --gpu cuda +``` + +Assurez-vous d’avoir le kit complet CUDA installé, y compris cuDNN et cuBLAS + +### exécution locale + +Ajoutez XAI_MODEL et définissez-le à l’une des options ci-dessus [use Llama run](#run-with-llama) +Vous pouvez laisser X_SERVER_URL et XAI_API_KEY vides, qui téléchargera le modèle de huggingface et le consultera localement + +# le client + +Pour savoir comment configurer votre bot discord, vous pouvez consulter la documentation officielle de discord + +# le développement + +## le test + +Ligne de commande pour plusieurs méthodes de test: + +```bash +pnpm test # Run tests once +pnpm test:watch # Run tests in watch mode +``` + +Pour les tests spécifiques à la base de données: + +```bash +pnpm test:sqlite # Run tests with SQLite +pnpm test:sqljs # Run tests with SQL.js +``` + +Les tests sont écrits en Jest et se trouvent dans le fichier SRC /\*_/_.test.ts. L’environnement de test est configuré comme suit: + +- chargement des variables d’environnement de.env.test +- utilisez un temps d’attente de 2 minutes pour exécuter des tests de longue durée +- support du module ESM +- exécuter les tests dans l’ordre (--runInBand) + +Pour créer un nouveau test, ajoutez un fichier.test.ts à côté du code à tester. \ No newline at end of file diff --git a/docs/docs/api/_media/README_JA.md b/docs/docs/api/_media/README_JA.md new file mode 100644 index 00000000000..2281db8a1bc --- /dev/null +++ b/docs/docs/api/_media/README_JA.md @@ -0,0 +1,174 @@ +# Eliza + +Eliza Banner + +## 機能 + +- 🛠 Discord、Twitter、Telegramのフル機能コネクタ +- 👥 マルチエージェントおよびルームサポート +- 📚 ドキュメントの簡単な取り込みと対話 +- 💾 検索可能なメモリおよびドキュメントストア +- 🚀 高い拡張性 - 機能を拡張するための独自のアクションとクライアントを作成可能 +- ☁️ Llama、OpenAI、Anthropic、Groqなど、多くのモデルをサポート +- 📦 すぐに使える! + +## 何に使えるのか? + +- 🤖 チャットボット +- 🕵️ 自律エージェント +- 📈 ビジネスプロセスの処理 +- 🎮 ビデオゲームのNPC + +# 始め方 + +**必須条件:** + +- [Node.js 22+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +- [pnpm](https://pnpm.io/installation) + +### .envファイルの編集 + +- .env.exampleを.envにコピーし、適切な値を入力 +- TWITTER環境変数を編集して、ボットのユーザー名とパスワードを追加 + +### キャラクターファイルの編集 + +- `src/core/defaultCharacter.ts`ファイルを確認 - これを変更可能 +- `pnpm start --characters="path/to/your/character.json"`を使用してキャラクターをロードし、複数のボットを同時に実行可能 + +.envファイルとキャラクターファイルを設定した後、以下のコマンドでボットを起動可能: + +``` +pnpm i +pnpm start +``` + +# Elizaのカスタマイズ + +### カスタムアクションの追加 + +コアディレクトリでのGitの競合を避けるために、カスタムアクションを`custom_actions`ディレクトリに追加し、それを`elizaConfig.yaml`ファイルに追加することをお勧めします。例については`elizaConfig.example.yaml`ファイルを参照してください。 + +## 異なるモデルでの実行 + +### Llamaでの実行 + +`XAI_MODEL`環境変数を`meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo`または`meta-llama/Meta-Llama-3.1-405B-Instruct`に設定することで、Llama 70Bまたは405Bモデルを実行可能 + +### Grokでの実行 + +`XAI_MODEL`環境変数を`grok-beta`に設定することで、Grokモデルを実行可能 + +### OpenAIでの実行 + +`XAI_MODEL`環境変数を`gpt-4o-mini`または`gpt-4o`に設定することで、OpenAIモデルを実行可能 + +## 追加の要件 + +Sharpをインストールする必要があるかもしれません。起動時にエラーが表示された場合は、以下のコマンドでインストールを試みてください: + +``` +pnpm install --include=optional sharp +``` + +# 環境設定 + +���まざまなプラットフォームに接続するために、.envファイルに環境変数を追加する必要があります: + +``` +# 必須環境変数 +DISCORD_APPLICATION_ID= +DISCORD_API_TOKEN= # ボットトークン +OPENAI_API_KEY=sk-* # OpenAI APIキー、sk-で始まる +ELEVENLABS_XI_API_KEY= # elevenlabsからのAPIキー + +# ELEVENLABS設定 +ELEVENLABS_MODEL_ID=eleven_multilingual_v2 +ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM +ELEVENLABS_VOICE_STABILITY=0.5 +ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9 +ELEVENLABS_VOICE_STYLE=0.66 +ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false +ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4 +ELEVENLABS_OUTPUT_FORMAT=pcm_16000 + +TWITTER_DRY_RUN=false +TWITTER_USERNAME= # アカウントのユーザー名 +TWITTER_PASSWORD= # アカウントのパスワード +TWITTER_EMAIL= # アカウントのメール +TWITTER_COOKIES= # アカウントのクッキー + +X_SERVER_URL= +XAI_API_KEY= +XAI_MODEL= + + +# Claudeに質問するため +ANTHROPIC_API_KEY= + +WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY +WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY + +BIRDEYE_API_KEY= + +SOL_ADDRESS=So11111111111111111111111111111111111111112 +SLIPPAGE=1 +RPC_URL=https://api.mainnet-beta.solana.com +HELIUS_API_KEY= + + +## Telegram +TELEGRAM_BOT_TOKEN= + +TOGETHER_API_KEY= +``` + +# ローカル推論設定 + +### CUDA設定 + +NVIDIA GPUを持っている場合、CUDAをインストールしてローカル推論を大幅に高速化可能 + +``` +pnpm install +npx --no node-llama-cpp source download --gpu cuda +``` + +CUDA Toolkit、cuDNN、cuBLASをインストールしていることを確認してください。 + +### ローカルでの実行 + +XAI_MODELを追加し、[Llamaでの実行](#run-with-llama)のオプションのいずれかに設定 - X_SERVER_URLとXAI_API_KEYを空白のままにしておくと、huggingfaceからモデルをダウンロードし、ローカルでクエリを実行します。 + +# クライアント + +## Discordボット + +Discordボットの設定に関するヘルプについては、こちらを参照してください: https://discordjs.guide/preparations/setting-up-a-bot-application.html + +# 開発 + +## テスト + +テストスイートを実行するには: + +```bash +pnpm test # テストを一度実行 +pnpm test:watch # ウォッチモードでテストを実行 +``` + +データベース固有のテストの場合: + +```bash +pnpm test:sqlite # SQLiteでテストを実行 +pnpm test:sqljs # SQL.jsでテストを実行 +``` + +テストはJestを使用して記述されており、`src/**/*.test.ts`ファイルにあります。テスト環境は次のように構成されています: + +- `.env.test`から環境変数をロード +- 長時間実行されるテストのために2分のタイムアウトを使用 +- ESMモジュールをサポート +- テストを順番に実行 (--runInBand) + +新しいテストを作成するには、テストするコードの隣に`.test.ts`ファイルを追加します。 diff --git a/docs/docs/api/_media/README_KOR.md b/docs/docs/api/_media/README_KOR.md new file mode 100644 index 00000000000..6cbc3063ba4 --- /dev/null +++ b/docs/docs/api/_media/README_KOR.md @@ -0,0 +1,171 @@ +# Eliza + +eliza banner + +## 기능 + +- 🛠 지지 discord 트위터/telegram 연결 +- 👥 지지여 모드 agent +- 📚 간단 한 문서를 가져오기와 문서를 번갈아 +- 💾 검색 할 수 있는 메모리와 문서 저장 +- 🚀 확장 가능 성이 높은, 사용자 정의 클라이언트와 행위를 확장 기능 +- ☁ ️여 모형 지지 llama · openai grok anthropic 등 +- 📦 간단 하기도 좋습니다. + +eliza로 뭘 할 수 있나요? + +- 🤖 챗 봇 +- 🕵 ️ 자주 agents +- 📈 업무 처리 과정을 자동화 +- 🎮 게임 npc + +# 사용시작 + +**전제 요구(필수):** + +- [Node.js 22 +](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) +- Nodejs 설치 +- [pnpm](https://pnpm.io/installation) +- pnpm을사용한다 + +## 편집.env 파일 + +- .env.example을.env로 복사하고 적절한 값을 입력한다 +- 트위터 환경을 편집하고, 트위터 계정과 비밀번호를 입력한다 + +## 캐릭터 파일 편집 + +- 파일 `src/core/defaultcharacter.ts ` - 그것을 수정 할 수 있다 +- 사용하셔도됩니다 `node --loader ts-node/esm src/index.ts --characters="path/to/your/character.json"` 여러 로봇을 동시에 실행하여 캐릭터를 불러옵니다. + +아이디와 캐릭터 파일 설정이 완료되었다면, 다음 명령줄을 입력하여 로봇을 실행시키십시오: + +``` +pnpm i +pnpm start +``` + +# 사용자 정의 Eliza + +### 일반 행동을 추가한다 + +커널 디렉터리에서 git 충돌을 방지하기 위해 custom_actions 디렉터리에 사용자 정의 동작을 추가하고 elizaconfig.yaml 파일에서 동작을 설정할 것을 제안한다.elizaconfig.example.yaml 파일의 예제는 참조할 수 있다. + +다른 대형 모델들을 배치한다 + +### 프로필Llama + +`XAI_MODEL`환경 변수를`meta-llama/meta-llam-3.1-70b-instruct-turbo`또는`meta-llama/meta-llam-3.1-405b-instruct`로 설정하여 실행할 수 있다라마 70b 405b 모델 + +## openai 설정 + +`XAI_MODEL`환경 변수를`gpt-4o-mini`또는`gpt-4o`로 설정하여 OpenAI 모델을 실행할 수 있다 + +## 기타 요구 사항 + +Sharp를 설치해야 할 수도 있습니다.시작시 오류가 발견되면 다음 명령으로 설치하십시오: + +``` +pnpm install-include=optional sharp +``` + +# 환경 설정 + +다양한 플랫폼에 연결하기 위해서는.env 파일에서 환경 변수를 추가해야 합니다: + +``` +# Required environment variables +DISCORD_APPLICATION_ID= +DISCORD_API_TOKEN= # Bot token +OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk- +ELEVENLABS_XI_API_KEY= # API key from elevenlabs + +# ELEVENLABS SETTINGS +ELEVENLABS_MODEL_ID=eleven_multilingual_v2 +ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM +ELEVENLABS_VOICE_STABILITY=0.5 +ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9 +ELEVENLABS_VOICE_STYLE=0.66 +ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false +ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4 +ELEVENLABS_OUTPUT_FORMAT=pcm_16000 + +TWITTER_DRY_RUN=false +TWITTER_USERNAME= # Account username +TWITTER_PASSWORD= # Account password +TWITTER_EMAIL= # Account email +TWITTER_COOKIES= # Account cookies + +X_SERVER_URL= +XAI_API_KEY= +XAI_MODEL= + + +# For asking Claude stuff +ANTHROPIC_API_KEY= + +WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY +WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY + +BIRDEYE_API_KEY= + +SOL_ADDRESS=So11111111111111111111111111111111111111112 +SLIPPAGE=1 +RPC_URL=https://api.mainnet-beta.solana.com +HELIUS_API_KEY= + + +## Telegram +TELEGRAM_BOT_TOKEN= + +TOGETHER_API_KEY= +``` + +# 로컬 설정 + +### cuda 설정 + +고성능 엔비디아 그래픽을 가지고 있다면 다음 명령줄에서 cuda를 사용하여 로컬 가속을 할 수 있다 + +``` +pnpm install +npx --no node-llama-cpp source download --gpu cuda +``` + +cuDNN과 cuBLAS를 포함한 완전한 cuda 키트를 설치했는지 확인하세요 + +### 로컬 실행 + +위의 [Llama로 실행](#run-with-llama) 옵션 중 하나로 XAI_MODEL을 추가한다 +X_SERVER_URL과 xai_api_key를 공백으로 두면 huggingface에서 모델을 다운로드하고 현지에서 쿼리한다 + +# 클라이언트 + +discord bot을 설정하는 방법에 대해 discord의 공식 문서를 볼 수 있습니까 + +# 개발 + +## 테스트 + +여러 테스트 방법을 위한 명령줄: + +```bash +pnpm test # Run tests once +pnpm test:watch # Run tests in watch mode +``` + +데이터베이스에 특화된 테스트: + +```bash +pnpm test:sqlite # Run tests with SQLite +pnpm test:sqljs # Run tests with SQL.js +``` + +테스트는 src/\*_/_.test.ts 파일에 있는 Jest로 작성된다.테스트 환경 설정은 다음과 같습니다: + +- .env.test에서 환경 변수를 불러온다 +- 장기 실행 테스트를 실행하기 위해 2분 제한 시간을 사용합니다 +- esm 모듈을 지원한다 +- 테스트 실행 순서 (--runInBand) + +새 테스트를 만들려면, 테스트할 코드 옆에.test.ts 파일을 추가하세요. \ No newline at end of file diff --git a/docs/docs/community/streams/2024-11-10.md b/docs/docs/community/streams/2024-11-10.md new file mode 100644 index 00000000000..bbf7ed10928 --- /dev/null +++ b/docs/docs/community/streams/2024-11-10.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 3 +title: "Threadguy x Shaw Interview" +description: "Threadguy interviews Shaw live on Twitch" +--- + +# Threadguy x Shaw 11-10-24 + +- Tweet: https://x.com/notthreadguy/status/1855809741340971518 +- VOD: https://www.twitch.tv/videos/2298718699 + +## Overview +Shaw discusses the intersection of AI and crypto, the development of AI agents on Twitter, and the vision for AI-powered trading and investing. He shares insights into the Eliza framework, the AI16Z universe, and the future of AI in the crypto space. + +## Notes +- 00:02:16 - Shaw is having the most fun in his life with the recent developments in AI and crypto. +- 00:03:36 - Crypto Twitter has embraced AI, calling agents "meme coins". Shaw discusses the relationship between AI developers and the crypto community. +- 00:08:50 - They discuss the recreation of DegenSpartan, AI characters, as a callback to "make crypto Twitter great again." +- 00:14:06 - The current meta is AI key opinion leaders (KOLs) and genuinely interesting AI-driven characters and interactions on Twitter. +- 00:19:36 - Shaw believes 99.99% of crypto will be traded between agents in the future, making investing more accessible and less risky for everyday people. +- 00:26:10 - Technological advancements, such as increased context length and reduced costs, have made AI agents more viable and interactive. +- 00:31:16 - Shaw mentions that people are now hanging on his every word, which is a new experience for him. +- 00:38:82 - Shaw discusses the Eliza project, an open-source framework for creating AI agents on GitHub. +- 00:46:24 - He mentions partnerships and collaborations with other projects building on the Eliza framework. +- 00:52:30 - Shaw talks about the development of a marketplace of trust for AI trading, focusing on the best traders and their advice. +- 00:57:44 - Shaw discusses the idea of an "agent accelerator" where they would work with an investment partner to help launch and invest in new AI projects. +- 01:07:28 - They discuss the various AI projects in the AI16Z universe, including Naval AI, Murad AI, DegenSpartan AI, and EZSYS. +- 01:14:12 - He believes that the future of Artificial General Intelligence (AGI) will be built using TypeScript, as it is the most popular and versatile programming language. +- 01:21:50 - Shaw believes that AI can help make crypto more accessible and less focused on gambling, ultimately giving people more time back. +- 01:29:30 - Shaw shares his vision of AI helping to make crypto trading less time-consuming and more accessible, giving people more time to spend with friends and family. +- 01:32:02 - He discusses the Gnon AI project and the community's response to the founders dumping the token. +- 01:36:56 - They talk about the upcoming launch of AI trading with AI16Z's Mark and the goal of creating a leaderboard for the best traders on Crypto Twitter. +- 01:48:44 - They briefly discuss Yuga Labs' Mecha Piece NFT project and its potential impact on the space. +- 01:52:14 - Shaw shares plans for a platform that allows users to customize and launch their own AI agents with additional capabilities. +- 02:02:20 - He reflects on the increased attention and collaboration opportunities since the rise of AI in crypto. +- 02:06:26 - Shaw mentions that his financial situation hasn't changed much since the rise of AI in crypto, as he hasn't sold any tokens, but the attention and collaboration opportunities have increased significantly. +- 02:10:07 - Shaw explains his strategy for staying informed about developments in AI and crypto by relying on key people in various communities. +- 02:13:28 - He explains why he switched to a Milady profile picture, citing the project's community and values. + +The interview covers a wide range of topics related to AI and crypto, focusing on the development of the Eliza framework, the future of AI-powered trading, and the growing intersection between the two fields, while also providing personal insights and experiences from Shaw's perspective. diff --git a/docs/docs/community/streams/2024-11-15.md b/docs/docs/community/streams/2024-11-15.md new file mode 100644 index 00000000000..7532d094c67 --- /dev/null +++ b/docs/docs/community/streams/2024-11-15.md @@ -0,0 +1,48 @@ +--- +sidebar_position: 4 +title: "What Did You Get Done This Week 1" +description: "WDYGDTW: Social Agents / Advancing towards AGI" +--- + +# WDYGDTW 1: Social Agents + +Link to space: https://x.com/i/spaces/1gqxvNpZVljxB/peek + +- 00:02:02 - Meeting Start +- 00:03:10 - Audio Check +- 00:04:04 - Call Purpose: Team Updates on Agents, Social Agents & AGI +- 00:05:03 - Time Limit: 5-10 mins per speaker +- 00:06:01 - Speaker Queue: Logan, Kyle (Raid Guild), Glue, Ropey, Loaf, Odie, SomewheresHe, Robin +- 00:06:32 - Logan's Update: Trust Marketplace +- 00:09:57 - Shaw explains Trust Marketplace +- 00:10:49 - Kyle (Raid Guild) Update: DevCon, EVM Wallet Integration, Bridging for AI agents +- 00:14:19 - Glue Update: Ducky AI, Open Sourcing Prompts & Tools +- 00:17:31 - Ropey Update: Eliza Repo, Base Model Steering, Telegram Fixes, Dynamic Platform Access +- 00:21:29 - Loaf Update: Eliza Architecture, Starknet Wallet Plugin, On-chain Games Plugins +- 00:24:59 - Max Update: Helping Users Set Up +- 00:25:45 - SomewheresHe Update: Sentience, Media Generation, Discord Launch, Brand Integration & Future of Media +- 00:29:46 - Robin Update: God's Fun, Agent Autonomy & OpenRouter +- 00:32:08 - IQ6900 Update: Building a Cooler Website +- 00:34:19 - Marvin Update: Running Eliza on TEEs, Security & Transparency +- 00:35:42 - Dot Update: Streamer Platform for Eliza Agents +- 00:37:35 - JW Update: Decentralized AI Cloud, Heurist Integration +- 00:43:08 - Neo Update: Pump Fun Data Analysis & Twitter Bot +- 00:44:57 - Bloom Update: AI-Centric Project, Agent Integration, Future Vision +- 00:49:49 - Reality Spiral Update: Twitter Client PR, JSON Outputs, Github Adapter +- 00:55:35 - Call for Open Sharing: Encourage non-Eliza projects +- 00:55:58 - Jen Update: Documentation for AI Agents +- 00:58:50 - OFI Update: Olama & OpenRouter Model, Solana Transactions, Pump Fun on Image Gen +- 01:14:44 - Butoshi Update: Satoshi AI, Boop Memory System +- 01:20:37 - Doc (Geon Reborn) Update: Echo Chambers Client Launch +- 01:23:16 - HCP Update: Bringing Agent Designs to Eliza, Embeddings on ARM64 +- 01:27:13 - Garrett Update: Deep Writer, Diagrams for Planning & Feedback Loops +- 01:30:16 - Lady Liberty Update: Music Agent Project +- 01:31:34 - BoyaLockser Update: Learning the Project +- 01:32:53 - Amy Update: Psychic AI, Twitter Bot for Psychic Readings +- 01:34:42 - Griffin Update: Seeking Contribution Opportunities +- 01:38:19 - Frank (Heurist) Update: Heurist API Integration +- 01:44:12 - Shaw's Update & Vision: Focus on Knowledge Transfer, Tutorials & Vision Sharing +- 01:50:31 - Trust Marketplace & Alpha Chat Announcement +- 01:56:41 - Emergent Narrative & Agent Operators +- 02:00:54 - Tim Update: Dashboard for Visualizing ELIZA Agents, Tribute Model +- 02:16:41 - Closing Thoughts and Thanks diff --git a/docs/sidebars.js b/docs/sidebars.js index 0c68bd916b3..4075dd8e1ef 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -164,6 +164,16 @@ const sidebars = { type: "category", label: "November 2024", items: [ + { + type: "doc", + id: "community/streams/2024-11-15", + label: "What Did You Get Done This Week 1", + }, + { + type: "doc", + id: "community/streams/2024-11-10", + label: "Threadguy x Shaw Interview", + }, { type: "doc", id: "community/streams/2024-11-08",