Skip to content

Commit 74f8984

Browse files
committed
Add Livepeer model and configuration details to documentation
- Updated ModelProviderName.md to include Livepeer as a model provider. - Added Livepeer model alias in Models.md. - Included Livepeer gateway URL in quickstart.md and configuration.md. - Enhanced documentation to guide users on setting up Livepeer models.
1 parent 74c85a2 commit 74f8984

File tree

6 files changed

+35
-2
lines changed

6 files changed

+35
-2
lines changed

docs/api/enumerations/ModelProviderName.md

+10
Original file line numberDiff line numberDiff line change
@@ -233,3 +233,13 @@ Available model providers
233233
#### Defined in
234234

235235
[packages/core/src/types.ts:240](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L240)
236+
237+
***
238+
239+
### LIVEPEER
240+
241+
> **LIVEPEER**: `"livepeer"`
242+
243+
#### Defined in
244+
245+
[packages/core/src/types.ts:241](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L241)

docs/api/type-aliases/Models.md

+4
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,10 @@ Model configurations by provider
100100

101101
> **akash\_chat\_api**: [`Model`](Model.md)
102102
103+
### livepeer
104+
105+
> **livepeer**: [`Model`](Model.md)
106+
103107
## Defined in
104108

105109
[packages/core/src/types.ts:188](https://github.com/elizaOS/eliza/blob/main/packages/core/src/types.ts#L188)

docs/docs/api/enumerations/ModelProviderName.md

+10
Original file line numberDiff line numberDiff line change
@@ -119,3 +119,13 @@
119119
#### Defined in
120120

121121
[packages/core/src/types.ts:132](https://github.com/elizaos/eliza/blob/4d1e66cbf7deea87a8a67525670a963cd00108bc/packages/core/src/types.ts#L132)
122+
123+
---
124+
125+
### LIVEPEER
126+
127+
> **LIVEPEER**: `"livepeer"`
128+
129+
#### Defined in
130+
131+
[packages/core/src/types.ts:133](https://github.com/elizaos/eliza/blob/4d1e66cbf7deea87a8a67525670a963cd00108bc/packages/core/src/types.ts#L133)

docs/docs/api/type-aliases/Models.md

+4
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@
5252

5353
> **heurist**: [`Model`](Model.md)
5454
55+
### livepeer
56+
57+
> **livepeer**: [`Model`](Model.md)
58+
5559
## Defined in
5660

5761
[packages/core/src/types.ts:105](https://github.com/elizaos/eliza/blob/7fcf54e7fb2ba027d110afcc319c0b01b3f181dc/packages/core/src/types.ts#L105)

docs/docs/guides/configuration.md

+3
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,9 @@ TOGETHER_API_KEY=
7272
# Heurist Settings
7373
HEURIST_API_KEY=
7474

75+
# Livepeer Settings
76+
LIVEPEER_GATEWAY_URL=
77+
7578
# Local Model Settings
7679
XAI_MODEL=meta-llama/Llama-3.1-7b-instruct
7780
```

docs/docs/quickstart.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ pnpm build
8282
OPENAI_API_KEY= # OpenAI API key
8383
GROK_API_KEY= # Grok API key
8484
ELEVENLABS_XI_API_KEY= # API key from elevenlabs (for voice)
85+
LIVEPEER_GATEWAY_URL= # Livepeer gateway URL
8586
```
8687
8788
## Choose Your Model
@@ -94,6 +95,7 @@ Eliza supports multiple AI models:
9495
- **Llama**: Set `XAI_MODEL=meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo`
9596
- **Grok**: Set `XAI_MODEL=grok-beta`
9697
- **OpenAI**: Set `XAI_MODEL=gpt-4o-mini` or `gpt-4o`
98+
- **Livepeer**: Set `LIVEPEER_IMAGE_MODEL` to your chosen Livepeer image model, available models [here](https://livepeer-eliza.com/)
9799
98100
You set which model to use inside the character JSON file
99101
@@ -216,8 +218,8 @@ pnpm start --characters="characters/trump.character.json,characters/tate.charact
216218
- Ensure Node.js 23.3.0 is installed
217219
- Use `node -v` to check version
218220
- Consider using [nvm](https://github.com/nvm-sh/nvm) to manage Node versions
219-
220-
NOTE: pnpm may be bundled with a different node version, ignoring nvm. If this is the case, you can use
221+
222+
NOTE: pnpm may be bundled with a different node version, ignoring nvm. If this is the case, you can use
221223
```bash
222224
pnpm env use --global 23.3.0
223225
```

0 commit comments

Comments
 (0)