TeleGPT

Telegpt

API DOCS | Выпуски | Twitter

Вне коротчатого бота для телеграммы.

Telegpt - это бот Telegram, основанный на рамках для телексида и Async_openai . Это обеспечивает простой способ взаимодействия с последними моделями CHATGPT, использующих свой собственный ключ API.

Функции

? Молния быстро с кодовой базой чистой ржавчины.
? Все типы чата (частная и группа) поддерживают.
Живые потоковые токены к вашему пузырьку сообщения.
⌨ В сочетании в телеграмме поддержки маркировки .
? Запись статистики использования токена и запрос по командам.
Полностью настраивается с помощью файловой конфигурации.
Функции администратора (бета) и поддержки управления доступом пользователя.

Получение TELEGPT

Докер

Мы рекомендуем вам использовать предварительно построенное изображение Docker при развертывании выделенного сервера, оно публикуется через реестр контейнеров Github By Github Action. В настоящее время поддерживаются машины с архитектурой AMD64.

1. Войдите в реестр контейнеров GitHub (необходимо, если неавторизовано при тяге):

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

2. Создайте файл config.json с шаблоном:

cp config.json.example config.json

Следуйте инструкциям ниже, чтобы заполнить токены в config.json .

• Получить Telegram Bot Tokens: https://core.telegram.org/bots/tutorial
• Get OpenAI API токены: https://platform.openai.com/account/api-keys

3. Запустите контейнер Docker:

docker-compose up -d # start the container

Другие команды вы можете найти полезными:

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

Скачать из релиза

Чтобы развернуть или тестировать собственное место, вы можете загрузить предварительно построенный двоичный файл непосредственно со страницы релизов. В настоящее время поддерживают хосты Linux и MacOS (Intel и Apple Silicon).

Строить из источника

Клонировать репозиторий и запустить:

$ cargo build --release

Использование

Вам нужно создать файл конфигурации перед запуском бота. Программа по умолчанию считывает telegpt.config.json из вашего текущего рабочего каталога, и вы также можете указать путь файла конфигурации через опцию -c .

Конфигурация описана в этом документе, и вот пример:

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

Чтобы начать бот, просто запустите:

$ /path/to/telegpt

Когда вы увидите, Bot is started сообщение, вы готовы к работе!

Включить словесную регистрацию

ПРИМЕЧАНИЕ. Ввод пользователей будет зарегистрирован на уровне DEBUG . Чтобы защитить конфиденциальность пользователей, пожалуйста, не включайте его в производственную среду.

В целях отладки вы можете включить журналы словеса, установив переменную среды RUST_LOG . Например:

$ RUST_LOG=TRACE /path/to/telegpt

Функции администратора (бета)

Эта функция зависит от базы данных для хранения конфигураций. Чтобы ваши данные не были потеряны после повторного запуска, вам необходимо установить путь базы данных в файле конфигурации.

Бот имеет встроенные встроенные функции администратора. Вы можете контролировать, кому разрешено использовать бот, и динамически изменить список участников через набор команд.

По умолчанию бот доступен для общественного использования. Это означает, что все, кто добавляет, это может пообщаться с ним, что может стоить значительно стоить ваши жетоны. Если вы хотите развернуть и использовать бот только в небольшой группе людей, отправьте команду /set_public off , чтобы сделать бота частным. Когда вы захотите сделать это снова, отправьте /set_public on .

Когда бот находится в частном режиме, только пользователи администратора и приглашенные участники могут с ним пообщаться. Вы можете добавить или удалить участники через команду /add_member и /del_member . Аргумент - имя пользователя . Например: /add_member cyandev .

В настоящее время только пользователи администратора могут использовать команды администратора, другим пользователям участников не разрешается их использовать.

База данных

BOT будет использовать базу данных SQLite для хранения некоторых данных, полученных во время выполнения. По умолчанию, если вы не предоставите локальный путь файла, данные будут храниться в базе данных памяти. Когда вы перезагружаете бот, все предыдущие данные (например, добавленные участники) будут потеряны. Мы рекомендуем вам использовать базу данных на основе файлов для удобства использования.

Дорожная карта

Telegpt будет активно поддерживать недавно, есть некоторые запланированные функции, которые находятся в разработке.

• Повторите с экспоненциальным отбором.
• ПРЕДУПРЕЖДЕНИЕ БЕЗОПАСНОСТИ.
• Более удобный интерфейс для операций администратора.
• Дистанционный контроль с API HTTP.

Вклад

Проблемы и PRS приветствуются. Перед тем, как отправить новые проблемы или PRS, лучше сначала проверить существующие. Обсуждения и запросы на функции хороши, прежде чем вы начнете работать над чем -то.

Лицензия

Грань