ai-mirow-projects
/
swarms
mirror of https://github.com/kyegomez/swarms
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '501eac0656'
${ noResults }
swarms/docs/examples/revgpt.md

3.2 KiB
Raw Blame History

ChatGPT User Guide with Abstraction

Welcome to the ChatGPT user guide! This document will walk you through the Reverse Engineered ChatGPT API, its usage, and how to leverage the abstraction in revgpt.py for seamless integration.

Table of Contents

  1. Installation
  2. Initial Setup and Configuration
  3. Using the Abstract Class from revgpt.py
  4. V1 Standard ChatGPT
  5. V3 Official Chat API
  6. Credits & Disclaimers

Installation

To kickstart your journey with ChatGPT, first, install the ChatGPT package:

python -m pip install --upgrade revChatGPT

Supported Python Versions:

  • Minimum: Python3.9
  • Recommended: Python3.11+

Initial Setup and Configuration

  1. Account Setup: Register on OpenAI's ChatGPT.
  2. Authentication: Obtain your access token from OpenAI's platform.
  3. Environment Variables: Configure your environment with the necessary variables. An example of these variables can be found at the bottom of the guide.

Using the Abstract Class from revgpt.py

The abstraction provided in revgpt.py is designed to simplify your interactions with ChatGPT.

  1. Import the Necessary Modules:
from dotenv import load_dotenv
from revgpt import AbstractChatGPT
  1. Load Environment Variables:
load_dotenv()
  1. Initialize the ChatGPT Abstract Class:
chat = AbstractChatGPT(api_key=os.getenv("ACCESS_TOKEN"), **config)
  1. Start Interacting with ChatGPT:
response = chat.ask("Hello, ChatGPT!")
print(response)

With the abstract class, you can seamlessly switch between different versions or models of ChatGPT without changing much of your code.

V1 Standard ChatGPT

If you wish to use V1 specifically:

  1. Import the model:
from swarms.models.revgptV1 import RevChatGPTModelv1
  1. Initialize:
model = RevChatGPTModelv1(access_token=os.getenv("ACCESS_TOKEN"), **config)
  1. Interact:
response = model.run("What's the weather like?")
print(response)

V3 Official Chat API

For users looking to integrate the official V3 API:

  1. Import the model:
from swarms.models.revgptV4 import RevChatGPTModelv4
  1. Initialize:
model = RevChatGPTModelv4(access_token=os.getenv("OPENAI_API_KEY"), **config)
  1. Interact:
response = model.run("Tell me a fun fact!")
print(response)

Credits & Disclaimers

  • This project is not an official OpenAI product and is not affiliated with OpenAI. Use at your own discretion.
  • Many thanks to all the contributors who have made this project possible.
  • Special acknowledgment to virtualharby for the motivating music!

By following this guide, you should now have a clear understanding of how to use the Reverse Engineered ChatGPT API and its abstraction. Happy coding!