Skip to content

Commit 2ae8ec7

Browse files
committed
add integration docs
1 parent 4d1e66c commit 2ae8ec7

File tree

5 files changed

+80
-1
lines changed

5 files changed

+80
-1
lines changed

docs/api/enumerations/ModelProviderName.md

+8
Original file line numberDiff line numberDiff line change
@@ -111,3 +111,11 @@
111111
#### Defined in
112112

113113
[packages/core/src/types.ts:130](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L130)
114+
115+
### HEURIST
116+
117+
> **HEURIST**: `"heurist"`
118+
119+
#### Defined in
120+
121+
[packages/core/src/types.ts:132](https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L132)

docs/docs/advanced/fine-tuning.md

+25
Original file line numberDiff line numberDiff line change
@@ -266,6 +266,31 @@ const llamaLocalSettings = {
266266
};
267267
```
268268

269+
### Heurist Provider
270+
271+
```typescript
272+
const heuristSettings = {
273+
settings: {
274+
stop: [],
275+
maxInputTokens: 128000,
276+
maxOutputTokens: 8192,
277+
repetition_penalty: 0.0,
278+
temperature: 0.7,
279+
},
280+
imageSettings: {
281+
steps: 20,
282+
},
283+
endpoint: "https://llm-gateway.heurist.xyz",
284+
model: {
285+
[ModelClass.SMALL]: "meta-llama/llama-3-70b-instruct",
286+
[ModelClass.MEDIUM]: "meta-llama/llama-3-70b-instruct",
287+
[ModelClass.LARGE]: "meta-llama/llama-3.1-405b-instruct",
288+
[ModelClass.EMBEDDING]: "", // Add later
289+
[ModelClass.IMAGE]: "PepeXL",
290+
}
291+
}
292+
```
293+
269294
## Testing and Validation
270295

271296
### Embedding Tests

docs/docs/api/enumerations/ModelProviderName.md

+11
Original file line numberDiff line numberDiff line change
@@ -109,3 +109,14 @@
109109
#### Defined in
110110

111111
[packages/core/src/types.ts:128](https://github.com/ai16z/eliza/blob/7fcf54e7fb2ba027d110afcc319c0b01b3f181dc/packages/core/src/types.ts#L128)
112+
113+
114+
***
115+
116+
### HEURIST
117+
118+
> **HEURIST**: `"heurist"`
119+
120+
#### Defined in
121+
122+
[packages/core/src/types.ts:132](https://github.com/ai16z/eliza/blob/4d1e66cbf7deea87a8a67525670a963cd00108bc/packages/core/src/types.ts#L132)

docs/docs/guides/configuration.md

+31
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,37 @@ TOGETHER_API_KEY=
7171
XAI_MODEL=meta-llama/Llama-3.1-7b-instruct
7272
```
7373

74+
### Image Generation
75+
76+
Configure image generation in your character file:
77+
78+
```json
79+
{
80+
"modelProvider": "HEURIST",
81+
"settings": {
82+
"imageSettings": {
83+
"steps": 20,
84+
"width": 512,
85+
"height": 512
86+
}
87+
}
88+
}
89+
```
90+
91+
Example usage:
92+
93+
```typescript
94+
const result = await generateImage({
95+
prompt: "a beautiful sunset",
96+
width: 512,
97+
height: 512,
98+
numIterations: 20, // optional
99+
guidanceScale: 7.5, // optional
100+
seed: -1, // optional
101+
modelId: "PepeXL" // optional
102+
}, runtime);
103+
```
104+
74105
## Character Configuration
75106

76107
### Character File Structure

docs/docs/quickstart.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -53,14 +53,18 @@ Before getting started with Eliza, ensure you have:
5353
# Suggested quickstart environment variables
5454
DISCORD_APPLICATION_ID= # For Discord integration
5555
DISCORD_API_TOKEN= # Bot token
56-
OPENAI_API_KEY= # OpenAI API key (starting with sk-*)
56+
HEURIST_API_KEY= # Heurist API key for LLM and image generation
57+
OPENAI_API_KEY= # OpenAI API key
5758
ELEVENLABS_XI_API_KEY= # API key from elevenlabs (for voice)
5859
```
5960

6061
## Choose Your Model
6162

6263
Eliza supports multiple AI models:
6364

65+
- **Heurist**: Set `modelProvider: "HEURIST"` in your character file
66+
- LLM: Uses Llama models (more available LLM models [here](https://heurist.mintlify.app/developer/supported-models))
67+
- Image Generation: Uses PepeXL model (more info of available models [here](https://heurist.mintlify.app/developer/image-generation-api))
6468
- **Llama**: Set `XAI_MODEL=meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo`
6569
- **Grok**: Set `XAI_MODEL=grok-beta`
6670
- **OpenAI**: Set `XAI_MODEL=gpt-4o-mini` or `gpt-4o`

0 commit comments

Comments
 (0)