Skip to content

Commit d279282

Browse files
authored
Merge pull request #320 from gabrielsants/readme_translate
docs: add a new Portuguese README version
2 parents b7b7fca + 29d38d3 commit d279282

File tree

2 files changed

+177
-0
lines changed

2 files changed

+177
-0
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
### [For Japanese Version: 日本語の説明](./README_JA.md)
77
### [For Korean Version: 한국어 설명](./README_KOR.md)
88
### [For French Version: Instructions en français](./README_FR.md)
9+
### [For Portuguese Version: Instruções em português](./README_PTBR.md)
910

1011
## Features
1112

README_PTBR.md

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# Eliza
2+
3+
<img src="./docs/static/img/eliza_banner.jpg" alt="Eliza Banner" width="100%" />
4+
5+
## Funcionalidades
6+
7+
- 🛠 Conectores completos para Discord, Twitter e Telegram
8+
- 👥 Suporte a múltiplos agentes e salas
9+
- 📚 Ingestão e interação fácil com seus documentos
10+
- 💾 Memória recuperável e armazenamento de documentos
11+
- 🚀 Altamente extensível - crie suas próprias ações e clientes para estender as capacidades
12+
- ☁️ Suporta muitos modelos, incluindo Llama local, OpenAI, Anthropic, Groq e mais
13+
- 📦 Funciona perfeitamente!
14+
15+
## Para que posso usá-lo?
16+
17+
- 🤖 Chatbots
18+
- 🕵️ Agentes autônomos
19+
- 📈 Gestão de processos empresariais
20+
- 🎮 NPCs em jogos de vídeo
21+
22+
# Começando
23+
24+
**Pré-requisitos (OBRIGATÓRIO):**
25+
26+
- [Python 2.7+](https://www.python.org/downloads/)
27+
- [Node.js 23.1+](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
28+
- [pnpm](https://pnpm.io/installation)
29+
30+
### Edite o arquivo .env
31+
32+
- Copie .env.example para .env e preencha os valores apropriados
33+
- Edite as variáveis de ambiente do TWITTER para adicionar o nome de usuário e senha do seu bot
34+
35+
### Edite o arquivo de personagem
36+
37+
- Confira o arquivo `src/core/defaultCharacter.ts` - você pode modificá-lo
38+
- Você também pode carregar personagens com o comando `pnpm start --characters="path/to/your/character.json"` e executar múltiplos bots ao mesmo tempo.
39+
40+
Após configurar o arquivo .env e o arquivo de personagem, você pode iniciar o bot com o seguinte comando:
41+
42+
```
43+
pnpm i
44+
pnpm start
45+
```
46+
47+
# Personalizando Eliza
48+
49+
### Adicionando ações personalizadas
50+
51+
Para evitar conflitos no diretório core, recomendamos adicionar ações personalizadas a um diretório `custom_actions` e depois adicioná-las ao arquivo `elizaConfig.yaml`. Veja o arquivo `elizaConfig.example.yaml` para um exemplo.
52+
53+
## Executando com diferentes modelos
54+
55+
### Executar com Llama
56+
57+
Você pode executar modelos Llama 70B ou 405B configurando a variável de ambiente `XAI_MODEL` para `meta-llama/Meta-Llama-3.1-70B-Instruct-Turbo` ou `meta-llama/Meta-Llama-3.1-405B-Instruct`
58+
59+
### Executar com Grok
60+
61+
Você pode executar modelos Grok configurando a variável de ambiente `XAI_MODEL` para `grok-beta`
62+
63+
### Executar com OpenAI
64+
65+
Você pode executar modelos OpenAI configurando a variável de ambiente `XAI_MODEL` para `gpt-4o-mini` ou `gpt-4o`
66+
67+
## Requisitos Adicionais
68+
69+
Pode ser necessário instalar o Sharp. Se você encontrar um erro ao iniciar, tente instalá-lo com o seguinte comando:
70+
71+
```
72+
pnpm install --include=optional sharp
73+
```
74+
75+
# Configuração do Ambiente
76+
77+
Você precisará adicionar variáveis de ambiente ao seu arquivo .env para se conectar a várias plataformas:
78+
79+
```
80+
# Variáveis de ambiente obrigatórias
81+
DISCORD_APPLICATION_ID=
82+
DISCORD_API_TOKEN= # Token do bot
83+
OPENAI_API_KEY=sk-* # Chave API do OpenAI, começando com sk-
84+
ELEVENLABS_XI_API_KEY= # Chave API do elevenlabs
85+
GOOGLE_GENERATIVE_AI_API_KEY= # Chave API do Gemini
86+
87+
# CONFIGURAÇÕES DO ELEVENLABS
88+
ELEVENLABS_MODEL_ID=eleven_multilingual_v2
89+
ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
90+
ELEVENLABS_VOICE_STABILITY=0.5
91+
ELEVENLABS_VOICE_SIMILARITY_BOOST=0.9
92+
ELEVENLABS_VOICE_STYLE=0.66
93+
ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false
94+
ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4
95+
ELEVENLABS_OUTPUT_FORMAT=pcm_16000
96+
97+
TWITTER_DRY_RUN=false
98+
TWITTER_USERNAME= # Nome de usuário da conta
99+
TWITTER_PASSWORD= # Senha da conta
100+
TWITTER_EMAIL= # Email da conta
101+
TWITTER_COOKIES= # Cookies da conta
102+
103+
X_SERVER_URL=
104+
XAI_API_KEY=
105+
XAI_MODEL=
106+
107+
108+
# Para perguntar coisas ao Claude
109+
ANTHROPIC_API_KEY=
110+
111+
WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
112+
WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
113+
114+
BIRDEYE_API_KEY=
115+
116+
SOL_ADDRESS=So11111111111111111111111111111111111111112
117+
SLIPPAGE=1
118+
RPC_URL=https://api.mainnet-beta.solana.com
119+
HELIUS_API_KEY=
120+
121+
122+
## Telegram
123+
TELEGRAM_BOT_TOKEN=
124+
125+
TOGETHER_API_KEY=
126+
```
127+
128+
# Configuração de Inferência Local
129+
130+
### Configuração CUDA
131+
132+
Se você tiver uma GPU NVIDIA, pode instalar o CUDA para acelerar dramaticamente a inferência local.
133+
134+
```
135+
pnpm install
136+
npx --no node-llama-cpp source download --gpu cuda
137+
```
138+
139+
Certifique-se de ter instalado o CUDA Toolkit, incluindo cuDNN e cuBLAS.
140+
141+
### Executando localmente
142+
143+
Adicione XAI_MODEL e configure-o para uma das opções acima de [Executar com Llama](#executar-com-llama) - você pode deixar X_SERVER_URL e XAI_API_KEY em branco, ele baixa o modelo do huggingface e faz consultas localmente
144+
145+
# Clientes
146+
147+
## Bot do Discord
148+
149+
Para ajuda com a configuração do seu Bot do Discord, confira aqui: https://discordjs.guide/preparations/setting-up-a-bot-application.html
150+
151+
# Desenvolvimento
152+
153+
## Testes
154+
155+
Para executar a suíte de testes:
156+
157+
```bash
158+
pnpm test # Executar testes uma vez
159+
pnpm test:watch # Executar testes no modo watch
160+
```
161+
162+
Para testes específicos de banco de dados:
163+
164+
```bash
165+
pnpm test:sqlite # Executar testes com SQLite
166+
pnpm test:sqljs # Executar testes com SQL.js
167+
```
168+
169+
Os testes são escritos usando Jest e podem ser encontrados em arquivos `src/**/*.test.ts`. O ambiente de teste está configurado para:
170+
171+
- Carregar variáveis de ambiente de `.env.test`
172+
- Usar um tempo limite de 2 minutos para testes de longa duração
173+
- Suportar módulos ESM
174+
- Executar testes em sequência (--runInBand)
175+
176+
Para criar novos testes, adicione um arquivo `.test.ts` adjacente ao código que você está testando.

0 commit comments

Comments
 (0)