TeleGPT

Telegpt

API Docs | Liberações | Twitter

Um bot chatgpt fora da caixa para telegrama.

O Telegpt é um bot de telegrama baseado na estrutura de telóxido e async_openai . Ele fornece uma maneira fácil de interagir com os mais recentes modelos ChatGPT que utilizam sua própria chave de API.

Características

? Lightning rápido com a base de código de ferrugem pura.
? Todos os tipos de bate -papo (privado e grupo) suportam.
Tokens de transmissão ao vivo para sua bolha de mensagens.
A suportes de renderização de renderização com sabor de telegrama com sabor de telegrama .
? Uso do token gravação estatística e consultável via comandos.
Totalmente personalizável com configuração baseada em arquivo.
Recursos do administrador (beta) e suporte ao controle de acesso ao usuário.

Obtendo o Telegpt

Docker

Recomendamos que você use a imagem do Docker pré -construída ao implantar um servidor dedicado, ele é publicado através do GitHub Container Registry pela GitHub Action. Atualmente, as máquinas com arquitetura AMD64 são suportadas.

1. Faça login no Registro de Contêineres do Github (necessário se não autorizado ao puxar):

docker login -u your_github_username -p your_personal_access_token https://ghcr.io

2. Crie um arquivo config.json com o modelo:

cp config.json.example config.json

Siga as instruções abaixo para preencher tokens em config.json .

• Obtenha tokens de bot de Telegram: https://core.telegram.org/bots/tutorial
• Obtenha tokens de API OpenAI: https://platform.openai.com/account/api-keys

3. Inicie o contêiner do docker:

docker-compose up -d # start the container

Outros comandos que você pode achar útil:

docker-compose logs -f # check the logs, press ctrl+c to stop viewing
docker-compose down # stop the container
docker-compose pull # pull the latest image

Download do lançamento

Para implantar ou testar internamente, você pode fazer o download do binário pré-criado diretamente na página de lançamentos. Atualmente, os hosts Linux e MacOS (Intel e Apple Silicon) são suportados.

Construir a partir da fonte

Clone o repositório e execute:

$ cargo build --release

Uso

Você precisa criar um arquivo de configuração antes de executar o bot. O programa lê telegpt.config.json do seu diretório de trabalho atual por padrão, e você também pode especificar o caminho do arquivo de configuração via opção -c .

A configuração é descrita neste documento e aqui está um exemplo:

{
  "openaiAPIKey" : " sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx " ,
  "botToken" : " 8888888888:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX " ,
  "adminUsernames" : [ " cyandev " ],
  "conversationLimit" : 30 ,
  "databasePath" : " ./path/to/telegpt.sqlite " ,
  "i18n" : {
    "resetPrompt" : " I’m ready for a new challenge. What can I do for you now? "
  }
}

Para iniciar o bot, basta correr:

$ /path/to/telegpt

Quando você vê a mensagem Bot is started , você está pronto para ir!

Habilite o registro detalhado

Nota: a entrada dos usuários será registrada no nível de DEBUG . Para proteger a privacidade do usuário, não o habilite no ambiente de produção.

Para fins de depuração, você pode ativar os logs detalhados definindo a variável de ambiente RUST_LOG . Por exemplo:

$ RUST_LOG=TRACE /path/to/telegpt

Recursos de administrador (beta)

Esse recurso depende do banco de dados para armazenar as configurações. Para garantir que seus dados não sejam perdidos após o relançamento, você precisa definir um caminho de banco de dados no arquivo de configuração.

O bot possui alguns recursos básicos de administrador embutidos. Você pode controlar quem tem permissão para usar o bot e alterar dinamicamente a lista de membros por meio de um conjunto de comandos.

Por padrão, o bot está disponível para uso público. Isso significa que todo mundo que acrescenta pode conversar com ele, o que pode custar muito seus tokens. Se você deseja implantar e usar o bot apenas dentro de um pequeno grupo de pessoas, envie /set_public off Command para tornar o bot privado. Quando você quiser torná -lo público novamente, envie /set_public on .

Quando o bot está no modo privado, apenas usuários administrativos e membros convidados podem conversar com ele. Você pode adicionar ou excluir membros via /add_member e /del_member comando. O argumento é o nome de usuário . Por exemplo: /add_member cyandev .

Atualmente, apenas usuários administrativos podem usar comandos de administrador, outros usuários de membros não podem usá -los.

Banco de dados

O bot usará o banco de dados SQLite para armazenar alguns dados produzidos durante o tempo de execução. Por padrão, se você não fornecer um caminho de arquivo local, os dados serão armazenados no banco de dados de memória. Ao reiniciar o bot, todos os dados anteriores (como membros adicionados) serão perdidos. Recomendamos que você use o banco de dados baseado em arquivos para usabilidade.

Roteiro

O Telegpt será mantido ativamente recentemente, existem alguns recursos planejados que estão em desenvolvimento.

• Represente com retomado exponencial.
• Predefinições de conversação.
• Interface mais fácil de usar para operações de administração.
• Controle remoto com APIs HTTP.

Contribuição

Questões e PRs são bem -vindos. Antes de enviar novos problemas ou PRs, é melhor verificar os existentes primeiro. Discussões e solicitações de recursos são agradáveis ​​antes de começar a trabalhar em algo.

Licença

Mit