Merge pull request #27 from ai16z/main

merge from main

Author: MarcoMandar

.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

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**
+
+<a href="https://github.com/ai16z/eliza/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=ai16z/eliza" />
+</a>
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=ai16z/eliza&type=Date)](https://star-history.com/#ai16z/eliza&Date)

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,19 +400,19 @@ 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
 
 • **service**: [`ServiceType`](../enumerations/ServiceType.md)
 
 #### 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()