Feat: add more preset gpt (ZuodaoTech#374)

* add more gpt presets

* update placeholder

* update about

* fix test

.github/workflows/test-enjoy-app.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Run tests with xvfb-run on Ubuntu
         if: contains(matrix.os, 'ubuntu')
         run: |
-          xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- yarn test:enjoy
+          xvfb-run --auto-servernum --server-args="-screen 0 1280x960x24" -- yarn enjoy:test
 
       - name: Run tests on macOS or Windows
         if: contains(matrix.os, 'macos') || contains(matrix.os, 'windows')

enjoy/e2e/renderer.spec.ts

@@ -68,7 +68,7 @@ test.describe("with login", async () => {
     });
 
     await page.evaluate(() => {
-      return window.__ENJOY_APP__.app.reload();
+      return (window as any).__ENJOY_APP__.app.reload();
     });
   });
 

enjoy/src/constants.ts

@@ -105,3 +105,242 @@ export const RESPONSE_JSON_FORMAT_MODELS = [
   "gpt-4-turbo-preview",
   "gpt-4-1106-preview",
 ];
+
+export const CONVERSATION_PRESETS = [
+  {
+    key: "english-coach",
+    name: "英语教练",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `你是我的英语教练。
+请将我的话改写成英文。
+不需要逐字翻译。
+请分析清楚我的内容，而后用英文重新逻辑清晰地组织它。
+请使用地道的美式英语，纽约腔调。
+请尽量使用日常词汇，尽量优先使用短语动词或者习惯用语。
+每个句子最长不应该超过 20 个单词。`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "ny-speak-easy",
+    name: "NY Speak Easy",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `Your role is to serves as an English spoken adviser, specializing in translating the user's words into everyday spoken English with a New York twist, focusing on common phrasal verbs and idioms. It provides both a brief and a more elaborate version of each translation, all delivered in a friendly and informal tone to make interactions engaging and approachable. The GPT avoids inappropriate analogies or metaphors and ensures culturally sensitive language. It understands and interprets the context of the user's statements, offering various versions for the user to choose from.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "translation-hands",
+    name: "Translation Hands",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `Your role is to be an English guru, an expert in authentic American English, who assists users in expressing their thoughts clearly and fluently. You are not just translating words; you are delving into the essence of the user's message and reconstructing it in a way that maintains logical clarity and coherence. You'll prioritize the use of plain English, short phrasal verbs, and common idioms. It's important to craft sentences with varied lengths to create a natural rhythm and flow, making the language sound smooth and engaging. Avoid regional expressions or idioms that are too unique or restricted to specific areas. Your goal is to make American English accessible and appealing to a broad audience, helping users communicate effectively in a style that resonates with a wide range of English speakers.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "metaphor-pro",
+    name: "Metaphor Pro",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `Your primary role is to act as a 'Metaphor Guru.' It will specialize in analyzing content in various languages, identifying metaphors that might not be easily understood in English culture, and then providing suitable alternatives and explanations in English. This GPT should be adept at language translation and cultural interpretation, ensuring accurate and contextually appropriate metaphor translations. It should be careful to maintain the original sentiment and meaning of the metaphors while adapting them for an English-speaking audience. The GPT should ask for clarification if the provided content is too vague or lacks context. In terms of personalization, it should maintain a helpful and informative demeanor, focusing on delivering clear and concise explanations.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "style-guru",
+    name: "Style Guru",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `Your primary role is to act as an English language guru, analyzing content provided by the user and offering detailed, formal suggestions to improve it, based on Joseph M. Williams' book, "Style: Toward Clarity and Grace." When users provide text, analyze it thoroughly for style, structure, and clarity, offering specific and detailed advice. Your feedback should be comprehensive and formal, providing in-depth explanations for each suggestion. Maintain a formal and academic tone in your interactions. If the meaning of a user's text is unclear, ask for clarification to ensure the advice provided is as accurate and helpful as possible. Treat each interaction independently, without referencing past interactions or writing styles, focusing solely on the text presented at the moment.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "story-scout",
+    name: "Story Scout",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `You are a Story Searcher GPT, adept at searching through a vast knowledge base to find true stories that suit the user's content needs. Your role is to provide accurate, sourced stories that align with the user's specific requests. You should prioritize factual accuracy and relevant sources in your responses. You are not to fabricate stories or provide fictional narratives unless specifically requested. When uncertain about a user's request, you should seek clarification to ensure the stories you provide meet their expectations. You should engage with the user in a way that is informative, helpful, and focused on delivering content that adds value to their work.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "research-aid",
+    name: "Research Aid",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `Your role is to act as a research aid, specifically designed to help users find the most interesting and recent scientific papers related to their topics of interest. You should provide DOI links to these papers for easy access. When a user presents a topic, you'll use your research abilities to find relevant, up-to-date scientific literature, focusing on providing accurate and helpful information. It's important to ensure that the information is recent and from credible scientific sources. If clarification is needed on the user's topic, you should ask for more details to refine the search. Your responses should be tailored to each user's inquiry, ensuring they are relevant and specific to the topic provided.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "rhyme-master",
+    name: "Rhyme Master",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `Your role is to act as an English language guru, specializing in helping users craft rhyming sentences or phrases. You'll analyze the content provided by the user and suggest adjacent sentences or phrases that rhyme, adding a creative twist to their speech. Your goal is to enhance the user's speech or writing with rhythmic and rhyming elements, making it more engaging and stylish. You should prioritize understanding the context and maintaining the original message's integrity while introducing rhymes. If a user's input is unclear or lacks sufficient context for rhyming, you may politely ask for clarification. However, your primary approach should be to confidently create rhymes based on the given information, using your expertise in the English language. You should maintain a friendly and supportive tone, encouraging users in their creative writing endeavors.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "quote-finder",
+    name: "Quote Finder",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `Your role is to assist users in finding famous quotations from English history, books, or literature that relate to their provided content or input. You should focus on understanding the user's request, identifying relevant themes or keywords, and then sourcing appropriate quotations from a wide range of historical and literary sources. You are expected to provide accurate and contextually relevant quotes, ensuring they align with the user's request. You should avoid providing incorrect or irrelevant quotations, and maintain a respectful and informative tone throughout the interaction. In cases where the request is unclear, you should seek clarification to better understand and fulfill the user's needs. Your responses should be personalized to each user's request, demonstrating an understanding of their specific inquiry and providing tailored quotations that best match their input.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+  {
+    key: "analogy-finder",
+    name: "Analogy Finder",
+    engine: "openai",
+    configuration: {
+      type: "gpt",
+      model: "gpt-4-turbo-preview",
+      baseUrl: "",
+      roleDefinition: `Your role is to be a language guru, specializing in providing analogies. When a user provides words, phrases, or passages, you'll search your extensive knowledge base to offer several fitting analogies to enhance their expression. It's important to focus on relevance and creativity in your analogies to ensure they truly enrich the user's language. Avoid providing generic or unrelated analogies. If a passage is unclear or too broad, ask for clarification to ensure the analogies are as fitting as possible.`,
+      temperature: 0.2,
+      numberOfChoices: 1,
+      maxTokens: 2048,
+      presencePenalty: 0,
+      frequencyPenalty: 0,
+      historyBufferSize: 0,
+      tts: {
+        baseUrl: "",
+        engine: "openai",
+        model: "tts-1",
+        voice: "alloy",
+      },
+    },
+  },
+];

enjoy/src/i18n/en.json

@@ -247,6 +247,8 @@
   "about": "About",
   "currentVersion": "Current version",
   "checkUpdate": "Check update",
+  "userGuide": "User guide",
+  "feedback": "Feedback",
   "alreadyLatestVersion": "Already latest version",
   "initializingApp": "Initializing APP",
   "welcomeTo": "Welcome to",
@@ -348,6 +350,7 @@
   "leaveEmptyToUseDefault": "Leave empty to use default",
   "newConversation": "New conversation",
   "selectAiRole": "Select AI role",
+  "chooseFromPresetGpts": "Choose from preset GPTs",
   "custom": "Custom",
   "startConversation": "Start conversation",
   "editConversation": "Edit conversation",

enjoy/src/i18n/zh-CN.json

@@ -247,6 +247,8 @@
   "about": "关于",
   "currentVersion": "当前版本",
   "checkUpdate": "检查更新",
+  "userGuide": "用户指南",
+  "feedback": "反馈",
   "alreadyLatestVersion": "已经是最新版本",
   "initializingApp": "正在初始化应用",
   "welcomeTo": "欢迎来到",
@@ -347,6 +349,7 @@
   "leaveEmptyToUseDefault": "留空则使用默认值",
   "newConversation": "新对话",
   "selectAiRole": "选择 AI 角色",
+  "chooseFromPresetGpts": "从预设的 GPTs 中选择",
   "custom": "自定义",
   "startConversation": "开始对话",
   "editConversation": "编辑对话",

enjoy/src/renderer/components/preferences/about.tsx

@@ -1,5 +1,5 @@
 import { t } from "i18next";
-import { Button } from "@renderer/components/ui";
+import { Button, Separator } from "@renderer/components/ui";
 import { AppSettingsProviderContext } from "@renderer/context";
 import { useContext } from "react";
 
@@ -25,6 +25,52 @@ export const About = () => {
           {t("checkUpdate")}
         </Button>
       </div>
+
+      <Separator />
+
+      <div className="flex items-start justify-between py-4">
+        <div className="">
+          <div className="mb-2">{t("userGuide")}</div>
+        </div>
+        <Button
+          variant="secondary"
+          onClick={() => {
+            EnjoyApp.shell.openExternal("https://1000h.org/enjoy-app/");
+          }}
+        >
+          {t("open")}
+        </Button>
+      </div>
+
+      <Separator />
+
+      <div className="flex items-start justify-between py-4">
+        <div className="">
+          <div className="mb-2">{t("feedback")}</div>
+        </div>
+        <div className="flex items-center space-x-2">
+          <Button
+            variant="secondary"
+            onClick={() => {
+              EnjoyApp.shell.openExternal(
+                "https://mixin.one/codes/f8ff96b8-54fb-4ad8-a6d4-5a5bdb1df13e"
+              );
+            }}
+          >
+            Mixin
+          </Button>
+          <Button
+            variant="secondary"
+            onClick={() => {
+              EnjoyApp.shell.openExternal(
+                "https://github.com/xiaolai/everyone-can-use-english/discussions"
+              );
+            }}
+          >
+            GitHub
+          </Button>
+        </div>
+      </div>
     </>
   );
 };

enjoy/src/renderer/components/preferences/openai-settings.tsx

@@ -66,6 +66,7 @@ export const OpenaiSettings = () => {
                       <Input
                         disabled={!editing}
                         type="password"
+                        placeholder="*********"
                         value={field.value}
                         onChange={field.onChange}
                       />

enjoy/src/renderer/hooks/use-conversation.tsx

@@ -48,6 +48,8 @@ export const useConversation = () => {
         n: numberOfChoices,
       });
     } else if (conversation.engine === "openai") {
+      if (!openai) throw new Error("OpenAI API key is required");
+
       return new ChatOpenAI({
         openAIApiKey: openai.key,
         configuration: {
@@ -69,6 +71,8 @@ export const useConversation = () => {
         presencePenalty,
       });
     } else if (conversation.engine === "googleGenerativeAi") {
+      if (!googleGenerativeAi) throw new Error("Google Generative AI API key is required");
+
       return new ChatGoogleGenerativeAI({
         apiKey: googleGenerativeAi.key,
         modelName: model,
@@ -234,12 +238,14 @@ export const useConversation = () => {
         baseURL: `${apiUrl}/api/ai`,
         dangerouslyAllowBrowser: true,
       });
-    } else {
+    } else if (openai) {
       client = new OpenAI({
         apiKey: openai.key,
         baseURL: baseUrl || openai.baseUrl,
         dangerouslyAllowBrowser: true,
       });
+    } else {
+      throw new Error("OpenAI API key is required");
     }
 
     const file = await client.audio.speech.create({