TeleGPT

Telegpt

API Docs | Lanzamientos | Gorjeo

Un bot de chatgpt fuera de caja para Telegram.

Telegpt es un bot de telegrama basado en el marco de telóxido y async_openai . Proporciona una manera fácil de interactuar con los últimos modelos ChatGPT utilizando su propia clave API.

Características

? Lightning rápido con base de código de óxido puro.
? Todos los tipos de chat (privado y grupal) admiten.
Tokens de transmisión en vivo a su burbuja de mensajes.
⌨️ Los soportes de representación de Markdown con sabor a telegrama .
? El registro estadístico de uso del token y la consulta a través de comandos.
Totalmente personalizable con la configuración basada en archivos.
Características de administrador (beta) y compatibles con el control de acceso al usuario.

Obtener telegpt

Estibador

Le recomendamos que use la imagen de Docker prebuilt al implementar un servidor dedicado, se publica a través de GitHub Contener Registry por GitHub Action. Actualmente, se admiten máquinas con arquitectura AMD64.

1. Inicie sesión en el registro de contenedores de GitHub (necesario si no está autorizado cuando se tira):

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

2. Cree un archivo config.json con la plantilla:

cp config.json.example config.json

Siga las instrucciones a continuación para completar los tokens en config.json .

• Obtenga Telegram Bot Tokens: https://core.telegram.org/bots/tutorial
• Obtenga tokens API OpenAI: https://platform.openai.com/account/api- keys

3. Inicie el contenedor Docker:

docker-compose up -d # start the container

Otros comandos que puede encontrar útiles:

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

Descargar desde el lanzamiento

Para implementar o probar internamente, puede descargar el binario pre-construido directamente desde la página de versiones. Actualmente, los hosts de Linux y MacOS (Intel y Apple Silicon) son compatibles.

Construir desde la fuente

Clon el repositorio y ejecute:

$ cargo build --release

Uso

Debe crear un archivo de configuración antes de ejecutar el bot. El programa lee telegpt.config.json desde su directorio de trabajo actual de forma predeterminada, y también puede especificar la ruta del archivo de configuración a través de -c opción.

La configuración se describe en este documento, y aquí hay un ejemplo:

{
  "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 comenzar el bot, simplemente ejecute:

$ /path/to/telegpt

Cuando vea el mensaje Bot is started , ¡está listo para comenzar!

Habilitar el registro verboso

Nota: La entrada de los usuarios se registrará en el nivel de DEBUG . Para proteger la privacidad del usuario, no lo habilite en el entorno de producción.

Para fines de depuración, puede habilitar los registros verbosos configurando la variable de entorno RUST_LOG . Por ejemplo:

$ RUST_LOG=TRACE /path/to/telegpt

Características de administrador (beta)

Esta característica depende de la base de datos para almacenar las configuraciones. Para asegurarse de que sus datos no se pierdan después de relanzar, debe establecer una ruta de base de datos en el archivo de configuración.

El bot tiene algunas características de administración básicas incorporadas. Puede controlar quién puede usar el bot y cambiar dinámicamente la lista de miembros a través de un conjunto de comandos.

Por defecto, el bot está disponible para uso público. Significa que todos los que lo agreguen pueden chatear con él, lo que puede costarle mucho a sus fichas. Si desea implementar y usar el BOT solo dentro de un pequeño grupo de personas, envíe /set_public off Command para hacer que el bot sea privado. Cuando desee volver a hacerlo público, envíe /set_public on .

Cuando el bot está en modo privado, solo los usuarios administrativos y los miembros invitados pueden chatear con él. Puede agregar o eliminar miembros a través del comando /add_member y /del_member . El argumento es el nombre de usuario . Por ejemplo: /add_member cyandev .

Actualmente, solo los usuarios administrativos pueden usar comandos de administración, otros usuarios miembros no pueden usarlos.

Base de datos

El BOT utilizará la base de datos SQLite para almacenar algunos datos producidos durante el tiempo de ejecución. Por defecto, si no proporciona una ruta de archivo local, los datos se almacenarán en la base de datos de memoria. Cuando reinicie el bot, todos los datos anteriores (como los miembros agregados) se perderán. Le recomendamos que use la base de datos basada en archivos para la usabilidad.

Hoja de ruta

Telegpt se mantendrá activamente recientemente, hay algunas características planificadas que están en desarrollo.

• Vuelva a intentarlo con retroceso exponencial.
• Presets de conversación.
• Interfaz más fácil de usar para operaciones de administración.
• Control remoto con API HTTP.

Contribución

Los problemas y los PR son bienvenidos. Antes de enviar nuevos problemas o PRS, es mejor verificar los existentes primero. Es bueno tener discusiones y solicitudes de funciones antes de comenzar a trabajar en algo.

Licencia

MIT