docs: add readme

Author: rpidanny

README.md

@@ -1,3 +1,77 @@
 # ChatGPT Browser API Proxy
 
-Exposes OpenAI APIs using ChatGPT Browser API.
+The **ChatGPT Browser API Proxy** is a project that enables the use of OpenAI APIs by leveraging the ChatGPT unofficial browser API while bypassing Cloudflare anti-bot detection. This proxy allows you to make API requests to OpenAI's services directly from your local machine.
+
+## Prerequisites
+
+Before using this API proxy, ensure that you have the following:
+
+- Node.js installed on your machine
+- Yarn package manager installed
+
+## Getting Started
+
+To set up and use the ChatGPT Browser API Proxy, follow these steps:
+
+1. Clone the repository to your local machine:
+
+   ```shell
+   git clone https://github.com/rpidanny/chatgpt-browser-api-proxy.git
+   ```
+
+2. Navigate to the project directory:
+
+   ```shell
+   cd chatgpt-browser-api-proxy
+   ```
+
+3. Install the project dependencies:
+
+   ```shell
+   yarn install
+   ```
+
+4. Copy the example environment file and rename it to `.env`:
+
+   ```shell
+   cp example.env .env
+   ```
+
+5. Open the `.env` file and add your OpenAI Access Token obtained from the OpenAI platform. Replace `<YOUR_ACCESS_TOKEN>` with your actual token.
+
+6. Start the proxy server in development mode:
+
+   ```shell
+   yarn start:dev
+   ```
+
+*Note:*
+
+You can get an Access Token by logging in to the ChatGPT webapp and then opening `https://chat.openai.com/api/auth/session`, which will return a JSON object containing your Access Token string.
+
+Access tokens last for few days.
+
+## Configuring for LangChain
+
+If you intend to use the proxy with _LangChain_, you need to set the `OPENAI_API_BASE` environment variable to specify the API base URL.
+
+```shell
+export OPENAI_API_BASE=http://localhost:3000/v1
+```
+
+## Making API Requests
+
+Once the proxy server is running, you can make API requests to OpenAI's services using the provided routes and endpoints. The proxy will handle the communication with the ChatGPT unofficial browser API and forward the responses to your local machine.
+
+## Notes
+
+- This project is an unofficial implementation and may not provide the same level of reliability or stability as official OpenAI APIs.
+- Usage of this project may be subject to OpenAI's terms of service. Please ensure compliance with their guidelines and policies.
+
+## Disclaimer
+
+This project is provided as-is, without any warranty or guarantee of its functionality. The developers and contributors are not responsible for any damages or issues arising from the use of this project.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).

example.env

@@ -1 +1 @@
-OPENAI_API_TOKEN=<Your OpenAI API Token>
+OPENAI_API_TOKEN=<YOUR_ACCESS_TOKEN>

src/global/clients/chatgpt.client.ts

@@ -1,17 +1,20 @@
 /* eslint-disable camelcase */
-import { Injectable } from '@nestjs/common';
+import { Inject, Injectable, Logger } from '@nestjs/common';
 import { randomUUID } from 'crypto';
 import { Browser, chromium } from 'playwright';
 
 @Injectable()
 export class ChatGPTClient {
   baseUrl = 'https://chat.openai.com';
+  parentMessageId = randomUUID();
   browser: Browser;
 
+  constructor(@Inject(Logger) private readonly logger: Logger) {}
+
   async init() {
-    console.log('Initializing ChatGPTClient');
+    this.logger.log('Initializing ChatGPTClient');
     this.browser = await chromium.launch({ headless: false });
-    console.log('ChatGPTClient initialized');
+    this.logger.log('ChatGPTClient initialized');
   }
 
   async conversation(prompt: string): Promise<string> {
@@ -20,7 +23,12 @@ export class ChatGPTClient {
     const headers = this.getHeaders();
     const payload = this.generateConversationPayload(prompt);
 
-    const answer = await this.call('POST', url, headers, payload);
+    const { answer } = await this.call(
+      'POST',
+      url,
+      headers,
+      payload
+    );
 
     return answer;
   }
@@ -47,13 +55,11 @@ export class ChatGPTClient {
           },
         },
       ],
-      parent_message_id: randomUUID(),
-      // conversation_id: "32326597-ad27-470f-85a0-d4514551bd15",
+      parent_message_id: this.parentMessageId,
       model: 'text-davinci-002-render-sha',
       timezone_offset_min: -120,
       history_and_training_disabled: false,
       supports_modapi: true,
-      stream: false
     };
   }
 
@@ -62,12 +68,12 @@ export class ChatGPTClient {
     url: string,
     headers?: Record<string, string>,
     body?: Record<string, unknown>
-  ): Promise<string> {
+  ): Promise<{ answer: string; conversationId: string }> {
     const context = await this.browser.newContext();
     const page = await context.newPage();
     await page.goto(this.baseUrl);
 
-    const answer = await page.evaluate(
+    const { answer, conversationId } = await page.evaluate(
       async ({ method, url, headers, body }) => {
         const textDecoder = new TextDecoder();
 
@@ -85,6 +91,7 @@ export class ChatGPTClient {
 
         let chunk: ReadableStreamReadResult<Uint8Array>;
         let answer = '';
+        let conversationId = '';
 
         while ((chunk = await reader.read()).done === false) {
           textDecoder
@@ -93,25 +100,27 @@ export class ChatGPTClient {
             .map((e) => e.trim().replace(/^\n+/, '').replace(/\n+$/, ''))
             .filter((e) => e.length > 0 || e !== '[DONE]')
             .map((e) => {
+              console.log(e);
               try {
                 const parsedEvent = JSON.parse(e);
 
                 if (parsedEvent.message.author.role === 'assistant') {
                   answer = parsedEvent.message.content.parts.join(' ');
+                  conversationId = parsedEvent.message.conversation_id;
                   return answer;
                 }
                 return '';
               } catch (error) {}
             });
         }
 
-        return answer;
+        return { answer, conversationId };
       },
       { method, url, headers, body }
     );
 
-    context.close();
+    await context.close();
 
-    return answer;
+    return { answer, conversationId };
   }
 }

src/global/global.module.ts

@@ -1,4 +1,4 @@
-import { DynamicModule, Global, Module } from '@nestjs/common';
+import { DynamicModule, Global, Logger, Module } from '@nestjs/common';
 
 import { ChatGPTClient } from './clients/chatgpt.client.js';
 
@@ -10,15 +10,16 @@ export class GlobalModule {
       module: GlobalModule,
       imports: [],
       providers: [
+        Logger,
         {
           provide: ChatGPTClient,
-          useFactory: async () => {
-            const client = new ChatGPTClient();
+          useFactory: async (logger: Logger) => {
+            const client = new ChatGPTClient(logger);
             await client.init();
 
             return client;
           },
-          inject: [],
+          inject: [Logger],
         },
       ],
       exports: [ChatGPTClient],