Merge pull request #142 from danny-avila/feat-endpoint-style-structure

Endpoint style structure and more customize of all model.
danny-avila · Apr 5, 2023 · b4d451d · b4d451d
2 parents 0ec68bf + 97e39b8
commit b4d451d
Show file tree

Hide file tree

Showing 106 changed files with 6,121 additions and 9,433 deletions.
diff --git a/LOCAL_INSTALL.md b/LOCAL_INSTALL.md
@@ -1,81 +1,82 @@
 ### Local
+
 - **Install the prerequisites**
-	- **Download chatgpt-clone**
-		- Download the latest release here: https://github.com/danny-avila/chatgpt-clone/releases/
-		- Or by clicking on the green code button in the top of the page and selecting "Download ZIP"
-		- Or (Recommended if you have Git installed) pull the latest release from the main branch
-		- If you downloaded a zip file, extract the content in "C:/chatgpt-clone/"
-		-**IMPORTANT : If you install the files somewhere else modify the instructions accordingly**
-		
-	- **To enable the Conversation search feature:**
-		-IF YOU DON'T WANT THIS FEATURE YOU CAN SKIP THIS STEP
-		- Download MeileSearch latest release from : https://github.com/meilisearch/meilisearch/releases
-		- Copy it to "C:/chatgpt-clone/"
-		- Rename the file to "meilisearch.exe"
-		- Open it by double clicking on it
-		- Copy the generated Master Key and save it somewhere (You will need it later)
-
-	- **Download and Install Node.js** 
-		- Navigate to https://nodejs.org/en/download and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)
-		
-	- **Create a MongoDB database**
-		- Navigate to https://www.mongodb.com/ and Sign In or Create an account
-		- Create a new project
-		- Build a Database using the free plan and name the cluster (example: chatgpt-clone)
-		- Use the "Username and Password" method for authentication
-		- Add your current IP to the access list
-		- Then in the Database Deployment tab click on Connect
-		- In "Choose a connection method" select "Connect your application"
-		- Driver = Node.js / Version = 4.1 or later
-		- Copy the connection string and save it somewhere(you will need it later)
-		
-	- **Get your OpenAI API key** here: https://platform.openai.com/account/api-keys and save it somewhere safe (you will need it later)
-
-	- **Get your Bing Access Token**
-		- Using MS Edge, navigate to bing.com
-		- Make sure you are logged in
-		- Open the DevTools by pressing F12 on your keyboard
-		- Click on the tab "Application" (On the left of the DevTools)
-		- Expand the "Cookies" (Under "Storage")
-		- You need to copy the value of the "_U" cookie, save it somewhere, you will need it later
-		
+
+  - **Download chatgpt-clone**
+    - Download the latest release here: https://github.com/danny-avila/chatgpt-clone/releases/
+    - Or by clicking on the green code button in the top of the page and selecting "Download ZIP"
+    - Or (Recommended if you have Git installed) pull the latest release from the main branch
+    - If you downloaded a zip file, extract the content in "C:/chatgpt-clone/" -**IMPORTANT : If you install the files somewhere else modify the instructions accordingly**
+  - **To enable the Conversation search feature:**
+    -IF YOU DON'T WANT THIS FEATURE YOU CAN SKIP THIS STEP
+
+    - Download MeileSearch latest release from : https://github.com/meilisearch/meilisearch/releases
+    - Copy it to "C:/chatgpt-clone/"
+    - Rename the file to "meilisearch.exe"
+    - Open it by double clicking on it
+    - Copy the generated Master Key and save it somewhere (You will need it later)
+
+  - **Download and Install Node.js**
+    - Navigate to https://nodejs.org/en/download and to download the latest Node.js version for your OS (The Node.js installer includes the NPM package manager.)
+  - **Create a MongoDB database**
+    - Navigate to https://www.mongodb.com/ and Sign In or Create an account
+    - Create a new project
+    - Build a Database using the free plan and name the cluster (example: chatgpt-clone)
+    - Use the "Username and Password" method for authentication
+    - Add your current IP to the access list
+    - Then in the Database Deployment tab click on Connect
+    - In "Choose a connection method" select "Connect your application"
+    - Driver = Node.js / Version = 4.1 or later
+    - Copy the connection string and save it somewhere(you will need it later)
+  - **Get your OpenAI API key** here: https://platform.openai.com/account/api-keys and save it somewhere safe (you will need it later)
+
+  - **Get your Bing Access Token**
+    - Using MS Edge, navigate to bing.com
+    - Make sure you are logged in
+    - Open the DevTools by pressing F12 on your keyboard
+    - Click on the tab "Application" (On the left of the DevTools)
+    - Expand the "Cookies" (Under "Storage")
+    - You need to copy the value of the "\_U" cookie, save it somewhere, you will need it later
+
 - **Create the ".env" File** You will need all your credentials, (API keys, access tokens, and Mongo Connection String, MeileSearch Master Key)
-	- Open "C:/chatgpt-clone/api/.env.example" in a text editor
-	- At this line **MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone"**
-		Replace mongodb://127.0.0.1:27017/chatgpt-clone with the MondoDB connection string you saved earlier, **remove "&w=majority" at the end**
-		- It should look something like this: "MONGO_URI="mongodb+srv://username:password@chatgpt-clone.lfbcwz3.mongodb.net/?retryWrites=true" 
-	- At this line **OPENAI_KEY=** you need to add your openai API key 
-	- Add your Bing token to this line **BING_TOKEN=** (needed for BingChat & Sydney)
-	- If you want to enable Search, **SEARCH=TRUE** if you do not want to enable search **SEARCH=FALSE**
-	- Add your previously saved MeiliSearch Master key to this line **MEILI_MASTER_KEY=** (the key is needed if search is enabled even on local install or you may encounter errors)
-	- Save the file as **"C:/chatgpt-clone/api/.env"**
+  - Open "C:/chatgpt-clone/api/.env.example" in a text editor
+  - At this line **MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone"**
+    Replace mongodb://127.0.0.1:27017/chatgpt-clone with the MondoDB connection string you saved earlier, **remove "&w=majority" at the end**
+    - It should look something like this: "MONGO_URI="mongodb+srv://username:password@chatgpt-clone.lfbcwz3.mongodb.net/?retryWrites=true"
+  - At this line **OPENAI_KEY=** you need to add your openai API key
+  - Add your Bing token to this line **BINGAI_TOKEN=** (needed for BingChat & Sydney)
+  - If you want to enable Search, **SEARCH=TRUE** if you do not want to enable search **SEARCH=FALSE**
+  - Add your previously saved MeiliSearch Master key to this line **MEILI_MASTER_KEY=** (the key is needed if search is enabled even on local install or you may encounter errors)
+  - Save the file as **"C:/chatgpt-clone/api/.env"**
 
 **DO THIS ONCE AFTER EVERY UPDATE**
+
 - **Run** `npm ci` in the "C:/chatgpt-clone/api" directory
 - **Run** `npm ci` in the "C:/chatgpt-clone/client" directory
 - **Run** `npm run build` in the "C:/chatgpt-clone/client"
 
 **DO THIS EVERY TIME YOU WANT TO START CHATGPT-CLONE**
+
 - **Run** `"meilisearch --master-key put_your_meilesearch_Master_Key_here"` in the "C:/chatgpt-clone" directory (Only if SEARCH=TRUE)
-- **Run** `npm start` in the "C:/chatgpt-clone/api" directory 
+- **Run** `npm start` in the "C:/chatgpt-clone/api" directory
 
 - **Visit** http://localhost:3080 (default port) & enjoy
 
-
 OPTIONAL BUT RECOMMENDED
+
 - **Make a batch file to automate the starting process**
-	- Open a text editor
-	- Paste the following code in a new document
-	- Put your MeiliSearch master key instead of "your_master_key_goes_here" 
-	- Save the file as "C:/chatgpt-clone/chatgpt-clone.bat"
-	- you can make a shortcut of this batch file and put it anywhere
+  - Open a text editor
+  - Paste the following code in a new document
+  - Put your MeiliSearch master key instead of "your_master_key_goes_here"
+  - Save the file as "C:/chatgpt-clone/chatgpt-clone.bat"
+  - you can make a shortcut of this batch file and put it anywhere
 
 ```
 REM the meilisearch executable needs to be at the root of the chatgpt-clone directory
 
 start "MeiliSearch" cmd /k "meilisearch --master-key your_master_key_goes_here
 
-REM ↑↑↑ meilisearch is the name of the meilisearch executable, put your own master key there  
+REM ↑↑↑ meilisearch is the name of the meilisearch executable, put your own master key there
 
 start "ChatGPT-Clone" cmd /k "cd api && npm start"
 

diff --git a/api/.env.example b/api/.env.example
@@ -15,34 +15,68 @@ NODE_ENV=development
 # Change this to your MongoDB URI if different and I recommend appending chatgpt-clone
 MONGO_URI="mongodb://127.0.0.1:27017/chatgpt-clone"
 
-# API key configuration.
-# Leave blank if you don't want them.
+
+#############################
+# Endpoint OpenAI:
+#############################
+
+# Access key from OpenAI platform
+# Leave it blank to disable this endpoint
 OPENAI_KEY=
 
-# Default ChatGPT API Model, options: 'gpt-4', 'text-davinci-003', 'gpt-3.5-turbo', 'gpt-3.5-turbo-0301'
-# you will have errors if you don't have access to a model like 'gpt-4', defaults to turbo if left empty/excluded.
-DEFAULT_API_GPT=gpt-3.5-turbo
+# Identify the available models, sperate by comma, and not space in it
+# Leave it blank to use internal settings.
+# OPENAI_MODELS=gpt-4,text-davinci-003,gpt-3.5-turbo,gpt-3.5-turbo-0301
+
+# Reverse proxy setting for OpenAI
+# https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
+# OPENAI_REVERSE_PROXY=<YOUR REVERSE PROXY>
+
+
+#############################
+# Endpoint BingAI (Also jailbreak Sydney):
+#############################
+
+# BingAI Tokens: the "_U" cookies value from bing.com
+# Leave it and BINGAI_USER_TOKEN blank to disable this endpoint.
+BINGAI_TOKEN=
+
+# BingAI User defined Token
+# Allow user to set their own token by client
+# Uncomment this to enable this feature.
+# (Not implemented yet.)
+# BINGAI_USER_TOKEN=1
 
-# _U Cookies Value from bing.com
-BING_TOKEN=
+
+#############################
+# Endpoint chatGPT:
+#############################
 
 # ChatGPT Browser Client (free but use at your own risk)
 # Access token from https://chat.openai.com/api/auth/session
-# Exposes your access token to a 3rd party
+# Exposes your access token to CHATGPT_REVERSE_PROXY
+# Leave it blank to disable this endpoint
 CHATGPT_TOKEN=
-# If you have access to other models on the official site, you can use them here.
-# Defaults to 'text-davinci-002-render-sha' if left empty.
-# options: gpt-4, text-davinci-002-render, text-davinci-002-render-paid, or text-davinci-002-render-sha
-# You cannot use a model that your account does not have access to. You can check 
-# which ones you have access to by opening DevTools and going to the Network tab. 
-# Refresh the page and look at the response body for https://chat.openai.com/backend-api/models.
-BROWSER_MODEL=
+
+# Identify the available models, sperate by comma, and not space in it
+# Leave it blank to use internal settings.
+# CHATGPT_MODELS=text-davinci-002-render-sha,text-davinci-002-render-paid,gpt-4
+
+# Reverse proxy setting for OpenAI
+# https://github.com/waylaidwanderer/node-chatgpt-api#using-a-reverse-proxy
+# By default it will use the node-chatgpt-api recommended proxy, (it's a third party server)
+# CHATGPT_REVERSE_PROXY=<YOUR REVERSE PROXY>
+
+
+#############################
+# Search:
+#############################
 
 # ENABLING SEARCH MESSAGES/CONVOS
 # Requires installation of free self-hosted Meilisearch or Paid Remote Plan (Remote not tested)
 # The easiest setup for this is through docker-compose, which takes care of it for you.
-# SEARCH=TRUE
-SEARCH=TRUE
+# SEARCH=1
+SEARCH=1
 
 # REQUIRED FOR SEARCH: MeiliSearch Host, mainly for api server to connect to the search server.
 # must replace '0.0.0.0' with 'meilisearch' if serving meilisearch with docker-compose
@@ -63,8 +97,11 @@ MEILI_HTTP_ADDR='0.0.0.0:7700'  # <-- local/remote
 MEILI_MASTER_KEY=JKMW-hGc7v_D1FkJVdbRSDNFLZcUv3S75yrxXP0SmcU # <-- ready made secure key for docker-compose
 
 
+#############################
 # User System
-# global enable/disable the sample user system.
+#############################
+
+# Enable the user system.
 # this is not a ready to use user system.
 # dont't use it, unless you can write your own code.
 # ENABLE_USER_SYSTEM=  # <-- make sure you don't comment this back in if you're not using your own user system
diff --git a/api/app/clients/bingai.js b/api/app/clients/bingai.js
@@ -1,30 +1,67 @@
 require('dotenv').config();
 const { KeyvFile } = require('keyv-file');
 
-const askBing = async ({ text, onProgress, convo }) => {
+const askBing = async ({
+  text,
+  parentMessageId,
+  conversationId,
+  jailbreak,
+  jailbreakConversationId,
+  context,
+  systemMessage,
+  conversationSignature,
+  clientId,
+  invocationId,
+  toneStyle,
+  onProgress
+}) => {
   const { BingAIClient } = await import('@waylaidwanderer/chatgpt-api');
+  const store = {
+    store: new KeyvFile({ filename: './data/cache.json' })
+  };
 
   const bingAIClient = new BingAIClient({
     // "_U" cookie from bing.com
-    userToken: process.env.BING_TOKEN,
+    userToken: process.env.BINGAI_TOKEN,
     // If the above doesn't work, provide all your cookies as a string instead
     // cookies: '',
     debug: false,
-    cache: { store: new KeyvFile({ filename: './data/cache.json' }) },
+    cache: store,
     proxy: process.env.PROXY || null
   });
 
-  let options = { onProgress };
-  if (convo) {
-    options = { ...options, ...convo };
-  }
+  let options = {};
 
-  if (options?.jailbreakConversationId == 'false') {
-    options.jailbreakConversationId = false;
+  if (jailbreakConversationId == 'false') {
+    jailbreakConversationId = false;
   }
 
-  if (convo.toneStyle) {
-    options.toneStyle = convo.toneStyle;
+  if (jailbreak)
+    options = {
+      jailbreakConversationId: jailbreakConversationId || jailbreak,
+      context,
+      systemMessage,
+      parentMessageId,
+      toneStyle,
+      onProgress
+    };
+  else {
+    options = {
+      conversationId,
+      context,
+      systemMessage,
+      parentMessageId,
+      toneStyle,
+      onProgress
+    };
+
+    // don't give those parameters for new conversation
+    // for new conversation, conversationSignature always is null
+    if (conversationSignature) {
+      options.conversationSignature = conversationSignature;
+      options.clientId = clientId;
+      options.invocationId = invocationId;
+    }
   }
 
   console.log('bing options', options);
@@ -33,30 +70,8 @@ const askBing = async ({ text, onProgress, convo }) => {
 
   return res;
 
-  // Example response for reference
-  // {
-  //   conversationSignature: 'wwZ2GC/qRgEqP3VSNIhbPGwtno5RcuBhzZFASOM+Sxg=',
-  //   conversationId: '51D|BingProd|026D3A4017554DE6C446798144B6337F4D47D5B76E62A31F31D0B1D0A95ED868',
-  //   clientId: '914800201536527',
-  //   invocationId: 1,
-  //   conversationExpiryTime: '2023-02-15T21:48:46.2892088Z',
-  //   response: 'Hello, this is Bing. Nice to meet you. 😊',
-  //   details: {
-  //     text: 'Hello, this is Bing. Nice to meet you. 😊',
-  //     author: 'bot',
-  //     createdAt: '2023-02-15T15:48:43.0631898+00:00',
-  //     timestamp: '2023-02-15T15:48:43.0631898+00:00',
-  //     messageId: '9d0c9a80-91b1-49ab-b9b1-b457dc3fe247',
-  //     requestId: '5b252ef8-4f09-4c08-b6f5-4499d2e12fba',
-  //     offense: 'None',
-  //     adaptiveCards: [ [Object] ],
-  //     sourceAttributions: [],
-  //     feedback: { tag: null, updatedOn: null, type: 'None' },
-  //     contentOrigin: 'DeepLeo',
-  //     privacy: null,
-  //     suggestedResponses: [ [Object], [Object], [Object] ]
-  //   }
-  // }
+  // for reference:
+  // https://github.com/waylaidwanderer/node-chatgpt-api/blob/main/demos/use-bing-client.js
 };
 
 module.exports = { askBing };