TeleGPT

Telegpt

API Docs | Rilis | Twitter

Bot chatgpt out-of-box untuk telegram.

Telegpt adalah bot telegram berdasarkan kerangka Teloksida dan Async_openai . Ini memberikan cara mudah untuk berinteraksi dengan model chatgpt terbaru yang menggunakan kunci API Anda sendiri.

Fitur

? Petir cepat dengan basis kode karat murni.
? Semua jenis obrolan (pribadi dan grup) dukungan.
Token streaming langsung ke gelembung pesan Anda.
⌨️ Dukungan Markdown Rendering Telegram .
? Penggunaan Token Perekaman Statistik dan Dapat Diuntungkan melalui Perintah.
Sepenuhnya dapat disesuaikan dengan konfigurasi berbasis file.
Fitur admin (beta) dan dukungan kontrol akses pengguna.

Mendapatkan telegpt

Buruh pelabuhan

Kami menyarankan Anda untuk menggunakan gambar Docker Prebuilt saat menggunakan server khusus, itu diterbitkan melalui Github Container Registry oleh Github Action. Saat ini, mesin dengan arsitektur AMD64 didukung.

1. Masuk ke Registry Kontainer GitHub (diperlukan jika tidak sah saat menarik):

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

2. Buat file config.json dengan template:

cp config.json.example config.json

Ikuti instruksi di bawah ini untuk mengisi token di config.json .

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

3. Mulai wadah Docker:

docker-compose up -d # start the container

Perintah lain yang mungkin Anda temukan berguna:

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

Unduh dari rilis

Untuk menggunakan atau menguji in-house, Anda dapat mengunduh biner yang sudah dibangun secara langsung dari halaman rilis. Saat ini, host Linux dan MacOS (Intel dan Apple Silicon) didukung.

Membangun dari sumber

Klon Repositori dan jalankan:

$ cargo build --release

Penggunaan

Anda perlu membuat file konfigurasi sebelum menjalankan bot. Program ini membaca telegpt.config.json dari direktori kerja Anda saat ini secara default, dan Anda juga dapat menentukan jalur file konfigurasi melalui opsi -c .

Konfigurasi dijelaskan dalam dokumen ini, dan berikut adalah contoh:

{
  "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? "
  }
}

Untuk memulai bot, cukup jalankan:

$ /path/to/telegpt

Ketika Anda melihat Bot is started , Anda siap untuk pergi!

Aktifkan logging verbose

Catatan: Input pengguna akan dicatat di level DEBUG . Untuk melindungi privasi pengguna, tolong jangan mengaktifkannya di lingkungan produksi.

Untuk tujuan debugging, Anda dapat mengaktifkan log verbose dengan mengatur variabel lingkungan RUST_LOG . Misalnya:

$ RUST_LOG=TRACE /path/to/telegpt

Fitur admin (beta)

Fitur ini tergantung pada database untuk menyimpan konfigurasi. Untuk memastikan data Anda tidak akan hilang setelah diluncurkan kembali, Anda perlu mengatur jalur basis data di file konfigurasi.

Bot memiliki beberapa fitur admin dasar bawaan. Anda dapat mengontrol siapa yang diizinkan menggunakan bot, dan secara dinamis mengubah daftar anggota melalui satu set perintah.

Secara default, bot tersedia untuk penggunaan publik. Itu berarti semua orang yang menambahkannya dapat mengobrol dengannya, yang mungkin sangat merugikan token Anda. Jika Anda ingin menggunakan dan menggunakan bot hanya dalam sekelompok kecil orang, kirim /set_public off perintah untuk membuat bot pribadi. Ketika Anda ingin mempublikasikannya lagi, kirim /set_public on .

Saat bot dalam mode pribadi, hanya pengguna admin dan anggota yang diundang yang dapat mengobrol dengannya. Anda dapat menambah atau menghapus anggota melalui /add_member dan /del_member perintah. Argumennya adalah nama pengguna . Misalnya: /add_member cyandev .

Saat ini, hanya pengguna admin yang dapat menggunakan perintah admin, pengguna anggota lain tidak diizinkan untuk menggunakannya.

Database

Bot akan menggunakan database SQLite untuk menyimpan beberapa data yang diproduksi selama runtime. Secara default, jika Anda tidak menyediakan jalur file lokal, data akan disimpan dalam database memori. Saat Anda memulai kembali bot, semua data sebelumnya (seperti anggota yang ditambahkan) akan hilang. Kami menyarankan Anda untuk menggunakan database berbasis file untuk kegunaan.

Peta jalan

Telegpt akan dipertahankan secara aktif baru -baru ini, ada beberapa fitur yang direncanakan yang sedang dalam pengembangan.

• Coba lagi dengan backoff eksponensial.
• Preset percakapan.
• Antarmuka yang lebih ramah pengguna untuk operasi admin.
• Pengendalian jarak jauh dengan HTTP API.

Kontribusi

Masalah dan PR disambut. Sebelum mengirimkan masalah atau PR baru, lebih baik memeriksa yang ada terlebih dahulu. Diskusi dan permintaan fitur menyenangkan sebelum Anda mulai mengerjakan sesuatu.

Lisensi

Mit