refactor(i18n): translate codebase and documentation to English
- Rewrite README.md, DEPLOY.md and RULES.md in English - Translate module docstring, license string and inline comments - Rename Portuguese state variables (is_agendamento, is_useragenda, is_configia) to English equivalents (is_schedule, is_dailyroutine, is_configai) - Replace Portuguese web-search and file-creation trigger phrases with English keywords
This commit is contained in:
@@ -1,43 +1,43 @@
|
||||
# PsAgentAI - Personal Agent AI Conversacional
|
||||
# PsAgentAI - Personal Conversational AI Agent
|
||||
|
||||
Sistema de Personal Agent AI Conversacional via Telegram que se comporta como uma companheira pessoal, conversando, cooperando e mantendo contexto contínuo com o usuário.
|
||||
Personal Conversational AI Agent system via Telegram that behaves as a personal companion, chatting, cooperating and maintaining continuous context with the user.
|
||||
|
||||
## Estrutura
|
||||
## Structure
|
||||
|
||||
```
|
||||
app/
|
||||
├── psagentai_agent.py # Código principal do agente
|
||||
├── iniciar.sh # Script de instalação e execução
|
||||
├── requirements.txt # Dependências Python
|
||||
├── .env # Configurações locais (não comitar)
|
||||
├── .env.example # Exemplo de configuração
|
||||
├── user_profile.json # Perfil do usuário
|
||||
├── agent_profile.json # Perfil do agente (personalidade, traços, notas)
|
||||
├── contexts/ # Históricos de conversa por data
|
||||
├── psagentai_agent.py # Main agent code
|
||||
├── iniciar.sh # Installation and execution script
|
||||
├── requirements.txt # Python dependencies
|
||||
├── .env # Local settings (do not commit)
|
||||
├── .env.example # Configuration example
|
||||
├── user_profile.json # User profile
|
||||
├── agent_profile.json # Agent profile (personality, traits, notes)
|
||||
├── contexts/ # Conversation history by date
|
||||
│ └── YYYY-MM-DD.json
|
||||
├── README.md
|
||||
└── LICENSE
|
||||
```
|
||||
|
||||
## Pré-requisitos
|
||||
## Prerequisites
|
||||
|
||||
- Python 3.9+
|
||||
- Conta no Telegram com bot criado via @BotFather
|
||||
- Pelo menos uma chave de API de IA suportada
|
||||
- Telegram account with bot created via @BotFather
|
||||
- At least one supported AI API key
|
||||
|
||||
## Configuração
|
||||
## Configuration
|
||||
|
||||
1. Copie `.env.example` para `.env` e preencha:
|
||||
- `TELEGRAM_BOT_TOKEN` — token do bot do Telegram
|
||||
- `TELEGRAM_CHAT_ID` — seu chat ID no Telegram
|
||||
- `OPENROUTER_API_KEY` ou outra chave de API compatível
|
||||
1. Copy `.env.example` to `.env` and fill in:
|
||||
- `TELEGRAM_BOT_TOKEN` — Telegram bot token
|
||||
- `TELEGRAM_CHAT_ID` — your Telegram chat ID
|
||||
- `OPENROUTER_API_KEY` or other compatible API key
|
||||
|
||||
2. Ajuste intervalos se desejar:
|
||||
2. Adjust intervals if desired:
|
||||
- `MIN_INTERVAL_MINUTES`
|
||||
- `MAX_INTERVAL_MINUTES`
|
||||
- `MIN_MESSAGE_LINES` — define o número mínimo de linhas por mensagem do agente (padrão: `15`)
|
||||
- `MIN_MESSAGE_LINES` — defines the minimum number of lines per agent message (default: `15`)
|
||||
|
||||
## Instalação e execução
|
||||
## Installation and execution
|
||||
|
||||
```bash
|
||||
cd app
|
||||
@@ -45,71 +45,71 @@ chmod +x iniciar.sh
|
||||
./iniciar.sh
|
||||
```
|
||||
|
||||
O script cria o ambiente virtual, instala dependências e inicia o agente.
|
||||
The script creates the virtual environment, installs dependencies and starts the agent.
|
||||
|
||||
## Funcionalidades
|
||||
## Features
|
||||
|
||||
- Onboarding inicial com perguntas para construir o perfil
|
||||
- Histórico de conversa por dia em `contexts/`
|
||||
- Perfil do usuário persistido em `user_profile.json`
|
||||
- Perfil do agente persistido em `agent_profile.json` (nome, personalidade, traços e notas)
|
||||
- Mensagens proativas em intervalos aleatórios configuráveis
|
||||
- Mínimo de linhas por mensagem do agente configurável via `.env`
|
||||
- Suporte a múltiplos provedores de IA:
|
||||
- Initial onboarding with questions to build the profile
|
||||
- Conversation history by day in `contexts/`
|
||||
- User profile persisted in `user_profile.json`
|
||||
- Agent profile persisted in `agent_profile.json` (name, personality, traits and notes)
|
||||
- Proactive messages at configurable random intervals
|
||||
- Minimum lines per agent message configurable via `.env`
|
||||
- Support for multiple AI providers:
|
||||
- OpenRouter
|
||||
- StepFun
|
||||
- QwenCloud
|
||||
- llama.cpp (local)
|
||||
- Atualização dinâmica do perfil via comandos naturais no chat
|
||||
- Dynamic profile update via natural commands in chat
|
||||
|
||||
## Comandos disponíveis
|
||||
## Available commands
|
||||
|
||||
- `/start` — inicia ou reinicia a conversa
|
||||
- `/ajuda` ou `/help` — exibe ajuda
|
||||
- `/perfil` — mostra perfil do usuário e do agente
|
||||
- `/agentprofile` — mostra apenas o perfil do agente
|
||||
- `/reset` — reseta perfis do usuário e do agente
|
||||
- `/limpar` — deleta todos os dados (perfis, contextos, chat_id)
|
||||
- `/onboarding` — reinicia o onboarding
|
||||
- `/newconfig` — reconfigura tudo do zero
|
||||
- `/cancelar` — cancela operação em andamento
|
||||
- `/veria` — mostra o provider e o modelo de IA atuais
|
||||
- `/configia` — configura interativamente o provider e o modelo de IA com seleção por botões
|
||||
- `/about` — exibe informações do sistema, versão, autor e licença
|
||||
- `/veriavision` — mostra o provider e o modelo de visão atuais
|
||||
- `/configiavision` — configura interativamente o modelo de visão com seleção por botões
|
||||
- `/baixar <nome>` — baixa um arquivo do workspace pelo nome
|
||||
- `/start` — starts or restarts the conversation
|
||||
- `/help` — displays help
|
||||
- `/profile` — shows user and agent profile summary
|
||||
- `/agentprofile` — shows only the agent profile
|
||||
- `/reset` — resets user and agent profiles
|
||||
- `/clear` — deletes all data (profiles, contexts, chat_id)
|
||||
- `/onboarding` — restarts onboarding
|
||||
- `/newconfig` — reconfigures everything from scratch
|
||||
- `/cancel` — cancels ongoing operation
|
||||
- `/viewai` — shows current AI provider and model
|
||||
- `/configai` — interactively configures AI provider and model with button selection
|
||||
- `/about` — displays system information, version, author and license
|
||||
- `/viewvision` — shows current vision provider and model
|
||||
- `/configvision` — interactively configures vision model with button selection
|
||||
- `/download <name>` — downloads a workspace file by name
|
||||
|
||||
## Editando arquivos do workspace
|
||||
## Editing workspace files
|
||||
|
||||
Você pode pedir para editar arquivos existentes no `workspace/` usando comandos como:
|
||||
- `edite o arquivo teste.txt e adicione uma linha 4`
|
||||
- `modifique o arquivo hello.py para imprimir hello world`
|
||||
- `no arquivo teste.txt troque Linha 2 por Linha 2 editada`
|
||||
You can ask to edit existing files in `workspace/` using commands like:
|
||||
- `edit the file test.txt and add line 4`
|
||||
- `modify the file hello.py to print hello world`
|
||||
- `in the file test.txt replace Line 2 with Line 2 edited`
|
||||
|
||||
O Agent irá localizar o arquivo, aplicar a alteração solicitada e salvar o resultado.
|
||||
- `/incluirnomeuperfil <nome>` — atualiza seu nome no perfil
|
||||
- `/incluirnoperfildoagent <texto>` — adiciona características ao perfil do agente
|
||||
The Agent will locate the file, apply the requested change and save the result.
|
||||
- `/addtouserprofile <text>` — updates information in your profile
|
||||
- `/addtoagentprofile <text>` — adds characteristics to the agent profile
|
||||
|
||||
## Atualizando o perfil durante a conversa
|
||||
## Updating profile during conversation
|
||||
|
||||
### Perfil do usuário
|
||||
### User profile
|
||||
|
||||
Você pode atualizar seu perfil a qualquer momento usando frases como:
|
||||
You can update your profile at any time using phrases like:
|
||||
|
||||
- `Inclui isso no meu perfil: ...`
|
||||
- `Anote no meu perfil: ...`
|
||||
- `Adicione no meu perfil: ...`
|
||||
- `Salve no meu perfil: ...`
|
||||
- `Include this in my profile: ...`
|
||||
- `Note in my profile: ...`
|
||||
- `Add to my profile: ...`
|
||||
- `Save in my profile: ...`
|
||||
|
||||
### Perfil do agente
|
||||
### Agent profile
|
||||
|
||||
Use `/incluirnoperfildoagent <texto>` para adicionar características ao perfil do agente.
|
||||
Ou use frases como:
|
||||
Use `/addtoagentprofile <text>` to add characteristics to the agent profile.
|
||||
Or use phrases like:
|
||||
|
||||
- `Inclui isso no perfil do agente: ...`
|
||||
- `Anote no perfil do agente: ...`
|
||||
- `Include this in the agent profile: ...`
|
||||
- `Note in the agent profile: ...`
|
||||
|
||||
## Licença
|
||||
## License
|
||||
|
||||
Uso proprietário. Veja o arquivo `LICENSE`.
|
||||
Proprietary use. See the `LICENSE` file.
|
||||
|
||||
Reference in New Issue
Block a user