feat: enable support for add http proxy for openai #52 (#53)

feat: enable support for adding http proxy for openai able to add config for Openai to send requests through the proxy Refs: #52 Signed-off-by: seven <[email protected]>
geek-fun · Apr 29, 2024 · 5a5f44d · 5a5f44d
1 parent d792022
commit 5a5f44d
Show file tree

Hide file tree

Showing 12 changed files with 69 additions and 38 deletions.
diff --git a/components.d.ts b/components.d.ts
@@ -21,6 +21,7 @@ declare module 'vue' {
     NCardHeader: typeof import('naive-ui')['NCardHeader']
     NConfigProvider: typeof import('naive-ui')['NConfigProvider']
     NDialogProvider: typeof import('naive-ui')['NDialogProvider']
+    NDivider: typeof import('naive-ui')['NDivider']
     NDropdown: typeof import('naive-ui')['NDropdown']
     NForm: typeof import('naive-ui')['NForm']
     NFormItem: typeof import('naive-ui')['NFormItem']

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,6 +28,7 @@
     "electron-store": "^8.1.0",
     "highlight.js": "^11.9.0",
     "https-proxy-agent": "^7.0.4",
+    "lodash": "^4.17.21",
     "markdown-it": "^14.1.0",
     "monaco-editor": "^0.46.0",
     "node-fetch": "^2.7.0",

diff --git a/src/electron/chatBotApi.ts b/src/electron/chatBotApi.ts
@@ -1,6 +1,7 @@
 import OpenAI from 'openai';
 import { HttpsProxyAgent } from 'https-proxy-agent';
 import fetch from 'node-fetch';
+import { isEmpty } from 'lodash';
 
 export enum ChatBotApiMethods {
   ASK = 'ASK',
@@ -17,14 +18,14 @@ export type ChatBotApiInput = {
   model?: string;
   assistantId?: string;
   threadId?: string;
+  httpProxy?: string;
 };
 
 const ASSISTANT_NAME = 'dockit-assistant';
 
-const createOpenaiClient = ({ apiKey }: { apiKey: string }) => {
-  const httpAgent = process.env.https_proxy
-    ? new HttpsProxyAgent(process.env.https_proxy)
-    : undefined;
+const createOpenaiClient = ({ apiKey, httpProxy }: { apiKey: string; httpProxy?: string }) => {
+  const proxy = !isEmpty(httpProxy) ? httpProxy : process.env.https_proxy;
+  const httpAgent = !isEmpty(proxy) ? new HttpsProxyAgent(proxy) : undefined;
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
   return new OpenAI({ httpAgent, apiKey, fetch });
@@ -90,14 +91,16 @@ const chatBotApi = {
     prompt,
     model,
     assistantId,
+    httpProxy,
   }: {
     apiKey: string;
     prompt: string;
     model: string;
+    httpProxy?: string;
     assistantId: string;
   }) => {
     // get the assistant by assistantId
-    const openai = createOpenaiClient({ apiKey });
+    const openai = createOpenaiClient({ apiKey, httpProxy });
     const assistant = await openai.beta.assistants.retrieve(assistantId);
     if (!assistant) {
       throw new Error('Assistant not found');
@@ -108,9 +111,17 @@ const chatBotApi = {
       instructions: prompt,
     });
   },
-  findAssistant: async ({ apiKey, assistantId }: { apiKey: string; assistantId: string }) => {
+  findAssistant: async ({
+    apiKey,
+    assistantId,
+    httpProxy,
+  }: {
+    apiKey: string;
+    assistantId: string;
+    httpProxy?: string;
+  }) => {
     try {
-      const openai = createOpenaiClient({ apiKey });
+      const openai = createOpenaiClient({ apiKey, httpProxy });
       return await openai.beta.assistants.retrieve(assistantId);
     } catch ({ status, details }) {
       if (status === 404) {
@@ -132,10 +143,19 @@ const registerChatBotApiListener = (
     'chatBotApi',
     async (
       _,
-      { method, question, apiKey, prompt, model, assistantId, threadId }: ChatBotApiInput,
+      {
+        method,
+        question,
+        apiKey,
+        prompt,
+        model,
+        assistantId,
+        threadId,
+        httpProxy,
+      }: ChatBotApiInput,
     ) => {
       if (method === ChatBotApiMethods.INITIALIZE) {
-        openai = createOpenaiClient({ apiKey });
+        openai = createOpenaiClient({ apiKey, httpProxy });
 
         const { assistantId, threadId } = await chatBotApi.initialize({
           openai,
@@ -147,17 +167,17 @@ const registerChatBotApiListener = (
 
       if (method === ChatBotApiMethods.ASK) {
         if (!openai) {
-          openai = createOpenaiClient({ apiKey });
+          openai = createOpenaiClient({ apiKey, httpProxy });
         }
         await chatBotApi.ask({ openai, assistantId, threadId, question: question, mainWindow });
       }
 
       if (method === ChatBotApiMethods.MODIFY_ASSISTANT) {
-        await chatBotApi.modifyAssistant({ apiKey, prompt, model, assistantId });
+        await chatBotApi.modifyAssistant({ apiKey, prompt, model, assistantId, httpProxy });
       }
 
       if (method === ChatBotApiMethods.FIND_ASSISTANT) {
-        return await chatBotApi.findAssistant({ apiKey, assistantId });
+        return await chatBotApi.findAssistant({ apiKey, assistantId, httpProxy });
       }
     },
   );

diff --git a/src/electron/preload.ts b/src/electron/preload.ts
@@ -32,21 +32,16 @@ contextBridge.exposeInMainWorld('fetchApi', {
 });
 
 contextBridge.exposeInMainWorld('chatBotApi', {
-  initialize: async (args: { apiKey: string; prompt: string; model: string }) =>
+  initialize: async (args: { apiKey: string; prompt: string; model: string; httpProxy?: string }) =>
     ipcRenderer.invoke('chatBotApi', { method: 'INITIALIZE', ...args }),
 
-  ask: async ({
-    question,
-    apiKey,
-    assistantId,
-    threadId,
-  }: {
+  ask: async (args: {
     apiKey: string;
     question: string;
     assistantId: string;
     threadId: string;
-  }) =>
-    ipcRenderer.invoke('chatBotApi', { method: 'ASK', question, apiKey, assistantId, threadId }),
+    httpProxy?: string;
+  }) => ipcRenderer.invoke('chatBotApi', { ...args, method: 'ASK' }),
 
   onMessageReceived: (callback: (value: unknown) => void) =>
     ipcRenderer.on('chat-bot-api-message-delta', (_event, value) => callback(value)),
@@ -56,8 +51,9 @@ contextBridge.exposeInMainWorld('chatBotApi', {
     prompt: string;
     model: string;
     assistantId: string;
+    httpProxy?: string;
   }) => ipcRenderer.invoke('chatBotApi', { method: 'MODIFY_ASSISTANT', ...args }),
 
-  findAssistant: async (args: { apiKey: string; assistantId: string }) =>
+  findAssistant: async (args: { apiKey: string; assistantId: string; httpProxy?: string }) =>
     ipcRenderer.invoke('chatBotApi', { method: 'FIND_ASSISTANT', ...args }),
 });
diff --git a/src/lang/enUS.ts b/src/lang/enUS.ts
@@ -22,6 +22,7 @@ export const enUS = {
       model: 'Model',
       apiKey: 'API Key',
       prompt: 'Prompt',
+      proxy: 'Network Proxy',
       form: {
         reset: 'Reset',
         save: 'Save & Enable',

diff --git a/src/lang/zhCN.ts b/src/lang/zhCN.ts
@@ -22,6 +22,7 @@ export const zhCN = {
       model: '模型',
       apiKey: 'API密钥',
       prompt: '提示词',
+      proxy: '网络代理',
       form: {
         reset: '重置',
         save: '保存并启用',

diff --git a/src/store/appStore.ts b/src/store/appStore.ts
@@ -21,7 +21,7 @@ export const useAppStore = defineStore('app', {
     uiThemeType: Exclude<ThemeType, ThemeType.AUTO>;
     skipVersion: string;
     aigcConfig: {
-      openAi: { apiKey?: string; model?: string; prompt?: string };
+      openAi: { apiKey?: string; model?: string; prompt?: string; httpProxy?: string };
     };
   } => {
     return {

diff --git a/src/store/chatStore.ts b/src/store/chatStore.ts
@@ -50,14 +50,12 @@ export const useChatStore = defineStore('chat', {
   actions: {
     async fetchChats() {
       const chats = await storeAPI.get('chats', undefined);
-      console.log('chats', JSON.stringify({ chats }));
       if (!chats || !chats.length) {
         return;
       }
       const { assistantId } = chats[0];
-      const { apiKey } = await getOpenAiConfig();
-      const assistant = await chatBotApi.findAssistant({ apiKey, assistantId });
-      console.log('assistant', JSON.stringify({ assistant }));
+      const { apiKey, httpProxy } = await getOpenAiConfig();
+      const assistant = await chatBotApi.findAssistant({ apiKey, assistantId, httpProxy });
       if (!assistant) {
         this.chats = [];
         await storeAPI.set('chats', []);
@@ -70,12 +68,13 @@ export const useChatStore = defineStore('chat', {
       if (!assistantId) {
         return;
       }
-      const { apiKey, prompt, model } = await getOpenAiConfig();
+      const { apiKey, prompt, model, httpProxy } = await getOpenAiConfig();
       await chatBotApi.modifyAssistant({
         apiKey,
         prompt: prompt ?? lang.global.t('setting.ai.defaultPrompt'),
         model,
         assistantId,
+        httpProxy,
       });
     },
     async sendMessage(content: string) {
@@ -97,18 +96,18 @@ export const useChatStore = defineStore('chat', {
         });
         receiveRegistration = true;
       }
-
+      const { apiKey, prompt, model, httpProxy } = await getOpenAiConfig();
       if (!this.chats[0]) {
         const chats = await storeAPI.get('chats', undefined);
         if (chats && chats.length) {
           this.chats = chats;
         } else {
           try {
-            const { apiKey, prompt, model } = await getOpenAiConfig();
             const { assistantId, threadId } = await chatBotApi.initialize({
               apiKey,
               model,
               prompt: prompt ?? lang.global.t('setting.ai.defaultPrompt'),
+              httpProxy,
             });
             this.chats.push({ id: ulid(), type: 'openai', messages: [], assistantId, threadId });
             await storeAPI.set('chats', pureObject(this.chats));
@@ -131,13 +130,12 @@ export const useChatStore = defineStore('chat', {
         ? `user's question: ${content} context: indexName - ${index.index}, indexMapping - ${index.mapping}`
         : `user's question: ${content}`;
       try {
-        const openaiConfig = await getOpenAiConfig();
-
         await chatBotApi.ask({
           question,
           assistantId,
           threadId,
-          apiKey: openaiConfig.apiKey,
+          apiKey,
+          httpProxy,
         });
       } catch (err) {
         messages[messages.length - 1].status = MessageStatus.FAILED;

diff --git a/src/views/editor/index.vue b/src/views/editor/index.vue
@@ -217,7 +217,7 @@ const executeQueryAction = async (
       ...action,
       index: action.index || established.value?.activeIndex?.index,
     });
-    console.log('get response data: ', data);
+
     displayJsonEditor(JSON.stringify(data, null, '  '));
   } catch (err) {
     const { status, details } = err as CustomError;

diff --git a/src/views/setting/components/aigc.vue b/src/views/setting/components/aigc.vue
@@ -16,6 +16,10 @@
               :placeholder="$t('setting.ai.defaultPrompt')"
             />
           </n-form-item-row>
+          <n-divider />
+          <n-form-item-row :label="$t('setting.ai.proxy')">
+            <n-input v-model:value="openAi.httpProxy" placeholder="http://127.0.0.1:7890" />
+          </n-form-item-row>
           <n-button type="error" @click="reset" class="action-button">
             {{ $t('setting.ai.form.reset') }}
           </n-button>
@@ -44,7 +48,7 @@ const { fetchChats, modifyAssistant } = chatStore;
 
 const openAi = ref({ ...aigcConfig.value.openAi });
 const reset = async () => {
-  openAi.value = { apiKey: '', model: '', prompt: '' };
+  openAi.value = { apiKey: '', model: '', prompt: '', httpProxy: '' };
   await saveAigcConfig({ ...aigcConfig.value, openAi: openAi.value, enabled: false });
 };
 

diff --git a/src/vite-env.d.ts b/src/vite-env.d.ts
@@ -35,16 +35,19 @@ export interface IChatBotAPI {
     apiKey,
     prompt,
     model,
+    httpProxy,
   }: {
     apiKey: string;
     prompt: string;
     model: string;
+    httpProxy?: string;
   }) => Promise<{ assistantId: string; threadId: string }>;
   ask: (args: {
     question: string;
     assistantId: string;
     threadId: string;
     apiKey: string;
+    httpProxy?: string;
   }) => Promise<void>;
   onMessageReceived: (
     fn: (value: {
@@ -66,14 +69,20 @@ export interface IChatBotAPI {
     apiKey,
     prompt,
     model,
+    httpProxy,
     assistantId,
   }: {
     apiKey: string;
     prompt: string;
     model: string;
+    httpProxy?: string;
     assistantId: string;
   }) => Promise<void>;
-  findAssistant: (args: { apiKey: string; assistantId: string }) => Promise<unknown>;
+  findAssistant: (args: {
+    apiKey: string;
+    assistantId: string;
+    httpProxy?: string;
+  }) => Promise<unknown>;
 }
 
 export interface ISourceFileAPI {