ChatGPT README

The project's README from github.com/acheong08/ChatGPT. As one markdown file: README.md.

ChatGPT

English - 中文 - Spanish - 日本語 - 한국어

PyPi Support_Platform Downloads

Reverse Engineered ChatGPT API by OpenAI. Extensible for chatbots etc.

Installation

python -m pip install --upgrade revChatGPT

Suport Python Version

V1 Standard ChatGPT

V1 uses a cloudflare bypass proxy to make life convenient for everyone. The proxy is open source: https://github.com/acheong08/ChatGPT-Proxy-V4

To set your own deployed proxy, set the environment variable CHATGPT_BASE_URL to https://yourproxy.com/api/

Rate limits

  • Proxy server: 5 requests / 10 seconds
  • OpenAI: 50 requests / hour for each account

Configuration

  1. Create account on OpenAI's ChatGPT
  2. Save your email and password

Authentication method: (Choose 1)

- Email/Password

Not supported for Google/Microsoft accounts.

{
  "email": "email",
  "password": "your password"
}

- Access token

https://chat.openai.com/api/auth/session

{
  "access_token": "<access_token>"
}

- Optional configuration:

{
  "conversation_id": "UUID...",
  "parent_id": "UUID...",
  "proxy": "...",
  "model": "gpt-4", // gpt-4-browsing, text-davinci-002-render-sha, gpt-4, gpt-4-plugins
  "plugin_ids": ["plugin-d1d6eb04-3375-40aa-940a-c2fc57ce0f51"], // Wolfram Alpha example
  "disable_history": true,
  "PUID": "<_puid cookie for plus accounts>", // Only if you have a plus account and use GPT-4
  "unverified_plugin_domains":["showme.redstarplugin.com"] // Unverfied plugins to install
}
  1. Save this as $HOME/.config/revChatGPT/config.json
  2. If you are using Windows, you will need to create an environment variable named HOME and set it to your home profile for the script to be able to locate the config.json file.

Plugin IDs can be found here. Remember to set model to gpt-4-plugins if plugins are enabled. Plugins may or may not work if you haven't installed them from the web interface. You can call chatbot.install_plugin(plugin_id=plugin_id) to install any one of them from code. Call chatbot.get_plugins() to get a list of all plugins available.

Usage

Command line

python3 -m revChatGPT.V1

        ChatGPT - A command-line interface to OpenAI's ChatGPT (https://chat.openai.com/chat)
        Repo: github.com/acheong08/ChatGPT
Type '!help' to show a full list of commands
Logging in...
You:
(Press Esc followed by Enter to finish)

The command line interface supports multi-line inputs and allows navigation using arrow keys. Besides, you can also edit history inputs by arrow keys when the prompt is empty. It also completes your input if it finds matched previous prompts. To finish input, press Esc and then Enter as solely Enter itself is used for creating new line in multi-line mode.

Set the environment variable NO_COLOR to true to disable color output.

Developer API

Basic example (streamed):

from revChatGPT.V1 import Chatbot
chatbot = Chatbot(config={
  "access_token": "<your access_token>"
})
print("Chatbot: ")
prev_text = ""
for data in chatbot.ask(
    "Hello world",
):
    message = data["message"][len(prev_text) :]
    print(message, end="", flush=True)
    prev_text = data["message"]
print()

Basic example (single result):

from revChatGPT.V1 import Chatbot
chatbot = Chatbot(config={
  "access_token": "<your access_token>"
})
prompt = "how many beaches does portugal have?"
response = ""
for data in chatbot.ask(
  prompt
):
    response = data["message"]
print(response)

All API methods

Refer to the wiki for advanced developer usage.

V3 Official Chat API

Recently released by OpenAI

  • Paid

Get API key from https://platform.openai.com/account/api-keys

Command line

python3 -m revChatGPT.V3 --api_key <api_key>

  $ python3 -m revChatGPT.V3

    ChatGPT - Official ChatGPT API
    Repo: github.com/acheong08/ChatGPT
    Version: 6.2

Type '!help' to show a full list of commands
Press Esc followed by Enter or Alt+Enter to send a message.

usage: V3.py [-h] --api_key API_KEY [--temperature TEMPERATURE] [--no_stream]
             [--base_prompt BASE_PROMPT] [--proxy PROXY] [--top_p TOP_P]
             [--reply_count REPLY_COUNT] [--enable_internet] [--config CONFIG]
             [--submit_key SUBMIT_KEY]
             [--model {gpt-3.5-turbo,gpt-3.5-turbo-16k,gpt-3.5-turbo-0301,gpt-3.5-turbo-0613,gpt-4,gpt-4-0314,gpt-4-32k,gpt-4-32k-0314,gpt-4-0613}]
             [--truncate_limit TRUNCATE_LIMIT]

Developer API

Basic example

from revChatGPT.V3 import Chatbot
chatbot = Chatbot(api_key="<api_key>")
chatbot.ask("Hello world")

Streaming example

from revChatGPT.V3 import Chatbot
chatbot = Chatbot(api_key="<api_key>")
for data in chatbot.ask_stream("Hello world"):
    print(data, end="", flush=True)

Awesome ChatGPT

My list

If you have a cool project you want added to the list, open an issue.

Disclaimers

This is not an official OpenAI product. This is a personal project and is not affiliated with OpenAI in any way. Don't sue me.

Contributors

This project exists thanks to all the people who contribute.

Additional credits

ChatGPT (acheong08/ChatGPT)

Searching Database…

27.9K ·GitHub
ChatGPT
archived
Что это такое?Неофициальный, реверс-инжиниренный API для ChatGPT на Python — он позволяет общаться с ChatGPT из своего кода или терминала, а не через сайт, и его можно расширять для создания чат-ботов.
Это библиотека, которую я импортирую, или утилита, которую я запускаю?И то и другое: это Python-библиотека, устанавливаемая через pip, с API для разработчиков, и в ней есть встроенный чат-интерфейс для командной строки (python3 -m revChatGPT.V1).
Как установить и запустить?Установите пакет revChatGPT из PyPI, затем запустите CLI командой python3 -m revChatGPT.V1. Нужен Python не ниже 3.9; рекомендуется 3.11+.
Что нужно для входа — только аккаунт OpenAI?Аккаунт OpenAI ChatGPT. Войти можно по email и паролю — аккаунты Google и Microsoft не поддерживаются — либо с помощью access token.
Если пользоваться активно, упрусь ли я в лимиты запросов?Да: общий прокси разрешает 5 запросов за 10 секунд, а OpenAI — 50 запросов в час на аккаунт. Можно развернуть свой прокси и указать его в переменной окружения CHATGPTBASEURL.
Можно ли сохранить логин, чтобы не вводить его каждый раз?Да — по желанию можно сохранить учётные данные в $HOME/.config/revChatGPT/config.json. В Windows нужно создать переменную окружения HOME, указывающую на ваш профиль, иначе скрипт не найдёт файл.
Проект ещё поддерживается?Нет — репозиторий на GitHub заархивирован, код доступен только для чтения и обновлений не получает. Метод V1 к тому же полагался на общий прокси для обхода Cloudflare, а не на поддерживаемый интерфейс.
Это официальный продукт OpenAI?Нет — в дисклеймере README сказано, что это личный проект, никак не связанный с OpenAI, а заканчивается он словами 'Don't sue me.'
Поддерживает ли API для разработчиков потоковые ответы?Да — в README показаны примеры и потоковой передачи, и получения одного результата, а полный список методов API и продвинутое использование описаны в вики проекта.
What are similar projects?gpt4free, AstrBot, langchain4j, chatbox, ChatTTS, repomix, wechat-chatgpt, developer
Which topics is it in?api-client, openai-api, chat, gpt, chatgpt, reverse-engineering, chatbot, deprecated, openai, command-line-tool, api, llm
Creator
acheong08
Size
1.9 MB
Stars
27.9K
Updated
CommitAug 02Release6.8.6Jul 20
Age
3y
Commits · 90 Days