chore: allow users to customize models(Close #142)

Author: Kerwin

README.en.md

@@ -190,7 +190,6 @@ pnpm dev
 - `OPENAI_ACCESS_TOKEN` one of two, `OPENAI_API_KEY` takes precedence when both are present
 - `OPENAI_API_BASE_URL` optional, available when `OPENAI_API_KEY` is set
 - `OPENAI_API_MODEL`  `ChatGPTAPI` OR `ChatGPTUnofficialProxyAPI`
-- `OPENAI_CHAT_MODEL` gpt-4 gpt-3.5-turbo-0301
 - `API_REVERSE_PROXY` optional, available when `OPENAI_ACCESS_TOKEN` is set [Reference](#introduction)
 - `AUTH_SECRET_KEY` Access Password，optional
 - `TIMEOUT_MS` timeout, in milliseconds, optional
@@ -243,8 +242,6 @@ services:
       OPENAI_API_BASE_URL: xxxx
       # ChatGPTAPI 或者 ChatGPTUnofficialProxyAPI
       OPENAI_API_MODEL: xxxx
-      # gpt-4 gpt-3.5-turbo-0301
-      OPENAI_CHAT_MODEL: xxxx
       # reverse proxy, optional
       API_REVERSE_PROXY: xxx
       # timeout, in milliseconds, optional

README.md

@@ -180,7 +180,6 @@ pnpm dev
 `API` 可用：
 
 - `OPENAI_API_KEY` 和 `OPENAI_ACCESS_TOKEN` 二选一
-- `OPENAI_CHAT_MODEL`  设置模型，可选，默认：`gpt-3.5-turbo`
 - `OPENAI_API_BASE_URL` 设置接口地址，可选，默认：`https://api.openai.com`
 - `OPENAI_API_DISABLE_DEBUG` 设置接口关闭 debug 日志，可选，默认：empty 不关闭
 
@@ -247,9 +246,6 @@ services:
       OPENAI_API_BASE_URL: xxx
       # ChatGPTAPI ChatGPTUnofficialProxyAPI
       OPENAI_API_MODEL: ChatGPTAPI
-      # API模型，可选，设置 OPENAI_API_KEY 时可用，https://platform.openai.com/docs/models
-      # gpt-4, gpt-4-0314, gpt-4-32k, gpt-4-32k-0314, gpt-3.5-turbo, gpt-3.5-turbo-0301, text-davinci-003, text-davinci-002, code-davinci-002
-      OPENAI_CHAT_MODEL: xxx
       # 反向代理，可选
       API_REVERSE_PROXY: xxx
       # 每小时最大请求次数，可选，默认无限
@@ -343,7 +339,6 @@ volumes:
 | `OPENAI_ACCESS_TOKEN` | `Web API` 二选一       | 使用 `Web API` 所需的 `accessToken` [(获取 accessToken)](https://chat.openai.com/api/auth/session) |
 | `OPENAI_API_BASE_URL`   | 可选，`OpenAI API` 时可用 |  `API`接口地址  |
 | `OPENAI_API_MODEL`   | ChatGPTAPI OR ChatGPTUnofficialProxyAPI |  `API`模型  |
-| `OPENAI_CHAT_MODEL`   | 可选，`OpenAI API` 时可用 |  `API`模型  |
 | `API_REVERSE_PROXY`   | 可选，`Web API` 时可用 | `Web API` 反向代理地址 [详情](https://github.com/transitive-bullshit/chatgpt-api#reverse-proxy)    |
 | `SOCKS_PROXY_HOST`   | 可选，和 `SOCKS_PROXY_PORT` 一起时生效 | Socks代理    |
 | `SOCKS_PROXY_PORT`   | 可选，和 `SOCKS_PROXY_HOST` 一起时生效 | Socks代理端口    |

docker-compose/docker-compose.yml

@@ -19,8 +19,6 @@ services:
       OPENAI_API_BASE_URL:
       # ChatGPTAPI 或者 ChatGPTUnofficialProxyAPI
       OPENAI_API_MODEL: 
-      # gpt-4 gpt-3.5-turbo-0301 等 
-      OPENAI_CHAT_MODEL:
       # 反向代理，可选
       API_REVERSE_PROXY:
       # 访问jwt加密参数，可选 不为空则允许登录 同时需要设置 MONGODB_URL

kubernetes/deploy.yaml

@@ -29,8 +29,6 @@ spec:
               value: 'https://api.openai.com'
             - name: OPENAI_API_MODEL
               value: ChatGPTAPI
-            - name: OPENAI_CHAT_MODEL
-              value: gpt-3.5-turbo
             - name: API_REVERSE_PROXY
               value: https://ai.fakeopen.com/api/conversation
             - name: AUTH_SECRET_KEY

service/.env.example

@@ -10,9 +10,6 @@ OPENAI_API_BASE_URL=
 # ChatGPTAPI 或者 ChatGPTUnofficialProxyAPI
 OPENAI_API_MODEL: 
 
-# OpenAI Chat Model - https://platform.openai.com/docs/models
-OPENAI_CHAT_MODEL:
-
 # set `true` to disable OpenAI API debug log
 OPENAI_API_DISABLE_DEBUG=
 

service/src/chatgpt/index.ts

@@ -5,7 +5,7 @@ import { ChatGPTAPI, ChatGPTUnofficialProxyAPI } from 'chatgpt'
 import { SocksProxyAgent } from 'socks-proxy-agent'
 import httpsProxyAgent from 'https-proxy-agent'
 import fetch from 'node-fetch'
-import type { AuditConfig } from 'src/storage/model'
+import type { AuditConfig, CHATMODEL } from 'src/storage/model'
 import jwt_decode from 'jwt-decode'
 import dayjs from 'dayjs'
 import type { TextAuditService } from '../utils/textAudit'
@@ -30,19 +30,19 @@ const ErrorCodeMessage: Record<string, string> = {
   500: '[OpenAI] 服务器繁忙，请稍后再试 | Internal Server Error',
 }
 
-let api: ChatGPTAPI | ChatGPTUnofficialProxyAPI
 let auditService: TextAuditService
 
-export async function initApi() {
+export async function initApi(chatModel: CHATMODEL) {
   // More Info: https://github.com/transitive-bullshit/chatgpt-api
 
   const config = await getCacheConfig()
   if (!config.apiKey && !config.accessToken)
     throw new Error('Missing OPENAI_API_KEY or OPENAI_ACCESS_TOKEN environment variable')
 
+  const model = chatModel as string
+
   if (config.apiModel === 'ChatGPTAPI') {
     const OPENAI_API_BASE_URL = config.apiBaseUrl
-    const model = config.chatModel
 
     const options: ChatGPTAPIOptions = {
       apiKey: config.apiKey,
@@ -69,10 +69,9 @@ export async function initApi() {
 
     await setupProxy(options)
 
-    api = new ChatGPTAPI({ ...options })
+    return new ChatGPTAPI({ ...options })
   }
   else {
-    const model = config.chatModel
     const options: ChatGPTUnofficialProxyAPIOptions = {
       accessToken: config.accessToken,
       apiReverseProxyUrl: isNotEmptyString(config.reverseProxy) ? config.reverseProxy : 'https://ai.fakeopen.com/api/conversation',
@@ -82,13 +81,13 @@ export async function initApi() {
 
     await setupProxy(options)
 
-    api = new ChatGPTUnofficialProxyAPI({ ...options })
+    return new ChatGPTUnofficialProxyAPI({ ...options })
   }
 }
 
 async function chatReplyProcess(options: RequestOptions) {
   const config = await getCacheConfig()
-  const model = config.chatModel
+  const model = options.chatModel
   const { message, lastContext, process, systemMessage, temperature, top_p } = options
 
   try {
@@ -107,7 +106,7 @@ async function chatReplyProcess(options: RequestOptions) {
       else
         options = { ...lastContext }
     }
-
+    const api = await initApi(model)
     const response = await api.sendMessage(message, {
       ...options,
       onProgress: (partialResponse) => {
@@ -305,8 +304,6 @@ async function getMessageById(id: string): Promise<ChatMessage | undefined> {
   else { return undefined }
 }
 
-initApi()
-
 export type { ChatContext, ChatMessage }
 
 export { chatReplyProcess, chatConfig, containsSensitiveWords }

service/src/chatgpt/types.ts

@@ -1,4 +1,5 @@
 import type { ChatMessage } from 'chatgpt'
+import type { CHATMODEL } from 'src/storage/model'
 
 export interface RequestOptions {
   message: string
@@ -7,6 +8,7 @@ export interface RequestOptions {
   systemMessage?: string
   temperature?: number
   top_p?: number
+  chatModel: CHATMODEL
 }
 
 export interface BalanceResponse {

service/src/index.ts

@@ -4,10 +4,10 @@ import * as dotenv from 'dotenv'
 import { ObjectId } from 'mongodb'
 import type { RequestProps } from './types'
 import type { ChatContext, ChatMessage } from './chatgpt'
-import { chatConfig, chatReplyProcess, containsSensitiveWords, initApi, initAuditService } from './chatgpt'
+import { chatConfig, chatReplyProcess, containsSensitiveWords, initAuditService } from './chatgpt'
 import { auth } from './middleware/auth'
 import { clearConfigCache, getCacheConfig, getOriginConfig } from './storage/config'
-import type { AuditConfig, ChatInfo, ChatOptions, Config, MailConfig, SiteConfig, UsageResponse, UserInfo } from './storage/model'
+import type { AuditConfig, CHATMODEL, ChatInfo, ChatOptions, Config, MailConfig, SiteConfig, UsageResponse, UserInfo } from './storage/model'
 import { Status } from './storage/model'
 import {
   clearChat,
@@ -31,6 +31,7 @@ import {
   updateConfig,
   updateRoomPrompt,
   updateRoomUsingContext,
+  updateUserChatModel,
   updateUserInfo,
   updateUserPassword,
   verifyUser,
@@ -384,9 +385,9 @@ router.post('/chat-process', [auth, limiter], async (req, res) => {
   let message: ChatInfo
   try {
     const config = await getCacheConfig()
+    const userId = req.headers.userId.toString()
+    const user = await getUserById(userId)
     if (config.auditConfig.enabled || config.auditConfig.customizeEnabled) {
-      const userId = req.headers.userId.toString()
-      const user = await getUserById(userId)
       if (user.email.toLowerCase() !== process.env.ROOT_USER && await containsSensitiveWords(config.auditConfig, prompt)) {
         res.send({ status: 'Fail', message: '含有敏感词 | Contains sensitive words', data: null })
         return
@@ -423,6 +424,7 @@ router.post('/chat-process', [auth, limiter], async (req, res) => {
       systemMessage,
       temperature,
       top_p,
+      chatModel: user.config.chatModel,
     })
     // return the whole response including usage
     res.write(`\n${JSON.stringify(result.data)}`)
@@ -581,6 +583,7 @@ router.post('/user-login', async (req, res) => {
       description: user.description,
       userId: user._id,
       root: username.toLowerCase() === process.env.ROOT_USER,
+      config: user.config,
     }, config.siteConfig.loginSalt.trim())
     res.send({ status: 'Success', message: '登录成功 | Login successfully', data: { token } })
   }
@@ -642,6 +645,22 @@ router.post('/user-info', auth, async (req, res) => {
   }
 })
 
+router.post('/user-chat-model', auth, async (req, res) => {
+  try {
+    const { chatModel } = req.body as { chatModel: CHATMODEL }
+    const userId = req.headers.userId.toString()
+
+    const user = await getUserById(userId)
+    if (user == null || user.status !== Status.Normal)
+      throw new Error('用户不存在 | User does not exist.')
+    await updateUserChatModel(userId, chatModel)
+    res.send({ status: 'Success', message: '更新成功 | Update successfully' })
+  }
+  catch (error) {
+    res.send({ status: 'Fail', message: error.message, data: null })
+  }
+})
+
 router.post('/verify', async (req, res) => {
   try {
     const { token } = req.body as { token: string }
@@ -692,7 +711,7 @@ router.post('/verifyadmin', async (req, res) => {
 
 router.post('/setting-base', rootAuth, async (req, res) => {
   try {
-    const { apiKey, apiModel, chatModel, apiBaseUrl, accessToken, timeoutMs, reverseProxy, socksProxy, socksAuth, httpsProxy } = req.body as Config
+    const { apiKey, apiModel, apiBaseUrl, accessToken, timeoutMs, reverseProxy, socksProxy, socksAuth, httpsProxy } = req.body as Config
 
     if (apiModel === 'ChatGPTAPI' && !isNotEmptyString(apiKey))
       throw new Error('Missing OPENAI_API_KEY environment variable.')
@@ -702,7 +721,6 @@ router.post('/setting-base', rootAuth, async (req, res) => {
     const thisConfig = await getOriginConfig()
     thisConfig.apiKey = apiKey
     thisConfig.apiModel = apiModel
-    thisConfig.chatModel = chatModel
     thisConfig.apiBaseUrl = apiBaseUrl
     thisConfig.accessToken = accessToken
     thisConfig.reverseProxy = reverseProxy
@@ -712,7 +730,6 @@ router.post('/setting-base', rootAuth, async (req, res) => {
     thisConfig.httpsProxy = httpsProxy
     await updateConfig(thisConfig)
     clearConfigCache()
-    initApi()
     const response = await chatConfig()
     res.send({ status: 'Success', message: '操作成功 | Successfully', data: response.data })
   }

service/src/storage/config.ts

@@ -33,7 +33,6 @@ export async function getOriginConfig() {
       process.env.OPENAI_ACCESS_TOKEN,
       process.env.OPENAI_API_BASE_URL,
       process.env.OPENAI_API_MODEL || 'ChatGPTAPI',
-      process.env.OPENAI_CHAT_MODEL || 'gpt-3.5-turbo',
       process.env.API_REVERSE_PROXY,
       (process.env.SOCKS_PROXY_HOST && process.env.SOCKS_PROXY_PORT)
         ? (`${process.env.SOCKS_PROXY_HOST}:${process.env.SOCKS_PROXY_PORT}`)
@@ -71,8 +70,6 @@ export async function getOriginConfig() {
     if (config.siteConfig.registerReview === undefined)
       config.siteConfig.registerReview = process.env.REGISTER_REVIEW === 'true'
   }
-  if (!isNotEmptyString(config.chatModel))
-    config.chatModel = 'gpt-3.5-turbo'
   if (config.apiModel !== 'ChatGPTAPI' && config.apiModel !== 'ChatGPTUnofficialProxyAPI') {
     if (isNotEmptyString(config.accessToken))
       config.apiModel = 'ChatGPTUnofficialProxyAPI'

service/src/storage/model.ts

@@ -21,6 +21,7 @@ export class UserInfo {
   avatar?: string
   description?: string
   updateTime?: string
+  config?: UserConfig
   constructor(email: string, password: string) {
     this.name = email
     this.email = email
@@ -32,6 +33,13 @@ export class UserInfo {
   }
 }
 
+export class UserConfig {
+  chatModel: CHATMODEL
+}
+
+// https://platform.openai.com/docs/models/overview
+export type CHATMODEL = 'gpt-3.5-turbo' | 'gpt-3.5-turbo-0301' | 'gpt-4' | 'gpt-4-0314' | 'gpt-4-32k' | 'gpt-4-32k-0314' | 'ext-davinci-002-render-sha-mobile' | 'gpt-4-mobile' | 'gpt-4-browsing'
+
 export class ChatRoom {
   _id: ObjectId
   roomId: number
@@ -130,7 +138,6 @@ export class Config {
     public accessToken?: string,
     public apiBaseUrl?: string,
     public apiModel?: string,
-    public chatModel?: string,
     public reverseProxy?: string,
     public socksProxy?: string,
     public socksAuth?: string,